X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9a29912f608e082001ee53b9873323c4bcd71f21..05f9197a346867069e89558a4e663cf54b2fd23b:/utils/tex2rtf/docs/tex2rtf.tex diff --git a/utils/tex2rtf/docs/tex2rtf.tex b/utils/tex2rtf/docs/tex2rtf.tex index 014c3e2648..f01f682d51 100644 --- a/utils/tex2rtf/docs/tex2rtf.tex +++ b/utils/tex2rtf/docs/tex2rtf.tex @@ -1,5 +1,5 @@ \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}}% @@ -8,11 +8,11 @@ \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% @@ -84,24 +84,13 @@ C++ class library \popref{wxWindows}{wxwindows}. \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 wxWindows 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}% @@ -111,6 +100,13 @@ a great help in giving advice for improvements to the manual. \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 @@ -581,6 +577,9 @@ are followed, e.g. use of $\backslash${\tt row} command in tabular environment.} 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}% @@ -669,6 +668,11 @@ and truncates filenames within HTML documents.} \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 wxWindows 2 applications (see the wxWindows manual +and the wxWindows 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. @@ -681,6 +685,7 @@ The default is 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}%