X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/36edded90cf3d4d11dc55362b332733b79e8f54d..eb17eaba370e68c2c59f29e4e20de979bf4655f2:/docs/latex/wx/htmlhlpf.tex diff --git a/docs/latex/wx/htmlhlpf.tex b/docs/latex/wx/htmlhlpf.tex index 03c206e6e3..9438e7a16d 100644 --- a/docs/latex/wx/htmlhlpf.tex +++ b/docs/latex/wx/htmlhlpf.tex @@ -1,4 +1,4 @@ -\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 @@ -19,10 +19,21 @@ 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. + +{\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} -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) \wxheading{Contents file (.hhc)} @@ -48,7 +59,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$