This document contains a number of style conventions designed to make it easier to use. Different typefaces indicate such things as screen messages and operator entries. The following sections describe the style conventions used.
Document Style Conventions
Functions
Functions are presented in capital letters when first presented. Packages are always included with double-colon syntax. This syntax is not always required, but including it ensures that functions will perform as written regardless of the current Lisp package.
Arguments
Optional arguments, which are not required for the function to work, are in italic text. Punctuation outside of the braces must be included, while everything inside the braces is purely descriptive. In this example:
(PackageA::FooFunc arg-1 :arg-2 `arg-3 (list))
Notes
Notes of special interest are set off from the text within horizontal rules:
Mouse and Keyboard Notation
The following conventions are used in the text:
Menu Notation
In N-Geometry, menu items that are preceded and followed by a period have multiple selections, which you select by clicking left, middle, or right on the mouse. (The different options are shown on the mouse documentation line, displayed at the bottom of the screen.)
Another fine product from Nichimen documentation!Copyright © 1996, Nichimen Graphics Corporation. All rights reserved.