Added wxPATH_NORM_SHORTCUT

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

diff --git a/docs/latex/wx/htmlhlpf.tex b/docs/latex/wx/htmlhlpf.tex
index 37c129e20bf78dfd0c32d3171e1d2e1fa73e3152..a3b7e4dc4128a7918576fa0427acd1906ce63717 100644 (file)
--- a/docs/latex/wx/htmlhlpf.tex
+++ b/docs/latex/wx/htmlhlpf.tex
@@ -1,44 +1,58 @@
-\membersection{Help Files Format}\label{helpformat}
+\subsection{Help Files Format}\label{helpformat}

 
 wxHTML library uses a reduced version of MS HTML Workshop format.
 
 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
+your tex2rtf.ini file.

 
 (See \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} for help controller description.)
 
 
 (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}
 
 \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}
 
 \end{verbatim}
 

-All filenames (including Default topic) are relative to the location of .hhp file.
+All filenames (including the Default topic) are relative to the 
+location of .hhp file.

 
 

-For larger projects I recommend storing everything but .hhp file into one .zip archive. (E.g. contents file 
-would then be reffered as myhelp.zip\#zip:contents.hhc)
+{\bf Localization note:} In addition, .hhp file may contain line
+
+\begin{verbatim}
+Charset=<rfc_charset>
+\end{verbatim}
+
+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}.

 
 \wxheading{Contents file (.hhc)}
 
 Contents file has HTML syntax and it can be parsed by regular HTML parser. It contains exactly one list
 
 \wxheading{Contents file (.hhc)}
 
 Contents file has HTML syntax and it can be parsed by regular HTML parser. It contains exactly one list

-(<ul>....</ul> statement):
+({\tt <ul>}....{\tt </ul>} statement):

 
 \begin{verbatim}
 <ul>
 
 
 \begin{verbatim}
 <ul>
 

-  <li> <object>
+  <li> <object type="text/sitemap">

            <param name="Name" value="@topic name@">
            <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>
        </object>

-  <li> <object>
+  <li> <object type="text/sitemap">

            <param name="Name" value="@topic name@">
            <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>
   ...    
 
        </object>
   ...    
 


@@ -46,29 +60,29 @@ Contents file has HTML syntax and it can be parsed by regular HTML parser. It co
 \end{verbatim}
 
 You can modify value attributes of param tags. {\it topic name} is name of chapter/topic as is displayed in
 \end{verbatim}
 
 You can modify value attributes of param tags. {\it topic name} is name of chapter/topic as is displayed in

-contents, {\it filename.htm} is HTML page name (relative to .hhp file) and {\it numeric_id} is optional 
+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}
 
 - it is used only when you use \helpref{wxHtmlHelpController::Display(int)}{wxhtmlhelpcontrollerdisplay}
 

-Items in the list may be nested - one \<li\> statement may contain \<ul\> sub-statement:
+Items in the list may be nested - one {\tt <li>} statement may contain a {\tt <ul>} sub-statement:

 
 \begin{verbatim}
 <ul>
 
 
 \begin{verbatim}
 <ul>
 

-  <li> <object>
+  <li> <object type="text/sitemap">

            <param name="Name" value="Top node">
            <param name="Name" value="Top node">

-          <param name="Local" value="top.htm">
+           <param name="Local" value="top.htm">

        </object>
        <ul>
        </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>
               </object>

-         ...
+      ...

        </ul>
        
        </ul>
        

-  <li> <object>
+  <li> <object type="text/sitemap">

            <param name="Name" value="Another Top">
            <param name="Name" value="Another Top">

-          <param name="Local" value="top2.htm">
+           <param name="Local" value="top2.htm">

        </object>
   ...    
 
        </object>
   ...