The cl-html-readme Reference Manual

This is the cl-html-readme Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:15:37 2022 GMT+0.

Table of Contents


1 Systems

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


1.1 cl-html-readme

A HTML Documentation Generator for Common Lisp projects.

Maintainer

Oliver <>

Author

Oliver <>

Home Page

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

License

MIT

Long Description

A HTML Documentation Generator for Common Lisp projects.

Version

1.0.1

Source

cl-html-readme.asd.

Child Component

src (module).


2 Modules

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


2.1 cl-html-readme/src

Source

cl-html-readme.asd.

Parent Component

cl-html-readme (system).

Child Components

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/cl-html-readme.asd

Source

cl-html-readme.asd.

Parent Component

cl-html-readme (system).

ASDF Systems

cl-html-readme.


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

Source

cl-html-readme.asd.

Parent Component

src (module).

Packages

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

Dependency

packages.lisp (file).

Source

cl-html-readme.asd.

Parent Component

src (module).

Public Interface
Internals

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

Dependency

dsl.lisp (file).

Source

cl-html-readme.asd.

Parent Component

src (module).

Public Interface
Internals

format-string (function).


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

Dependency

readme-util.lisp (file).

Source

cl-html-readme.asd.

Parent Component

src (module).

Public Interface

doc-to-html (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 cl-html-readme

Source

packages.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 cl-html-readme-dsl

Source

packages.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


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.

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.


5.1.2 Ordinary 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.

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.

Function: heading-p (element)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Function: make-path (path)

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>

Package

cl-html-readme.

Source

readme-util.lisp.

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.

Function: semantic-p (element)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Function: toc-container-p (element)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Function: toc-heading-p (properties)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Function: toc-item-p (element)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Function: toc-p (element)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Function: toc-root-p (element)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

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.


5.1.3 Generic functions

Generic Function: add-text (tree-builder text)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Methods
Method: add-text ((instance tree-builder) text)
Generic Function: close-element (tree-builder)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Methods
Method: close-element ((instance tree-builder))
Generic Function: get-tree (tree-builder)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

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.

Methods
Method: open-element ((instance tree-builder) element-symbol element-properties)

5.1.4 Standalone methods

Method: initialize-instance :after ((instance tree-builder) &rest init-args)
Source

dsl.lisp.


5.1.5 Conditions

Condition: dsl-syntax-error
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Direct superclasses

simple-error.


5.1.6 Classes

Class: tree-builder
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Direct methods
Direct slots
Slot: node-stack
Slot: root-node

5.2 Internals


5.2.1 Special variables

Special Variable: *dsl-elements*
Package

cl-html-readme-dsl.

Source

dsl.lisp.


5.2.2 Ordinary functions

Function: format-string (str &key replace-tabs escape)
Package

cl-html-readme.

Source

readme-util.lisp.

Function: get-dsl-element (element)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Function: pop-stack (tree-builder)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Function: push-content (dsl-element-node item)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Function: push-stack (tree-builder item)
Package

cl-html-readme-dsl.

Source

dsl.lisp.

Function: serialize (output-stream doc)
Package

cl-html-readme.

Source

html-writer.lisp.

Function: set-heading-ids (doc)

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

Package

cl-html-readme.

Source

html-writer.lisp.

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.

Function: set-toc (doc)

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

Package

cl-html-readme.

Source

html-writer.lisp.

Function: validate-properties (element properties)
Package

cl-html-readme-dsl.

Source

dsl.lisp.


5.2.3 Classes

Class: dsl-element-node
Package

cl-html-readme-dsl.

Source

dsl.lisp.

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.

Direct slots
Slot: text
Initargs

:text


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   D   E   F   G   H   I   M   O   P   R   S   T   V   W  
Index Entry  Section

A
add-text: Public generic functions
add-text: Public generic functions

C
close-element: Public generic functions
close-element: Public generic functions

D
doc-to-html: Public ordinary functions

E
extract-toc: Public ordinary functions

F
format-string: Private ordinary functions
Function, doc-to-html: Public ordinary functions
Function, extract-toc: Public ordinary functions
Function, format-string: Private ordinary functions
Function, get-dsl-element: Private ordinary functions
Function, heading-p: Public ordinary functions
Function, make-path: Public ordinary functions
Function, pop-stack: Private ordinary functions
Function, push-content: Private ordinary functions
Function, push-stack: Private ordinary functions
Function, read-file: Public ordinary functions
Function, semantic-p: Public ordinary functions
Function, serialize: Private ordinary functions
Function, set-heading-ids: Private ordinary functions
Function, set-heading-indentation-levels: Private ordinary functions
Function, set-toc: Private ordinary functions
Function, toc-container-p: Public ordinary functions
Function, toc-heading-p: Public ordinary functions
Function, toc-item-p: Public ordinary functions
Function, toc-p: Public ordinary functions
Function, toc-root-p: Public ordinary functions
Function, validate-properties: Private ordinary functions
Function, walk-tree: Public ordinary functions

G
Generic Function, add-text: Public generic functions
Generic Function, close-element: Public generic functions
Generic Function, get-tree: Public generic functions
Generic Function, open-element: Public generic functions
get-dsl-element: Private ordinary functions
get-tree: Public generic functions
get-tree: Public generic functions

H
heading-p: Public ordinary functions

I
initialize-instance: Public standalone methods

M
make-path: Public ordinary functions
Method, add-text: Public generic functions
Method, close-element: Public generic functions
Method, get-tree: Public generic functions
Method, initialize-instance: Public standalone methods
Method, open-element: Public generic functions

O
open-element: Public generic functions
open-element: Public generic functions

P
pop-stack: Private ordinary functions
push-content: Private ordinary functions
push-stack: Private ordinary functions

R
read-file: Public ordinary functions

S
semantic-p: Public ordinary functions
serialize: Private ordinary functions
set-heading-ids: Private ordinary functions
set-heading-indentation-levels: Private ordinary functions
set-toc: Private ordinary functions

T
toc-container-p: Public ordinary functions
toc-heading-p: Public ordinary functions
toc-item-p: Public ordinary functions
toc-p: Public ordinary functions
toc-root-p: Public ordinary functions

V
validate-properties: Private ordinary functions

W
walk-tree: Public ordinary functions


A.4 Data types