The monkeylib-html Reference Manual
Table of Contents
The monkeylib-html Reference Manual
This is the monkeylib-html Reference Manual, version 1.0,
generated automatically by Declt version 3.0 "Montgomery Scott"
on Tue Dec 22 14:26:28 2020 GMT+0.
1 Systems
The main system appears first, followed by any subsystem dependency.
1.1 monkeylib-html
- Author
Peter Seibel <peter@gigamonkeys.com>
- License
BSD
- Description
HTML generation
- Version
1.0
- Dependencies
- com.gigamonkeys.macro-utilities
- com.gigamonkeys.test-framework
- com.gigamonkeys.pathnames
- com.gigamonkeys.utilities
- monkeylib-text-output
- monkeylib-text-languages
- Source
monkeylib-html.asd (file)
- Components
-
2 Files
Files are sorted by type and then listed depth-first from the systems
components trees.
2.1 Lisp
2.1.1 monkeylib-html.asd
- Location
monkeylib-html.asd
- Systems
monkeylib-html (system)
2.1.2 monkeylib-html/packages.lisp
- Parent
monkeylib-html (system)
- Location
packages.lisp
- Packages
monkeylib-html
2.1.3 monkeylib-html/string-escaping.lisp
- Dependency
packages.lisp (file)
- Parent
monkeylib-html (system)
- Location
string-escaping.lisp
- Internal Definitions
-
2.1.4 monkeylib-html/html.lisp
- Dependencies
-
- Parent
monkeylib-html (system)
- Location
html.lisp
- Exported Definitions
-
- Internal Definitions
-
2.1.5 monkeylib-html/html-tests.lisp
- Dependencies
-
- Parent
monkeylib-html (system)
- Location
html-tests.lisp
- Internal Definitions
-
2.1.6 monkeylib-html/xml.lisp
- Dependency
packages.lisp (file)
- Parent
monkeylib-html (system)
- Location
xml.lisp
- Exported Definitions
-
- Internal Definitions
-
2.1.7 monkeylib-html/xml-macros.lisp
- Dependencies
-
- Parent
monkeylib-html (system)
- Location
xml-macros.lisp
3 Packages
Packages are listed by definition order.
3.1 monkeylib-html
- Source
packages.lisp (file)
- Use List
- monkeylib-text-languages
- monkeylib-text-output
- com.gigamonkeys.pathnames
- com.gigamonkeys.test
- com.gigamonkeys.utilities
- common-lisp
- Exported Definitions
-
- Internal Definitions
-
4 Definitions
Definitions are sorted by export status, category, package, and then by
lexicographic order.
4.1 Exported definitions
4.1.1 Macros
- Macro: define-html-macro NAME (&rest PARAMETERS) &body BODY
-
- Package
monkeylib-html
- Source
html.lisp (file)
- Macro: define-html-special-operator NAME (LANGUAGE PROCESSOR &rest OTHER-PARAMETERS) &body BODY
-
- Package
monkeylib-html
- Source
html.lisp (file)
- Macro: define-xml-language NAME &body ELEMENT-DEFS
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Macro: html &body BODY
-
- Package
monkeylib-html
- Source
html.lisp (file)
- Macro: with-html-output (STREAM &key PRETTY) &body BODY
-
- Package
monkeylib-html
- Source
html.lisp (file)
- Macro: xhtml &body BODY
-
- Package
monkeylib-html
- Source
html.lisp (file)
- Macro: xml &body BODY
-
- Package
monkeylib-html
- Source
xml.lisp (file)
4.1.2 Functions
- Function: emit-html SEXP
-
- Package
monkeylib-html
- Source
html.lisp (file)
- Function: emit-xhtml SEXP
-
- Package
monkeylib-html
- Source
html.lisp (file)
- Function: emit-xml SEXP
-
- Package
monkeylib-html
- Source
xml.lisp (file)
4.1.3 Classes
- Class: html ()
-
- Package
monkeylib-html
- Source
html.lisp (file)
- Direct superclasses
xml (class)
- Direct methods
-
- Direct Default Initargs
Initarg | Value |
:output-file-type | "html" |
:input-readtable | (copy-readtable) |
- Class: xhtml ()
-
- Package
monkeylib-html
- Source
html.lisp (file)
- Direct superclasses
xml (class)
- Direct methods
top-level-environment (method)
- Class: xml ()
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Direct superclasses
language (class)
- Direct subclasses
-
- Direct methods
-
- Direct slots
- Slot: name-converter
-
- Initargs
:name-converter
- Initform
(function string-downcase)
- Readers
name-converter (generic function)
- Writers
(setf name-converter) (generic function)
- Direct Default Initargs
Initarg | Value |
:input-readtable | (monkeylib-text-languages:case-preserving-readtable) |
:input-package | (find-package :keyword) |
:output-file-type | "xml" |
4.2 Internal definitions
4.2.1 Special variables
- Special Variable: *attribute-escapes*
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Special Variable: *element-escapes*
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Special Variable: *testfiles*
-
- Package
monkeylib-html
- Source
html-tests.lisp (file)
4.2.2 Macros
- Macro: define-xml-macro NAME (&rest PARAMETERS) &body BODY
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Macro: define-xml-special-operator NAME (LANGUAGE PROCESSOR &rest OTHER-PARAMETERS) &body BODY
-
- Package
monkeylib-html
- Source
xml.lisp (file)
4.2.3 Functions
- Function: block-element-p TAG ENV
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: cons-form-p FORM &optional TEST
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: empty-element-p TAG ENV
-
- Package
monkeylib-html
- Source
html.lisp (file)
- Function: environment-value KEY ENV
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: escape IN TO-ESCAPE
-
- Package
monkeylib-html
- Source
string-escaping.lisp (file)
- Function: escape-char CHAR
-
- Package
monkeylib-html
- Source
string-escaping.lisp (file)
- Function: escapes ENV
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: generate-xml-macro-with-attributes NAME MACRO-SYMBOL ATTRIBUTES PARAMETERS BODY
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: html->string SEXP
-
- Package
monkeylib-html
- Source
html-tests.lisp (file)
- Function: in-attribute ENV
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: in-attribute-p ENV
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: look NUMBER
-
- Package
monkeylib-html
- Source
html-tests.lisp (file)
- Function: new-env KEY VALUE ENV
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: new-test SEXP &optional NUMBER
-
- Package
monkeylib-html
- Source
html-tests.lisp (file)
- Function: new-tests ()
-
- Package
monkeylib-html
- Source
html-tests.lisp (file)
- Function: next-number ()
-
- Package
monkeylib-html
- Source
html-tests.lisp (file)
- Function: non-empty-element-p TAG ENV
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: ok NUMBER
-
- Package
monkeylib-html
- Source
html-tests.lisp (file)
- Function: paragraph-element-p TAG ENV
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: parse-cons-form SEXP
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: parse-explicit-attributes-sexp SEXP
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: parse-implicit-attributes-sexp SEXP
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: parse-xml-macro-lambda-list ARGS
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: preserve-whitespace-p TAG ENV
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: process-cons-sexp-xml LANGUAGE PROCESSOR FORM ENVIRONMENT
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Function: test-file INPUT
-
- Package
monkeylib-html
- Source
html-tests.lisp (file)
4.2.4 Generic functions
- Generic Function: emit-attributes LANGUAGE PROCESSOR ATTRIBUTES ENVIRONMENT
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Methods
- Method: emit-attributes (LANGUAGE xml) PROCESSOR ATTRIBUTES ENVIRONMENT
-
- Generic Function: emit-close-tag LANGUAGE PROCESSOR TAG BODY-P ENVIRONMENT
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Methods
- Method: emit-close-tag (LANGUAGE html) PROCESSOR TAG BODY-P ENVIRONMENT
-
- Source
html.lisp (file)
- Method: emit-close-tag (LANGUAGE xml) PROCESSOR TAG BODY-P ENVIRONMENT
-
- Generic Function: emit-element-body LANGUAGE PROCESSOR TAG BODY ENVIRONMENT
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Methods
- Method: emit-element-body (LANGUAGE xml) PROCESSOR TAG BODY ENVIRONMENT
-
- Generic Function: emit-open-tag LANGUAGE PROCESSOR TAG BODY-P ATTRIBUTES ENVIRONMENT
-
- Package
monkeylib-html
- Source
xml.lisp (file)
- Methods
- Method: emit-open-tag (LANGUAGE html) PROCESSOR TAG BODY-P ATTRIBUTES ENVIRONMENT
-
- Source
html.lisp (file)
- Method: emit-open-tag (LANGUAGE xml) PROCESSOR TAG BODY-P ATTRIBUTES ENVIRONMENT
-
- Generic Function: name-converter OBJECT
-
- Generic Function: (setf name-converter) NEW-VALUE OBJECT
-
- Package
monkeylib-html
- Methods
- Method: name-converter (XML xml)
-
automatically generated reader method
- Source
xml.lisp (file)
- Method: (setf name-converter) NEW-VALUE (XML xml)
-
automatically generated writer method
- Source
xml.lisp (file)
Appendix A Indexes
A.1 Concepts
| Index Entry | | Section |
|
F | | |
| File, Lisp, monkeylib-html.asd: | | The monkeylib-html․asd file |
| File, Lisp, monkeylib-html/html-tests.lisp: | | The monkeylib-html/html-tests․lisp file |
| File, Lisp, monkeylib-html/html.lisp: | | The monkeylib-html/html․lisp file |
| File, Lisp, monkeylib-html/packages.lisp: | | The monkeylib-html/packages․lisp file |
| File, Lisp, monkeylib-html/string-escaping.lisp: | | The monkeylib-html/string-escaping․lisp file |
| File, Lisp, monkeylib-html/xml-macros.lisp: | | The monkeylib-html/xml-macros․lisp file |
| File, Lisp, monkeylib-html/xml.lisp: | | The monkeylib-html/xml․lisp file |
|
L | | |
| Lisp File, monkeylib-html.asd: | | The monkeylib-html․asd file |
| Lisp File, monkeylib-html/html-tests.lisp: | | The monkeylib-html/html-tests․lisp file |
| Lisp File, monkeylib-html/html.lisp: | | The monkeylib-html/html․lisp file |
| Lisp File, monkeylib-html/packages.lisp: | | The monkeylib-html/packages․lisp file |
| Lisp File, monkeylib-html/string-escaping.lisp: | | The monkeylib-html/string-escaping․lisp file |
| Lisp File, monkeylib-html/xml-macros.lisp: | | The monkeylib-html/xml-macros․lisp file |
| Lisp File, monkeylib-html/xml.lisp: | | The monkeylib-html/xml․lisp file |
|
M | | |
| monkeylib-html.asd: | | The monkeylib-html․asd file |
| monkeylib-html/html-tests.lisp: | | The monkeylib-html/html-tests․lisp file |
| monkeylib-html/html.lisp: | | The monkeylib-html/html․lisp file |
| monkeylib-html/packages.lisp: | | The monkeylib-html/packages․lisp file |
| monkeylib-html/string-escaping.lisp: | | The monkeylib-html/string-escaping․lisp file |
| monkeylib-html/xml-macros.lisp: | | The monkeylib-html/xml-macros․lisp file |
| monkeylib-html/xml.lisp: | | The monkeylib-html/xml․lisp file |
|
A.2 Functions
| Index Entry | | Section |
|
( | | |
| (setf name-converter) : | | Internal generic functions |
| (setf name-converter) : | | Internal generic functions |
|
B | | |
| block-element-p : | | Internal functions |
|
C | | |
| cons-form-p : | | Internal functions |
|
D | | |
| define-html-macro : | | Exported macros |
| define-html-special-operator : | | Exported macros |
| define-xml-language : | | Exported macros |
| define-xml-macro : | | Internal macros |
| define-xml-special-operator : | | Internal macros |
|
E | | |
| emit-attributes : | | Internal generic functions |
| emit-attributes : | | Internal generic functions |
| emit-close-tag : | | Internal generic functions |
| emit-close-tag : | | Internal generic functions |
| emit-close-tag : | | Internal generic functions |
| emit-element-body : | | Internal generic functions |
| emit-element-body : | | Internal generic functions |
| emit-html : | | Exported functions |
| emit-open-tag : | | Internal generic functions |
| emit-open-tag : | | Internal generic functions |
| emit-open-tag : | | Internal generic functions |
| emit-xhtml : | | Exported functions |
| emit-xml : | | Exported functions |
| empty-element-p : | | Internal functions |
| environment-value : | | Internal functions |
| escape : | | Internal functions |
| escape-char : | | Internal functions |
| escapes : | | Internal functions |
|
F | | |
| Function, block-element-p : | | Internal functions |
| Function, cons-form-p : | | Internal functions |
| Function, emit-html : | | Exported functions |
| Function, emit-xhtml : | | Exported functions |
| Function, emit-xml : | | Exported functions |
| Function, empty-element-p : | | Internal functions |
| Function, environment-value : | | Internal functions |
| Function, escape : | | Internal functions |
| Function, escape-char : | | Internal functions |
| Function, escapes : | | Internal functions |
| Function, generate-xml-macro-with-attributes : | | Internal functions |
| Function, html->string : | | Internal functions |
| Function, in-attribute : | | Internal functions |
| Function, in-attribute-p : | | Internal functions |
| Function, look : | | Internal functions |
| Function, new-env : | | Internal functions |
| Function, new-test : | | Internal functions |
| Function, new-tests : | | Internal functions |
| Function, next-number : | | Internal functions |
| Function, non-empty-element-p : | | Internal functions |
| Function, ok : | | Internal functions |
| Function, paragraph-element-p : | | Internal functions |
| Function, parse-cons-form : | | Internal functions |
| Function, parse-explicit-attributes-sexp : | | Internal functions |
| Function, parse-implicit-attributes-sexp : | | Internal functions |
| Function, parse-xml-macro-lambda-list : | | Internal functions |
| Function, preserve-whitespace-p : | | Internal functions |
| Function, process-cons-sexp-xml : | | Internal functions |
| Function, test-file : | | Internal functions |
|
G | | |
| generate-xml-macro-with-attributes : | | Internal functions |
| Generic Function, (setf name-converter) : | | Internal generic functions |
| Generic Function, emit-attributes : | | Internal generic functions |
| Generic Function, emit-close-tag : | | Internal generic functions |
| Generic Function, emit-element-body : | | Internal generic functions |
| Generic Function, emit-open-tag : | | Internal generic functions |
| Generic Function, name-converter : | | Internal generic functions |
|
H | | |
| html : | | Exported macros |
| html->string : | | Internal functions |
|
I | | |
| in-attribute : | | Internal functions |
| in-attribute-p : | | Internal functions |
|
L | | |
| look : | | Internal functions |
|
M | | |
| Macro, define-html-macro : | | Exported macros |
| Macro, define-html-special-operator : | | Exported macros |
| Macro, define-xml-language : | | Exported macros |
| Macro, define-xml-macro : | | Internal macros |
| Macro, define-xml-special-operator : | | Internal macros |
| Macro, html : | | Exported macros |
| Macro, with-html-output : | | Exported macros |
| Macro, xhtml : | | Exported macros |
| Macro, xml : | | Exported macros |
| Method, (setf name-converter) : | | Internal generic functions |
| Method, emit-attributes : | | Internal generic functions |
| Method, emit-close-tag : | | Internal generic functions |
| Method, emit-close-tag : | | Internal generic functions |
| Method, emit-element-body : | | Internal generic functions |
| Method, emit-open-tag : | | Internal generic functions |
| Method, emit-open-tag : | | Internal generic functions |
| Method, name-converter : | | Internal generic functions |
|
N | | |
| name-converter : | | Internal generic functions |
| name-converter : | | Internal generic functions |
| new-env : | | Internal functions |
| new-test : | | Internal functions |
| new-tests : | | Internal functions |
| next-number : | | Internal functions |
| non-empty-element-p : | | Internal functions |
|
O | | |
| ok : | | Internal functions |
|
P | | |
| paragraph-element-p : | | Internal functions |
| parse-cons-form : | | Internal functions |
| parse-explicit-attributes-sexp : | | Internal functions |
| parse-implicit-attributes-sexp : | | Internal functions |
| parse-xml-macro-lambda-list : | | Internal functions |
| preserve-whitespace-p : | | Internal functions |
| process-cons-sexp-xml : | | Internal functions |
|
T | | |
| test-file : | | Internal functions |
|
W | | |
| with-html-output : | | Exported macros |
|
X | | |
| xhtml : | | Exported macros |
| xml : | | Exported macros |
|
A.3 Variables
A.4 Data types