9 lines
4.1 KiB
Plaintext
9 lines
4.1 KiB
Plaintext
ROOMS USERS' >>MODULE NAME<<
|
||
2
|
||
|
||
4
|
||
|
||
1
|
||
|
||
>>Module Name<<
|
||
1
|
||
|
||
4
|
||
|
||
By: >>Your Name<< (>>Your net address<<)
|
||
Uses: >>Other modules necessary to run this one<<
|
||
>>Type INTERNAL here if the file is for Internal Use Only<<
|
||
This document last edited on >>DATE<<.
|
||
INTRODUCTION
|
||
>>This paragraph should be replaced by an overview of your module.<<
|
||
MODULE 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.
|
||
Be sure to include the following information in any module explanations:
|
||
ÿÿ |