Send all menu item actions to a dedicated target. This is to ensure

[wxWidgets.git] / docs / tech / tn0003.txt

diff --git a/docs/tech/tn0003.txt b/docs/tech/tn0003.txt
index 7a79f3859b91930c9d8bc2900317c87770844a37..bec2e461abb30e8ed4f07621cabedee0145d9ef3 100644 (file)
--- a/docs/tech/tn0003.txt
+++ b/docs/tech/tn0003.txt
@@ -9,6 +9,8 @@ wxWindows uses Tex2RTF to process Latex-like input files (.tex)
 and output in HTML, WinHelp RTF and Word RTF. Tex2RTF is provided
 in the wxWindows distribution and in the CVS archive, under
 utils/tex2rtf. Please start by perusing the Tex2RTF manual.
 and output in HTML, WinHelp RTF and Word RTF. Tex2RTF is provided
 in the wxWindows distribution and in the CVS archive, under
 utils/tex2rtf. Please start by perusing the Tex2RTF manual.

+See http://www.wxwindows.org/tex2rtf/index.htm for a browseable
+manual and binaries for specific platforms.

 
 If adding to the existing manual in docs/latex/wx, you need to
 create a new .tex file, e.g. myclass.tex, and add it to the
 
 If adding to the existing manual in docs/latex/wx, you need to
 create a new .tex file, e.g. myclass.tex, and add it to the


@@ -86,12 +88,12 @@ DO:
   format and running through the Windows help compiler to check
   for missing labels, etc.
 
   format and running through the Windows help compiler to check
   for missing labels, etc.
 

-- quote all '_' characters with a '\' character (e.g. "MY\_PROGRAM" 
+- quote all '_' and '&' characters with a '\' character (e.g. "MY\_PROGRAM"

   unless the '_' is inside a comment or a \begin{verbatim} ...
   \end{verbatim} block
 
 - check that your changes/additions to any TEX documentation 
   unless the '_' is inside a comment or a \begin{verbatim} ...
   \end{verbatim} block
 
 - check that your changes/additions to any TEX documentation 

-  compiles before checking it in!  Use the '-checkcurleybrace' 
+  compiles before checking it in!  Use the '-checkcurleybraces' 

   and '-checksyntax' commandline parameters (or the OPTIONS menu 
   if running in GUI mode) to check for some of the more common 
   mistakes.  See TROUBLESHOOTING below for more details
   and '-checksyntax' commandline parameters (or the OPTIONS menu 
   if running in GUI mode) to check for some of the more common 
   mistakes.  See TROUBLESHOOTING below for more details


@@ -217,7 +219,7 @@ Creates a fresh bitmap. If the final argument is omitted, the display depth of
 the screen is used.
 
 \func{virtual bool}{Create}{\param{void*}{ data}, \param{int}{ type},
 the screen is used.
 
 \func{virtual bool}{Create}{\param{void*}{ data}, \param{int}{ type},

- \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = -1}}
+ \param{int}{ width}, \param{int}{ height}, \param{int}{ depth = $-1$}}

 
 Creates a bitmap from the given data, which can be of arbitrary type.
 
 
 Creates a bitmap from the given data, which can be of arbitrary type.
 


@@ -236,7 +238,7 @@ of possible values.}
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the call succeeded, FALSE otherwise.
+\true if the call succeeded, \false otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -268,3 +270,7 @@ Special forms:
 
 - use \destruct macro for the destructors \func{}{\destruct{MyClass}}{\void}
 
 
 - use \destruct macro for the destructors \func{}{\destruct{MyClass}}{\void}
 

+- use \true and \false instead of true/TRUE/{\tt true}/...
+
+- use \arg{paramname} to refer to the argument inside of the function
+  description