This is the cl-html-readme Reference Manual, version 2.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:01:30 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.
2.0.0
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).
initialize-instance (method).
*dsl-elements* (special variable).
add-text (generic function).
close-element (generic function).
dsl-element-node (class).
dsl-syntax-error (condition).
dsl-text-node (class).
dsl-tree-builder-error (condition).
expand-toc (function).
filter-property-list-entries (function).
get-dsl-element (function).
get-property-list-keys (function).
get-toc-headings (function).
get-tree (generic function).
heading-p (function).
make-tree-builder (function).
open-element (generic function).
pop-stack (function).
push-content (function).
push-stack (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).
tree-builder-v1 (class).
validate (function).
validate-element (function).
validate-text (function).
walk-tree (function).
write-toc (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).
read-stream (function).
read-string (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).
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).
read-stream (function).
read-string (function).
format-string (function).
serialize (function).
set-heading-ids (function).
set-heading-indentation-levels (function).
cl-html-readme-dslcommon-lisp.
*dsl-elements* (special variable).
add-text (generic function).
close-element (generic function).
dsl-element-node (class).
dsl-syntax-error (condition).
dsl-text-node (class).
dsl-tree-builder-error (condition).
expand-toc (function).
filter-property-list-entries (function).
get-dsl-element (function).
get-property-list-keys (function).
get-toc-headings (function).
get-tree (generic function).
heading-p (function).
make-tree-builder (function).
open-element (generic function).
pop-stack (function).
push-content (function).
push-stack (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).
tree-builder-v1 (class).
validate (function).
validate-element (function).
validate-text (function).
walk-tree (function).
write-toc (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.
The width of a tab.
Renders a documentation object to HTML. The function has the following parameters:
<ul>
<li>output-stream nil or a stream into which the resulting HTML is written.</li>
<li>documentation A documentation object following the syntax of the DSL.</li>
</ul>
Creates an absolute path. The function has the following parameters:
<ul>
<li>path A path relative to *home-directory*, e.g. <code>"examples/example-1.lisp"</code>. 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>
Reads a text stream and returns it as a string. The function has the following parameters:
<ul>
<li>stream An input stream.</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>
Parses a multiline string and returns it as a string. The function has the following parameters:
<ul>
<li>string A string.</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>
tree-builder-v1) &rest init-args) ¶Replace toc element with toc-root. Returns a new documentation object.
Filter entries of a property list
Get the keys of a property list
Returns a documentation object representing the toc heading tree
Assign ids to toc-headings. Returns a new documentation object.
Set indentation levels of heading elements. Returns a new documentation object.
Validate a documentation object
DSL tree traversal. The function assumes that the documentation object conforms to
the syntax of the DSL. No validation is applied. 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>
Extracts toc and writes toc-root, toc-container, toc-item elements into the builder. - toc-properties: The properties of the corresponding toc-form
tree-builder-v1) text) ¶tree-builder-v1)) ¶tree-builder-v1)) ¶Generate resulting tree
tree-builder-v1) element-symbol element-properties) ¶simple-error.
simple-error.
| 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 |
|---|