-image_linkimage_link ] [
-image_fileimage_file ] [
-faviconfavicon ] [
-sitename ] [
omhelpcommand starts OMhelp from a DOS or Unix prompt. This creates a web site from the OMhelp input files are described in this manual.
It is suggested that you run OMhelp in an empty directory so that the only files in that directory will be those generated by OMhelp. This suggestion is made because OMhelp will create a large number of output files that correspond to the web site.
corresponds to the section which has tag as its cross reference tag . Here ext is
htm, unless the
xmlcommand line option is specified in which case it is
xml. The file
is special to browsers because it is loaded when the corresponding directory, but not a specific file, is specified. OMhelp automatically generates a file with this name that loads the section corresponding to the argument root_file.
childtable, and children commands.
It is recommended that you run OMhelp in a different directory than the location of the starting input file (see Program Execution above). If you insist on running OMhelp in the directory containing the file specified by root_file, place
.\at the beginning of root_file.
-debugis present, extra output that aids in the debugging OMhelp input files is generated. This includes the following:
local.wrd. In this case, see the dictionary instructions for installing under Unix or Windows .
-xmlis present, an XHTML version of the web site is built (otherwise an HTML version is built). In this case the output files have the
.xmlextension (otherwise they have the
.htmextension). This enables the support of latex commands in OMhelp input files using XHTML and MathML (see Chapter 7 of MathML ).
-printableis present, a printable version of the web site is output as just one file The name of the file is
-xmlis present). In the printable file, each section title and heading is labeled with an identifier so that it can be located by its position in the output file. These position identifies are included in the linking text for each cross reference so that the target of the reference can be located by its position in the output file.
The printable output file does not contain the OMhelp search section because printed output is not interactive. Thus, if you are using the printable option, the cross reference tag
_searchwill not be defined. You can see the printable version of the OMhelp documentation by selecting _printable.htm () .
-printablecommand overrides the normal behavior of the fend command.
-noframeis present, all of the information for a section is displayed in one frame. This overrides the normal behavior of the fend command.
-nowarncommand line option.
-image_linkis present, the argument image_link must follow it. In this case, the image is placed at the top of the links for each section (
-image_fileimage_file can be used to specify your own image, which should be about the same size as the default image). If image_link is equal to the empty string (
""), the image does not link to anything. Otherwise, image_link specifies a world wide web address (URL) that is linked to when the image is selected.
_image.gif) is distributed with OMhelp. If the command line argument
-image_fileis present, the argument image_file must follow. In this case, the default image is replaced by image_file, which should be about the same size as the default image. The text image_file can either a complete path specification or relative to the directory containing the file specified by root_file. Note that the directories specified by the path commands are not searched for the file specified by image_file.
-faviconis present, the argument favicon must follow. In this case, favicon should be a 16 by 16 pixel icon and the file extension
.png(you can use the Microsoft Paint program to create and store such an icon). The text favicon can either a complete path specification or relative to the directory containing the file specified by root_file. Note that the directories specified by the path commands are not searched for the file specified by favicon.
-faviconcommand line option was used when building the OMhelp web documentation. If you view this documentaiton , you should see the icon at the left of the address bar in your browser. (This icon corresponds to the file
omh/image/help_icon.pngin the OMhelp distribution.) This works well in Firefox, but there currently seem to be some problems with Internet Explorer .
-siteis present, the argument name must follow. In this case name specifies the name of the web site being built. This name is currently used in the title for the web site search utility. It may have other uses in the future.
-omhelp_diris present, the argument dir must follow. In this case dir specifies the directory where the OMhelp data is stored; for example, the files
local.wrd. This is intended for testing during installation and should not be necessary during normal use.