docs/latex/wx/htmlhlpf.tex

   1 \section{Help Files Format}\label{helpformat}
   2
   3 wxHTML library uses a reduced version of MS HTML Workshop format.
   4 Tex2RTF can produce these files when generating HTML, if you set {\bf htmlWorkshopFiles} to {\bf true} in
   5 your tex2rtf.ini file.
   6
   7 (See \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} for help controller description.)
   8
   9 A {\bf book} consists of three files : header file, contents file and index file.
  10
  11 \wxheading{Header file (.hhp)}
  12
  13 Header file must contain these lines (and may contain additional lines which are ignored) :
  14
  15 \begin{verbatim}
  16 Contents file=@filename.hhc@
  17 Index file=@filename.hhk@
  18 Title=@title of your book@
  19 Default topic=@default page to be displayed.htm@
  20 \end{verbatim}
  21
  22 All filenames (including the Default topic) are relative to the location of .hhp file.
  23
  24 For larger projects I recommend storing everything but .hhp file into one .zip archive. (The contents file
  25 would then be referred to as myhelp.zip\#zip:contents.hhc)
  26
  27 \wxheading{Contents file (.hhc)}
  28
  29 Contents file has HTML syntax and it can be parsed by regular HTML parser. It contains exactly one list
  30 (\verb$<ul>$....\verb$</ul>$ statement):
  31
  32 \begin{verbatim}
  33 <ul>
  34
  35   <li> <object>
  36            <param name="Name" value="@topic name@">
  37            <param name="ID" value=@numeric_id@>
  38            <param name="Local" value="@filename.htm@">
  39        </object>
  40   <li> <object>
  41            <param name="Name" value="@topic name@">
  42            <param name="ID" value=@numeric_id@>
  43            <param name="Local" value="@filename.htm@">
  44        </object>
  45   ...
  46
  47 </ul>
  48 \end{verbatim}
  49
  50 You can modify value attributes of param tags. {\it topic name} is name of chapter/topic as is displayed in
  51 contents, {\it filename.htm} is HTML page name (relative to .hhp file) and {\it numeric\_id} is optional
  52 - it is used only when you use \helpref{wxHtmlHelpController::Display(int)}{wxhtmlhelpcontrollerdisplay}
  53
  54 Items in the list may be nested - one \verb$<li>$ statement may contain a \verb$<ul>$ sub-statement:
  55
  56 \begin{verbatim}
  57 <ul>
  58
  59   <li> <object>
  60            <param name="Name" value="Top node">
  61            <param name="Local" value="top.htm">
  62        </object>
  63        <ul>
  64          <li> <object>
  65                   <param name="Name" value="subnode in topnode">
  66                   <param name="Local" value="subnode1.htm">
  67               </object>
  68           ...
  69        </ul>
  70
  71   <li> <object>
  72            <param name="Name" value="Another Top">
  73            <param name="Local" value="top2.htm">
  74        </object>
  75   ...
  76
  77 </ul>
  78 \end{verbatim}
  79
  80 \wxheading{Index file (.hhk)}
  81
  82 Index files have same format as contents file except that ID params are ignored and sublists are {\bf not}
  83 allowed.
  84