This is the cl-html-readme Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:19:29 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-html-readmeA HTML Documentation Generator for Common Lisp projects.
Oliver <frechmatz@gmx.de>
Oliver <frechmatz@gmx.de>
MIT
A HTML Documentation Generator for Common Lisp projects.
1.0.1
src (module).
Modules are listed depth-first from the system components tree.
cl-html-readme/srccl-html-readme (system).
packages.lisp (file).
dsl.lisp (file).
readme-util.lisp (file).
html-writer.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-html-readme/cl-html-readme.asdcl-html-readme/src/packages.lispcl-html-readme/src/dsl.lispcl-html-readme/src/readme-util.lispcl-html-readme/src/html-writer.lispcl-html-readme/cl-html-readme.asdcl-html-readme (system).
cl-html-readme/src/dsl.lisppackages.lisp (file).
src (module).
add-text (generic function).
close-element (generic function).
dsl-syntax-error (condition).
extract-toc (function).
get-tree (generic function).
heading-p (function).
initialize-instance (method).
open-element (generic function).
semantic-p (function).
toc-container-p (function).
toc-heading-p (function).
toc-item-p (function).
toc-p (function).
toc-root-p (function).
tree-builder (class).
walk-tree (function).
*dsl-elements* (special variable).
dsl-element-node (class).
dsl-text-node (class).
get-dsl-element (function).
pop-stack (function).
push-content (function).
push-stack (function).
validate-properties (function).
cl-html-readme/src/readme-util.lispdsl.lisp (file).
src (module).
*home-directory* (special variable).
*tab-width* (special variable).
make-path (function).
read-file (function).
format-string (function).
cl-html-readme/src/html-writer.lispreadme-util.lisp (file).
src (module).
doc-to-html (function).
serialize (function).
set-heading-ids (function).
set-heading-indentation-levels (function).
set-toc (function).
Packages are listed by definition order.
cl-html-readmecommon-lisp.
*home-directory* (special variable).
*tab-width* (special variable).
doc-to-html (function).
make-path (function).
read-file (function).
format-string (function).
serialize (function).
set-heading-ids (function).
set-heading-indentation-levels (function).
set-toc (function).
cl-html-readme-dslcommon-lisp.
add-text (generic function).
close-element (generic function).
dsl-syntax-error (condition).
extract-toc (function).
get-tree (generic function).
heading-p (function).
open-element (generic function).
semantic-p (function).
toc-container-p (function).
toc-heading-p (function).
toc-item-p (function).
toc-p (function).
toc-root-p (function).
tree-builder (class).
walk-tree (function).
*dsl-elements* (special variable).
dsl-element-node (class).
dsl-text-node (class).
get-dsl-element (function).
pop-stack (function).
push-content (function).
push-stack (function).
validate-properties (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Home directory of the project for which documentation is to be generated.
Width of a tab. Used, when tabs are to be replaced with space characters.
Serializes a documentation object to HTML. The function has the following parameters:
<ul>
<li>output-stream A stream into which the resulting HTML is written.</li>
<li>documentation A list following the syntax of the DSL.</li>
</ul>
Extracts toc and pushes toc-root, toc-container, toc-item elements into the builder.
Creates an absolute path. The function has the following parameters:
<ul>
<li>path A path relative to *home-directory*, e.g. examples/example-1.lisp. A path can be represented as String or as Pathname.</li>
</ul>
Reads a text file and returns it as a string. The function has the following parameters:
<ul>
<li>path Path of the file relative to *home-directory*.</li>
<li>:replace-tabs If t then tabs are replaced with spaces according to the *tab-width* variable.</li>
<li>:escape If t then special characters are replaced with HTML character entities.</li>
</ul>
Walk a DSL tree. The function has the following arguments:
<ul>
<li>documentation An instance of <documentation>./li>
<li>:open-element A function that is called when a DSL element is opened.
<p>(lambda(element-symbol element-properties content))</p>
Returns a context that is passed to :close-element.</li>
<li>:close-element A function that is called when a previously opened DSL element closes.
<p>(lambda(context)) Context value as returned by open-element.</p></li>
<li>:text A function that is called for each text node.
<p>(lambda(str))</p></li>
</ul>
tree-builder) text) ¶tree-builder)) ¶tree-builder)) ¶Generate resulting tree
tree-builder) element-symbol element-properties) ¶tree-builder) &rest init-args) ¶Assign ids to toc-headings. Returns a new documentation tree.
Set indentation levels of heading elements. Returns a new documentation tree.
Replace toc element with toc-root. Returns a new documentation tree.
| Jump to: | A C D E F G H I M O P R S T V W |
|---|
| Jump to: | A C D E F G H I M O P R S T V W |
|---|
| Jump to: | *
C E N R S T |
|---|
| Jump to: | *
C E N R S T |
|---|
| Jump to: | C D F H M P R S T |
|---|
| Jump to: | C D F H M P R S T |
|---|