A little cleanup for this demo

[wxWidgets.git] / docs / latex / wx / htmlhlpf.tex

diff --git a/docs/latex/wx/htmlhlpf.tex b/docs/latex/wx/htmlhlpf.tex
index 9438e7a16d6b657f9beaab44ab23bf14b2d6db40..9f21cfa2954d299e1953f44e826c79bb55de7861 100644 (file)
--- a/docs/latex/wx/htmlhlpf.tex
+++ b/docs/latex/wx/htmlhlpf.tex
@@ -1,4 +1,4 @@
-\section{Help Files Format}\label{helpformat}
+\subsection{Help Files Format}\label{helpformat}
 
 wxHTML library uses a reduced version of MS HTML Workshop format.
 Tex2RTF can produce these files when generating HTML, if you set {\bf htmlWorkshopFiles} to {\bf true} in
@@ -6,17 +6,19 @@ your tex2rtf.ini file.
 
 (See \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} for help controller description.)
 
-A {\bf book} consists of three files : header file, contents file and index file.
+A {\bf book} consists of three files: header file, contents file and index file.
+You can make a regular zip archive of these files, plus the HTML and any image files,
+for wxHTML (or helpview) to read; and the .zip file can optionally be renamed to .htb.
 
 \wxheading{Header file (.hhp)}
 
 Header file must contain these lines (and may contain additional lines which are ignored) :
 
 \begin{verbatim}
-Contents file=@filename.hhc@
-Index file=@filename.hhk@
-Title=@title of your book@
-Default topic=@default page to be displayed.htm@
+Contents file=<filename.hhc>
+Index file=<filename.hhk>
+Title=<title of your book>
+Default topic=<default page to be displayed.htm>
 \end{verbatim}
 
 All filenames (including the Default topic) are relative to the 
@@ -25,33 +27,32 @@ location of .hhp file.
 {\bf Localization note:} In addition, .hhp file may contain line
 
 \begin{verbatim}
-Charset=@rfc_charset@
+Charset=<rfc_charset>
 \end{verbatim}
 
-which specifies what charset (e.g. "iso8859_1") was used in contents
+which specifies what charset (e.g. "iso8859\_1") was used in contents
 and index files. Please note that this line is incompatible with
 MS HTML Help Workshop and it would either silently remove it or complain
 with some error. See also 
-\helpref{Writing non-English applications.}{nonenglishoverview}
-
+\helpref{Writing non-English applications}{nonenglishoverview}.
 
 \wxheading{Contents file (.hhc)}
 
 Contents file has HTML syntax and it can be parsed by regular HTML parser. It contains exactly one list
-(\verb$<ul>$....\verb$</ul>$ statement):
+(\tt{<ul>}....\tt{</ul>} statement):
 
 \begin{verbatim}
 <ul>
 
-  <li> <object>
+  <li> <object type="text/sitemap">
            <param name="Name" value="@topic name@">
-          <param name="ID" value=@numeric_id@>
-          <param name="Local" value="@filename.htm@">
+           <param name="ID" value=@numeric_id@>
+           <param name="Local" value="@filename.htm@">
        </object>
-  <li> <object>
+  <li> <object type="text/sitemap">
            <param name="Name" value="@topic name@">
-          <param name="ID" value=@numeric_id@>
-          <param name="Local" value="@filename.htm@">
+           <param name="ID" value=@numeric_id@>
+           <param name="Local" value="@filename.htm@">
        </object>
   ...    
 
@@ -62,26 +63,26 @@ You can modify value attributes of param tags. {\it topic name} is name of chapt
 contents, {\it filename.htm} is HTML page name (relative to .hhp file) and {\it numeric\_id} is optional 
 - it is used only when you use \helpref{wxHtmlHelpController::Display(int)}{wxhtmlhelpcontrollerdisplay}
 
-Items in the list may be nested - one \verb$<li>$ statement may contain a \verb$<ul>$ sub-statement:
+Items in the list may be nested - one \tt{<li>} statement may contain a \tt{<ul>} sub-statement:
 
 \begin{verbatim}
 <ul>
 
-  <li> <object>
+  <li> <object type="text/sitemap">
            <param name="Name" value="Top node">
-          <param name="Local" value="top.htm">
+           <param name="Local" value="top.htm">
        </object>
        <ul>
-         <li> <object>
-                  <param name="Name" value="subnode in topnode">
-                 <param name="Local" value="subnode1.htm">
+         <li> <object type="text/sitemap">
+              <param name="Name" value="subnode in topnode">
+              <param name="Local" value="subnode1.htm">
               </object>
-         ...
+      ...
        </ul>
        
-  <li> <object>
+  <li> <object type="text/sitemap">
            <param name="Name" value="Another Top">
-          <param name="Local" value="top2.htm">
+           <param name="Local" value="top2.htm">
        </object>
   ...