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►
────────────────────────────────────────────────────────────────────────────
 
 :link reftype={fn | hd | spot | launch | inform} [res=name]
        [refid=id] [object='name'] [data='parameter']
        [x=n y=n cx=n cy=n].
 
The :link tag establishes a hypertext (or hypergraphic) link.
 
Hypertext is a word or phrase that is linked to a section, footnote, spot,
another program, or an application message. By choosing the hypertext, the
user can cause the referenced section, footnote, or spot to appear on the
display, start the referenced program, or send a message to the application.
The user chooses hypertext by clicking it with the mouse or by selecting it
with the TAB key and pressing the ENTER key. To identify hypertext, the
system displays it using the help highlight color. In the help source file,
the hypertext starts with the :link tag and ends with the :elink tag.
 
The :link tag is also used in link-definition files to establish
hypergraphic links. A hypergraphic is a bitmap that is linked to a section,
footnote, spot, another program, or an application message. By choosing the
hypergraphic, the user can cause the referenced section, footnote, or spot
to appear on the display, start the referenced program, or send a message to
the application. The user chooses a hypergrahpic by clicking it with the
mouse or by selecting it with the TAB key and pressing the ENTER key. For
more information on hypergraphic links, see the :artlink tag.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
reftype    Identifies the type of element to which the text is being linked.
           It must be one of the following values:
 
           Value   Meaning
           ─────────────────────────────────────────────────────────────────
           fn      Links text to a footnote. The footnote is displayed when
                   the user chooses the text or graphic.
 
           hd      Links text to a section heading. The heading is displayed
                   when the user chooses the text or graphic.
 
           spot    Links text to a spot. The spot is displayed when the user
                   chooses the text or graphic.
 
           launch  Links text to another program. The program starts when
                   the user chooses the text or bitmap.
 
           inform  Links text to an application message. The application
                   receives a message when the user chooses the text or
                   bitmap.
 
res        When the hd option is specified in the reftype parameter, the
           name value of the res parameter identifies the heading of the
           section to display. The name value must be the resource number
           that uniquely identifies the section and must be given in the
           res parameter of a :h tag.
 
           When the inform option is specified in the reftype parameter, the
           name value of the res parameter identifies the integer sent to
           the application with the HM_INFORM message.
 
refid      Identifies the section heading, footnote, or spot to display. The
           id value must be the label that uniquely identifies the section
           heading, footnote, or spot and must be the label given in the id
           parameter of a :h, :fn, or :spot tag.
 
object     Specifies the program to start. The name value must be a valid MS
           OS/2 filename specifying the directory, filename, and file
           extension of the program. The name must be enclosed in single
           quotation marks ('). This parameter is required when the launch
           option of the reftype parameter is specified; otherwise, it is
           not used.
 
data       Specifies the parameter strings needed by the program named in
           the object parameter. Use of this parameter depends on whether
           parameters are required by the program. If used, the parameter
           value must be a string enclosed in single quotation marks (').
 
x          Specifies the x-coordinate of the lower-left corner of a portion
           of a bitmap. This parameter is used only in a link-definition
           file to define a hypergraphic link to a segmented bitmap.
 
y          Specifies the y-coordinate of the lower-left corner of a portion
           of a bitmap. This parameter is used only in a link-definition
           file to define a hypergraphic link to a segmented bitmap.
 
cx         Specifies the width of a portion of a bitmap. This parameter is
           used only in a link-definition file to define a hypergraphic link
           to a segmented bitmap.
 
cy         Specifies the height of a portion of a bitmap. This parameter is
           used only in a link-definition file to define a hypergraphic link
           to a segmented bitmap.
 
Example
 
This example uses the :link and :elink tags to define the hypertext phrase
"key labels":
 
    Different keyboards may have different
    :link reftype=fn refid=keylabel.key labels:elink..
 
See Also
 
 :artlink, :elink, :fn, :h, :spot
 
                                      ♦