amigaguide.guide - Amigaguide.guide/Global Commands

    Global Commands
    ***************

    Global Commands

    $VER: <AmigaDOS version string>
         Specify an Amiga standard version string.  "VER" must be uppercase.
         The format for an Amiga version string is:  <name> (mm/dd/yy).  If you
         have this in your Amigaguide file, you can use the AmigaDOS command
         "Version" to get the string.

    (C) <copyright>
         Specify a copyright notice for this file.

    AUTHOR <name>
         Specify the author of this file.

    DATABASE <name>
         Identifies this file as an Amigaguide document.  Must be the very first
         thing in the file!

    DNODE <name>
         This is an obsolete command, do not use.  It used to be for indicating
         a "dynamic node", but is not needed because the Amigaguide system will
         search for a node that doesn't exist, at which point a dynamic node
         host can return the node.

    ENDNODE
         Specify the end of a hypertext node definition.

    FONT <name> <size>
         Specify the font to use for the database.

    HEIGHT <rows>
         The number of rows in the largest node.

    HELP
         Specify a help node accessible with the "Help" button.

    INDEX <path/node>
         Specify an index node accessible with the "Index" button.

    MACRO <name> <commands>
         Define a macro for this document.  A macro is made up of attribute
         commands and or other macros, and is used like other attributes.  A
         macro can override the built in attributes.  A macro can accept
         arguments by embeding a '$' symbol with a number, for each argument
         supported; IE, '$1', '$2', etc.  If an argument is given when using
         the macro, but is not defined in the macro, then it simply doesn't
         appear, which might be usefull to somebody.  V40.

    	     Example:

                  @macro bold "\ $1 \"
                    ...

                  This is an example of a \@{bold "bold"} macro.

    MASTER <path>
         Specifies the AmigaDOS file path of the original document this
         Amigaguide file was derived from.

    NODE <name> <title>
         Specify the beginning of a hypertext node definition.

    ONCLOSE <rxcommand>
         Specify an ARexx script to execute when this document is closed.  The
         script's return value is not significant.  V40.

    ONOPEN <rxcommand>
         Specify an ARexx script to execute when this document is opened.  The
         document will not be opened if the script returns an error.  V40.

    REM <remark>
    REMARK <remark>
         Used to place a remark in the document which is not displayed.

    SMARTWRAP
         A more inteligent word wrapping algorithm than WORDWRAP.  Paragraphs
         must be separated by two line feeds (visualy, a blank line).  V40.

    TAB <num>
         Define the size in spaces of a tab.  Defaults to 8.  V40.

    WIDTH <chars>
         The number of columns in the largest node.

    WORDWRAP
         Use wordwrapping for all paragraphs.  To be wordwrapped, the paragraph
         must have no line feeds.  V39.  Since this is ugly to work with, and
         ugly to look at in Amigaguide 2.x and lower, you should use SMARTWRAP
         and write your Amigaguide files to look wordwrapped - this makes your
         document look decent on all systems while taking advantage of V40 and
         above since SMARTWRAP will be ignored on pre-V40 Amiga's.
May Ivanova be with you.