Contents Up Previous Next

Tex2RTF Commands

backgroundcolour:1
backgroundimage:1
backslashraw:0
bcol:2
brclear:0
cextract:0
chapterheading:1
cinsert:0
class:1
clipsfunc:3
copyright:0
cparam:2
definecolour:4
fcol:2
followedlinkcolour:1
footnotepopup:2
functionsection:1
func:3
gloss:1
helpglossary:1
helpignore:1
helponly:1
helpinput:1
helpfontfamily:1
helpfontsize:1
helpref:2
helprefn:2
htmlignore:1
htmlonly:1
image:2
imagel:2
imagemap:3
imager:2
indented:2
latexignore:1
latexonly:1
lbraceraw:0
linkcolour:1
membersection:1
member:1
normalbox:1
normalboxd:1
param:1
popref:2
psboxto:2
rbraceraw:0
registered:0
row:1
ruledrow:1
rtfignore:1
rtfonly:1
rtfsp:0
sectionheading:1
setfooter:6
setheader:6
sethotspotcolour:1
sethotspotunderline:1
settransparency:1
textcolour:1
toocomplex:1
twocolitem:2
twocolitemruled:2
twocollist:1
twocolwidtha:1
twocolwidthb:1
urlref:2
winhelpignore:1
winhelponly:1
xlpignore:1
xlponly:1


backgroundcolour:1

Specifies the page background colour, in HTML only. The argument consists of three numbers from 0 to 255 separated by semicolons, for red, green and blue values respectively.

    \backgroundcolour{255;255;255}
    \backgroundcolour{0;0;255}
The first example sets the background to white, the second sets the background to blue.

Instead of using a LaTeX command, you may find it more convenient to use the equivalent .ini file setting, backgroundColour.


backgroundimage:1

Specifies the page background image, in HTML only. The argument is a URL for the GIF file to be used as the background.

For example:

    \backgroundimage{tile.gif}
This sets the background to a tile file.

Instead of using a LaTeX command, you may find it more convenient to use the equivalent .ini file setting, backgroundImage.


backslashraw:0

Outputs a raw backslash into the output (not LaTeX). Useful when inserting RTF (for example) that cannot be dealt with by Tex2RTF. E.g.

    \backslashraw{'e3}
inserts the text \'e3 into the RTF file.


bcol:2

Sets the background colour for a block of text (RTF only). Has no known effect in the RTF readers currently tried (Word for Window and Windows Help).

See also \definecolour, \fcol.


brclear:0

Stops aligning content following a left or right-aligned image in HTML only.

See also \imagel, \imager.


cextract:0

Prints a C++ extraction operator (>>).


chapterheading:1

Like \chapter, but does not increment the chapter number and does not print a chapter number in the printed documentation contents page, or in the chapter heading. Used to implement glossaries and other sections that are not real chapters.


cinsert:0

Prints a C++ insertion operator (<<).


class:1

Outputs the argument, an index entry (LaTeX only) and a keyword entry (WinHelp only). Used in class reference documentation.


clipsfunc:3

Formats a CLIPS function, given the return value, function name, and arguments.


copyright:0

Outputs the copyright symbol.


cparam:2

Formats a CLIPS type and argument. Used within the third argument of a \clipsfunc command.


definecolour:4

Defines a new colour that can be used in the document (RTF only). This command can also be spelt \definecolor.

The first argument is the lower-case name of the colour, and the following three arguments specify the red, green and blue intensities, in the range 0 to 255.

The default colours are equivalent to the following definitions:

    \definecolour{black}{0}{0}{0}
    \definecolour{cyan}{0}{255}{255}
    \definecolour{green}{0}{255}{0}
    \definecolour{magenta}{255}{0}{255}
    \definecolour{red}{255}{0}{0}
    \definecolour{yellow}{255}{255}{0}
    \definecolour{white}{255}{255}{255}
To use colours in a document, use the \fcol and \bcol commands.

Note that a document that defines its own colours should be converted twice within the same Tex2RTF session.


fcol:2

Sets the foreground colour for a block of text (RTF and HTML).

For example:

    This sentence is brightened up by some \fcol{red}{red text}.
gives:

This sentence is brightened up by some red text.

See also \definecolour, \bcol.


followedlinkcolour:1

Specifies the followed link colour for the whole page, HTML only. The argument consists of three numbers from 0 to 255 separated by semicolons, for red, green and blue values respectively.

For example:

    \followedlinkcolour{255;255;255}
    \followedlinkcolour{0;0;255}
The first example sets the followed link text to white, and the second sets the followed link text to blue.

See also \backgroundcolour, \textcolour, \linkcolour.

Instead of using a LaTeX command, you may find it more convenient to use the equivalent .ini file setting, followedLinkColour.


footnotepopup:2

In linear RTF, a footnote is created following the first argument, as with \footnote.

In WinHelp RTF, a the first argument is highlighted and becomes a popup reference to the second argument. See also \footnote and \popref.

This command is not supported for formats other than LaTeX, linear RTF and WinHelp RTF.


functionsection:1

Defines a subsection, adding the C++ function name to the LaTeX index or the WinHelp keyword list.

Should be followed by a \func command to specify function details.


func:3

Defines a C++ function, given the return type, function name, and parameter list.

Should occur after a \functionsection command.


gloss:1

Marks a glossary entry. In LaTeX, this is a synonym for an \item with an optional argument, within a \description environment, and the argument is added to the index.

In Windows Help, this is identical to a \section* in a report.

If labels are associated with the glossary entries, they can be referenced by \helpref or \popref jumps. A glossary entry is currently the only type of destination that popref may refer to.

This is an example of making a glossary in a report:

    \begin{helpglossary}

    \gloss{API}\label{api}

    Application Programmer's Interface - a set of calls and
    classes defining how a library (in this case, wxWidgets)
    can be used.

    \gloss{Canvas}\label{canvas}

    A canvas in XView and wxWidgets is a subwindow...

    \gloss{DDE}\label{dde}

    Dynamic Data Exchange - Microsoft's interprocess
    communication protocol. wxWidgets provides an abstraction
    of DDE under both Windows and UNIX.

    \end{helpglossary}

helpglossary:1

An environment for making a glossary (not standard LaTeX). See \gloss for usage.


helpignore:1

Ignores the argument in Tex2RTF generated files, but not LaTeX.


helponly:1

Only outputs the argument in Tex2RTF generated files.


helpinput:1

Only includes the given file in Tex2RTF generated files.


helpfontfamily:1

Specifies the font family for Tex2RTF generated files. The argument may be Swiss or Times.


helpfontsize:1

Specifies the font size for Tex2RTF generated files.


helpref:2

Specifies a jump to a labelled chapter, section, subsection subsubsection or figure.

The first argument is text to be highlighted (mouseable in help systems) and the second is the reference label. In linear documents, the section number is given following the text, unless the \helprefn command is used instead, where the section number is suppressed.

Note that when generating HTML, the label contents is automatically defined, and may be referenced using \helpref.


helprefn:2

Specifies a jump to a labelled chapter, section, subsection subsubsection or figure.

The first argument is text to be highlighted (mouseable in help systems) and the second is the reference label. See \helpref for the form where the section number is printed in linear documents.


htmlignore:1

Ignores the argument in HTML.


htmlonly:1

Only outputs the argument in HTML.


image:2

This is translated to a PSBOX macro package \psboxto command in LaTeX, the first argument being a sizing command and the second a filename.

In HTML mode, the second argument is used to generate a PostScript file reference.

In RTF mode, the second argument is tried with first a BMP extension and then a WMF extension to find a suitable Windows bitmap file, placeable metafile, or segmented hypergraphics file (.SHG). If a suitable file is found, in Windows Help mode a bmc command is inserted into the RTF file with a reference to the file. In linear RTF mode, the bitmap or metafile is converted into hex and inserted into the RTF document.

Note that only RGB-encoded Windows bitmaps, or placeable metafiles, are valid for input to Tex2RTF. You can convert a RLE (run length encoded) bitmap file into a (bigger) RGB file using a program such as Paintshop Pro. A placeable metafile has a special header with dimension information. One may be constructed by a wxWidgets program by calling the function wxMakeMetafilePlaceable. The Microsoft Windows SDK has a sample program that loads and steps through placeable and ordinary metafiles.

Another wrinkle is that programs differ in the methods they use to recognise pictures in RTF files. You may need to use the bitmapMethod setting, which can be "hex'' (embed the hex data in the file with a \dibitmap keyword), "includepicture'' (use the MS Word 6.0 INCLUDEPICTURE field) or "import'' (an earlier name for INCLUDEPICTURE).

Here is an example of using the \image command.

    \begin{figure}
    $$\image{5cm;0cm}{heart.ps}$$

    \caption{My picture}\label{piccy}
    \end{figure}
The dollars centre the image in the horizontal plane. The syntax of the first argument to \image is taken from syntax used by the \psbox package: it allows specification of the horizontal and vertical dimensions of the image. Scaling will take place for PostScript and metafile images. A value of zero indicates that the image should be scaled in proportion to the non-zero dimension. Zeros for both dimensions will leave the image unscaled in the case of metafiles, or scaled to fit the page in the case of PostScript.

See also \imagel, \imager for aligned images in HTML.


imagel:2

Similar to \image, but left-aligns the image with respect to the following content. Use \brclear to stop aligning the content to the right of the image.

See also \imager.


imagemap:3

This is translated to an HTML image map reference, or (in LaTeX) a PostScript psbox command. This allows images in HTML to have hotspots, where the user clicks on a part of the image and the browser jumps to a particular file.

The first argument is the same as the first argument to the \image command (ignored in HTML). The second argument must be the name of the image map entry, and the second is the filename to be displayed inline.

    \imagemap{}{tree.gif}{myname}
translates to:

    <a href="/cgi-bin/imagemap/mymap">
      <img src="tree.gif" ismap></a><p>
The snag with this is that, apart from the inconvenience of having to register a map file with the server, the map file will also have references to particular HTML files. If they exist in the current document, these names are not known until the file is generated. In which case, the map entries should probably refer to symbolic links that can be easily changed later.


imager:2

Similar to \image, but right-aligns the image with respect to the following content. Use \brclear to stop aligning the content to the left of the image.

See also \imagel.


indented:2

Environment supplied by Tex2RTF to allow (possibly nested) indentation of LaTeX and RTF text. The first argument is the amount to be indented.

For example:

    \begin{indented}{2cm}
    This text should be indented by a couple of centimetres.
    This can be useful to highlight paragraphs.
    \end{indented}
produces:


latexignore:1

Ignores the argument in LaTeX.


latexonly:1

Only prints the argument in LaTeX.


lbraceraw:0

Outputs a raw left brace into the output (not LaTeX). Useful when inserting RTF (for example) that cannot be dealt with by Tex2RTF.


linkcolour:1

Specifies the link colour for the whole page, HTML only. The argument consists of three numbers from 0 to 255 separated by semicolons, for red, green and blue values respectively.

For example:

    \linkcolour{255;255;255}
    \linkcolour{0;0;255}
The first example sets the link text to white, and the second sets the link text to blue.

See also \backgroundcolour, \textcolour, \followedlinkcolour.

Instead of using a LaTeX command, you may find it more convenient to use the equivalent .ini file setting, linkColour.


membersection:1

Used when formatting C++ classes to print a subsection for the member name.


member:1

Used to format a C++ member variable name.


normalbox:1

Draws a box around the given paragraph in LaTeX and RTF. In HTML and XLP formats, horizontal rules are drawn before and after the text.

For example:

    \normalbox{This should be a boxed paragraph for highlighting
    important information, such as information for registering
    a shareware program.}
gives:


This should be a boxed paragraph for highlighting important information, such as information for registering a shareware program.

See also \normalboxd for double-bordered text.


normalboxd:1

Draws a double border around the given paragraph in LaTeX and RTF. In HTML and XLP formats, horizontal rules are drawn before and after the text.

For example:

    \normalboxd{This should be a boxed paragraph for
    highlighting important information, such as information
    for registering a shareware program.}
gives:


This should be a boxed paragraph for highlighting important information,such as information for registering a shareware program.

See also \normalbox for single-bordered text.


param:1

Formats a C++ type and argument pair. Should be used within the third argument of a a \func command.


popref:2

Similar to \helprefn, except that in Windows Help, the destination text is popped up in a small window to be dismissed with a mouse click, instead of going to a separate section.

Currently this command can only refer to a labelled glossary entry; see \gloss.


psboxto:2

Identical to \image.


rbraceraw:0

Outputs a raw right brace into the output (not LaTeX). Useful when inserting RTF (for example) that cannot be dealt with by Tex2RTF.


registered:0

Outputs the 'registered' symbol in HTML, and (r) in other formats.


row:1

A Tex2RTF command signifying the row of a table within the \tabular environment. See also \ruledrow.


ruledrow:1

A Tex2RTF command signifying a ruled row of a table within the \tabular environment. See also \row.


rtfignore:1

Ignores the argument in linear RTF.


rtfonly:1

Only outputs the argument in linear RTF.


rtfsp:0

Outputs a space in RTF. Tex2RTF tries to insert a space where one is implied by a newline, but cannot cope where a line starts or ends with a command, in the middle of a paragraph. Use this command to insert a space explicitly.


sectionheading:1

Like \section, but does not increment the section number and does not print a section number in the printed documentation contents page, or in the section heading.


setfooter:6

Tex2RTF has a non-standard way of setting headers and footers, but the default macro definitions in texhelp.sty may be altered to your current method.

The arguments are as follows:

  1. Left footer, even pages
  2. Centre footer, even pages
  3. Right footer, even pages
  4. Left footer, odd pages
  5. Centre footer, odd pages
  6. Right footer, odd pages

For many documents, the first three arguments will be left empty.

The behaviour for first pages of a chapter, section or document is to have a blank header, but print the footer.

For best results, define headers and footers for each chapter or section.

Note that this command works only for LaTeX and linear RTF. See also \setheader.


setheader:6

Tex2RTF has a non-standard way of setting headers and footers, but the default macro definitions in texhelp.sty may be altered to your current method.

The arguments are as follows:

  1. Left header, even pages
  2. Centre header, even pages
  3. Right header, even pages
  4. Left header, odd pages
  5. Centre header, odd pages
  6. Right header, odd pages

For many documents, the first three arguments will be left empty. If \pagestyle is not plain or empty, the header will separated from the rest of the page by a rule.

The behaviour for first pages of a chapter, section or document is to have a blank header, but print the footer.

For best results, define headers and footers for each chapter or section.

Note that this command works only for LaTeX and linear RTF. See also \setfooter.


sethotspotcolour:1

If the argument is yes, on or ok, subsequent WinHelp hotspots will be green. If any other value, the hotspots will be the normal text colour. Note that this doesn't apply to section hotspots, only to helpref hotspots.


sethotspotunderline:1

If the argument is yes, on or ok, subsequent WinHelp hotspots will be underlined (the default). If any other value, the hotspots will not be underlined. Note that this doesn't apply to section hotspots, only to helpref hotspots.


settransparency:1

WinHelp mode only (version 4 of WinHelp). If the argument is yes, on or ok, subsequent bitmaps will be inserted in transparent mode: areas of white will be made transparent. If the argument is any other value (such as no, ok or false), the bitmaps will not be transparent.


textcolour:1

Specifies the text foreground colour for the whole page, HTML only. The argument consists of three numbers from 0 to 255 separated by semicolons, for red, green and blue values respectively.

For example:

    \textcolour{255;255;255}
    \textcolour{0;0;255}
The first example sets the text to white, and the second sets the text to blue.

See also \backgroundcolour, \linkcolour, \followedlinkcolour.

Instead of using a LaTeX command, you may find it more convenient to use the equivalent .ini file setting, textColour.


toocomplex:1

An environment for dealing with complex LaTeX commands that Tex2RTF cannot handle. In normal LaTeX, the argument will be output as normal. In Tex2RTF output, the argument will be output as verbatim text, for the user to hand-translate into the desired output format.

See also \comment.


twocolitem:2

Used to specify a row for a two column list, a Tex2RTF extension to optimize two-column lists for different file formats. See \twocollist, \twocolitemruled.


twocolitemruled:2

Used to specify a ruled row for a two column list, a Tex2RTF extension to optimize two-column lists for different file formats. See \twocollist, \twocolitem.


twocollist:1

A Tex2RTF environment for specifying a table of two columns, often used in manuals and help files (for example, for listing commands and their meanings). The first column should be one line only, and the second can be an arbitrary number of paragraphs.

The reason that a normal tabular environment cannot be used is that WinHelp does not allow borders in table cells, so a different method must be employed if any of the rows are to be ruled. In LaTeX, a table is used to implement this environment. In RTF, indentation is used instead.

Use this environment in conjunction with \twocolitem and \twocolitemruled. To set the widths of the first and second column, use \twocolwidtha and \twocolwidthb.

Example:

    \htmlignore{\begin{twocollist}}
    \twocolitemruled{{\bf Command}}{{\bf Description}}
    \twocolitem{File}{The file menu is used to select various
    file-related operations, such as saving and loading.}
    \twocolitem{Edit}{The Edit menu is used for
    selection, copying, pasting, etc.}
    \end{twocollist}
This produces:

Command Description
File The file menu is used to select various file-related operations, such as saving and loading.
Edit The Edit menu is used for selection, copying, pasting, etc.


twocolwidtha:1

Sets the width of the first column in a two column list to the given dimension. See also \twocollist and \twocolwidthb.


twocolwidthb:1

Sets the width of the second column in a two column list to the given dimension. See also \twocollist and \twocolwidtha.


urlref:2

Specifies a jump to a URL (univeral resource location).

The first argument is text to be highlighted (mouseable in HTML browsers) and the second is the URL. In linear documents, the URL is given following the text.

Example:

    See also the \urlref{wxWidgets manual}
      {http://www.aiai.ed.ac.uk/~jacs.html}.
(the line is broken only to keep to this manual's page width).


winhelpignore:1

Ignores the argument in WinHelp RTF.


winhelponly:1

Only outputs the argument in WinHelp RTF.


xlpignore:1

Ignores the argument in XLP mode (wxHelp files).


xlponly:1

Only outputs the argument in XLP mode (wxHelp files).