Compilation fixes

[wxWidgets.git] / utils / tex2rtf / docs / tex2rtf.tex

\documentstyle[a4,makeidx,verbatim,texhelp,fancyhea,mysober,mytitle]{report}%
\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}}%
\newcommand{\indexit}[1]{#1\index{#1}}%
\newcommand{\inioption}[1]{{\bf {\tt #1}}\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 2.0:\\A \LaTeX\ to RTF and HTML converter}%
\author{Julian Smart}%
\date{November 1999}%
}%
\winhelponly{\title{Manual for Tex2RTF 2.0}%
\author{by Julian Smart\\$$\image{1cm;0cm}{tex2rtf.wmf}$$}%
}%
\makeindex%
\begin{document}%
\maketitle%
\pagestyle{fancyplain}%
\bibliographystyle{plain}%
\pagenumbering{roman}%
\setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
\tableofcontents%

\chapter*{Copyright notice}%
\setheader{{\it COPYRIGHT}}{}{}{}{}{{\it COPYRIGHT}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%

Copyright (c) 1997 Julian Smart.

Permission to use, copy, modify, and distribute this software and its
documentation for any purpose is hereby granted without fee, provided that the
above copyright notice, author statement and this permission notice appear in
all copies of this software and related documentation.

THE SOFTWARE IS PROVIDED ``AS-IS'' AND WITHOUT WARRANTY OF ANY KIND, EXPRESS,
IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

IN NO EVENT SHALL JULIAN SMART OR THE ARTIFICIAL INTELLIGENCE
APPLICATIONS INSTITUTE OR UNIVERSITY OF EDINBURGH BE LIABLE FOR ANY
SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR
ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY
OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.

\chapter{Introduction}%
\pagenumbering{arabic}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%

This document describes a utility for converting \popref{\LaTeX}{latexgloss}\ files into
several other formats.

Only a subset of \LaTeX\ can be processed by this utility, especially
since the target document language will never perfectly match \LaTeX.
Whether the quality of the results is good enough will depend upon the
application and your own expectations. {\it This caveat is worth emphasizing}, because
many people assume that any old \LaTeX\ document will go through without modification: it might,
but the chances are you'll need to modify it a bit for Tex2RTF. Tex2RTF was written with
portable document maintenance and generation in mind, with less emphasis on accepting all \LaTeX\ syntax.
You have been warned!

Tex2RTF is heavily biased towards making on-line, hypertext versions of
\rtfsp\LaTeX\ documents, but the \popref{RTF}{rtf} converter can be used to generate linear,
paper-based documents too.

The latest version of Tex2RTF, plus source code, can be accessedfrom:

\begin{verbatim}
http://web.ukonline.co.uk/julian.smart/tex2rtf
ftp://www.remstar.com/pub/wxwin/tex2rtf
\end{verbatim}

It is available in Sun Open Look, Motif, Windows 3.1, Windows 95/NT, and
non-GUI UNIX versions.

Tex2RTF was developed using the free Open Look, Motif and Windows 3.1
C++ class library \popref{wxWindows}{wxwindows}.

\section{Status of Tex2RTF}\index{status of Tex2RTF}%

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}%

Thanks are due to the many people in AIAI and on the Internet at large
who have pointed out bugs or shortcomings in Tex2RTF. Michel Lavaud has been
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
\item Added \verb$\insertatlevel$ command.
\end{itemize}

Version 1.63, October 21st 1997

\begin{itemize}\itemsep=0pt
\item Debugged problem with Word bookmarks not being inserted for unnumbered
sections.
\end{itemize}

Version 1.62, August 18th 1997

\begin{itemize}\itemsep=0pt