Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

                                                      ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
 <help [res=number] [name=name] [tutorial=name]>titletext
 
The help tag creates a help panel. A help panel is one or more lines of text
that the user can view as a whole. The help-panel title, specified by title,
appears in the title bar of the help window. The title is added to the table
of contents for the help document. This lets the user choose the help panel
for viewing. A help panel must start with the help tag and end with the
/help tag.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
res        Identifies the help-panel resource number. The number value can
           be any integer, but it must be unique (that is, no other help
           panel may have the same number) and it must be in the range 1 to
           32,000. The resource number is used in an application's help
           table and help subtables to identify the help panel to display
           for a given window or menu item.
 
name       Identifies the help-panel resource name. The name value can be
           any combination of letters and digits, but it must be unique
           (that is, no other help panel may have the same name). The
           resource name is used by an application to display a specific
           help panel.
 
tutorial   Specifies the name of the application-supplied tutorial
           associated with the help panel. The name value can be a
           combination of letters and digits.
 
title      Specifies the title that appears in the title bar of the help
           window and in the table of contents for the help document.
 
text       Specifies the text in the help panel. The text can contain any
           number of other tags but must not contain another help tag.
 
Comments
 
If the tutorial parameter is given, the system adds the Tutorial command to
the Help menu. If the user chooses the command, the system runs the
corresponding tutorial.
 
Example
 
This example uses the help tag to create a help panel:
 
    <help name=cpy>Copy
    The Copy command copies files from one directory to
    another, or from one drive to another.
    <p>
    Syntax
    <p>
    Copy filename destination
    </help>
 
See Also
 
 /help
 
                                      ♦