Commits

Paul Sexton  committed ad6153e

"Internal" and "External" symbols are now segregated, with external symbols appearing first in the table of contents.

  • Participants
  • Parent commits 13be9a0

Comments (0)

Files changed (3)

     (otherwise (error "Unknown entity type: ~S" entity))))
 
 
+(defun str+ (&rest strings)
+  "* Usage
+: (str+ STRING [STRING...])
+* Arguments
+- STRINGS :: One or more strings.
+* Returns
+A string.
+* Description
+Returns the concatenation of all supplied strings. Shorthand
+for =(concatenate 'string . STRINGS)=."
+  (apply #'concatenate 'string strings))
+
+
 (defun entity->string (entity)
   "* Usage
 : (entity->string ENTITY)
   (write-out "~&#+STARTUP: showall")
   ;; H:NNN = below this many levels deep, headings become bulleted lists
   ;; toc:NNN = go this many levels deep in table of contents
-  (write-out "~&#+OPTIONS: toc:3 H:10 @:t tags:nil~%~%"))
+  (write-out "~&#+OPTIONS: toc:4 H:10 @:t tags:nil~%~%"))
 
 
 
 
 
 (defun document-package-contents (pkg &optional (accessibilities
-                                                 (list :internal :external)))
+                                                 (list :external :internal)))
   "* Usage
 : (document-package-contents PKG [ACCESSIBILITIES])
 * Arguments
       (writing-section ("Class Hierarchy")
         (write-class-hierarchy (mapcar #'find-class classes))
         ))
-    (write-chapter classes :class "Classes")
-    (write-chapter structures :structure "Structures")
-    (write-chapter types :type "Types")
-    (write-chapter constants :constant "Constants")
-    (write-chapter vars :variable "Global Variables")
-    (write-chapter macros :macro "Macros")
-    (write-chapter functions :function "Functions")
-    (write-chapter generics :generic "Generic Functions")
+    (dolist (access accessibilities)
+      (let ((accstr (format nil "~:(~A~) " access)))
+        (writing-section ((str+ accstr "Symbols"))
+          (write-out "~%~%")
+          (write-chapter (accessible-symbols classes access pkg)
+                         :class (str+ accstr "Classes"))
+          (write-chapter (accessible-symbols structures access pkg)
+                         :structure (str+ accstr "Structures"))
+          (write-chapter (accessible-symbols types access pkg)
+                         :type (str+ accstr "Types"))
+          (write-chapter (accessible-symbols constants access pkg)
+                         :constant (str+ accstr "Constants"))
+          (write-chapter (accessible-symbols vars access pkg)
+                         :variable (str+ accstr "Global Variables"))
+          (write-chapter (accessible-symbols macros access pkg)
+                         :macro (str+ accstr "Macros"))
+          (write-chapter (accessible-symbols functions access pkg)
+                         :function (str+ accstr "Functions"))
+          (write-chapter (accessible-symbols generics access pkg)
+                         :generic (str+ accstr "Generic Functions")))))
     (when (plusp (hash-table-count *ambiguities*))
       (writing-section ("Ambiguous Symbols")
         (iterate
     (write-index pkg accessibilities)))
 
 
+(defun accessible-symbols (syms access pkg)
+  "* Usage
+: (accessible-symbols SYMS ACCESS PKG)
+* Arguments
+- SYMS :: A list of symbols.
+- ACCESS :: One of the keywords =:INTERNAL= or =:EXTERNAL=.
+- PKG :: A package object.
+* Returns
+A list of symbols.
+* Description
+Given a list of symbols, SYMS, returns the subset of SYMS whose
+accessibility in PKG matches ACCESS."
+  (remove-if-not (lambda (sym)
+                   (eql (symbol-accessibility sym pkg) access))
+                 syms))
+
 
 (defun write-class-hierarchy (classes)
   "* Usage

File doc/clod-doc.html

 <title>CLOD</title>
 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
 <meta name="generator" content="Org-mode"/>
-<meta name="generated" content="2010-02-26 23:43:30 NZDT"/>
+<meta name="generated" content="2010-02-27 00:36:10 NZDT"/>
 <meta name="author" content="Paul Sexton"/>
 <meta name="description" content=""/>
 <meta name="keywords" content=""/>
 <p><a name="clod" id="clod"></a>
 <a name="package==clod" id="package==clod"></a>
 </p>
-<p>
-</p>
-<p>
-</p>
+
+
 <div id="table-of-contents">
 <h2>Table of Contents</h2>
 <div id="text-table-of-contents">
 <ul>
-<li></li>
 <li><a href="#sec-1">1 Internal Package: <code>clod</code></a>
 <ul>
 <li>
 <ul>
-<li>
-</li>
 <li><a href="#sec-1.1">1.1 Description</a></li>
 <li><a href="#sec-1.2">1.2 Why use CLOD?</a></li>
 <li><a href="#sec-1.3">1.3 Dependencies</a></li>
 <li><a href="#sec-1.7">1.7 Limitations</a></li>
 </ul>
 </li>
-<li><a href="#sec-1.1">1.1 Types</a>
+<li><a href="#sec-1.1">1.1 External Symbols</a>
 <ul>
-<li>
-</li>
-<li><a href="#sec-1.1.1">1.1.1 Internal Type: ==entity==</a></li>
+<li><a href="#sec-1.1.1">1.1.1 External Functions</a>
+<ul>
+<li><a href="#sec-1.1.1.1">1.1.1.1 External Function: <code>document-package</code></a></li>
+<li><a href="#sec-1.1.1.2">1.1.1.2 External Function: <code>document-packages</code></a></li>
+</ul></li>
 </ul>
 </li>
-<li><a href="#sec-1.2">1.2 Global Variables</a>
+<li><a href="#sec-1.2">1.2 Internal Symbols</a>
 <ul>
-<li>
-</li>
-<li><a href="#sec-1.2.1">1.2.1 Internal Variable: <code>*alphabet*</code></a></li>
-<li><a href="#sec-1.2.2">1.2.2 Internal Variable: <code>*ambiguities*</code></a></li>
-<li><a href="#sec-1.2.3">1.2.3 Internal Variable: <code>*auto-links*</code></a></li>
-<li><a href="#sec-1.2.4">1.2.4 Internal Variable: <code>*brief-methods*</code></a></li>
-<li><a href="#sec-1.2.5">1.2.5 Internal Variable: <code>*class-diagram*</code></a></li>
-<li><a href="#sec-1.2.6">1.2.6 Internal Variable: <code>*document-author*</code></a></li>
-<li><a href="#sec-1.2.7">1.2.7 Internal Variable: <code>*document-email*</code></a></li>
-<li><a href="#sec-1.2.8">1.2.8 Internal Variable: <code>*document-title*</code></a></li>
-<li><a href="#sec-1.2.9">1.2.9 Internal Variable: <code>*heading-char*</code></a></li>
-<li><a href="#sec-1.2.10">1.2.10 Internal Variable: <code>*heading-level*</code></a></li>
-<li><a href="#sec-1.2.11">1.2.11 Internal Variable: <code>*hyperspec-root*</code></a></li>
-<li><a href="#sec-1.2.12">1.2.12 Internal Variable: <code>*left-margin*</code></a></li>
-<li><a href="#sec-1.2.13">1.2.13 Internal Variable: <code>*line-width*</code></a></li>
-<li><a href="#sec-1.2.14">1.2.14 Internal Variable: <code>*lines-between-sections*</code></a></li>
-<li><a href="#sec-1.2.15">1.2.15 Internal Variable: <code>*out*</code></a></li>
-<li><a href="#sec-1.2.16">1.2.16 Internal Variable: <code>*unsafe-html-chars*</code></a></li>
+<li><a href="#sec-1.2.1">1.2.1 Internal Types</a>
+<ul>
+<li><a href="#sec-1.2.1.1">1.2.1.1 Internal Type: ==entity==</a></li>
 </ul>
 </li>
-<li><a href="#sec-1.3">1.3 Macros</a>
+<li><a href="#sec-1.2.2">1.2.2 Internal Global Variables</a>
 <ul>
-<li>
-</li>
-<li><a href="#sec-1.3.1">1.3.1 Internal Macro: <code>do-own-symbols</code></a></li>
-<li><a href="#sec-1.3.2">1.3.2 Internal Macro: <code>write-indented</code></a></li>
-<li><a href="#sec-1.3.3">1.3.3 Internal Macro: <code>writing-bulleted-list</code></a></li>
-<li><a href="#sec-1.3.4">1.3.4 Internal Macro: <code>writing-section</code></a></li>
-<li><a href="#sec-1.3.5">1.3.5 Internal Macro: <code>writing-section-for-symbol</code></a></li>
+<li><a href="#sec-1.2.2.1">1.2.2.1 Internal Variable: <code>*alphabet*</code></a></li>
+<li><a href="#sec-1.2.2.2">1.2.2.2 Internal Variable: <code>*ambiguities*</code></a></li>
+<li><a href="#sec-1.2.2.3">1.2.2.3 Internal Variable: <code>*auto-links*</code></a></li>
+<li><a href="#sec-1.2.2.4">1.2.2.4 Internal Variable: <code>*brief-methods*</code></a></li>
+<li><a href="#sec-1.2.2.5">1.2.2.5 Internal Variable: <code>*class-diagram*</code></a></li>
+<li><a href="#sec-1.2.2.6">1.2.2.6 Internal Variable: <code>*document-author*</code></a></li>
+<li><a href="#sec-1.2.2.7">1.2.2.7 Internal Variable: <code>*document-email*</code></a></li>
+<li><a href="#sec-1.2.2.8">1.2.2.8 Internal Variable: <code>*document-title*</code></a></li>
+<li><a href="#sec-1.2.2.9">1.2.2.9 Internal Variable: <code>*heading-char*</code></a></li>
+<li><a href="#sec-1.2.2.10">1.2.2.10 Internal Variable: <code>*heading-level*</code></a></li>
+<li><a href="#sec-1.2.2.11">1.2.2.11 Internal Variable: <code>*hyperspec-root*</code></a></li>
+<li><a href="#sec-1.2.2.12">1.2.2.12 Internal Variable: <code>*left-margin*</code></a></li>
+<li><a href="#sec-1.2.2.13">1.2.2.13 Internal Variable: <code>*line-width*</code></a></li>
+<li><a href="#sec-1.2.2.14">1.2.2.14 Internal Variable: <code>*lines-between-sections*</code></a></li>
+<li><a href="#sec-1.2.2.15">1.2.2.15 Internal Variable: <code>*out*</code></a></li>
+<li><a href="#sec-1.2.2.16">1.2.2.16 Internal Variable: <code>*unsafe-html-chars*</code></a></li>
 </ul>
 </li>
-<li><a href="#sec-1.4">1.4 Functions</a>
+<li><a href="#sec-1.2.3">1.2.3 Internal Macros</a>
 <ul>
-<li>
+<li><a href="#sec-1.2.3.1">1.2.3.1 Internal Macro: <code>do-own-symbols</code></a></li>
+<li><a href="#sec-1.2.3.2">1.2.3.2 Internal Macro: <code>write-indented</code></a></li>
+<li><a href="#sec-1.2.3.3">1.2.3.3 Internal Macro: <code>writing-bulleted-list</code></a></li>
+<li><a href="#sec-1.2.3.4">1.2.3.4 Internal Macro: <code>writing-section</code></a></li>
+<li><a href="#sec-1.2.3.5">1.2.3.5 Internal Macro: <code>writing-section-for-symbol</code></a></li>
+</ul>
 </li>
-<li><a href="#sec-1.4.1">1.4.1 Internal Function: <code>docpkg</code></a></li>
-<li><a href="#sec-1.4.2">1.4.2 External Function: <code>document-package</code></a></li>
-<li><a href="#sec-1.4.3">1.4.3 Internal Function: <code>document-package-contents</code></a></li>
-<li><a href="#sec-1.4.4">1.4.4 External Function: <code>document-packages</code></a></li>
-<li><a href="#sec-1.4.5">1.4.5 Internal Function: <code>entity-&gt;string</code></a></li>
-<li><a href="#sec-1.4.6">1.4.6 Internal Function: <code>entity-&gt;tag</code></a></li>
-<li><a href="#sec-1.4.7">1.4.7 Internal Function: <code>html-safe-string</code></a></li>
-<li><a href="#sec-1.4.8">1.4.8 Internal Function: <code>list-&gt;string-with-commas</code></a></li>
-<li><a href="#sec-1.4.9">1.4.9 Internal Function: <code>list-all-direct-slots</code></a></li>
-<li><a href="#sec-1.4.10">1.4.10 Internal Function: <code>list-all-indirect-slots</code></a></li>
-<li><a href="#sec-1.4.11">1.4.11 Internal Function: <code>list-all-slot-accessors</code></a></li>
-<li><a href="#sec-1.4.12">1.4.12 Internal Function: <code>make-class-link</code></a></li>
-<li><a href="#sec-1.4.13">1.4.13 Internal Function: <code>make-package-link</code></a></li>
-<li><a href="#sec-1.4.14">1.4.14 Internal Function: <code>make-specialised-lambda-list</code></a></li>
-<li><a href="#sec-1.4.15">1.4.15 Internal Function: <code>make-target</code></a></li>
-<li><a href="#sec-1.4.16">1.4.16 Internal Function: <code>org-safe-symbol</code></a></li>
-<li><a href="#sec-1.4.17">1.4.17 Internal Function: <code>simple-type?</code></a></li>
-<li><a href="#sec-1.4.18">1.4.18 Internal Function: <code>symbol-accessibility</code></a></li>
-<li><a href="#sec-1.4.19">1.4.19 Internal Function: <code>type-&gt;string</code></a></li>
-<li><a href="#sec-1.4.20">1.4.20 Internal Function: <code>uses-for-symbol</code></a></li>
-<li><a href="#sec-1.4.21">1.4.21 Internal Function: <code>word-wrap</code></a></li>
-<li><a href="#sec-1.4.22">1.4.22 Internal Function: <code>wrap-and-write</code></a></li>
-<li><a href="#sec-1.4.23">1.4.23 Internal Function: <code>wrap-and-write-code</code></a>
+<li><a href="#sec-1.2.4">1.2.4 Internal Functions</a>
+<ul>
+<li><a href="#sec-1.2.4.1">1.2.4.1 Internal Function: <code>accessible-symbols</code></a></li>
+<li><a href="#sec-1.2.4.2">1.2.4.2 Internal Function: <code>docpkg</code></a></li>
+<li><a href="#sec-1.2.4.3">1.2.4.3 Internal Function: <code>document-package-contents</code></a></li>
+<li><a href="#sec-1.2.4.4">1.2.4.4 Internal Function: <code>entity-&gt;string</code></a></li>
+<li><a href="#sec-1.2.4.5">1.2.4.5 Internal Function: <code>entity-&gt;tag</code></a></li>
+<li><a href="#sec-1.2.4.6">1.2.4.6 Internal Function: <code>html-safe-string</code></a></li>
+<li><a href="#sec-1.2.4.7">1.2.4.7 Internal Function: <code>list-&gt;string-with-commas</code></a></li>
+<li><a href="#sec-1.2.4.8">1.2.4.8 Internal Function: <code>list-all-direct-slots</code></a></li>
+<li><a href="#sec-1.2.4.9">1.2.4.9 Internal Function: <code>list-all-indirect-slots</code></a></li>
+<li><a href="#sec-1.2.4.10">1.2.4.10 Internal Function: <code>list-all-slot-accessors</code></a></li>
+<li><a href="#sec-1.2.4.11">1.2.4.11 Internal Function: <code>make-class-link</code></a></li>
+<li><a href="#sec-1.2.4.12">1.2.4.12 Internal Function: <code>make-package-link</code></a></li>
+<li><a href="#sec-1.2.4.13">1.2.4.13 Internal Function: <code>make-specialised-lambda-list</code></a></li>
+<li><a href="#sec-1.2.4.14">1.2.4.14 Internal Function: <code>make-target</code></a></li>
+<li><a href="#sec-1.2.4.15">1.2.4.15 Internal Function: <code>org-safe-symbol</code></a></li>
+<li><a href="#sec-1.2.4.16">1.2.4.16 Internal Function: <code>simple-type?</code></a></li>
+<li><a href="#sec-1.2.4.17">1.2.4.17 Internal Function: <code>str+</code></a></li>
+<li><a href="#sec-1.2.4.18">1.2.4.18 Internal Function: <code>symbol-accessibility</code></a></li>
+<li><a href="#sec-1.2.4.19">1.2.4.19 Internal Function: <code>type-&gt;string</code></a></li>
+<li><a href="#sec-1.2.4.20">1.2.4.20 Internal Function: <code>uses-for-symbol</code></a></li>
+<li><a href="#sec-1.2.4.21">1.2.4.21 Internal Function: <code>word-wrap</code></a></li>
+<li><a href="#sec-1.2.4.22">1.2.4.22 Internal Function: <code>wrap-and-write</code></a></li>
+<li><a href="#sec-1.2.4.23">1.2.4.23 Internal Function: <code>wrap-and-write-code</code></a></li>
+<li><a href="#sec-1.2.4.24">1.2.4.24 Internal Function: <code>write-bullet-point</code></a></li>
+<li><a href="#sec-1.2.4.25">1.2.4.25 Internal Function: <code>write-chapter</code></a></li>
+<li><a href="#sec-1.2.4.26">1.2.4.26 Internal Function: <code>write-class-hierarchy</code></a></li>
+<li><a href="#sec-1.2.4.27">1.2.4.27 Internal Function: <code>write-disambiguation</code></a></li>
+<li><a href="#sec-1.2.4.28">1.2.4.28 Internal Function: <code>write-docstring</code></a></li>
+<li><a href="#sec-1.2.4.29">1.2.4.29 Internal Function: <code>write-docstring-section</code></a></li>
+<li><a href="#sec-1.2.4.30">1.2.4.30 Internal Function: <code>write-heading</code></a></li>
+<li><a href="#sec-1.2.4.31">1.2.4.31 Internal Function: <code>write-index</code></a></li>
+<li><a href="#sec-1.2.4.32">1.2.4.32 Internal Function: <code>write-list-as-paragraph</code></a></li>
+<li><a href="#sec-1.2.4.33">1.2.4.33 Internal Function: <code>write-out</code></a></li>
+<li><a href="#sec-1.2.4.34">1.2.4.34 Internal Function: <code>write-preamble</code></a></li>
+</ul>
+</li>
+<li><a href="#sec-1.2.5">1.2.5 Internal Generic Functions</a>
+<ul>
+<li><a href="#sec-1.2.5.1">1.2.5.1 Internal Generic Function: <code>document</code></a></li>
+<li><a href="#sec-1.2.5.2">1.2.5.2 Internal Generic Function: <code>make-link</code></a></li>
+</ul></li>
+</ul>
+</li>
+<li><a href="#sec-1.3">1.3 Index</a>
+<ul>
+<li><a href="#sec-1.3.1">1.3.1 Nonalphabetic</a></li>
+<li><a href="#sec-1.3.2">1.3.2 A</a></li>
+<li><a href="#sec-1.3.3">1.3.3 C</a></li>
+<li><a href="#sec-1.3.4">1.3.4 D</a></li>
+<li><a href="#sec-1.3.5">1.3.5 E</a></li>
+<li><a href="#sec-1.3.6">1.3.6 H</a></li>
+<li><a href="#sec-1.3.7">1.3.7 L</a></li>
+<li><a href="#sec-1.3.8">1.3.8 M</a></li>
+<li><a href="#sec-1.3.9">1.3.9 O</a></li>
+<li><a href="#sec-1.3.10">1.3.10 S</a></li>
+<li><a href="#sec-1.3.11">1.3.11 T</a></li>
+<li><a href="#sec-1.3.12">1.3.12 U</a></li>
+<li><a href="#sec-1.3.13">1.3.13 W</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
 <div id="outline-container-1" class="outline-2">
 <h2 id="sec-1"><span class="section-number-2">1</span> Internal Package: <code>clod</code></h2>
 <div class="outline-text-2" id="text-1">
 
-<p></p>
-<p>
-</p><ul>
+
+<ul>
 <li>
 Uses:
 <a href="#package==common-lisp">common-lisp</a>, <a href="#package==iterate">iterate</a>, <a href="#package==closer-mop">closer-mop</a>, <a href="#package==cl-ppcre">cl-ppcre</a>
 <h4 id="sec-1.1"><span class="section-number-4">1.1</span> Description</h4>
 <div class="outline-text-4" id="text-1.1">
 
-<p></p>
-<p>
-</p>
+
+
 <p>
 CLOD is a tool for creating documentation for Common Lisp programs.
 CLOD examines a loaded package and writes information about all the
 <dt>Org mode</dt><dd>
 <a href="http://orgmode.org/">http://orgmode.org/</a>
 
-<p>
-</p></dd>
+</dd>
 </dl>
 </div>
 
 <h4 id="sec-1.2"><span class="section-number-4">1.2</span> Why use CLOD?</h4>
 <div class="outline-text-4" id="text-1.2">
 
-<p></p>
-<p>
-</p>
-<p>
-</p><ul>
+
+
+<ul>
 <li>
 You can use org markup within docstrings (easy for humans to read) to
 create subsections, bulleted lists, hyperlinks within the document or
 #+INCLUDE: "filename" quote
 </pre>
 
-<p></p></li>
+</li>
 <li>
 Include an entire file with common lisp syntax highlighting
 <pre class="example">
 #+INCLUDE: "filename.lisp" src lisp
 </pre>
 
-<p></p></li>
+</li>
 <li>
 Timestamps and datestamps:
 <pre class="example">
 {{{ modification-time(%r) }}}
 </pre>
 
-<p>11:41:36 PM
+<p>12:35:59 AM
 </p><pre class="example">
 {{{ date(%Y-%m-%d) }}}
 </pre>
 
-<p>2010-02-26
+<p>2010-02-27
 </p></li>
 <li>
 Define text macros, use with <code>{{{macro(arg1,arg2)}}}</code>
 #+MACRO: foo Replacement text $1 $2
 </pre>
 
-<p></p></li>
+</li>
 <li>
 Embed any LaTeX code directly (no special markup needed)
 </li>
 Automatic syntax highlighting of source code examples in exported
 documents, eg:
 
-<p>
-</p></li>
+</li>
 </ul>
 </li>
 </ul>
 
 
 
-<p>
-</p></div>
+</div>
 
 </div>
 
 <h4 id="sec-1.3"><span class="section-number-4">1.3</span> Dependencies</h4>
 <div class="outline-text-4" id="text-1.3">
 
-<p></p>
-<p>
-</p>
-<p>
-</p><ul>
+
+
+<ul>
 <li>
 ASDF
 </li>
 <li>
 CL-PPCRE: <a href="http://weitz.de/cl-ppcre/">http://weitz.de/cl-ppcre/</a>
 
-<p>
-</p></li>
+</li>
 </ul>
 </div>
 
 <h4 id="sec-1.4"><span class="section-number-4">1.4</span> How to use</h4>
 <div class="outline-text-4" id="text-1.4">
 
-<p></p>
-<p>
-</p>
-<p>
-</p><ol>
+
+
+<ol>
 <li>
 Install CLOD somewhere ASDF can find it.
 </li>
 Load filename.org into Emacs. Export to HTML with <code>M-x org-export</code>, or press
 C-c C-e to be presented with a menu of export options.
 
-<p>
-</p></li>
+</li>
 </ol>
 </div>
 
 <h4 id="sec-1.5"><span class="section-number-4">1.5</span> Writing the documentation</h4>
 <div class="outline-text-4" id="text-1.5">
 
-<p></p>
-<p>
-</p>
+
+
 <p>
 All documentation produced by CLOD is obtained by introspection, i.e.  the
 running CL process examining itself. If a symbol has an associated docstring,
 semicolons ;;; are assumed to be example lisp source code. The first 3
 semicolons are removed and the rest of the line is syntax highlighted.
 
-<p>
-</p></li>
+</li>
 </ul>
 </div>
 
 <h4 id="sec-1.6"><span class="section-number-4">1.6</span> Example</h4>
 <div class="outline-text-4" id="text-1.6">
 
-<p></p>
-<p>
-</p>
+
+
 <p>
 Here is the docstring for <a href="#document-package">document-package</a>.
 </p>
-<p>
-</p><pre class="example">
+<pre class="example">
 * Usage
 : (document-package PKG FILE/STREAM &amp;key AUTO-LINKS
 :      LINES-BETWEEN-SECTIONS BRIEF-METHODS TITLE
 - [[document-packages]]
 </pre>
 
-<p></p>
-<p>
-</p></div>
+
+</div>
 
 </div>
 
 <h4 id="sec-1.7"><span class="section-number-4">1.7</span> Limitations</h4>
 <div class="outline-text-4" id="text-1.7">
 
-<p></p>
-<p>
-</p>
-<p>
-</p><ul>
+
+
+<ul>
 <li>
 There is no portable way to access the lambda lists of functions. Thus, you
 need to describe these manually in function docstrings.
 
-<p>
-</p></li>
+</li>
 </ul>
 </div>
 
 </div>
 
 <div id="outline-container-1.1" class="outline-3">
-<h3 id="sec-1.1"><span class="section-number-3">1.1</span> Types</h3>
+<h3 id="sec-1.1"><span class="section-number-3">1.1</span> External Symbols</h3>
 <div class="outline-text-3" id="text-1.1">
 
-<p></p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="..3d..entity..3d.." id="..3d..entity..3d.."></a>
-<a name="type==..3d..entity..3d.." id="type==..3d..entity..3d.."></a>
-</p>
-<p>
-</p>
-<p>
-</p>
+
+
+
+
+
 </div>
 
 <div id="outline-container-1.1.1" class="outline-4">
-<h4 id="sec-1.1.1"><span class="section-number-4">1.1.1</span> Internal Type: ==entity==</h4>
+<h4 id="sec-1.1.1"><span class="section-number-4">1.1.1</span> External Functions</h4>
 <div class="outline-text-4" id="text-1.1.1">
 
-<p></p>
-<p>
-The type 'entity' can have any of several different symbols as its value.
-Each value is a different kind of 'meaning' which a symbol can have within
-a package. For example, <code>:function</code> is a function, <code>:class</code> is a class,
-and so on.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2" class="outline-3">
-<h3 id="sec-1.2"><span class="section-number-3">1.2</span> Global Variables</h3>
-<div class="outline-text-3" id="text-1.2">
-
-<p></p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>alphabet</b>" id="<b>alphabet</b>"></a>
-<a name="variable==*alphabet*" id="variable==*alphabet*"></a>
-</p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.1" class="outline-4">
-<h4 id="sec-1.2.1"><span class="section-number-4">1.2.1</span> Internal Variable: <code>*alphabet*</code></h4>
-<div class="outline-text-4" id="text-1.2.1">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.1.1" class="outline-5">
-<h5 id="sec-1.2.1.1"><span class="section-number-5">1.2.1.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.1.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-(#\A #\B #\C #\D #\E #\F #\G #\H #\I #\J #\K #\L #\M #\N #\O #\P #\Q #\R #\S
-#\T #\U #\V #\W #\X #\Y #\Z)
-</pre>
-
-<p></p>
-<p>
-Type: <code>cons</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.1.2" class="outline-5">
-<h5 id="sec-1.2.1.2"><span class="section-number-5">1.2.1.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.1.2">
-
-<p></p>
-<p>
-List of uppercase letters (characters) from A to Z.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>ambiguities</b>" id="<b>ambiguities</b>"></a>
-<a name="variable==*ambiguities*" id="variable==*ambiguities*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.2" class="outline-4">
-<h4 id="sec-1.2.2"><span class="section-number-4">1.2.2</span> Internal Variable: <code>*ambiguities*</code></h4>
-<div class="outline-text-4" id="text-1.2.2">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.2.1" class="outline-5">
-<h5 id="sec-1.2.2.1"><span class="section-number-5">1.2.2.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.2.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-#&lt;HASH-TABLE :TEST EQL size 0/60 #x235EDDDE&gt;
-</pre>
-
-<p></p>
-<p>
-Type: <code>hash-table</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.2.2" class="outline-5">
-<h5 id="sec-1.2.2.2"><span class="section-number-5">1.2.2.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.2.2">
-
-<p></p>
-<p>
-Hash table created during package documentation. Stores all
-symbols which have multiple 'meanings' within the package.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>auto-links</b>" id="<b>auto-links</b>"></a>
-<a name="variable==*auto-links*" id="variable==*auto-links*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.3" class="outline-4">
-<h4 id="sec-1.2.3"><span class="section-number-4">1.2.3</span> Internal Variable: <code>*auto-links*</code></h4>
-<div class="outline-text-4" id="text-1.2.3">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.3.1" class="outline-5">
-<h5 id="sec-1.2.3.1"><span class="section-number-5">1.2.3.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.3.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-NIL
-</pre>
-
-<p></p>
-<p>
-Type: <code>null</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.3.2" class="outline-5">
-<h5 id="sec-1.2.3.2"><span class="section-number-5">1.2.3.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.3.2">
-
-<p></p>
-<p>
-If true, all occurrences of package symbols anywhere in the documentation
-will be turned into hyperlinks, even if they are not marked up as such.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>brief-methods</b>" id="<b>brief-methods</b>"></a>
-<a name="variable==*brief-methods*" id="variable==*brief-methods*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.4" class="outline-4">
-<h4 id="sec-1.2.4"><span class="section-number-4">1.2.4</span> Internal Variable: <code>*brief-methods*</code></h4>
-<div class="outline-text-4" id="text-1.2.4">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.4.1" class="outline-5">
-<h5 id="sec-1.2.4.1"><span class="section-number-5">1.2.4.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.4.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-T
-</pre>
-
-<p></p>
-<p>
-Type: <code>boolean</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.4.2" class="outline-5">
-<h5 id="sec-1.2.4.2"><span class="section-number-5">1.2.4.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.4.2">
-
-<p></p>
-<p>
-If true, most documentation for methods is assumed to be found in the docstring
-for their generic function. A generic function's methods are therefore described
-in a very brief format (bulleted list).
-</p>
-<p>
-If false, each method receives its own section, just like other functions.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>class-diagram</b>" id="<b>class-diagram</b>"></a>
-<a name="variable==*class-diagram*" id="variable==*class-diagram*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.5" class="outline-4">
-<h4 id="sec-1.2.5"><span class="section-number-4">1.2.5</span> Internal Variable: <code>*class-diagram*</code></h4>
-<div class="outline-text-4" id="text-1.2.5">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.5.1" class="outline-5">
-<h5 id="sec-1.2.5.1"><span class="section-number-5">1.2.5.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.5.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-NIL
-</pre>
-
-<p></p>
-<p>
-Type: <code>null</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.5.2" class="outline-5">
-<h5 id="sec-1.2.5.2"><span class="section-number-5">1.2.5.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.5.2">
-
-<p></p>
-<p>
-If true, creates a section describing the package class hierarchy as a
-'dot' diagram, which can be fed to the GraphViz program (if installed) to
-create a visual representation of the hierarchy.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>document-author</b>" id="<b>document-author</b>"></a>
-<a name="variable==*document-author*" id="variable==*document-author*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.6" class="outline-4">
-<h4 id="sec-1.2.6"><span class="section-number-4">1.2.6</span> Internal Variable: <code>*document-author*</code></h4>
-<div class="outline-text-4" id="text-1.2.6">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.6.1" class="outline-5">
-<h5 id="sec-1.2.6.1"><span class="section-number-5">1.2.6.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.6.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-"Paul Sexton"
-</pre>
-
-<p></p>
-<p>
-Type: <code>simple-base-string</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.6.2" class="outline-5">
-<h5 id="sec-1.2.6.2"><span class="section-number-5">1.2.6.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.6.2">
-
-<p></p>
-<p>
-The author of the document. A string.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>document-email</b>" id="<b>document-email</b>"></a>
-<a name="variable==*document-email*" id="variable==*document-email*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.7" class="outline-4">
-<h4 id="sec-1.2.7"><span class="section-number-4">1.2.7</span> Internal Variable: <code>*document-email*</code></h4>
-<div class="outline-text-4" id="text-1.2.7">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.7.1" class="outline-5">
-<h5 id="sec-1.2.7.1"><span class="section-number-5">1.2.7.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.7.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-"eeeickythump@gmail.com"
-</pre>
-
-<p></p>
-<p>
-Type: <code>simple-base-string</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.7.2" class="outline-5">
-<h5 id="sec-1.2.7.2"><span class="section-number-5">1.2.7.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.7.2">
-
-<p></p>
-<p>
-The email address of the document's author. A string.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>document-title</b>" id="<b>document-title</b>"></a>
-<a name="variable==*document-title*" id="variable==*document-title*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.8" class="outline-4">
-<h4 id="sec-1.2.8"><span class="section-number-4">1.2.8</span> Internal Variable: <code>*document-title*</code></h4>
-<div class="outline-text-4" id="text-1.2.8">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.8.1" class="outline-5">
-<h5 id="sec-1.2.8.1"><span class="section-number-5">1.2.8.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.8.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-"CLOD"
-</pre>
-
-<p></p>
-<p>
-Type: <code>simple-base-string</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.8.2" class="outline-5">
-<h5 id="sec-1.2.8.2"><span class="section-number-5">1.2.8.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.8.2">
-
-<p></p>
-<p>
-The title of the document. A string.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>heading-char</b>" id="<b>heading-char</b>"></a>
-<a name="variable==*heading-char*" id="variable==*heading-char*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.9" class="outline-4">
-<h4 id="sec-1.2.9"><span class="section-number-4">1.2.9</span> Internal Variable: <code>*heading-char*</code></h4>
-<div class="outline-text-4" id="text-1.2.9">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.9.1" class="outline-5">
-<h5 id="sec-1.2.9.1"><span class="section-number-5">1.2.9.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.9.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-#\*
-</pre>
-
-<p></p>
-<p>
-Type: <code>standard-char</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.9.2" class="outline-5">
-<h5 id="sec-1.2.9.2"><span class="section-number-5">1.2.9.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.9.2">
-
-<p></p>
-<p>
-Character used at the beginning of lines to signify headings and
-subheadings. Should not be changed.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>heading-level</b>" id="<b>heading-level</b>"></a>
-<a name="variable==*heading-level*" id="variable==*heading-level*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.10" class="outline-4">
-<h4 id="sec-1.2.10"><span class="section-number-4">1.2.10</span> Internal Variable: <code>*heading-level*</code></h4>
-<div class="outline-text-4" id="text-1.2.10">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.10.1" class="outline-5">
-<h5 id="sec-1.2.10.1"><span class="section-number-5">1.2.10.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.10.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-4
-</pre>
-
-<p></p>
-<p>
-Type: <code>integer</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.10.2" class="outline-5">
-<h5 id="sec-1.2.10.2"><span class="section-number-5">1.2.10.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.10.2">
-
-<p></p>
-<p>
-Number of levels 'deep' within the outline. Used when creating
-headings for sections and subsections.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>hyperspec-root</b>" id="<b>hyperspec-root</b>"></a>
-<a name="variable==*hyperspec-root*" id="variable==*hyperspec-root*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.11" class="outline-4">
-<h4 id="sec-1.2.11"><span class="section-number-4">1.2.11</span> Internal Variable: <code>*hyperspec-root*</code></h4>
-<div class="outline-text-4" id="text-1.2.11">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.11.1" class="outline-5">
-<h5 id="sec-1.2.11.1"><span class="section-number-5">1.2.11.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.11.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-"http://www.lispworks.com/reference/HyperSpec/"
-</pre>
-
-<p></p>
-<p>
-Type: <code>simple-base-string</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.11.2" class="outline-5">
-<h5 id="sec-1.2.11.2"><span class="section-number-5">1.2.11.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.11.2">
-
-<p></p>
-<p>
-URL or directory where the Hyperspec is found. Not currently
-implemented.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>left-margin</b>" id="<b>left-margin</b>"></a>
-<a name="variable==*left-margin*" id="variable==*left-margin*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.12" class="outline-4">
-<h4 id="sec-1.2.12"><span class="section-number-4">1.2.12</span> Internal Variable: <code>*left-margin*</code></h4>
-<div class="outline-text-4" id="text-1.2.12">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.12.1" class="outline-5">
-<h5 id="sec-1.2.12.1"><span class="section-number-5">1.2.12.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.12.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-0
-</pre>
-
-<p></p>
-<p>
-Type: <code>bit</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.12.2" class="outline-5">
-<h5 id="sec-1.2.12.2"><span class="section-number-5">1.2.12.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.12.2">
-
-<p></p>
-<p>
-Width of the current 'left margin', in spaces.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>line-width</b>" id="<b>line-width</b>"></a>
-<a name="variable==*line-width*" id="variable==*line-width*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.13" class="outline-4">
-<h4 id="sec-1.2.13"><span class="section-number-4">1.2.13</span> Internal Variable: <code>*line-width*</code></h4>
-<div class="outline-text-4" id="text-1.2.13">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.13.1" class="outline-5">
-<h5 id="sec-1.2.13.1"><span class="section-number-5">1.2.13.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.13.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-80
-</pre>
-
-<p></p>
-<p>
-Type: <code>integer</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.13.2" class="outline-5">
-<h5 id="sec-1.2.13.2"><span class="section-number-5">1.2.13.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.13.2">
-
-<p></p>
-<p>
-Width to which paragraphs are wrapped, in characters.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>lines-between-sections</b>" id="<b>lines-between-sections</b>"></a>
-<a name="variable==*lines-between-sections*" id="variable==*lines-between-sections*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.14" class="outline-4">
-<h4 id="sec-1.2.14"><span class="section-number-4">1.2.14</span> Internal Variable: <code>*lines-between-sections*</code></h4>
-<div class="outline-text-4" id="text-1.2.14">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.14.1" class="outline-5">
-<h5 id="sec-1.2.14.1"><span class="section-number-5">1.2.14.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.14.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-T
-</pre>
-
-<p></p>
-<p>
-Type: <code>boolean</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.14.2" class="outline-5">
-<h5 id="sec-1.2.14.2"><span class="section-number-5">1.2.14.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.14.2">
-
-<p></p>
-<p>
-If true, sections of the document will be separated by horizontal lines.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>out</b>" id="<b>out</b>"></a>
-<a name="variable==*out*" id="variable==*out*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.15" class="outline-4">
-<h4 id="sec-1.2.15"><span class="section-number-4">1.2.15</span> Internal Variable: <code>*out*</code></h4>
-<div class="outline-text-4" id="text-1.2.15">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.15.1" class="outline-5">
-<h5 id="sec-1.2.15.1"><span class="section-number-5">1.2.15.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.15.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-#&lt;BASIC-FILE-CHARACTER-OUTPUT-STREAM ("/home/paul/lisp/clod/doc/clod
-doc.org"/4 ISO-8859-1) #x235EB876&gt;
-</pre>
-
-<p></p>
-<p>
-Type: <code>basic-file-character-output-stream</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.15.2" class="outline-5">
-<h5 id="sec-1.2.15.2"><span class="section-number-5">1.2.15.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.15.2">
-
-<p></p>
-<p>
-Global variable that is bound to the output stream used by CLOD
-while writing documentation.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="<b>unsafe-html-chars</b>" id="<b>unsafe-html-chars</b>"></a>
-<a name="variable==*unsafe-html-chars*" id="variable==*unsafe-html-chars*"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.2.16" class="outline-4">
-<h4 id="sec-1.2.16"><span class="section-number-4">1.2.16</span> Internal Variable: <code>*unsafe-html-chars*</code></h4>
-<div class="outline-text-4" id="text-1.2.16">
-
-<p></p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.2.16.1" class="outline-5">
-<h5 id="sec-1.2.16.1"><span class="section-number-5">1.2.16.1</span> Value</h5>
-<div class="outline-text-5" id="text-1.2.16.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-(#\&lt; #\&gt; #\= #\% #\? #\+ #\$ #\/ #\&amp; #\@ #\, #\{ #\} #\^ #\~)
-</pre>
-
-<p></p>
-<p>
-Type: <code>cons</code>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.2.16.2" class="outline-5">
-<h5 id="sec-1.2.16.2"><span class="section-number-5">1.2.16.2</span> Description</h5>
-<div class="outline-text-5" id="text-1.2.16.2">
-
-<p></p>
-<p>
-List of characters which are unsafe within HTML links and anchors, and
-which need to be converted to a safe representation.
-</p>
-<p>
-See also: <a href="#html-safe-string">html-safe-string</a>.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-</div>
-
-</div>
-
-<div id="outline-container-1.3" class="outline-3">
-<h3 id="sec-1.3"><span class="section-number-3">1.3</span> Macros</h3>
-<div class="outline-text-3" id="text-1.3">
-
-<p></p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="do-own-symbols" id="do-own-symbols"></a>
-<a name="macro==do-own-symbols" id="macro==do-own-symbols"></a>
-</p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.3.1" class="outline-4">
-<h4 id="sec-1.3.1"><span class="section-number-4">1.3.1</span> Internal Macro: <code>do-own-symbols</code></h4>
-<div class="outline-text-4" id="text-1.3.1">
-
-<p></p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.3.1.1" class="outline-5">
-<h5 id="sec-1.3.1.1"><span class="section-number-5">1.3.1.1</span> Usage</h5>
-<div class="outline-text-5" id="text-1.3.1.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-(do-own-symbols (VAR PKG)
-   ...body...)
-</pre>
-
-<p></p></div>
-
-</div>
-
-<div id="outline-container-1.3.1.2" class="outline-5">
-<h5 id="sec-1.3.1.2"><span class="section-number-5">1.3.1.2</span> Arguments</h5>
-<div class="outline-text-5" id="text-1.3.1.2">
-
-<p></p>
-<p>
-</p><dl>
-<dt>VAR</dt><dd>
-symbol naming a variable that will be bound to each symbol in turn.
-</dd>
-<dt>PKG</dt><dd>
-a package.
-</dd>
-</dl>
-</div>
-
-</div>
-
-<div id="outline-container-1.3.1.3" class="outline-5">
-<h5 id="sec-1.3.1.3"><span class="section-number-5">1.3.1.3</span> Description</h5>
-<div class="outline-text-5" id="text-1.3.1.3">
-
-<p></p>
-<p>
-Iterate through all the non-imported symbols in the package <code>PKG</code>.
-<code>BODY</code> is executed once for each such symbol, with <code>VAR</code> bound to each
-symbol in turn.
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="write-indented" id="write-indented"></a>
-<a name="macro==write-indented" id="macro==write-indented"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.3.2" class="outline-4">
-<h4 id="sec-1.3.2"><span class="section-number-4">1.3.2</span> Internal Macro: <code>write-indented</code></h4>
-<div class="outline-text-4" id="text-1.3.2">
-
-<p></p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.3.2.1" class="outline-5">
-<h5 id="sec-1.3.2.1"><span class="section-number-5">1.3.2.1</span> Usage</h5>
-<div class="outline-text-5" id="text-1.3.2.1">
-
-<p></p>
-<p>
-</p><pre class="example">
-(write-indented (INDENT)
-   ...body...)
-</pre>
-
-<p></p></div>
-
-</div>
-
-<div id="outline-container-1.3.2.2" class="outline-5">
-<h5 id="sec-1.3.2.2"><span class="section-number-5">1.3.2.2</span> Arguments</h5>
-<div class="outline-text-5" id="text-1.3.2.2">
-
-<p></p>
-<p>
-</p><dl>
-<dt>INDENT</dt><dd>
-An integer.
-</dd>
-</dl>
-</div>
-
-</div>
-
-<div id="outline-container-1.3.2.3" class="outline-5">
-<h5 id="sec-1.3.2.3"><span class="section-number-5">1.3.2.3</span> Return Value</h5>
-<div class="outline-text-5" id="text-1.3.2.3">
-
-<p></p>
-<p>
-Ignored.
-</p></div>
-
-</div>
-
-<div id="outline-container-1.3.2.4" class="outline-5">
-<h5 id="sec-1.3.2.4"><span class="section-number-5">1.3.2.4</span> Description</h5>
-<div class="outline-text-5" id="text-1.3.2.4">
-
-<p></p>
-<p>
-All text that is written within the body of the form will be indented
-a further <code>INDENT</code> spaces from the left margin.
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="writing-bulleted-list" id="writing-bulleted-list"></a>
-<a name="macro==writing-bulleted-list" id="macro==writing-bulleted-list"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.3.3" class="outline-4">
-<h4 id="sec-1.3.3"><span class="section-number-4">1.3.3</span> Internal Macro: <code>writing-bulleted-list</code></h4>
-<div class="outline-text-4" id="text-1.3.3">
-
-<p></p>
-<p>
-Not documented.
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="writing-section" id="writing-section"></a>
-<a name="macro==writing-section" id="macro==writing-section"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.3.4" class="outline-4">
-<h4 id="sec-1.3.4"><span class="section-number-4">1.3.4</span> Internal Macro: <code>writing-section</code></h4>
-<div class="outline-text-4" id="text-1.3.4">
-
-<p></p>
-<p>
-Not documented.
-</p>
-<p>
-</p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="writing-section-for-symbol" id="writing-section-for-symbol"></a>
-<a name="macro==writing-section-for-symbol" id="macro==writing-section-for-symbol"></a>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.3.5" class="outline-4">
-<h4 id="sec-1.3.5"><span class="section-number-4">1.3.5</span> Internal Macro: <code>writing-section-for-symbol</code></h4>
-<div class="outline-text-4" id="text-1.3.5">
-
-<p></p>
-<p>
-Not documented.
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-</p>
-<p>
-</p></div>
-</div>
-
-</div>
-
-<div id="outline-container-1.4" class="outline-3">
-<h3 id="sec-1.4"><span class="section-number-3">1.4</span> Functions</h3>
-<div class="outline-text-3" id="text-1.4">
-
-<p></p>
-<p>
-
-</p>
-<hr/>
-<p>
-<a name="docpkg" id="docpkg"></a>
-<a name="function==docpkg" id="function==docpkg"></a>
-</p>
-<p>
-</p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.4.1" class="outline-4">
-<h4 id="sec-1.4.1"><span class="section-number-4">1.4.1</span> Internal Function: <code>docpkg</code></h4>
-<div class="outline-text-4" id="text-1.4.1">
-
-<p></p>
-<p>
-Not documented.
-</p>
-<p>
-</p>
-<p>
-
-</p>
+
+
 <hr/>
 <p>
 <a name="document-package" id="document-package"></a>
 <a name="function==document-package" id="function==document-package"></a>
 </p>
-<p>
-</p>
-<p>
-</p></div>
-
-</div>
-
-<div id="outline-container-1.4.2" class="outline-4">
-<h4 id="sec-1.4.2"><span class="section-number-4">1.4.2</span> External Function: <code>document-package</code></h4>
-<div class="outline-text-4" id="text-1.4.2">
-
-<p></p>
-<p>
-</p>
-</div>
-
-<div id="outline-container-1.4.2.1" class="outline-5">
-<h5 id="sec-1.4.2.1"><span class="section-number-5">1.4.2.1</span> Usage</h5>
-<div class="outline-text-5" id="text-1.4.2.1">
-
-<p></p>
-<p>
-</p><pre class="example">
+
+
+</div>
+
+<div id="outline-container-1.1.1.1" class="outline-5">
+<h5 id="sec-1.1.1.1"><span class="section-number-5">1.1.1.1</span> External Function: <code>document-package</code></h5>
+<div class="outline-text-5" id="text-1.1.1.1">
+
+
+
+</div>
+
+<div id="outline-container-1.1.1.1.1" class="outline-6">
+<h6 id="sec-1.1.1.1.1"><span class="section-number-6">1.1.1.1.1</span> Usage</h6>
+<div class="outline-text-6" id="text-1.1.1.1.1">
+
+
+<pre class="example">
 (document-package PKG FILE/STREAM &amp;key AUTO-LINKS
      LINES-BETWEEN-SECTIONS BRIEF-METHODS CLASS-DIAGRAM
      TITLE AUTHOR EMAIL)
 </pre>
 
-<p></p></div>
-
-</div>
-
-<div id="outline-container-1.4.2.2" class="outline-5">
-<h5 id="sec-1.4.2.2"><span class="section-number-5">1.4.2.2</span> Arguments</h5>
-<div class="outline-text-5" id="text-1.4.2.2">
-
-<p></p>
-<p>
-</p><dl>
+</div>
+
+</div>
+
+<div id="outline-container-1.1.1.1.2" class="outline-6">
+<h6 id="sec-1.1.1.1.2"><span class="section-number-6">1.1.1.1.2</span> Arguments</h6>
+<div class="outline-text-6" id="text-1.1.1.1.2">
+
+
+<dl>
 <dt>PKG</dt><dd>
 A package name or package object.
 </dd>
 
 </div>
 
-<div id="outline-container-1.4.2.3" class="outline-5">
-<h5 id="sec-1.4.2.3"><span class="section-number-5">1.4.2.3</span> Returns</h5>
-<div class="outline-text-5" id="text-1.4.2.3">
-
-<p></p>
+<div id="outline-container-1.1.1.1.3" class="outline-6">
+<h6 id="sec-1.1.1.1.3"><span class="section-number-6">1.1.1.1.3</span> Returns</h6>
+<div class="outline-text-6" id="text-1.1.1.1.3">
+
+
 <p>
 A string, or nil.
 </p></div>
 
 </div>
 
-<div id="outline-container-1.4.2.4" class="outline-5">
-<h5 id="sec-1.4.2.4"><span class="section-number-5">1.4.2.4</span> Description</h5>
-<div class="outline-text-5" id="text-1.4.2.4">
-
-<p></p>
+<div id="outline-container-1.1.1.1.4" class="outline-6">
+<h6 id="sec-1.1.1.1.4"><span class="section-number-6">1.1.1.1.4</span> Description</h6>
+<div class="outline-text-6" id="text-1.1.1.1.4">
+
+
 <p>
 Produce documentation for the package <code>PKG</code>.
 </p>
 <code>NIL</code>: documentation is written to a string, which is then returned by
 this function.
 
-<p>
-</p></li>
+</li>
 </ul>
 
 <p>Explanation of optional arguments:
 description, containing a description of the package hierarchy
 in the form of a GraphViz 'dot' diagram (see <a href="http://www.graphviz.org/">http://www.graphviz.org/</a>).
 
-<p>
-</p></li>
+</li>
 </ul>
 </div>
 
 </div>
 
-<div id="outline-container-1.4.2.5" class="outline-5">
-<h5 id="sec-1.4.2.5"><span class="section-number-5">1.4.2.5</span> See also</h5>
-<div class="outline-text-5" id="text-1.4.2.5">
-
-<p></p>
-<p>
-</p><ul>
+<div id="outline-container-1.1.1.1.5" class="outline-6">
+<h6 id="sec-1.1.1.1.5"><span class="section-number-6">1.1.1.1.5</span> See also</h6>
+<div class="outline-text-6" id="text-1.1.1.1.5">
+
+
+<ul>
 <li>
 <a href="#document-packages">document-packages</a>
 
+
+</li>
+</ul>
+
+
+<hr/>
 <p>
+<a name="document-packages" id="document-packages"></a>
+<a name="function==document-packages" id="function==document-packages"></a>
+</p>
+
+</div>
+</div>
+
+</div>
+
+<div id="outline-container-1.1.1.2" class="outline-5">
+<h5 id="sec-1.1.1.2"><span class="section-number-5">1.1.1.2</span> External Function: <code>document-packages</code></h5>
+<div class="outline-text-5" id="text-1.1.1.2">
+
+
+
+</div>
+
+<div id="outline-container-1.1.1.2.1" class="outline-6">
+<h6 id="sec-1.1.1.2.1"><span class="section-number-6">1.1.1.2.1</span> Usage</h6>
+<div class="outline-text-6" id="text-1.1.1.2.1">
+
+
+<pre class="example">
+(document-packages PACKAGES FILE/STREAM &amp;key AUTO-LINKS
+     LINES-BETWEEN-SECTIONS BRIEF-METHODS TITLE
+     AUTHOR EMAIL)
+</pre>
+
+</div>
+
+</div>
+
+<div id="outline-container-1.1.1.2.2" class="outline-6">
+<h6 id="sec-1.1.1.2.2"><span class="section-number-6">1.1.1.2.2</span> Arguments</h6>
+<div class="outline-text-6" id="text-1.1.1.2.2">
+
+
+<dl>
+<dt>PACKAGES</dt><dd>
+A list of package objects, or symbols naming packages.
+</dd>
+<dt>FILE/STREAM</dt><dd>
+A string (filename), stream object, or <code>NIL</code>.
+</dd>
+</dl>
+</div>
+
+</div>
+
+<div id="outline-container-1.1.1.2.3" class="outline-6">
+<h6 id="sec-1.1.1.2.3"><span class="section-number-6">1.1.1.2.3</span> Returns</h6>
+<div class="outline-text-6" id="text-1.1.1.2.3">
+
+
+<p>
+A string, or nil.
+</p></div>
+
+</div>
+
+<div id="outline-container-1.1.1.2.4" class="outline-6">
+<h6 id="sec-1.1.1.2.4"><span class="section-number-6">1.1.1.2.4</span> Description</h6>
+<div class="outline-text-6" id="text-1.1.1.2.4">
+
+
+<p>
+Produces documentation for all the packages in <code>PACKAGES</code>, within a
+single file.
+See <a href="#document-package">document-package</a> for more details.
+</p>
+
+
+
+
+</div>
+</div>
+</div>
+</div>
+
+</div>
+
+<div id="outline-container-1.2" class="outline-3">
+<h3 id="sec-1.2"><span class="section-number-3">1.2</span> Internal Symbols</h3>
+<div class="outline-text-3" id="text-1.2">
+
+
+
+
+
+
+</div>
+
+<div id="outline-container-1.2.1" class="outline-4">
+<h4 id="sec-1.2.1"><span class="section-number-4">1.2.1</span> Internal Types</h4>
+<div class="outline-text-4" id="text-1.2.1">
+
+
+
+<hr/>
+<p>
+<a name="..3d..entity..3d.." id="..3d..entity..3d.."></a>
+<a name="type==..3d..entity..3d.." id="type==..3d..entity..3d.."></a>
+</p>
+
+
+</div>
+
+<div id="outline-container-1.2.1.1" class="outline-5">
+<h5 id="sec-1.2.1.1"><span class="section-number-5">1.2.1.1</span> Internal Type: ==entity==</h5>
+<div class="outline-text-5" id="text-1.2.1.1">
+
+
+<p>
+The type 'entity' can have any of several different symbols as its value.
+Each value is a different kind of 'meaning' which a symbol can have within
+a package. For example, <code>:function</code> is a function, <code>:class</code> is a class,
+and so on.
+</p>
+
+
+
+</div>
+</div>
+
+</div>
+
+<div id="outline-container-1.2.2" class="outline-4">
+<h4 id="sec-1.2.2"><span class="section-number-4">1.2.2</span> Internal Global Variables</h4>
+<div class="outline-text-4" id="text-1.2.2">
+
+
+
+<hr/>
+<p>
+<a name="<b>alphabet</b>" id="<b>alphabet</b>"></a>
+<a name="variable==*alphabet*" id="variable==*alphabet*"></a>
+</p>
+
+
+</div>
+
+<div id="outline-container-1.2.2.1" class="outline-5">
+<h5 id="sec-1.2.2.1"><span class="section-number-5">1.2.2.1</span> Internal Variable: <code>*alphabet*</code></h5>
+<div class="outline-text-5" id="text-1.2.2.1">
+
+
+
+
+</div>
+
+<div id="outline-container-1.2.2.1.1" class="outline-6">
+<h6 id="sec-1.2.2.1.1"><span class="section-number-6">1.2.2.1.1</span> Value</h6>
+<div class="outline-text-6" id="text-1.2.2.1.1">
+
+
+<pre class="example">
+(#\A #\B #\C #\D #\E #\F #\G #\H #\I #\J #\K #\L #\M #\N #\O #\P #\Q #\R #\S
+#\T #\U #\V #\W #\X #\Y #\Z)
+</pre>
+
+
+<p>
+Type: <code>cons</code>
+</p>
+
+</div>
+
+</div>
+
+<div id="outline-container-1.2.2.1.2" class="outline-6">
+<h6 id="sec-1.2.2.1.2"><span class="section-number-6">1.2.2.1.2</span> Description</h6>
+<div class="outline-text-6" id="text-1.2.2.1.2">
+
+