summaryrefslogtreecommitdiff
path: root/docsrc/xlisp/xlisp-doc/reference/reference-format.htm
diff options
context:
space:
mode:
Diffstat (limited to 'docsrc/xlisp/xlisp-doc/reference/reference-format.htm')
-rw-r--r--docsrc/xlisp/xlisp-doc/reference/reference-format.htm83
1 files changed, 83 insertions, 0 deletions
diff --git a/docsrc/xlisp/xlisp-doc/reference/reference-format.htm b/docsrc/xlisp/xlisp-doc/reference/reference-format.htm
new file mode 100644
index 0000000..140d2c0
--- /dev/null
+++ b/docsrc/xlisp/xlisp-doc/reference/reference-format.htm
@@ -0,0 +1,83 @@
+<html><head><title>Entry Format</title>
+
+<link rel="stylesheet" type="text/css" href="reference.css">
+
+</head>
+
+<body>
+
+<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
+<a href="../manual/contents.htm">Contents</a> |
+<a href="../tutorials/tutorials.htm">Tutorials</a> |
+<a href="../examples/examples.htm">Examples</a> |
+<a href="reference-index.htm">Reference</a>
+
+<hr>
+
+<h1>Entry Format</h1>
+
+<hr>
+
+<p>Each entry is a symbol of some variety that the XLISP system will
+recognize. The parts of each reference entry include:</p>
+
+<ol>
+
+<li><p>The <b>Headline</b> of the page gives the name or symbol of the
+entry.</p></li>
+
+<li><p>The <b>Reference</b> section below the headline gives infomations in
+the following order:</p></li>
+
+<ul>
+
+<li><p><b>Type</b> may be one of the following:</p></li>
+
+<ul>
+<li><nobr>function (subr)</nobr></li>
+<li><nobr>predicate function (subr)</nobr></li>
+<li><nobr>special form (fsubr)</nobr></li>
+<li><nobr>reader expansion</nobr></li>
+<li><nobr>system variable</nobr></li>
+<li><nobr>system constant</nobr></li>
+<li><nobr>keyword</nobr></li>
+<li><nobr>object</nobr></li>
+<li><nobr>message selector</nobr></li>
+</ul>
+
+<li><p><b>Source</b> specifies the source file where the routine or code
+associated with the entry resides. [Please not that I have copied the
+source file locations out of the Tim I Mikkelsen manual without checking,
+so some of them may be wrong.]</p></li>
+
+</ul>
+
+<li><p><b>Syntax</b> defines the syntax or usage of the entry. It is also
+used to specify the arguments. Items written in <i>italics</i> 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.</p></li>
+
+<li><p><b>Description</b> defines the entry, necessary conditions, results,
+defaults, etc.</p></li>
+
+<li><p><b>Examples</b> shows example uses of the entry.</p></li>
+
+<li><p>The <b>Comments</b> section after the examples includes additional
+information such as compatibility notes, bugs, usage notes, potential
+problems, keystroke equivalences, etc.</p></li>
+
+</ol>
+
+<p><nobr>&nbsp;&nbsp;<a href="#top">Back to Top</a></nobr></p>
+
+<hr>
+
+<a href="../start.htm">Nyquist / XLISP 2.0</a>&nbsp; -&nbsp;
+<a href="../manual/contents.htm">Contents</a> |
+<a href="../tutorials/tutorials.htm">Tutorials</a> |
+<a href="../examples/examples.htm">Examples</a> |
+<a href="reference-index.htm">Reference</a>
+
+</body></html> \ No newline at end of file