X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/22d6efa851642c6a69174278fc50f712f41e2271..4e28924cdb58dfbba0ec6cd5d52ef1346d0cb569:/docs/latex/wx/htmlhlpf.tex diff --git a/docs/latex/wx/htmlhlpf.tex b/docs/latex/wx/htmlhlpf.tex index 37c129e20b..dbc30ba75a 100644 --- a/docs/latex/wx/htmlhlpf.tex +++ b/docs/latex/wx/htmlhlpf.tex @@ -1,10 +1,14 @@ -\membersection{Help Files Format}\label{helpformat} +\section{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 +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)} @@ -17,15 +21,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 -( statement): +(\verb$$ statement): \begin{verbatim}