docs/latex/wx/htmlhlpf.tex

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