Hi,
I added to the docs imformation on the chm part of fpdoc.
There are five or six options I would like to document better than the
short description --help --format=chm gives, where should they go in
fpdoc.tex?
Regards,
Andrew
Index: fpdoc.tex
===================================================================
--- fpdoc.tex (revision 345)
+++ fpdoc.tex (working copy)
@@ -110,6 +110,7 @@
\item[Man] Unix man pages. Each function/procedure/method identifier is a man
page. Constants are on a separate page, as are types, variables and
resourcestrings.
+\item[CHM] HTML files compressed into a .chm file using lzx compression.
\end{description}
Plans exist to create direct RTF output as well.
@@ -342,6 +343,7 @@
\item[latex] LaTex, which uses the \file{fpc.sty} style used by the \fpc
documentation.
\item[xml-struct] Structured XML.
+\item[chm] Compressed HTML.
\end{description}
% help
@@ -408,6 +410,14 @@
directory. Inside the subdirectory, commands as the above could be used to
provide links to other documentation packages.
+Example:
+\begin{verbatim}
+--import=../fcl.cnt,ms-its:fcl.chm::/
+\end{verbatim}
+As in the previous example this will read the file fcl.cnt in the parent
+directory. But all links to items in the fcl.cnt file, will be prepended
+with \file{ms-its:fcl.chm::/}. This is how chm's are crosslinked.
+
Note that for Latex documentation, this option is ignored.
% input
@@ -462,6 +472,7 @@
This option tells \fpdoc where the output file should be generated.
How this option is interpreted depends on the format that is used.
For latex, this is interpreted as the filename for the tex file.
+For chm, this is interpreted as the output filename.
For all other formats, this is interpreted as the directory where all
documentation files will be written. The directory will be created if
it does not yet exist.
@@ -478,6 +489,10 @@
--format=latex --output=docs/classes.tex
\end{verbatim}
will generate latex documentation in the file \file{docs/classes}.
+\begin{verbatim}
+--format=chm --output=docs.chm
+\end{verbatim}
+will generate chm documentation in the file \file{docs.chm}.
% package
\subsection{package}
_______________________________________________
fpc-devel maillist - [email protected]
http://lists.freepascal.org/mailman/listinfo/fpc-devel
