The cl-html-readme Reference Manual

Table of Contents

The cl-html-readme Reference Manual

This is the cl-html-readme Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:23:40 2020 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 cl-html-readme

Maintainer

Oliver <frechmatz@gmx.de>

Author

Oliver <frechmatz@gmx.de>

Home Page

https://github.com/Frechmatz/cl-html-readme

License

MIT

Description

A HTML Documentation Generator for Common Lisp projects.

Long Description

A HTML Documentation Generator for Common Lisp projects.

Version

1.0.0

Source

cl-html-readme.asd (file)

Component

src (module)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 cl-html-readme/src

Parent

cl-html-readme (system)

Location

src/

Components

• packages.lisp (file)
• dsl.lisp (file)
• readme-util.lisp (file)
• html-writer.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-html-readme.asd

Location

cl-html-readme.asd

Systems

cl-html-readme (system)

3.1.2 cl-html-readme/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

• cl-html-readme-dsl
• cl-html-readme

3.1.3 cl-html-readme/src/dsl.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/dsl.lisp

Exported Definitions

• add-text (generic function)
• add-text (method)
• close-element (generic function)
• close-element (method)
• dsl-syntax-error (condition)
• extract-toc (function)
• get-tree (generic function)
• get-tree (method)
• heading-p (function)
• open-element (generic function)
• open-element (method)
• 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)

Internal Definitions

• *dsl-elements* (special variable)
• dsl-element-node (class)
• dsl-syntax-error-message (method)
• dsl-text-node (class)
• get-dsl-element (function)
• pop-stack (function)
• push-content (function)
• push-stack (function)
• validate-properties (function)

3.1.4 cl-html-readme/src/readme-util.lisp

Dependency

dsl.lisp (file)

Parent

src (module)

Location

src/readme-util.lisp

Exported Definitions

• *home-directory* (special variable)
• *tab-width* (special variable)
• make-path (function)
• read-file (function)

Internal Definitions

format-string (function)

3.1.5 cl-html-readme/src/html-writer.lisp

Dependency

readme-util.lisp (file)

Parent

src (module)

Location

src/html-writer.lisp

Exported Definitions

doc-to-html (function)

Internal Definitions

• serialize (function)
• set-heading-ids (function)
• set-heading-indentation-levels (function)
• set-toc (function)

4 Packages

Packages are listed by definition order.

4.1 cl-html-readme-dsl

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• add-text (generic function)
• add-text (method)
• close-element (generic function)
• close-element (method)
• dsl-syntax-error (condition)
• extract-toc (function)
• get-tree (generic function)
• get-tree (method)
• heading-p (function)
• open-element (generic function)
• open-element (method)
• 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)

Internal Definitions

• *dsl-elements* (special variable)
• dsl-element-node (class)
• dsl-syntax-error-message (generic function)
• dsl-syntax-error-message (method)
• dsl-text-node (class)
• get-dsl-element (function)
• pop-stack (function)
• push-content (function)
• push-stack (function)
• validate-properties (function)

4.2 cl-html-readme

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• *home-directory* (special variable)
• *tab-width* (special variable)
• doc-to-html (function)
• make-path (function)
• read-file (function)

Internal Definitions

• format-string (function)
• serialize (function)
• set-heading-ids (function)
• set-heading-indentation-levels (function)
• set-toc (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *home-directory*

Home directory of the project for which documentation is to be generated.

Package

cl-html-readme

Source

readme-util.lisp (file)

Special Variable: *tab-width*

Width of a tab. Used, when tabs are to be replaced with space characters.

Package

cl-html-readme

Source

readme-util.lisp (file)

5.1.2 Functions

Function: doc-to-html OUTPUT-STREAM DOCUMENTATION

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>

Package

cl-html-readme

Source

html-writer.lisp (file)

Function: extract-toc DOC TREE-BUILDER

Extracts toc and pushes toc-root, toc-container, toc-item elements into the builder.

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: heading-p ELEMENT

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: make-path PATH

Creates a path relative to *home-directory*. The function has the following parameters: <ul>
<li>path The path, e.g. examples/example-1.lisp. A path can be represented as String or as Pathname.</li>
</ul>

Package

cl-html-readme

Source

readme-util.lisp (file)

Function: read-file PATH &key REPLACE-TABS ESCAPE

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>

Package

cl-html-readme

Source

readme-util.lisp (file)

Function: semantic-p ELEMENT

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: toc-container-p ELEMENT

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: toc-heading-p PROPERTIES

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: toc-item-p ELEMENT

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: toc-p ELEMENT

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: toc-root-p ELEMENT

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: walk-tree DOCUMENTATION &key OPEN-ELEMENT CLOSE-ELEMENT TEXT

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>

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

5.1.3 Generic functions

Generic Function: add-text TREE-BUILDER TEXT

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Methods

Method: add-text (INSTANCE tree-builder) TEXT

Generic Function: close-element TREE-BUILDER

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Methods

Method: close-element (INSTANCE tree-builder)

Generic Function: get-tree TREE-BUILDER

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Methods

Method: get-tree (INSTANCE tree-builder)

Generate resulting tree

Generic Function: open-element TREE-BUILDER ELEMENT-SYMBOL ELEMENT-PROPERTIES

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Methods

Method: open-element (INSTANCE tree-builder) ELEMENT-SYMBOL ELEMENT-PROPERTIES

5.1.4 Conditions

Condition: dsl-syntax-error ()

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Direct superclasses

error (condition)

Direct methods

dsl-syntax-error-message (method)

Direct slots

Slot: message

Initargs

:message

Readers

dsl-syntax-error-message (generic function)

5.1.5 Classes

Class: tree-builder ()

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• get-tree (method)
• add-text (method)
• close-element (method)
• open-element (method)
• initialize-instance (method)

Direct slots

Slot: node-stack

Slot: root-node

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *dsl-elements*

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

5.2.2 Functions

Function: format-string STR &key REPLACE-TABS ESCAPE

Package

cl-html-readme

Source

readme-util.lisp (file)

Function: get-dsl-element ELEMENT

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: pop-stack TREE-BUILDER

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: push-content DSL-ELEMENT-NODE ITEM

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: push-stack TREE-BUILDER ITEM

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Function: serialize OUTPUT-STREAM DOC

Package

cl-html-readme

Source

html-writer.lisp (file)

Function: set-heading-ids DOC

Assign ids to toc-headings. Returns a new documentation tree.

Package

cl-html-readme

Source

html-writer.lisp (file)

Function: set-heading-indentation-levels DOC

Set indentation levels of heading elements. Returns a new documentation tree.

Package

cl-html-readme

Source

html-writer.lisp (file)

Function: set-toc DOC

Replace toc element with toc-root. Returns a new documentation tree.

Package

cl-html-readme

Source

html-writer.lisp (file)

Function: validate-properties ELEMENT PROPERTIES

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

5.2.3 Generic functions

Generic Function: dsl-syntax-error-message CONDITION

Package

cl-html-readme-dsl

Methods

Method: dsl-syntax-error-message (CONDITION dsl-syntax-error)

Source

dsl.lisp (file)

5.2.4 Classes

Class: dsl-element-node ()

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: element-symbol

Initargs

:element-symbol

Slot: element-properties

Initargs

:element-properties

Slot: content

Initform

(list)

Class: dsl-text-node ()

Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: text

Initargs

:text

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types