NXM Help HELP

↑ Go to the full list of NXM Help pages.

This facility covers the HELP system.

Commands - TREE - Show the help tree of topics/sections.

TREE - Show the help tree of topics/sections.

Usage - This section describes how to use help

This section describes how to use help

Building_Help_Files - Help files are built by writing text as it should appear in a help browser.

Help files are built by writing text as it should appear in a help browser. NextMidas supports a markup language that is a minor extension of the X-Midas markup language. In this language, most keywords are indicated by a tilde (~) as the first character in a line excluding white space. One exception is the See Also keyword which can appear anywhere in the text without a tilde.

form: ~Main
text

The text here shows up in the main help screen for this file as is.  This
allows comments to be inserted among the section bullets to categorize or
comment on different sections.

form: ~Comment <comment text>

The Comment keyword will cause the remaining text of the line to be
completely ignored. Comments cannot span multiple lines so each line
of a multiline comment must be prefixed with ~Comment.

form: ~Include <fname>

Causes the text of the specified filename to be read completely as if
the file contents where present here. Analogous to the C preprocessor
include directive.

form: ~Section <section name>
text

When a Section keyword is found, the next token is taken to be the
section name. Everything from the next line to the next Section,
File or End token is taken
to be the contents of the token. Sections cannot be nested.

<subsection name>

text

When a SubSection keyword is found, the next token is taken to be the
subsection name. Everything from the next line to the next SubSection,
Section, File or End token is taken to be the contents of the token.
SubSections cannot be nested.  They can be addressed in See Also
references by using a section#subsection syntax.

or - closes on the previous section.

closes on the previous section.

form: SEE ALSO:  <opt> <area> <name>

The See Also keyword is processed up to the next period or end of line.
It cannot span multiple lines.  Multiple items can be comma separated.
If <opt> or <area> are not specified, they are defaulted from the
current page or previous entry in a comma separated list.

Currently supported areas are HLP, EXP, and DOC.

NOTE: The ALSO and the colon are optional.

NotFound - This help section entry was not found.

There is a malformed help file or the path was restricted while
performing HELP/BUILD.