]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/htmlhlpf.tex
fall back on text value if no long/double value could be retrieved from the cell
[wxWidgets.git] / docs / latex / wx / htmlhlpf.tex
index ecb6a3ea2f31f3893f73f5508c4b3cf500718ae3..af4ebdc9b76f2e71fb2682ecf22214fa8f29970c 100644 (file)
@@ -1,6 +1,8 @@
-\membersection{Help Files Format}\label{helpformat}
+\section{Help Files Format}\label{helpformat}
 
-wxHTML library uses 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.)
 
@@ -17,15 +19,25 @@ Title=@title of your book@
 Default topic=@default page to be displayed.htm@
 \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
-(<ul>....</ul> statement):
+(\verb$<ul>$....\verb$</ul>$ statement):
 
 \begin{verbatim}
 <ul>
@@ -46,10 +58,10 @@ 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
-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}
 
-Items in the list may be nested - one \<li\> statement may contain \<ul\> sub-statement:
+Items in the list may be nested - one \verb$<li>$ statement may contain a \verb$<ul>$ sub-statement:
 
 \begin{verbatim}
 <ul>
@@ -75,7 +87,6 @@ Items in the list may be nested - one \<li\> statement may contain \<ul\> sub-st
 </ul>
 \end{verbatim}
 
-
 \wxheading{Index file (.hhk)}
 
 Index files have same format as contents file except that ID params are ignored and sublists are {\bf not}