\documentstyle[a4,makeidx,verbatim,texhelp,fancyhea,mysober,mytitle]{report}%
-\input{psbox.tex}
+%\input{psbox.tex}
\newcommand{\commandref}[2]{\helpref{{\tt $\backslash$#1}}{#2}}%
\newcommand{\commandrefn}[2]{\helprefn{{\tt $\backslash$#1}}{#2}\index{#1}}%
\newcommand{\commandpageref}[2]{\latexignore{\helprefn{{\tt $\backslash$#1}}{#2}}\latexonly{{\tt $\backslash$#1} {\it page \pageref{#2}}}\index{#1}}%
\parskip=10pt%
\parindent=0pt%
%\backgroundcolour{255;255;255}\textcolour{0;0;0}% Has an effect in HTML only
-\winhelpignore{\title{Manual for Tex2RTF 1.64:\\A \LaTeX\ to RTF and HTML converter}%
+\winhelpignore{\title{Manual for Tex2RTF 2.0: A \LaTeX\ to RTF and HTML converter}%
\author{Julian Smart}%
-\date{October 1997}%
+\date{November 1999}%
}%
-\winhelponly{\title{Manual for Tex2RTF 1.64}%
+\winhelponly{\title{Manual for Tex2RTF 2.0}%
\author{by Julian Smart\\$$\image{1cm;0cm}{tex2rtf.wmf}$$}%
}%
\makeindex%
non-GUI UNIX versions.
Tex2RTF was developed using the free Open Look, Motif and Windows 3.1
-C++ class library \popref{wxWindows}{wxwindows}.
+C++ class library \popref{wxWidgets}{wxwidgets}.
\section{Status of Tex2RTF}\index{status of Tex2RTF}%
-Tex2RTF is under continual development, often following users'
-suggestions. From version 1.33, Tex2RTF is effectively in a second phase
-of development. In addition to the bare minimum of syntax and facilities
-for producing useable help systems or linear RTF, commands are being
-added to allow visually effective, even aesthetically pleasing,
-documentation to be produced.
-
-Examples are the \verb$\indented$, \verb$\twocollist$ and \verb$\marginpar$\rtfsp
-commands; over time I hope to be able to reproduce most of the popular
-styles of formatting and presentation in Windows Help files, whilst
-allowing a reasonable equivalent to be generated in the other formats.
-
-Some new developments in the various formats still need to be catered
-for by Tex2RTF, such as Windows 95 help files and HTML 3.0. Features
-that can be added to Tex2RTF as a result of these developments include
-math and inline image map support in HTML, table support in Windows
-Help, and generally better formatting abilities in both. However, documentation
-about these formats is sketchy at the time of writing (October 1995).
+Windows HTML help, and wxWidgets 2 wxHTML help, are now catered for using
+the htmlWorkshopFiles setting.
+
+Tex2RTF is very rarely updated these days: it would be nice to
+rewrite the parser (and indeed the rest of it) at some point,
+to improve error reporting, space handling and ability to
+handle more advanced Tex/Latex commands.
\section{Acknowledgements}\index{acknowledgements}%
\section{Change log}\index{change log}%
+Version 2.0, August 24th 1999
+
+\begin{itemize}\itemsep=0pt
+\item Added htmlWorkshopFiles setting, to output .hpp, .hhc
+and .hhk (HTML Workshop) files, for generating MS HTML Help or wxHTML Help.
+\end{itemize}
+
Version 1.64, October 20th 1998
\begin{itemize}\itemsep=0pt
The only default filename in the list is {\tt psbox.tex}.}
\twocolitem{\inioption{isInteractive}}{If true, runs in interactive mode (the default).}
\twocolitem{\inioption{runTwice}}{If true, runs the converter twice.}
+\twocolitem{\inioption{ignoreBadRefs}}{If true (or yes), ignores bad helpref references
+and simply writes the text in the first argument. Useful when a program such as HelpGen
+generates references to classes documented in another manual.}
\end{twocollist}
\subsubsection{Presentation options}\index{options, presentation}%
\twocolitem{\inioption{htmlIndex}}{If true, specifies generation of an {\tt .htx} index file for an HTML document.
This file can be used in wxHelp version 2 or other programs. The file consists of a number of lines,
each line with three fields separated by bar characters: the indexed phrase, the file, and a label in the file.}
+
+\twocolitem{\inioption{htmlWorkshopFiles}}{If true, specifies generation of {\tt .hpp, .hhc} and {\tt .hhk} files
+which can be used to create both MS HTML Help and wxHTML Help files. wxHTML Help
+is the HTML help facility that can be used by wxWidgets 2 applications (see the wxWidgets manual
+and the wxWidgets HTML sample).}
\twocolitem{\inioption{upperCaseNames}}{If true, filenames in links are in upper case. By default
filenames are in lower case.}
\twocolitem{\inioption{backgroundColour}}{Specifies the RGB background colour for the document, e.g. {\tt 255;255;255} for white.
the generation of separate HTML files below section level. This can reduce the
number of HTML files substantially. A subsection contents list is inserted before
the first subsection.}
+\twocolitem{\inioption{htmlFaceName}}{A string specifying the overall font face, such as ``"Arial, Lucida, Helvetica".}
\end{twocollist}
\section{DDE commands}\index{DDE}%
Since Tex2RTF reads the whole file into memory, a lot of memory is needed.
For very large documents, 16MB of RAM is adviseable.
-I tested conversion of the wxWindows 1.63 manual on both VC++ 1.5 and
+I tested conversion of the wxWidgets 1.63 manual on both VC++ 1.5 and
Watcom WIN32s versions of Tex2RTF, both running under Windows 3.11 on a
Gateway P60 with 16MB of RAM and a 2MB disk cache. Two passes were
made, with 1.5MB of WinHelp RTF being generated. The unoptimized 16-bit
commonly used by documents in the World Wide Web distributed hypertext
system, and formats text dynamically rather like Windows Help.
\item wxHelp\index{wxHelp}. This is the platform-independent help system for
-the class library wxWindows (see the wxWindows User Manual \cite{smart93a}).
+the class library wxWidgets (see the wxWidgets User Manual \cite{smart93a}).
It can display ASCII files with embedded codes
for changing font styles, but no formatting is done by wxHelp.
\end{itemize}
\rtfsp\commandrefn{label}{label}, \commandrefn{helpref}{helpref},
\rtfsp\commandrefn{helprefn}{helprefn}, and \commandrefn{popref}{popref}.
Tex2RTF outputs help files that may be read linearly using the
-\rtfsp$<<$ and $>>$ buttons, and an additonal Up button for
+\rtfsp$<<$ and $>>$ buttons, with an additional Up button for
ease of navigation.
When writing HTML, multiple files are generated from one \LaTeX\ file
Optional arguments are specified using square brackets or parentheses.
-The braces that start command arguments must not be seperated from
+The braces that start command arguments must not be separated from
the other arguments by whitespace. For example, the following produces
an error:
line when invoking Tex2RTF, and compiling to a different directory.
Tex2RTF instructs the help compiler to use the input file directory
to find bitmaps and metafiles, so using a different output directory
-is not a problem. See the Tex2RTF {\tt src/makefile.dos} for an example
-of maintaining both formats.}
+is not a problem.}
There is a slight wrinkle with generation of the {\tt .cnt} file:
to work around a `feature' in the Windows 95 help compiler, Tex2RTF may insert
format your input document appropriately, with lines of reasonable length.
The generated xlp file is an ASCII file that can be read directly by
-wxHelp, the generic wxWindows help viewer.
+wxHelp, the generic wxWidgets help viewer.
\chapter{Command reference}\index{command reference}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\gloss{API}\label{api}
Application Programmer's Interface - a set of calls and
- classes defining how a library (in this case, wxWindows)
+ classes defining how a library (in this case, wxWidgets)
can be used.
\gloss{Canvas}\label{canvas}
- A canvas in XView and wxWindows is a subwindow...
+ A canvas in XView and wxWidgets is a subwindow...
\gloss{DDE}\label{dde}
Dynamic Data Exchange - Microsoft's interprocess
- communication protocol. wxWindows provides an abstraction
+ communication protocol. wxWidgets provides an abstraction
of DDE under both Windows and UNIX.
\end{helpglossary}
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 wxWindows program by calling
+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.
Example:
\begin{verbatim}
- See also the \urlref{wxWindows manual}
+ See also the \urlref{wxWidgets manual}
{http://www.aiai.ed.ac.uk/~jacs.html}.
\end{verbatim}
A typesetting language implemented as a set of \TeX\ macros. It is
distinguished for allowing specification of the document structure,
-whilst taking care of most layout concerns. It represents the opposite
+while taking care of most layout concerns. It represents the opposite
end of the spectrum from WYSIWYG word processors.
\gloss{RTF}\label{rtf}
\gloss{wxHelp}\label{wxhelp}
wxHelp is the hypertext help facility used to provide on-line
-documentation for UNIX-based wxWindows applications. Under Windows 3.1,
+documentation for UNIX-based wxWidgets applications. Under Windows 3.1,
Windows Help is used instead.
-\gloss{wxWindows}\label{wxwindows}
+\gloss{wxWidgets}\label{wxwidgets}
-wxWindows is a free C++ toolkit for writing applications that are
+wxWidgets is a free C++ toolkit for writing applications that are
portable across several platforms. Currently these are Motif, Open Look,
-Windows 3.1 and Windows NT. Tex2RTF is written using wxWindows.
+Windows 3.1 and Windows NT. Tex2RTF is written using wxWidgets.
\end{helpglossary}
projects / wxWidgets.git / blobdiff