X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/42d306a033f27c2164d6692fe8c28d165c9a105b..267a7108512069169a855457d027cd68fed5bf2e:/docs/latex/wx/htmlhlpf.tex diff --git a/docs/latex/wx/htmlhlpf.tex b/docs/latex/wx/htmlhlpf.tex index cf3d5fce48..dbc30ba75a 100644 --- a/docs/latex/wx/htmlhlpf.tex +++ b/docs/latex/wx/htmlhlpf.tex @@ -6,7 +6,9 @@ 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)} @@ -19,10 +21,20 @@ 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 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. (The contents file -would then be referred to 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)} @@ -48,7 +60,7 @@ 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 \verb$
  • $ statement may contain a \verb$