This is the cl-html-readme Reference Manual, version 3.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 11:51:16 2026 GMT+0.
cl-html-readme/cl-html-readme.asdcl-html-readme/src/packages.lispcl-html-readme/src/plist-util.lispcl-html-readme/src/validation.lispcl-html-readme/src/base-dsl.lispcl-html-readme/src/target-dsl.lispcl-html-readme/src/dsl.lispcl-html-readme/src/dsl-compiler.lispcl-html-readme/src/readme-util.lispcl-html-readme/src/html-writer.lispThe 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.
3.0.0
src (module).
Modules are listed depth-first from the system components tree.
cl-html-readme/srccl-html-readme (system).
packages.lisp (file).
plist-util.lisp (file).
validation.lisp (file).
base-dsl.lisp (file).
target-dsl.lisp (file).
dsl.lisp (file).
dsl-compiler.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/plist-util.lispcl-html-readme/src/validation.lispcl-html-readme/src/base-dsl.lispcl-html-readme/src/target-dsl.lispcl-html-readme/src/dsl.lispcl-html-readme/src/dsl-compiler.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/plist-util.lisppackages.lisp (file).
src (module).
filter-properties (function).
sort-by-key (function).
unique (function).
with-properties (function).
cl-html-readme/src/validation.lispplist-util.lisp (file).
src (module).
initialize-instance (method).
property-list-validator (class).
reject (generic function).
validate (generic function).
validator (class).
cl-html-readme/src/base-dsl.lispvalidation.lisp (file).
src (module).
add-text (generic function).
close-form (generic function).
dsl (class).
get-special-form-validator (generic function).
initialize-instance (method).
instance (function).
make-builder (generic function).
open-form (generic function).
property-list-validator (class).
reject (method).
syntax-error (condition).
to-tree (generic function).
tree-builder (class).
unbalanced-tree-error (condition).
validate (method).
walk (generic function).
*default-property-validator* (special variable).
*dsl* (special variable).
default-property-validator (class).
default-tree-builder (class).
dsl-form-node (class).
dsl-text-node (class).
pop-stack (function).
push-content (function).
push-stack (function).
signal-fatal-error (function).
validate-special-form (function).
validate-text (function).
cl-html-readme/src/target-dsl.lispbase-dsl.lisp (file).
src (module).
get-special-form-validator (method).
instance (function).
*dsl* (special variable).
*heading-validator* (special variable).
*semantic-validator* (special variable).
*toc-container-validator* (special variable).
*toc-item-validator* (special variable).
*toc-root-validator* (special variable).
dsl (class).
cl-html-readme/src/dsl.lisptarget-dsl.lisp (file).
src (module).
get-special-form-validator (method).
instance (function).
*dsl* (special variable).
*heading-validator* (special variable).
*semantic-validator* (special variable).
*toc-validator* (special variable).
dsl (class).
cl-html-readme/src/dsl-compiler.lispdsl.lisp (file).
src (module).
compile-documentation (function).
clean-headings (function).
expand-toc (function).
get-toc-headings (function).
set-heading-ids (function).
set-heading-indentation-levels (function).
write-toc (function).
cl-html-readme/src/readme-util.lispdsl-compiler.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).
format-string-impl (function).
cl-html-readme/src/html-writer.lispreadme-util.lisp (file).
src (module).
*get-heading-attributes* (special variable).
*get-semantic-attributes* (special variable).
*get-toc-container-attributes* (special variable).
*get-toc-item-attributes* (special variable).
*get-toc-root-attributes* (special variable).
doc-to-html (function).
*print-newline* (special variable).
add-attribute (generic function).
add-custom-attributes (function).
attribute-renderer (class).
render-attributes (generic function).
serialize (function).
Packages are listed by definition order.
cl-html-readme-validationcl-html-readmecl-html-readme-dslcl-html-readme-base-dslcl-html-readme-plist-utilcl-html-readme-dsl-compilercl-html-readme-target-dslcl-html-readme-validationcommon-lisp.
property-list-validator (class).
reject (generic function).
validate (generic function).
validator (class).
cl-html-readmecommon-lisp.
*get-heading-attributes* (special variable).
*get-semantic-attributes* (special variable).
*get-toc-container-attributes* (special variable).
*get-toc-item-attributes* (special variable).
*get-toc-root-attributes* (special variable).
*home-directory* (special variable).
*tab-width* (special variable).
doc-to-html (function).
make-path (function).
read-file (function).
read-stream (function).
read-string (function).
*print-newline* (special variable).
add-attribute (generic function).
add-custom-attributes (function).
attribute-renderer (class).
format-string (function).
format-string-impl (function).
render-attributes (generic function).
serialize (function).
cl-html-readme-dslcommon-lisp.
instance (function).
*dsl* (special variable).
*heading-validator* (special variable).
*semantic-validator* (special variable).
*toc-validator* (special variable).
dsl (class).
cl-html-readme-base-dslcommon-lisp.
add-text (generic function).
close-form (generic function).
dsl (class).
get-special-form-validator (generic function).
instance (function).
make-builder (generic function).
open-form (generic function).
property-list-validator (class).
syntax-error (condition).
to-tree (generic function).
tree-builder (class).
unbalanced-tree-error (condition).
walk (generic function).
*default-property-validator* (special variable).
*dsl* (special variable).
default-property-validator (class).
default-tree-builder (class).
dsl-form-node (class).
dsl-text-node (class).
pop-stack (function).
push-content (function).
push-stack (function).
signal-fatal-error (function).
validate-special-form (function).
validate-text (function).
cl-html-readme-plist-utilcommon-lisp.
filter-properties (function).
sort-by-key (function).
unique (function).
with-properties (function).
cl-html-readme-dsl-compilercommon-lisp.
compile-documentation (function).
clean-headings (function).
expand-toc (function).
get-toc-headings (function).
set-heading-ids (function).
set-heading-indentation-levels (function).
write-toc (function).
cl-html-readme-target-dslcommon-lisp.
instance (function).
*dsl* (special variable).
*heading-validator* (special variable).
*semantic-validator* (special variable).
*toc-container-validator* (special variable).
*toc-item-validator* (special variable).
*toc-root-validator* (special variable).
dsl (class).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Get the attributes of a heading form. A heading is rendered as a <code>"<h1>"</code> ... <code>"<h6>" </code> HTML element. The hook is called with the properties of the DSL <code>heading</code> form.
Get the attributes of a semantic form. A semantic form is rendered as a <code>"<${properties.name}>"</code> HTML element. The hook is called with the properties of the DSL <code>semantic</code> form.
Get the HTML attributes of a TOC container form. Such forms are created during the TOC expansion. A container is an entry of the TOC that has sub-entries. Containers are rendered as <code>"<ul>"</code> HTML elements. The hook is called with the properties of the DSL <code>toc</code> form.
Get the attributes of a TOC item form. Such forms are created during the TOC expansion. Each entry of the TOC is represented by an item. Items are rendered as <code>"<li>"</code> HTML elements. The hook is called with the properties of the DSL <code>toc</code> form.
Get the attributes of the TOC root form. This form is created during the TOC expansion. The TOC root is rendered as a <code>"<ul>"</code> HTML element. The hook is called with the properties of the DSL <code>toc</code> form.
Home directory of the project for which documentation is to be generated.
The width of a tab.
Compile a documentation object that follows the syntax of the DSL to the target DSL represention. The target representation is passed to the HTML rendering backend.
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 cl-html-readme-dsl::dsl.</li>
</ul>
Filter entries of a property list.
filter-fn: A function that is called with a property keyword. If the function returns nil
then the property will be omitted from the resulting property list.
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>
Stable sort of a property list by its keys. Ascending (A...Z). Key comparison via lowercase symbol-name.
Remove duplicate keys. First occurence of a key wins.
Iterate over properties and call handler with key and value.
Add a plain string.
default-tree-builder) text) ¶Close a DSL special form.
default-tree-builder)) ¶Returns an instance of cl-html-readme-validation:property-validator or
nil of the form-symbol is not supported by the DSL. The function has the
following parameters:
<ul><li>form-symbol A symbol</li></ul>
Creates an instance of a validating tree-builder
Open a DSL special form.
default-tree-builder) form-symbol form-properties) ¶Error handler
property-list-validator) format-control format-arguments) ¶Get the resulting tree.
default-tree-builder)) ¶Generate resulting tree
Validate properties
default-property-validator) object) ¶property-list-validator) property-list) ¶Validating traversal of a documentation object. The function has the following parameters:
<ul>
<li>open-form-handler: A function that is called when a DSL special form is opened. Can be nil.
<code>(lambda (form-symbol form-properties content))</code>
Returns a context that is passed to close-form-handler.</li>
<li>close-form-handler: A function that is called when a previously opened DSL special
form is closed. Can be nil. <code>(lambda (context))</code></li>
<li>text-handler: A function that is called for plain string occurences outside of
DSL special form properties. Can be nil. <code>(lambda (text))</code></li>
</ul>
property-list-validator) &key) ¶default-tree-builder) &rest init-args) ¶Signalled when a documentation object does not conform to the DSL specification, e.g. undefined DSL special forms, missing mandatory DSL special form properties, unsupported DSL special form properties.
simple-error.
Signalled when a documentation object to be programmatically build has opened a DSL special form but not closed it or a DSL special form is being closed but has not been opened.
simple-error.
The base DSL
Property validator
Validator interface
Name of the validator
:name
Private helper hook for unit tests to get more predictable HTML output.
<p>Helper function to cleanup heading properties</p>
<ul>
<li>Remove ids of heading forms that are not marked as toc relevant<li>
<li>Remove toc indicator from all headings</li>
</ul>
Replace toc form with toc-root. Returns a new documentation object.
Returns a documentation object representing the toc heading tree
Render documentation object that follows cl-html-readme-target-dsl.
Helper function which assigns an id to all heading elements. Returns a new documentation object.
Set indentation levels of heading forms. Returns a new documentation object.
Check if the given form-symbol is a symbol and that the form-properties
are a list. If these conditions are met then get and invoke
a property validator.
Validate if the given text node is a string
Extracts toc and writes toc-root, toc-container, toc-item forms into the builder.
The function has the following parameters:
<ul>
<li>doc An object following cl-html-readme-base-dsl:instance</li>
<li>toc-properties The properties of the toc-form</li>
<li>tree-builder An instance of cl-html-readme-base-dsl:tree-builder into which
the resulting document is written</li>
</ul>
attribute-renderer) indicator value) ¶attribute-renderer) &key prepend-space) ¶A property list
A validator that does not apply any checks.
An implementation of the tree-builder class.
| Jump to: | A C D E F G I M O P R S T U V W |
|---|
| Jump to: | A C D E F G I M O P R S T U V W |
|---|
| Jump to: | *
A C D F M N O P R S T |
|---|
| Jump to: | *
A C D F M N O P R S T |
|---|
| Jump to: | A B C D F H M P R S T U V |
|---|
| Jump to: | A B C D F H M P R S T U V |
|---|