Writing for the HTML Help System:

  Contributions are very welcome. If you wish to make a contribution to
  the HTML Help System, please contact the maintainer: 
    fritzdotmuelleratmaildotcom

The structure of the \help directory:

  \help\index.htm
    Lists the help languages installed on the system.
    Loaded automatically if LANG is not set to an available language
    and English (EN) not installed.
  \help\%LANG%\index.htm
    HELP will load this by default. %LANG% is the language selected by
    setting the LANG environment variable. If LANG isn't set, EN is assumed.
  \help\%LANG%\help.htm
    HELP will load this when the user presses F1 or clicks on 
    "Help on Help".
  \help\docinfo\bi\nls\%LANG%.bi
    Stores bookshelf files, for use with Aitor's bookshlf tool, to
    create the language index (\help\index.htm).

Creating compressed help files:

  You should use for your compressed file set a name such as: 
    \help\...\[name]\[name].zip
  If you wish to compress your help files, they should be in the
  zip format. They should have the same filename as the directory
  they are stored in, and the zip extension. For instance:
    \help\en\myhelp\myhelp.zip
  The index.htm can be inside the zip file, but help and bookshlf
  will both work better if it is not.
  Directory structures are allowed within the zip file. However,
  encryption and some of the older and more obscure compression
  methods are not supported.

Creating modified versions of the help files:

  Use a distinct title on the title page (often index.htm) in any
  modified versions. This is to avoid any confusion or conflicts,
  and most importantly, is necessary under the
  GNU Free Documentation License part 4A.
  In addition to changing the title, please update the history, list of
  authors etc, in accordance with section 4 of the   
  GNU Free Documentation License.
  If the file set is meant to describe a new or modified package, or if
  the file set undergoes a fundamental change (e.g. a translation), then
  it is best to use a distinct subdirectory name, as explained in "The
  structure of the \help directory" above. This is simply a matter of
  doing a find and replace on the subdirectory name in index.htm, and is
  well worth it. 
  For example, a streamlined version of the "hhstndrd" file set might be
  called "hhmicro". This would be the name of the subdirectory, and the
  title in index.htm might be: 
    FreeDOS Hilfe (hhmicro 1.0)
  It is reasonable to change only the version number (rather than the
  name and directory "hhmicro") when releasing updates. 

Creating or adding new files:

  It is advised that the following license message be put at the end of
  any new help files (unless it is going to be a stand alone file, not
  included in a help file set):

    ...
    <hr>
    <address>

    <b>Copyright &copy; 2008
    <a href="mailto:myemail@address.com">My name</a></b><br>
    This file forms part of The FreeDOS HTML Help Documentation, and is
    covered under its terms, see:
    <a href="../index.htm">index.htm</a>

    </address>
    </body>
    </html>

  Providing an email is entirely optional; if you load your help files on
  to a website, then email addresses can be subjected to spamming.
  The terms are the GNU Free Documentation License.

Editing a file stored in a zip:

  You may wish to unzip the html files so that they can be read with
  another browser, or to edit them. Zip files usually take priority over
  uncompressed files; if you want to make sure that help reads an edited,
  uncompressed version of a file, you should replace or delete the
  original version inside that zip. 

Testing help files:

  The reference browsers for testing help files are:
    * the FreeDOS HTML Help Viewer (help.exe)
    * Netscape Navigator. 

Creating tables:

  Unfortunately, help does not support table tags. Use the preformatting
  tags <pre> </pre> for tables of information. 

General tips:

  Press F5 or Ctrl+R to refresh the file being displayed by Help.The
  effects of changes to the file can be seen immediately. Useful when
  editing help files in a windows-type environment.
  To use HTML Help Viewer to view files that aren't yet integrated into
  the file set, the help path override switch can be used:
    help /O[drive:][path]filename[.htm]
  or if relative to the /HELP folder:
    help /L[subdirs]filename[.htm]

See also:

  Tags supported by HTML Help
  Authoring Resources

[Main menu] [top]


Copyright © 2003-4 Robert Platt, updated 2008 by W. Spiegl
This file forms part of The FreeDOS HTML Help Documentation, and is
covered under its terms: see index.htm