The cl-html-readme Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-html-readme Reference Manual

This is the cl-html-readme Reference Manual, version 1.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Thu Mar 11 12:10:24 2021 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

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.1

Source

cl-html-readme.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

2 Modules

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


Previous: , Up: Modules   [Contents][Index]

2.1 cl-html-readme/src

Parent

cl-html-readme (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-html-readme.asd

Location

cl-html-readme.asd

Systems

cl-html-readme (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

src (module)

Location

src/packages.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/dsl.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

dsl.lisp (file)

Parent

src (module)

Location

src/readme-util.lisp

Exported Definitions
Internal Definitions

format-string (function)


Previous: , Up: Lisp files   [Contents][Index]

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

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 cl-html-readme-dsl

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

4.2 cl-html-readme

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 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 (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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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

Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Conditions

Condition: dsl-syntax-error ()
Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Direct superclasses

simple-error (condition)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Classes

Class: tree-builder ()
Package

cl-html-readme-dsl

Source

dsl.lisp (file)

Direct superclasses

standard-object (class)

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

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *dsl-elements*
Package

cl-html-readme-dsl

Source

dsl.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 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


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-html-readme.asd: The cl-html-readme․asd file
cl-html-readme/src: The cl-html-readme/src module
cl-html-readme/src/dsl.lisp: The cl-html-readme/src/dsl․lisp file
cl-html-readme/src/html-writer.lisp: The cl-html-readme/src/html-writer․lisp file
cl-html-readme/src/packages.lisp: The cl-html-readme/src/packages․lisp file
cl-html-readme/src/readme-util.lisp: The cl-html-readme/src/readme-util․lisp file

F
File, Lisp, cl-html-readme.asd: The cl-html-readme․asd file
File, Lisp, cl-html-readme/src/dsl.lisp: The cl-html-readme/src/dsl․lisp file
File, Lisp, cl-html-readme/src/html-writer.lisp: The cl-html-readme/src/html-writer․lisp file
File, Lisp, cl-html-readme/src/packages.lisp: The cl-html-readme/src/packages․lisp file
File, Lisp, cl-html-readme/src/readme-util.lisp: The cl-html-readme/src/readme-util․lisp file

L
Lisp File, cl-html-readme.asd: The cl-html-readme․asd file
Lisp File, cl-html-readme/src/dsl.lisp: The cl-html-readme/src/dsl․lisp file
Lisp File, cl-html-readme/src/html-writer.lisp: The cl-html-readme/src/html-writer․lisp file
Lisp File, cl-html-readme/src/packages.lisp: The cl-html-readme/src/packages․lisp file
Lisp File, cl-html-readme/src/readme-util.lisp: The cl-html-readme/src/readme-util․lisp file

M
Module, cl-html-readme/src: The cl-html-readme/src module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

A
add-text: Exported generic functions
add-text: Exported generic functions

C
close-element: Exported generic functions
close-element: Exported generic functions

D
doc-to-html: Exported functions

E
extract-toc: Exported functions

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

G
Generic Function, add-text: Exported generic functions
Generic Function, close-element: Exported generic functions
Generic Function, get-tree: Exported generic functions
Generic Function, open-element: Exported generic functions
get-dsl-element: Internal functions
get-tree: Exported generic functions
get-tree: Exported generic functions

H
heading-p: Exported functions

M
make-path: Exported functions
Method, add-text: Exported generic functions
Method, close-element: Exported generic functions
Method, get-tree: Exported generic functions
Method, open-element: Exported generic functions

O
open-element: Exported generic functions
open-element: Exported generic functions

P
pop-stack: Internal functions
push-content: Internal functions
push-stack: Internal functions

R
read-file: Exported functions

S
semantic-p: Exported functions
serialize: Internal functions
set-heading-ids: Internal functions
set-heading-indentation-levels: Internal functions
set-toc: Internal functions

T
toc-container-p: Exported functions
toc-heading-p: Exported functions
toc-item-p: Exported functions
toc-p: Exported functions
toc-root-p: Exported functions

V
validate-properties: Internal functions

W
walk-tree: Exported functions

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
C   E   N   R   S   T  
Index Entry  Section

*
*dsl-elements*: Internal special variables
*home-directory*: Exported special variables
*tab-width*: Exported special variables

C
content: Internal classes

E
element-properties: Internal classes
element-symbol: Internal classes

N
node-stack: Exported classes

R
root-node: Exported classes

S
Slot, content: Internal classes
Slot, element-properties: Internal classes
Slot, element-symbol: Internal classes
Slot, node-stack: Exported classes
Slot, root-node: Exported classes
Slot, text: Internal classes
Special Variable, *dsl-elements*: Internal special variables
Special Variable, *home-directory*: Exported special variables
Special Variable, *tab-width*: Exported special variables

T
text: Internal classes

Jump to:   *  
C   E   N   R   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   P   S   T  
Index Entry  Section

C
cl-html-readme: The cl-html-readme system
cl-html-readme: The cl-html-readme package
cl-html-readme-dsl: The cl-html-readme-dsl package
Class, dsl-element-node: Internal classes
Class, dsl-text-node: Internal classes
Class, tree-builder: Exported classes
Condition, dsl-syntax-error: Exported conditions

D
dsl-element-node: Internal classes
dsl-syntax-error: Exported conditions
dsl-text-node: Internal classes

P
Package, cl-html-readme: The cl-html-readme package
Package, cl-html-readme-dsl: The cl-html-readme-dsl package

S
System, cl-html-readme: The cl-html-readme system

T
tree-builder: Exported classes

Jump to:   C   D   P   S   T