X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6aa358aebb951956f0e0ab645788e00a4b904886..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/htmlhlpf.tex diff --git a/docs/latex/wx/htmlhlpf.tex b/docs/latex/wx/htmlhlpf.tex index d4fbfbdb46..a3b7e4dc41 100644 --- a/docs/latex/wx/htmlhlpf.tex +++ b/docs/latex/wx/htmlhlpf.tex @@ -1,4 +1,4 @@ -\section{Help Files Format}\label{helpformat} +\subsection{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 @@ -15,10 +15,10 @@ for wxHTML (or helpview) to read; and the .zip file can optionally be renamed to 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= +Index file= +Title= +Default topic=<default page to be displayed.htm> \end{verbatim} All filenames (including the Default topic) are relative to the @@ -27,7 +27,7 @@ location of .hhp file. {\bf Localization note:} In addition, .hhp file may contain line \begin{verbatim} -Charset=@rfc_charset@ +Charset=<rfc_charset> \end{verbatim} which specifies what charset (e.g. "iso8859\_1") was used in contents @@ -39,20 +39,20 @@ with some error. See also \wxheading{Contents file (.hhc)} Contents file has HTML syntax and it can be parsed by regular HTML parser. It contains exactly one list -(\tt{<ul>}....\tt{</ul>} statement): +({\tt <ul>}....{\tt </ul>} statement): \begin{verbatim} <ul> - <li> <object> + <li> <object type="text/sitemap"> <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> - <li> <object> + <li> <object type="text/sitemap"> <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> ... @@ -63,26 +63,26 @@ You can modify value attributes of param tags. {\it topic name} is name of chapt 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 \tt{<li>} statement may contain a \tt{<ul>} sub-statement: +Items in the list may be nested - one {\tt <li>} statement may contain a {\tt <ul>} sub-statement: \begin{verbatim} <ul> - <li> <object> + <li> <object type="text/sitemap"> <param name="Name" value="Top node"> - <param name="Local" value="top.htm"> + <param name="Local" value="top.htm"> </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> - ... + ... </ul> - <li> <object> + <li> <object type="text/sitemap"> <param name="Name" value="Another Top"> - <param name="Local" value="top2.htm"> + <param name="Local" value="top2.htm"> </object> ...