The common-doc Reference Manual

Methods

Method: cells (ROW row)

Method: (setf cells) NEW-VALUE (ROW row)

The cells in the row.

Source: classes.lisp (file)

Generic Function: children OBJECT

Generic Function: (setf children) NEW-VALUE OBJECT

Package

Methods

Method: children (DOCUMENT document)

Method: (setf children) NEW-VALUE (DOCUMENT document)

The document’s children nodes.

Source: classes.lisp (file)

Method: children (DEFINITION-LIST definition-list)

Method: (setf children) NEW-VALUE (DEFINITION-LIST definition-list)

The list of @c(definition) instances.

Source: classes.lisp (file)

Method: children (ORDERED-LIST ordered-list)

Method: (setf children) NEW-VALUE (ORDERED-LIST ordered-list)

The list of @c(list-item) instances.

Source: classes.lisp (file)

Method: children (UNORDERED-LIST unordered-list)

Method: (setf children) NEW-VALUE (UNORDERED-LIST unordered-list)

The list of @c(list-item) instances.

Source: classes.lisp (file)

Method: children (CONTENT-NODE content-node)

Method: (setf children) NEW-VALUE (CONTENT-NODE content-node)

The node’s children.

Source: classes.lisp (file)

Generic Function: created-on OBJECT

Generic Function: (setf created-on) NEW-VALUE OBJECT

Package

Methods

Method: created-on (DOCUMENT document)

Method: (setf created-on) NEW-VALUE (DOCUMENT document)

The date and time when the document was
created. By default, this is the date and time at instance creation.

Source: classes.lisp (file)

Generic Function: creator OBJECT

Generic Function: (setf creator) NEW-VALUE OBJECT

Package

Methods

Method: creator (DOCUMENT document)

Method: (setf creator) NEW-VALUE (DOCUMENT document)

The creator of the document.

Source: classes.lisp (file)

Generic Function: definition OBJECT

Generic Function: (setf definition) NEW-VALUE OBJECT

Package

Methods

Method: definition (DEFINITION definition)

Method: (setf definition) NEW-VALUE (DEFINITION definition)

Defines the term.

Source: classes.lisp (file)

Generic Function: description OBJECT

Generic Function: (setf description) NEW-VALUE OBJECT

Package

Methods

Method: description (DOCUMENT document)

Method: (setf description) NEW-VALUE (DOCUMENT document)

A description of the document.

Source: classes.lisp (file)

Method: description (FIGURE figure)

Method: (setf description) NEW-VALUE (FIGURE figure)

A description of the image.

Source: classes.lisp (file)

Method: description (IMAGE image)

Method: (setf description) NEW-VALUE (IMAGE image)

A plain text description of the image.

Source: classes.lisp (file)

Generic Function: document-reference OBJECT

Generic Function: (setf document-reference) NEW-VALUE OBJECT

Package

Methods

Method: document-reference (DOCUMENT-LINK document-link)

Method: (setf document-reference) NEW-VALUE (DOCUMENT-LINK document-link)

A reference ID for the linked document.
If @c(NIL), the link is only to a section within the document.

Source: classes.lisp (file)

Generic Function: emit-document DOCUMENT-FORMAT DOCUMENT STREAM

Dump a CommonDoc document into a stream.

Package: common-doc.format
Source: format.lisp (file)

Generic Function: emit-to-string FORMAT DOCUMENT

Package

common-doc.format

Methods

Method: emit-to-string (FORMAT document-format) (NODE document-node)

Source: format.lisp (file)

Method: emit-to-string (FORMAT document-format) (DOCUMENT document)

Source: format.lisp (file)

Generic Function: expand-macro NODE

Replace a macro node with a primitive node.

Package

Source

macros.lisp (file)

Methods

Method: expand-macro (NODE define-meta-macro): Define the metadata macro, and return an empty text node.

Method: expand-macro (MACRO macro-node)

Method: expand-macro (NODE document-node): The default macroexpansion: Do nothing.

Generic Function: expand-macros NODE

Recursively expand all macros in ‘node‘.

Package

Source

macros.lisp (file)

Methods

Method: expand-macros (DOC document): Expand the macros in a document.

Method: expand-macros (NODE content-node): Expand the macros in a node with children.

Method: expand-macros (NODE definition): Expand the macros in a definition.

Method: expand-macros (NODE base-list): Expand the macros in a base list.

Method: expand-macros (NODE document-node): The default macroexpansion.

Generic Function: footer OBJECT

Generic Function: (setf footer) NEW-VALUE OBJECT

Package

Methods

Method: footer (ROW row)

Method: (setf footer) NEW-VALUE (ROW row)

The row footer.

Source: classes.lisp (file)

Generic Function: header OBJECT

Generic Function: (setf header) NEW-VALUE OBJECT

Package

Methods

Method: header (ROW row)

Method: (setf header) NEW-VALUE (ROW row)

The row header.

Source: classes.lisp (file)

Generic Function: image OBJECT

Generic Function: (setf image) NEW-VALUE OBJECT

Package

Methods

Method: image (FIGURE figure)

Method: (setf image) NEW-VALUE (FIGURE figure)

The figure’s image.

Source: classes.lisp (file)

Generic Function: keywords OBJECT

Generic Function: (setf keywords) NEW-VALUE OBJECT

Package

Methods

Method: keywords (DOCUMENT document)

Method: (setf keywords) NEW-VALUE (DOCUMENT document)

A list of strings, each being a keyword for the document.

Source: classes.lisp (file)

Generic Function: language OBJECT

Generic Function: (setf language) NEW-VALUE OBJECT

Package

Methods

Method: language (DOCUMENT document)

Method: (setf language) NEW-VALUE (DOCUMENT document)

An @link[uri=http://www.ietf.org/rfc/rfc4646.txt](RFC4646) string denoting the language the document is written in.

Source: classes.lisp (file)

Method: language (CODE-BLOCK code-block)

Method: (setf language) NEW-VALUE (CODE-BLOCK code-block)

The language of the code block’s contents.

Source: classes.lisp (file)

Generic Function: metadata OBJECT

Generic Function: (setf metadata) NEW-VALUE OBJECT

Package

Methods

Method: metadata (DOCUMENT-NODE document-node)

Method: (setf metadata) NEW-VALUE (DOCUMENT-NODE document-node)

Node metadata.

Source: classes.lisp (file)

Generic Function: name OBJECT

Generic Function: (setf name) NEW-VALUE OBJECT

Package

Methods

Method: name (MACRO-NODE macro-node)

Method: (setf name) NEW-VALUE (MACRO-NODE macro-node)

The name of the macro.

Source: macros.lisp (file)

Generic Function: node CONDITION

Generic Function: (setf node) NEW-VALUE CONDITION

Package

common-doc.error

Methods

Method: node (CONDITION no-macro-expander)

Method: (setf node) NEW-VALUE (CONDITION no-macro-expander)

Source: error.lisp (file)

Generic Function: node-equal NODE-A NODE-B

Recursively check whether two nodes are equal.

Package

Source

equality.lisp (file)

Methods

Method: node-equal (NODE-A document-node) (NODE-B document-node)

Generic Function: node-reference OBJECT

Generic Function: (setf node-reference) NEW-VALUE OBJECT

Package

Methods

Method: node-reference (DOCUMENT-LINK document-link)

Method: (setf node-reference) NEW-VALUE (DOCUMENT-LINK document-link)

A reference ID for the linked node.

Source: classes.lisp (file)

Generic Function: node-specific-equal NODE-A NODE-B

Use this method to make node equality more specific.

Package

Source

equality.lisp (file)

Methods

Method: node-specific-equal (SECTION-A section) (SECTION-B section)

Method: node-specific-equal (FIGURE-A figure) (FIGURE-B figure)

Method: node-specific-equal (IMAGE-A image) (IMAGE-B image)

Method: node-specific-equal (DEFINITION-A definition) (DEFINITION-B definition)

Method: node-specific-equal (LINK-A web-link) (LINK-B web-link)

Method: node-specific-equal (LINK-A document-link) (LINK-B document-link)

Method: node-specific-equal (CODE-A code-block) (CODE-B code-block)

Method: node-specific-equal (TEXT-A text-node) (TEXT-B text-node)

Method: node-specific-equal (NODE-A document-node) (NODE-B document-node): By default, return true.

Generic Function: parse-document DOCUMENT-FORMAT INPUT

Parse an input into a CommonDoc document.

Package: common-doc.format
Source: format.lisp (file)

Generic Function: publisher OBJECT

Generic Function: (setf publisher) NEW-VALUE OBJECT

Package

Methods

Method: publisher (DOCUMENT document)

Method: (setf publisher) NEW-VALUE (DOCUMENT document)

The document’s publisher.

Source: classes.lisp (file)

Generic Function: reference OBJECT

Generic Function: (setf reference) NEW-VALUE OBJECT

Package

Methods

Method: reference (DOCUMENT document)

Method: (setf reference) NEW-VALUE (DOCUMENT document)

A reference string to uniquely identify the document within a certain context.

Source: classes.lisp (file)

Method: reference (DOCUMENT-NODE document-node)

Method: (setf reference) NEW-VALUE (DOCUMENT-NODE document-node)

A unique string identifying the node.

Source: classes.lisp (file)

Generic Function: rights OBJECT

Generic Function: (setf rights) NEW-VALUE OBJECT

Package

Methods

Method: rights (DOCUMENT document)

Method: (setf rights) NEW-VALUE (DOCUMENT document)

Information on the document’s copyright.

Source: classes.lisp (file)

Generic Function: rows OBJECT

Generic Function: (setf rows) NEW-VALUE OBJECT

Package

Methods

Method: rows (TABLE table)

Method: (setf rows) NEW-VALUE (TABLE table)

The list of rows in a table.

Source: classes.lisp (file)

Generic Function: source OBJECT

Generic Function: (setf source) NEW-VALUE OBJECT

Package

Methods

Method: source (IMAGE image)

Method: (setf source) NEW-VALUE (IMAGE image)

The source where the image is stored.

Source: classes.lisp (file)

Generic Function: subject OBJECT

Generic Function: (setf subject) NEW-VALUE OBJECT

Package

Methods

Method: subject (DOCUMENT document)

Method: (setf subject) NEW-VALUE (DOCUMENT document)

The subject the document deals with.

Source: classes.lisp (file)

Generic Function: term OBJECT

Generic Function: (setf term) NEW-VALUE OBJECT

Package

Methods

Method: term (DEFINITION definition)

Method: (setf term) NEW-VALUE (DEFINITION definition)

The definition term.

Source: classes.lisp (file)

Generic Function: text OBJECT

Generic Function: (setf text) NEW-VALUE OBJECT

Package

Methods

Method: text (TEXT-NODE text-node)

Method: (setf text) NEW-VALUE (TEXT-NODE text-node)

The node’s text.

Source: classes.lisp (file)

Generic Function: title OBJECT

Generic Function: (setf title) NEW-VALUE OBJECT

Package

Methods

Method: title (DOCUMENT document)

Method: (setf title) NEW-VALUE (DOCUMENT document)

The document’s title.

Source: classes.lisp (file)

Method: title (SECTION section)

Method: (setf title) NEW-VALUE (SECTION section)

The section title.

Source: classes.lisp (file)

Generic Function: traverse-document NODE FUNCTION &optional DEPTH

Apply a side-effectful function recursively to every element
in the document. Depth-first. Doesn’t apply the function to the document itself.

Package

Source

traverse.lisp (file)

Methods

Method: traverse-document (DOC document) FUNCTION &optional DEPTH

Method: traverse-document (CNODE content-node) FUNCTION &optional DEPTH

Method: traverse-document (DNODE document-node) FUNCTION &optional DEPTH

Generic Function: uri OBJECT

Generic Function: (setf uri) NEW-VALUE OBJECT

Package

Methods

Method: uri (WEB-LINK web-link)

Method: (setf uri) NEW-VALUE (WEB-LINK web-link)

The URI of the external resource.

Source: classes.lisp (file)

Generic Function: version OBJECT

Generic Function: (setf version) NEW-VALUE OBJECT

Package

Methods

Method: version (DOCUMENT document)

Method: (setf version) NEW-VALUE (DOCUMENT document)

The document version.

Source: classes.lisp (file)

6.1.5 Conditions

Condition: common-doc-error ()

The base class of all CommonDoc errors.

Package: common-doc.error
Source: error.lisp (file)
Direct superclasses: simple-error (condition)
Direct subclasses: macro-error (condition)

Condition: macro-error ()

The base class of all macro-related errors.

Package: common-doc.error
Source: error.lisp (file)
Direct superclasses: common-doc-error (condition)
Direct subclasses: no-macro-expander (condition)

Condition: no-macro-expander ()

Signaled when a macro node has no @c(expand-macro) method.

Package

common-doc.error

Source

error.lisp (file)

Direct superclasses

macro-error (condition)

Direct methods

node (method)
node (method)

Direct slots

Slot: node

The node that couldn’t be expanded.

Initargs: :node
Readers: node (generic function)
Writers: (setf node) (generic function)

6.1.6 Classes

Class: base-list ()

The base class of all lists.

Package

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct subclasses

unordered-list (class)
ordered-list (class)
definition-list (class)

Direct methods

print-object (method)
node-text (method)
expand-macros (method)

Class: base-quote ()

The base class of all quotes.

Package

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Direct subclasses

inline-quote (class)
block-quote (class)

Class: block-quote ()

A block quote.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: base-quote (class)

Class: bold ()

Text in this element is bold.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: markup (class)

Class: cell ()

A cell in a table.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: content-node (class)

Class: code ()

Text in this element is monospaced or otherwise marked as code or computer output.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: markup (class)

Class: code-block ()

A block of code.

Package

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Direct methods

node-specific-equal (method)
language (method)
language (method)

Direct slots

Slot: language

The language of the code block’s contents.

Type: (or null string)
Initargs: :language
Readers: language (generic function)
Writers: (setf language) (generic function)

Class: content-node ()

A node with children. This is the base class of all nodes
that have a @c(children) slot (Except @c(document), since this class inherits from @c(document-node)) and can also be used as a way to represent a generic grouping of elements. This is useful when building a CommonDoc document by parsing some input language.

Package

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct subclasses

paragraph (class)
markup (class)
code-block (class)
base-quote (class)
link (class)
list-item (class)
cell (class)
section (class)
macro-node (class)

Direct methods

print-object (method)
toc-traverse (method)
node-text (method)
traverse-document (method)
expand-macros (method)
children (method)
children (method)

Direct slots

Slot: children

The node’s children.

Type: (trivial-types:proper-list common-doc:document-node)
Initargs: :children
Readers: children (generic function)
Writers: (setf children) (generic function)

Class: define-meta-macro ()

A metadata macro.

Package

Source

macros.lisp (file)

Direct superclasses

macro-node (class)

Direct methods

expand-macro (method)
meta-macro-name (method)

Direct slots

Slot: name

The macro’s name.

Type: string
Initargs: :name
Readers: meta-macro-name (generic function)

Class: definition ()

An item in a definition list.

Package

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods

node-specific-equal (method)
node-text (method)
expand-macros (method)
definition (method)
definition (method)
term (method)
term (method)

Direct slots

Slot: term

The definition term.

Type: (trivial-types:proper-list common-doc:document-node)
Initargs: :term
Readers: term (generic function)
Writers: (setf term) (generic function)

Slot: definition

Defines the term.

Type: (trivial-types:proper-list common-doc:document-node)
Initargs: :definition
Readers: definition (generic function)
Writers: (setf definition) (generic function)

Class: definition-list ()

A list of definitions.

Package

Source

classes.lisp (file)

Direct superclasses

base-list (class)

Direct methods

children (method)
children (method)

Direct slots

Slot: children

The list of @c(definition) instances.

Type: (trivial-types:proper-list common-doc:definition)
Initargs: :children
Readers: children (generic function)
Writers: (setf children) (generic function)

Class: document ()

A document.

Metadata is mostly based on
@link[uri=https://en.wikipedia.org/wiki/Dublin_Core](Dublin Core) and the @link[uri=https://en.wikipedia.org/wiki/OpenDocument_technical_specification#Metadata](OpenDocument) format.

Package

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

print-object (method)
toc-traverse (method)
node-text (method)
traverse-document (method)
emit-to-string (method)
expand-macros (method)
created-on (method)
created-on (method)
version (method)
version (method)
rights (method)
rights (method)
language (method)
language (method)
reference (method)
reference (method)
keywords (method)
keywords (method)
description (method)
description (method)
subject (method)
subject (method)
publisher (method)
publisher (method)
creator (method)
creator (method)
title (method)
title (method)
children (method)
children (method)

Direct slots

Slot: children

The document’s children nodes.

Type: (trivial-types:proper-list common-doc:document-node)
Initargs: :children
Readers: children (generic function)
Writers: (setf children) (generic function)

Slot: title

The document’s title.

Type: string
Initargs: :title
Readers: title (generic function)
Writers: (setf title) (generic function)

Slot: creator

The creator of the document.

Type: string
Initargs: :creator
Readers: creator (generic function)
Writers: (setf creator) (generic function)

Slot: publisher

The document’s publisher.

Type: string
Initargs: :publisher
Readers: publisher (generic function)
Writers: (setf publisher) (generic function)

Slot: subject

The subject the document deals with.

Type: string
Initargs: :subject
Readers: subject (generic function)
Writers: (setf subject) (generic function)

Slot: description

A description of the document.

Type: string
Initargs: :description
Readers: description (generic function)
Writers: (setf description) (generic function)

Slot: keywords

A list of strings, each being a keyword for the document.

Type: (trivial-types:proper-list string)
Initargs: :keywords
Readers: keywords (generic function)
Writers: (setf keywords) (generic function)

Slot: reference

A reference string to uniquely identify the document within a certain context.

Type: string
Initargs: :reference
Readers: reference (generic function)
Writers: (setf reference) (generic function)

Slot: language

An @link[uri=http://www.ietf.org/rfc/rfc4646.txt](RFC4646) string denoting the language the document is written in.

Type: string
Initargs: :language
Readers: language (generic function)
Writers: (setf language) (generic function)

Slot: rights

Information on the document’s copyright.

Type: string
Initargs: :rights
Readers: rights (generic function)
Writers: (setf rights) (generic function)

Slot: version

The document version.

Type: string
Initargs: :version
Readers: version (generic function)
Writers: (setf version) (generic function)

Slot: created-on

The date and time when the document was
created. By default, this is the date and time at instance creation.

Type: local-time:timestamp
Initargs: :created-on
Initform: (local-time:now)
Readers: created-on (generic function)
Writers: (setf created-on) (generic function)

Class: document-format ()

A data format that can be parsed into a CommonDoc document, or that a document can be formatted to.

Package

common-doc.format

Source

format.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

emit-to-string (method)
emit-to-string (method)

Class: document-link ()

A link to a section of this document, to another document and
optionally a section within that document. See also the @c(reference) slot in the @c(document) class.

Package

Source

classes.lisp (file)

Direct superclasses

link (class)

Direct methods

print-object (method)
node-specific-equal (method)
node-reference (method)
node-reference (method)
document-reference (method)
document-reference (method)

Direct slots

Slot: document-reference

A reference ID for the linked document.
If @c(NIL), the link is only to a section within the document.

Type: (or null string)
Initargs: :document-reference
Readers: document-reference (generic function)
Writers: (setf document-reference) (generic function)

Slot: node-reference

A reference ID for the linked node.

Type: (or null string)
Initargs: :node-reference
Readers: node-reference (generic function)
Writers: (setf node-reference) (generic function)

Class: document-node ()

The base class of all document classes.

Package

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

content-node (class)
text-node (class)
base-list (class)
definition (class)
image (class)
figure (class)
table (class)
row (class)

Direct methods

node-equal (method)
node-specific-equal (method)
node-metadata-equal (method)
node-children-equal (method)
traverse-document (method)
emit-to-string (method)
expand-macros (method)
expand-macro (method)
reference (method)
reference (method)
metadata (method)
metadata (method)

Direct slots

Slot: metadata

Node metadata.

Type: (or null hash-table)
Initargs: :metadata
Readers: metadata (generic function)
Writers: (setf metadata) (generic function)

Slot: reference

A unique string identifying the node.

Type: (or null string)
Initargs: :reference
Readers: reference (generic function)
Writers: (setf reference) (generic function)

Class: figure ()

A figure, an image plus an annotation.

Package

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods

node-specific-equal (method)
node-text (method)
description (method)
description (method)
image (method)
image (method)

Direct slots

Slot: image

The figure’s image.

Type: common-doc:image
Initargs: :image
Readers: image (generic function)
Writers: (setf image) (generic function)

Slot: description

A description of the image.

Type: (trivial-types:proper-list common-doc:document-node)
Initargs: :description
Readers: description (generic function)
Writers: (setf description) (generic function)

Class: image ()

An image.

Package

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods

node-specific-equal (method)
node-text (method)
description (method)
description (method)
source (method)
source (method)

Direct slots

Slot: source

The source where the image is stored.

Type: string
Initargs: :source
Readers: source (generic function)
Writers: (setf source) (generic function)

Slot: description

A plain text description of the image.

Type: (or null string)
Initargs: :description
Readers: description (generic function)
Writers: (setf description) (generic function)

Class: inline-quote ()

A quote that occurs inside a paragraph in the document.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: base-quote (class)

Class: italic ()

Text in this element is italicized.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: markup (class)

Class: link ()

The base class for all links, internal and external.

Package

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Direct subclasses

document-link (class)
web-link (class)

Class: list-item ()

The item in a non-definition list.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: content-node (class)

Class: macro-node ()

A macro to be expanded.

Package

Source

macros.lisp (file)

Direct superclasses

content-node (class)

Direct subclasses

define-meta-macro (class)

Direct methods

expand-macro (method)
name (method)
name (method)

Direct slots

Slot: name

The name of the macro.

Type: string
Initargs: :name
Readers: name (generic function)
Writers: (setf name) (generic function)

Class: markup ()

The superclass of all inline markup elements.

Package

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Direct subclasses

bold (class)
italic (class)
underline (class)
strikethrough (class)
code (class)
superscript (class)
subscript (class)

Class: ordered-list ()

A list where the elements are ordered.

Package

Source

classes.lisp (file)

Direct superclasses

base-list (class)

Direct methods

children (method)
children (method)

Direct slots

Slot: children

The list of @c(list-item) instances.

Type: (trivial-types:proper-list common-doc:list-item)
Initargs: :children
Readers: children (generic function)
Writers: (setf children) (generic function)

Class: paragraph ()

A paragraph.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: content-node (class)

Class: row ()

A row in a table.

Package

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods

node-text (method)
cells (method)
cells (method)
footer (method)
footer (method)
header (method)
header (method)

Direct slots

Slot: header

The row header.

Type: (trivial-types:proper-list common-doc:document-node)
Initargs: :header
Readers: header (generic function)
Writers: (setf header) (generic function)

Slot: footer

The row footer.

Type: (trivial-types:proper-list common-doc:document-node)
Initargs: :footer
Readers: footer (generic function)
Writers: (setf footer) (generic function)

Slot: cells

The cells in the row.

Type: (trivial-types:proper-list common-doc:cell)
Initargs: :cells
Readers: cells (generic function)
Writers: (setf cells) (generic function)

Class: section ()

Represents a section in the document. Unlike HTML, where a
section is just another element, sections in CommonDoc contain their contents.

Package

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Direct methods

print-object (method)
node-specific-equal (method)
toc-traverse (method)
node-text (method)
title (method)
title (method)

Direct slots

Slot: title

The section title.

Type: (trivial-types:proper-list common-doc:document-node)
Initargs: :title
Readers: title (generic function)
Writers: (setf title) (generic function)

Class: strikethrough ()

Text in this element is striked out.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: markup (class)

Class: subscript ()

Text in this element is subscripted relative to containing elements.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: markup (class)

Class: superscript ()

Text in this element is superscripted relative to containing elements.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: markup (class)

Class: table ()

A table.

Package

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods

node-text (method)
rows (method)
rows (method)

Direct slots

Slot: rows

The list of rows in a table.

Type: (trivial-types:proper-list common-doc:row)
Initargs: :rows
Readers: rows (generic function)
Writers: (setf rows) (generic function)

Class: text-node ()

A node representing a bare string of text.

Package

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods

print-object (method)
node-specific-equal (method)
node-text (method)
text (method)
text (method)

Direct slots

Slot: text

The node’s text.

Type: string
Initargs: :text
Readers: text (generic function)
Writers: (setf text) (generic function)

Class: underline ()

Text in this element is underlined.

Package: common-doc
Source: classes.lisp (file)
Direct superclasses: markup (class)

Class: unordered-list ()

A list where the elements are unordered.

Package

Source

classes.lisp (file)

Direct superclasses

base-list (class)

Direct methods

children (method)
children (method)

Direct slots

Slot: children

The list of @c(list-item) instances.

Type: (trivial-types:proper-list common-doc:list-item)
Initargs: :children
Readers: children (generic function)
Writers: (setf children) (generic function)

Class: web-link ()

An external link.

Package

Source

classes.lisp (file)

Direct superclasses

link (class)

Direct methods

node-specific-equal (method)
uri (method)
uri (method)

Direct slots

Slot: uri

The URI of the external resource.

Type: quri.uri:uri
Initargs: :uri
Readers: uri (generic function)
Writers: (setf uri) (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *meta-macros*

A hash table of metadata macros to their definition.

Package: common-doc.macro
Source: macros.lisp (file)

Special Variable: *node-slots*

Package: common-doc
Source: define.lisp (file)

Special Variable: *registry*

A hash table from tag names to node classes.

Package: common-doc
Source: define.lisp (file)

6.2.2 Functions

Function: %expand-macros NODE

Package: common-doc.macro
Source: macros.lisp (file)

Function: construct CLASS CHILDREN METADATA REFERENCE

Instantiate a class with children and metadata.

Package: common-doc
Source: constructors.lisp (file)

Function: extract NODE

Package: common-doc.ops
Source: toc.lisp (file)

Function: filter-depth NODE MAX-DEPTH

Remove all nodes deeper than max-depth.

Package: common-doc.ops
Source: toc.lisp (file)

Function: hash-table-equal TABLE-A TABLE-B

Check whether two hash tables are equal.

Package: common-doc.ops
Source: equality.lisp (file)

Function: hash-table-key-equal TABLE-A TABLE-B

Check whether two hash tables have the same keys.

Package: common-doc.ops
Source: equality.lisp (file)

Function: node-list-equal LIST-A LIST-B

Package: common-doc.ops
Source: equality.lisp (file)

Function: un-nest NODE

Remove unnecessary nesting, ie: (((A))) => (A).

Package: common-doc.ops
Source: toc.lisp (file)

6.2.3 Generic functions

Generic Function: meta-macro-name OBJECT

Package

Methods

Method: meta-macro-name (DEFINE-META-MACRO define-meta-macro)

The macro’s name.

Source: macros.lisp (file)

Generic Function: node-children-equal NODE-A NODE-B

Package

Methods

Method: node-children-equal (NODE-A document-node) (NODE-B document-node)

Recursively check for equality in the children of a node.

Source: equality.lisp (file)

Generic Function: node-metadata-equal NODE-A NODE-B

Package

Methods

Method: node-metadata-equal (NODE-A document-node) (NODE-B document-node)

Check whether two nodes have the same metadata.

Source: equality.lisp (file)

Generic Function: node-text NODE

Extract a string with all the text inside a node.

Package

Source

text.lisp (file)

Methods

Method: node-text (DOC document): Extract text from a document.

Method: node-text (SECTION section): Extract text from a section.

Method: node-text (TABLE table): Extract text from a table.

Method: node-text (ROW row): Extract text from a row of cells.

Method: node-text (FIG figure): Extract the description from a figure.

Method: node-text (IMAGE image): Extract the description from an image.

Method: node-text (DEF definition): Extract text from a definition.

Method: node-text (TEXT text-node): Extract text from a text node.

Method: node-text (LIST list): Extract text from a list of nodes.

Method: node-text (NODE base-list): Extract text from a content node.

Method: node-text (NODE content-node): Extract text from a content node.

Generic Function: toc-traverse NODE

A function that traverses a document tree looking for section nodes.

Package