!Seealso:               Cross References
 
  Purpose
 
    Seealso references are references from one long entry to other long
    entries. The list of seealso references appears in a window above the
    long entry.
 
  Format
 
        !seealso: key-words[space or tab key-words]
 
    where key-words is one of the following:
         text-from-a-short-entry
    or
         filename.ngo:text-from-a-short-entry
    or
         filename.ngo:seealso-title
 
      Notes:    !Seealso, like all other bang commands, must be typed
                starting in the leftmost screen column.
 
                The text-from-a-short-entry must appear at the start of
                the short entry that expands to the long entry you want.
                The text can be any number of words, starting at the
                beginning of the short entry, and ending with a space or
                tab. The short entry can be either in the current data
                file, or another file.
 
                The third format of !seealso allows you to include a
                reference to any long entry that's in a file by itself.
                In this case, there's no short entry from which to draw
                text for the Seealso window, so you simply make up the
                text for seealso-title. The Guides then puts
                seealso-title in the Seealso window.
 
                A table is often implemented as a long entry directly off
                a menu item, and is thus in a file by itself. You can use
                this format to incorporate a !seealso reference to such a
                table.
 
  Description
 
    The !seealso command moves the user to another long entry. The text
    after !seealso comes from a short entry; when the user highlights
    that text in the Seealso window and presses Return, he is taken
    automatically to the long entry that lies underneath the highlighted
    short entry.
 
    You do not need to use the entire text of the short entry. For
    example, if the long entry you are referring to is under a short
    entry that reads:
 
           !short:Cross References      Using !seealso in Long Entries
 
    your seealso could read:
 
           !seealso: Cross
       or
           !seealso: "Cross References"
 
    In other words, you need only include enough text to uniquely
    identify the short entry. The text must, however, be taken from the
    beginning of the entry.
 
    Multiple references in a single !seealso command are separated by one
    or more spaces or tabs. If the key-words text includes embedded
    spaces, tabs, or colons, it must be enclosed within double quotation
    marks, as in the second example above. If the key-words text happens
    to include a double quote mark, enclose the key-words text within
    single quote marks, instead of doubles, like this: !seealso:'a
    see-also entry containing " marks'.
 
    The key-words text can come from a short entry either in the same
    file, or in a different file. To indicate a reference to a short
    entry in another file, precede the key-words text with the filename,
    as in:
 
           !seealso: otherfil.ngo:"More Info"

This page last updated on Fri Nov 30 10:51:58 MSK 2001
Copyright © 1992-2001, Vitaly Filatov, Moscow, Russia
Webmaster