The monkeylib-html Reference Manual

This is the monkeylib-html Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:18:20 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 monkeylib-html

HTML generation

Author

Peter Seibel <>

License

BSD

Version

1.0

Dependencies
  • com.gigamonkeys.macro-utilities (system).
  • com.gigamonkeys.test-framework (system).
  • com.gigamonkeys.pathnames (system).
  • com.gigamonkeys.utilities (system).
  • monkeylib-text-output (system).
  • monkeylib-text-languages (system).
Source

monkeylib-html.asd.

Child 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/monkeylib-html.asd

Source

monkeylib-html.asd.

Parent Component

monkeylib-html (system).

ASDF Systems

monkeylib-html.


2.1.2 monkeylib-html/packages.lisp

Source

monkeylib-html.asd.

Parent Component

monkeylib-html (system).

Packages

monkeylib-html.


2.1.3 monkeylib-html/string-escaping.lisp

Dependency

packages.lisp (file).

Source

monkeylib-html.asd.

Parent Component

monkeylib-html (system).

Internals

2.1.4 monkeylib-html/html.lisp

Dependencies
Source

monkeylib-html.asd.

Parent Component

monkeylib-html (system).

Public Interface
Internals

2.1.5 monkeylib-html/html-tests.lisp

Dependencies
Source

monkeylib-html.asd.

Parent Component

monkeylib-html (system).

Internals

2.1.6 monkeylib-html/xml.lisp

Dependency

packages.lisp (file).

Source

monkeylib-html.asd.

Parent Component

monkeylib-html (system).

Public Interface
Internals

2.1.7 monkeylib-html/xml-macros.lisp

Dependencies
Source

monkeylib-html.asd.

Parent Component

monkeylib-html (system).


3 Packages

Packages are listed by definition order.


3.1 monkeylib-html

Source

packages.lisp.

Use List
  • com.gigamonkeys.pathnames.
  • com.gigamonkeys.test.
  • com.gigamonkeys.utilities.
  • common-lisp.
  • monkeylib-text-languages.
  • monkeylib-text-output.
Public Interface
Internals

4 Definitions

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


4.1 Public Interface


4.1.1 Macros

Macro: define-html-macro (name (&rest parameters) &body body)
Package

monkeylib-html.

Source

html.lisp.

Macro: define-html-special-operator (name (language processor &rest other-parameters) &body body)
Package

monkeylib-html.

Source

html.lisp.

Macro: define-xml-language (name &body element-defs)
Package

monkeylib-html.

Source

xml.lisp.

Macro: html (&body body)
Package

monkeylib-html.

Source

html.lisp.

Macro: with-html-output ((stream &key pretty) &body body)
Package

monkeylib-html.

Source

html.lisp.

Macro: xhtml (&body body)
Package

monkeylib-html.

Source

html.lisp.

Macro: xml (&body body)
Package

monkeylib-html.

Source

xml.lisp.


4.1.2 Ordinary functions

Function: emit-html (sexp)
Package

monkeylib-html.

Source

html.lisp.

Function: emit-xhtml (sexp)
Package

monkeylib-html.

Source

html.lisp.

Function: emit-xml (sexp)
Package

monkeylib-html.

Source

xml.lisp.


4.1.3 Standalone methods

Method: comment ((language xml) text)
Package

monkeylib-text-languages.

Source

xml.lisp.

Method: embeddable-value-form ((language xml) form environment)
Package

monkeylib-text-languages.

Source

xml.lisp.

Method: identifier ((language xml) form)
Package

monkeylib-text-languages.

Source

xml.lisp.

Method: initialize-instance :after ((html html) &key &allow-other-keys)
Source

html.lisp.

Method: initialize-instance :after ((xml xml) &key &allow-other-keys)
Source

xml.lisp.

Method: process-sexp ((language xml) processor form environment)
Package

monkeylib-text-languages.

Source

xml.lisp.

Method: sexp-form-p ((language xml) form)
Package

monkeylib-text-languages.

Source

xml.lisp.

Method: top-level-environment ((language html))
Package

monkeylib-text-languages.

Source

html.lisp.

Method: top-level-environment ((language xhtml))
Package

monkeylib-text-languages.

Source

html.lisp.

Method: top-level-environment ((language xml))
Package

monkeylib-text-languages.

Source

xml.lisp.


4.1.4 Classes

Class: html
Package

monkeylib-html.

Source

html.lisp.

Direct superclasses

xml.

Direct methods
Direct Default Initargs
InitargValue
:output-file-typehtml
:input-readtable(copy-readtable)
Class: xhtml
Package

monkeylib-html.

Source

html.lisp.

Direct superclasses

xml.

Direct methods

top-level-environment.

Class: xml
Package

monkeylib-html.

Source

xml.lisp.

Direct superclasses

language.

Direct subclasses
Direct methods
Direct Default Initargs
InitargValue
:input-readtable(case-preserving-readtable)
:input-package(find-package keyword)
:output-file-typexml
Direct slots
Slot: name-converter
Initform

(function string-downcase)

Initargs

:name-converter

Readers

name-converter.

Writers

(setf name-converter).


4.2 Internals


4.2.1 Special variables

Special Variable: *attribute-escapes*
Package

monkeylib-html.

Source

xml.lisp.

Special Variable: *element-escapes*
Package

monkeylib-html.

Source

xml.lisp.

Special Variable: *testfiles*
Package

monkeylib-html.

Source

html-tests.lisp.


4.2.2 Macros

Macro: define-xml-macro (name (&rest parameters) &body body)
Package

monkeylib-html.

Source

xml.lisp.

Macro: define-xml-special-operator (name (language processor &rest other-parameters) &body body)
Package

monkeylib-html.

Source

xml.lisp.


4.2.3 Ordinary functions

Function: block-element-p (tag env)
Package

monkeylib-html.

Source

xml.lisp.

Function: cons-form-p (form &optional test)
Package

monkeylib-html.

Source

xml.lisp.

Function: empty-element-p (tag env)
Package

monkeylib-html.

Source

html.lisp.

Function: environment-value (key env)
Package

monkeylib-html.

Source

xml.lisp.

Function: escape (in to-escape)
Package

monkeylib-html.

Source

string-escaping.lisp.

Function: escape-char (char)
Package

monkeylib-html.

Source

string-escaping.lisp.

Function: escapes (env)
Package

monkeylib-html.

Source

xml.lisp.

Function: generate-xml-macro-with-attributes (name macro-symbol attributes parameters body)
Package

monkeylib-html.

Source

xml.lisp.

Function: html->string (sexp)
Package

monkeylib-html.

Source

html-tests.lisp.

Function: in-attribute (env)
Package

monkeylib-html.

Source

xml.lisp.

Function: in-attribute-p (env)
Package

monkeylib-html.

Source

xml.lisp.

Function: look (number)
Package

monkeylib-html.

Source

html-tests.lisp.

Function: new-env (key value env)
Package

monkeylib-html.

Source

xml.lisp.

Function: new-test (sexp &optional number)
Package

monkeylib-html.

Source

html-tests.lisp.

Function: new-tests ()
Package

monkeylib-html.

Source

html-tests.lisp.

Function: next-number ()
Package

monkeylib-html.

Source

html-tests.lisp.

Function: non-empty-element-p (tag env)
Package

monkeylib-html.

Source

xml.lisp.

Function: ok (number)
Package

monkeylib-html.

Source

html-tests.lisp.

Function: paragraph-element-p (tag env)
Package

monkeylib-html.

Source

xml.lisp.

Function: parse-cons-form (sexp)
Package

monkeylib-html.

Source

xml.lisp.

Function: parse-explicit-attributes-sexp (sexp)
Package

monkeylib-html.

Source

xml.lisp.

Function: parse-implicit-attributes-sexp (sexp)
Package

monkeylib-html.

Source

xml.lisp.

Function: parse-xml-macro-lambda-list (args)
Package

monkeylib-html.

Source

xml.lisp.

Function: preserve-whitespace-p (tag env)
Package

monkeylib-html.

Source

xml.lisp.

Function: process-cons-sexp-xml (language processor form environment)
Package

monkeylib-html.

Source

xml.lisp.

Function: test-file (input)
Package

monkeylib-html.

Source

html-tests.lisp.


4.2.4 Generic functions

Generic Function: emit-attributes (language processor attributes environment)
Package

monkeylib-html.

Source

xml.lisp.

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.

Methods
Method: emit-close-tag ((language html) processor tag body-p environment)
Source

html.lisp.

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.

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.

Methods
Method: emit-open-tag ((language html) processor tag body-p attributes environment)
Source

html.lisp.

Method: emit-open-tag ((language xml) processor tag body-p attributes environment)
Generic Reader: name-converter (object)
Package

monkeylib-html.

Methods
Reader Method: name-converter ((xml xml))

automatically generated reader method

Source

xml.lisp.

Target Slot

name-converter.

Generic Writer: (setf name-converter) (object)
Package

monkeylib-html.

Methods
Writer Method: (setf name-converter) ((xml xml))

automatically generated writer method

Source

xml.lisp.

Target Slot

name-converter.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   C   D   E   F   G   H   I   L   M   N   O   P   S   T   W   X  
Index Entry  Section

(
(setf name-converter): Private generic functions
(setf name-converter): Private generic functions

B
block-element-p: Private ordinary functions

C
comment: Public standalone methods
cons-form-p: Private ordinary functions

D
define-html-macro: Public macros
define-html-special-operator: Public macros
define-xml-language: Public macros
define-xml-macro: Private macros
define-xml-special-operator: Private macros

E
embeddable-value-form: Public standalone methods
emit-attributes: Private generic functions
emit-attributes: Private generic functions
emit-close-tag: Private generic functions
emit-close-tag: Private generic functions
emit-close-tag: Private generic functions
emit-element-body: Private generic functions
emit-element-body: Private generic functions
emit-html: Public ordinary functions
emit-open-tag: Private generic functions
emit-open-tag: Private generic functions
emit-open-tag: Private generic functions
emit-xhtml: Public ordinary functions
emit-xml: Public ordinary functions
empty-element-p: Private ordinary functions
environment-value: Private ordinary functions
escape: Private ordinary functions
escape-char: Private ordinary functions
escapes: Private ordinary functions

F
Function, block-element-p: Private ordinary functions
Function, cons-form-p: Private ordinary functions
Function, emit-html: Public ordinary functions
Function, emit-xhtml: Public ordinary functions
Function, emit-xml: Public ordinary functions
Function, empty-element-p: Private ordinary functions
Function, environment-value: Private ordinary functions
Function, escape: Private ordinary functions
Function, escape-char: Private ordinary functions
Function, escapes: Private ordinary functions
Function, generate-xml-macro-with-attributes: Private ordinary functions
Function, html->string: Private ordinary functions
Function, in-attribute: Private ordinary functions
Function, in-attribute-p: Private ordinary functions
Function, look: Private ordinary functions
Function, new-env: Private ordinary functions
Function, new-test: Private ordinary functions
Function, new-tests: Private ordinary functions
Function, next-number: Private ordinary functions
Function, non-empty-element-p: Private ordinary functions
Function, ok: Private ordinary functions
Function, paragraph-element-p: Private ordinary functions
Function, parse-cons-form: Private ordinary functions
Function, parse-explicit-attributes-sexp: Private ordinary functions
Function, parse-implicit-attributes-sexp: Private ordinary functions
Function, parse-xml-macro-lambda-list: Private ordinary functions
Function, preserve-whitespace-p: Private ordinary functions
Function, process-cons-sexp-xml: Private ordinary functions
Function, test-file: Private ordinary functions

G
generate-xml-macro-with-attributes: Private ordinary functions
Generic Function, (setf name-converter): Private generic functions
Generic Function, emit-attributes: Private generic functions
Generic Function, emit-close-tag: Private generic functions
Generic Function, emit-element-body: Private generic functions
Generic Function, emit-open-tag: Private generic functions
Generic Function, name-converter: Private generic functions

H
html: Public macros
html->string: Private ordinary functions

I
identifier: Public standalone methods
in-attribute: Private ordinary functions
in-attribute-p: Private ordinary functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

L
look: Private ordinary functions

M
Macro, define-html-macro: Public macros
Macro, define-html-special-operator: Public macros
Macro, define-xml-language: Public macros
Macro, define-xml-macro: Private macros
Macro, define-xml-special-operator: Private macros
Macro, html: Public macros
Macro, with-html-output: Public macros
Macro, xhtml: Public macros
Macro, xml: Public macros
Method, (setf name-converter): Private generic functions
Method, comment: Public standalone methods
Method, embeddable-value-form: Public standalone methods
Method, emit-attributes: Private generic functions
Method, emit-close-tag: Private generic functions
Method, emit-close-tag: Private generic functions
Method, emit-element-body: Private generic functions
Method, emit-open-tag: Private generic functions
Method, emit-open-tag: Private generic functions
Method, identifier: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, name-converter: Private generic functions
Method, process-sexp: Public standalone methods
Method, sexp-form-p: Public standalone methods
Method, top-level-environment: Public standalone methods
Method, top-level-environment: Public standalone methods
Method, top-level-environment: Public standalone methods

N
name-converter: Private generic functions
name-converter: Private generic functions
new-env: Private ordinary functions
new-test: Private ordinary functions
new-tests: Private ordinary functions
next-number: Private ordinary functions
non-empty-element-p: Private ordinary functions

O
ok: Private ordinary functions

P
paragraph-element-p: Private ordinary functions
parse-cons-form: Private ordinary functions
parse-explicit-attributes-sexp: Private ordinary functions
parse-implicit-attributes-sexp: Private ordinary functions
parse-xml-macro-lambda-list: Private ordinary functions
preserve-whitespace-p: Private ordinary functions
process-cons-sexp-xml: Private ordinary functions
process-sexp: Public standalone methods

S
sexp-form-p: Public standalone methods

T
test-file: Private ordinary functions
top-level-environment: Public standalone methods
top-level-environment: Public standalone methods
top-level-environment: Public standalone methods

W
with-html-output: Public macros

X
xhtml: Public macros
xml: Public macros