fixed docs to accomodate more strict wxHTML Help controller

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@11269 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík 2001-08-02 23:31:49 +00:00
parent 4f5fffcc74
commit a643192e96

View File

@ -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) : Header file must contain these lines (and may contain additional lines which are ignored) :
\begin{verbatim} \begin{verbatim}
Contents file=@filename.hhc@ Contents file=<filename.hhc>
Index file=@filename.hhk@ Index file=<filename.hhk>
Title=@title of your book@ Title=<title of your book>
Default topic=@default page to be displayed.htm@ Default topic=<default page to be displayed.htm>
\end{verbatim} \end{verbatim}
All filenames (including the Default topic) are relative to the 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 {\bf Localization note:} In addition, .hhp file may contain line
\begin{verbatim} \begin{verbatim}
Charset=@rfc_charset@ Charset=<rfc_charset>
\end{verbatim} \end{verbatim}
which specifies what charset (e.g. "iso8859\_1") was used in contents which specifies what charset (e.g. "iso8859\_1") was used in contents
@ -44,15 +44,15 @@ Contents file has HTML syntax and it can be parsed by regular HTML parser. It co
\begin{verbatim} \begin{verbatim}
<ul> <ul>
<li> <object> <li> <object type="text/sitemap">
<param name="Name" value="@topic name@"> <param name="Name" value="@topic name@">
<param name="ID" value=@numeric_id@> <param name="ID" value=@numeric_id@>
<param name="Local" value="@filename.htm@"> <param name="Local" value="@filename.htm@">
</object> </object>
<li> <object> <li> <object type="text/sitemap">
<param name="Name" value="@topic name@"> <param name="Name" value="@topic name@">
<param name="ID" value=@numeric_id@> <param name="ID" value=@numeric_id@>
<param name="Local" value="@filename.htm@"> <param name="Local" value="@filename.htm@">
</object> </object>
... ...
@ -68,21 +68,21 @@ Items in the list may be nested - one \tt{<li>} statement may contain a \tt{<ul>
\begin{verbatim} \begin{verbatim}
<ul> <ul>
<li> <object> <li> <object type="text/sitemap">
<param name="Name" value="Top node"> <param name="Name" value="Top node">
<param name="Local" value="top.htm"> <param name="Local" value="top.htm">
</object> </object>
<ul> <ul>
<li> <object> <li> <object type="text/sitemap">
<param name="Name" value="subnode in topnode"> <param name="Name" value="subnode in topnode">
<param name="Local" value="subnode1.htm"> <param name="Local" value="subnode1.htm">
</object> </object>
... ...
</ul> </ul>
<li> <object> <li> <object type="text/sitemap">
<param name="Name" value="Another Top"> <param name="Name" value="Another Top">
<param name="Local" value="top2.htm"> <param name="Local" value="top2.htm">
</object> </object>
... ...