XEROX >>PACKAGE NAME<< 2 4 1 >>Package Name<< 1 4 By: >>Your Name<< (>>Your net address<<) >>Other packages necessary to run this one<< INTRODUCTION >>This document provides a template and instructions for formatting the Lisp Users' package documentation. It is available on EasyTemplate.TEdit. By copying this document and editing it inTEdit, you should be able to duplicate the looks of the current Lisp Users' manual. You can run through this document using the NEXT key. All text that should not be present in your document should be replaced with the appropriate text. For example, this paragraph should be replaced by an overview of your package. For a longer explanation of how to document your package, consult DocumentationTemplate.TEdit. Any problems with this template should be reported to Susana Wessling, wessling.pa@xerox.<< DOCUMENT LOOKS Fonts Please make all normal text Modern 10-point font. Heads >>HEADS<< are in 10-point modern bold caps if they are major heads or, >>Heads<< are in 10-point modern bold, caps and lowercase, if they are subheads. >>RUNNING HEADS<< You should include the running Xerox head found at the top of this document in your document. Please insert your package name on the right side of it. Remember that you have to include it as a running head in the page layout menu. Page numbers The page numbers in this document are set correctly; they should be centered at the bottom of the page. Please make sure your document places the numbers correctly. Your copy of this document should start with the default page number of 1; this will be edited as all of the documentation is put together. Other looks By using the expanded menus, you can see how each of the variables is set for this document. Use the same settings for your document. For example, if you want to check on the paragraph width, use the Paragraph Formatting expanded menu, select the paragraphs in this document, and button SHOW. You can then see how the parameters are set in this document, and copy them into your own. PACKAGE EXPLANATIONS Functions, Variables, and Lisp Code Examples >>It is usual to first give the name of a function, then describe its purpose and each of its arguments. When the name of a function is first given, it is set off like this: (IMAGEFNSCREATE DISPLAYFN IMAGEBOXFN PUTFN GETFN COPYFN) [Function] The function name is in 10-point regular Modern, all caps. Arguments are in 10-point italic Modern, in all caps, mixed case, or lowercase, as they appear in the system. Variables look like functions, except that the word ``Variable,'' enclosed in square brackets, follows the variable name. Please note that these are the characters [], not the parentheses ().<< This is an example of code. It is in 10-point Terminal font. Function names, commands, file names, and the like are in 10-point modern. OTHER FORMATTING IDEAS Bullets and Dashes If you wish to use special formatting characters, you can copy these: · This is a bullet: ÿÿïfÿ · This is an em-dash: ÿÿï%ÿ (used between pieces of text, e.g. "Georgeÿÿï%ÿI mean the one who...") ÿÿ ÿ· This is an en-dash: ÿÿï$ÿ (used between two characters, e.g. 1ÿÿï$ÿ2) Other Examples For other examples, see the long template, DocumentationTemplate.TEdit.(LIST ((PAGE NIL (FOLIOINFO (ARABIC) STARTINGPAGE# 1) (0 0 612 792) ((FOLIO NIL (PARALOOKS (QUAD CENTERED) CHARLOOKS (SUPERSCRIPT 0 SIZE 10 FAMILY MODERN OVERLINE OFF STRIKEOUT OFF UNDERLINE OFF SLOPE REGULAR WEIGHT MEDIUM) FORMATINFO (ARABIC)) (174 36 288 36) NIL) (HEADING NIL (HEADINGTYPE RUNNINGHEAD) (84 744 444 36) NIL) (TEXT NIL NIL (84 96 456 600) NIL))) (PAGE NIL NIL (0 0 612 792) ((FOLIO NIL (PARALOOKS (QUAD CENTERED) CHARLOOKS (SUPERSCRIPT 0 SIZE 10 FAMILY MODERN OVERLINE OFF STRIKEOUT OFF UNDERLINE OFF SLOPE REGULAR WEIGHT MEDIUM)) (282 42 72 36) NIL) (HEADING NIL (HEADINGTYPE RUNNINGHEAD) (84 744 444 36) NIL) (TEXT NIL NIL (84 96 456 600) NIL))) (PAGE NIL NIL (0 0 612 792) ((FOLIO NIL (PARALOOKS (QUAD CENTERED) CHARLOOKS (SUPERSCRIPT 0 SIZE 10 FAMILY MODERN OVERLINE OFF STRIKEOUT OFF UNDERLINE OFF SLOPE REGULAR WEIGHT MEDIUM)) (282 42 72 36) NIL) (HEADING NIL (HEADINGTYPE RUNNINGHEAD) (84 744 444 36) NIL) (TEXT NIL NIL (84 96 456 600) NIL)))))(È1È È1È ¼È(ŠŠ8(È (ŠŠ8DÈÈ PAGEHEADING RUNNINGHEADTERMINAL  HELVETICA MODERN MODERN MODERN MODERNMODERN LOGO HRULE.GETFNMODERN  HRULE.GETFNMODERN  HRULE.GETFNMODERN  HRULE.GETFNMODERN  HRULE.GETFNMODERN *- J2 ! ,è 1 ].¯' ùe=MF.+G árzº