Entry Format

Each entry is a symbol of some variety that the XLISP system will recognize. The parts of each reference entry include:

1. The Headline of the page gives the name or symbol of the entry.

2. The Reference section below the headline gives infomations in the following order:

• Type may be one of the following:

• function (subr)
• predicate function (subr)
• special form (fsubr)
• reader expansion
• system variable
• system constant
• keyword
• object
• message selector

• Source specifies the source file where the routine or code associated with the entry resides. [Please note that I have copied the source file locations out of the Tim I Mikkelsen manual without checking, so some of them may be wrong.]

3. Syntax defines the syntax or usage of the entry. It is also used to specify the arguments. Items written in italics are arguments. Items enclosed between square brackets like '[' and ']' are optional entries. Items that have '...' [ellipses] indicate that there can be one or many of the item. Items enclosed between '{' and '}' which are separated by '|' indicate that one of the items should be included.

4. Description defines the entry, necessary conditions, results, defaults, etc.

5. Examples shows example uses of the entry.

6. The Comments section after the examples includes additional information such as compatibility notes, bugs, usage notes, potential problems, keystroke equivalences, etc.

  Back to Top