This is the cl-html-readme Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:45:58 2022 GMT+0.
Next: Modules, Previous: The cl-html-readme Reference Manual, Up: The cl-html-readme Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
A 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).
Next: Files, Previous: Systems, Up: The cl-html-readme Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
cl-html-readme (system).
Next: Packages, Previous: Modules, Up: The cl-html-readme Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-html-readme/src/packages.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-html-readme (system).
Next: cl-html-readme/src/dsl.lisp, Previous: cl-html-readme/cl-html-readme.asd, Up: Lisp [Contents][Index]
src (module).
Next: cl-html-readme/src/readme-util.lisp, Previous: cl-html-readme/src/packages.lisp, Up: Lisp [Contents][Index]
packages.lisp (file).
src (module).
Next: cl-html-readme/src/html-writer.lisp, Previous: cl-html-readme/src/dsl.lisp, Up: Lisp [Contents][Index]
dsl.lisp (file).
src (module).
format-string (function).
Previous: cl-html-readme/src/readme-util.lisp, Up: Lisp [Contents][Index]
readme-util.lisp (file).
src (module).
doc-to-html (function).
Next: Definitions, Previous: Files, Up: The cl-html-readme Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: cl-html-readme-dsl, Previous: Packages, Up: Packages [Contents][Index]
common-lisp.
Previous: cl-html-readme, Up: Packages [Contents][Index]
common-lisp.
Next: Indexes, Previous: Packages, Up: The cl-html-readme Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
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.
Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]
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>
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Generate resulting tree
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]
simple-error.
Previous: Conditions, Up: Public Interface [Contents][Index]
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]
Next: Classes, Previous: Special variables, Up: Internals [Contents][Index]
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.
Previous: Ordinary functions, Up: Internals [Contents][Index]
Previous: Definitions, Up: The cl-html-readme Reference Manual [Contents][Index]
| 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 |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| 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 |
|---|