The common-doc Reference Manual

4.1.1 common-doc/common-doc.asd

Source

common-doc.asd.

Parent Component

common-doc (system).

ASDF Systems

common-doc.

---

4.1.2 common-doc/src/packages.lisp

Source

common-doc.asd.

Parent Component

src (module).

Packages

• common-doc.util.
• common-doc.
• common-doc.file.
• common-doc.error.
• common-doc.ops.
• common-doc.macro.
• common-doc.format.

---

4.1.3 common-doc/src/define.lisp

Dependency

packages.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

• define-node (macro).
• find-node (function).
• find-special-slots (function).
• find-tag (function).

Internals

• *node-slots* (special variable).
• *registry* (special variable).

---

4.1.4 common-doc/src/error.lisp

Dependency

define.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

• common-doc-error (condition).
• macro-error (condition).
• no-macro-expander (condition).
• node (reader method).
• (setf node) (writer method).

---

4.1.5 common-doc/src/file.lisp

Dependency

error.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

• *base-directory* (special variable).
• absolute-path (function).
• relativize-pathname (function).

---

4.1.6 common-doc/src/classes.lisp

Dependency

file.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

• base-list (class).
• base-quote (class).
• block-quote (class).
• bold (class).
• cell (class).
• cells (reader method).
• (setf cells) (writer method).
• children (reader method).
• children (reader method).
• children (reader method).
• children (reader method).
• children (reader method).
• (setf children) (writer method).
• (setf children) (writer method).
• (setf children) (writer method).
• (setf children) (writer method).
• (setf children) (writer method).
• code (class).
• code-block (class).
• content-node (class).
• created-on (reader method).
• (setf created-on) (writer method).
• creator (reader method).
• (setf creator) (writer method).
• definition (reader method).
• (setf definition) (writer method).
• definition (class).
• definition-list (class).
• description (reader method).
• description (reader method).
• description (reader method).
• (setf description) (writer method).
• (setf description) (writer method).
• (setf description) (writer method).
• document (class).
• document-link (class).
• document-node (class).
• document-reference (reader method).
• (setf document-reference) (writer method).
• figure (class).
• footer (reader method).
• (setf footer) (writer method).
• header (reader method).
• (setf header) (writer method).
• image (reader method).
• (setf image) (writer method).
• image (class).
• inline-quote (class).
• italic (class).
• keywords (reader method).
• (setf keywords) (writer method).
• language (reader method).
• language (reader method).
• (setf language) (writer method).
• (setf language) (writer method).
• link (class).
• list-item (class).
• markup (class).
• metadata (reader method).
• (setf metadata) (writer method).
• node-reference (reader method).
• (setf node-reference) (writer method).
• ordered-list (class).
• paragraph (class).
• publisher (reader method).
• (setf publisher) (writer method).
• reference (reader method).
• reference (reader method).
• (setf reference) (writer method).
• (setf reference) (writer method).
• rights (reader method).
• (setf rights) (writer method).
• row (class).
• rows (reader method).
• (setf rows) (writer method).
• section (class).
• source (reader method).
• (setf source) (writer method).
• strikethrough (class).
• subject (reader method).
• (setf subject) (writer method).
• subscript (class).
• superscript (class).
• table (class).
• term (reader method).
• (setf term) (writer method).
• text (reader method).
• (setf text) (writer method).
• text-node (class).
• title (reader method).
• title (reader method).
• (setf title) (writer method).
• (setf title) (writer method).
• underline (class).
• unordered-list (class).
• uri (reader method).
• (setf uri) (writer method).
• version (reader method).
• (setf version) (writer method).
• web-link (class).

---

4.1.7 common-doc/src/metadata.lisp

Dependency

classes.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

• do-meta (macro).
• get-meta (function).
• (setf get-meta) (function).
• make-meta (function).

---

4.1.8 common-doc/src/constructors.lisp

Dependency

metadata.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

• make-block-quote (function).
• make-bold (function).
• make-cell (function).
• make-code (function).
• make-code-block (function).
• make-content (function).
• make-definition (function).
• make-definition-list (function).
• make-document (function).
• make-document-link (function).
• make-figure (function).
• make-image (function).
• make-inline-quote (function).
• make-italic (function).
• make-list-item (function).
• make-ordered-list (function).
• make-paragraph (function).
• make-row (function).
• make-section (function).
• make-strikethrough (function).
• make-subscript (function).
• make-superscript (function).
• make-table (function).
• make-text (function).
• make-underline (function).
• make-unordered-list (function).
• make-web-link (function).

Internals

construct (function).

---

4.1.9 common-doc/src/macros.lisp

Dependency

constructors.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

• define-meta-macro (class).
• expand-macro (generic function).
• expand-macros (generic function).
• macro-node (class).
• name (reader method).
• (setf name) (writer method).

Internals

• %expand-macros (function).
• *meta-macros* (special variable).
• meta-macro-name (reader method).

---

4.1.10 common-doc/src/format.lisp

Dependency

macros.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

• document-format (class).
• emit-document (generic function).
• emit-to-string (method).
• emit-to-string (method).
• parse-document (generic function).

---

4.1.11 common-doc/src/util.lisp

Dependency

format.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

string-to-slug (function).

---

4.1.12 common-doc/src/operations/traverse.lisp

Source

common-doc.asd.

Parent Component

operations (module).

Public Interface

• traverse-document (generic function).
• with-document-traversal (macro).

---

4.1.13 common-doc/src/operations/figures.lisp

Dependency

traverse.lisp (file).

Source

common-doc.asd.

Parent Component

operations (module).

Public Interface

• collect-figures (function).
• collect-images (function).

---

4.1.14 common-doc/src/operations/tables.lisp

Dependency

figures.lisp (file).

Source

common-doc.asd.

Parent Component

operations (module).

Public Interface

collect-tables (function).

---

4.1.15 common-doc/src/operations/links.lisp

Dependency

tables.lisp (file).

Source

common-doc.asd.

Parent Component

operations (module).

Public Interface

collect-external-links (function).

---

4.1.16 common-doc/src/operations/text.lisp

Dependency

links.lisp (file).

Source

common-doc.asd.

Parent Component

operations (module).

Public Interface

collect-all-text (function).

Internals

node-text (generic function).

---

4.1.17 common-doc/src/operations/unique-ref.lisp

Dependency

text.lisp (file).

Source

common-doc.asd.

Parent Component

operations (module).

Public Interface

fill-unique-refs (function).

---

4.1.18 common-doc/src/operations/toc.lisp

Dependency

unique-ref.lisp (file).

Source

common-doc.asd.

Parent Component

operations (module).

Public Interface

table-of-contents (function).

Internals

• extract (function).
• filter-depth (function).
• toc-traverse (generic function).
• un-nest (function).

---

4.1.19 common-doc/src/operations/equality.lisp

Dependency

toc.lisp (file).

Source

common-doc.asd.

Parent Component

operations (module).

Public Interface

• node-equal (generic function).
• node-specific-equal (generic function).

Internals

• hash-table-equal (function).
• hash-table-key-equal (function).
• node-children-equal (method).
• node-list-equal (function).
• node-metadata-equal (method).

---

4.1.20 common-doc/src/print.lisp

Dependency

operations (module).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

• dump (function).
• dump-to-string (function).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).
• print-object (method).

---

6.1.1 Special variables

Special Variable: *base-directory* ¶

The directory all resources with relative paths are based from. This is intended to be bound by a @c(let) by specific input formats.

Package

common-doc.file.

Source

file.lisp.

---

6.1.2 Macros

Macro: define-node (name (&rest superclasses) slots &body class-options) ¶

Define a CommonDoc node.

Package

common-doc.

Source

define.lisp.

Macro: do-meta ((key value node) &body body) ¶

Iterate over the keys and values of a node’s metadata.

Package

common-doc.

Source

metadata.lisp.

Macro: with-document-traversal ((doc node &optional depth) &body body) ¶

Execute @cl:param(body) in each @cl:param(node) of the document.

Package

common-doc.ops.

Source

traverse.lisp.

---

6.1.3 Ordinary functions

Function: absolute-path (pathname-or-string) ¶

Take a pathname or namestring. If it’s absolute, return it, otherwise, merge it with @c(*base-directory*).

Package

common-doc.file.

Source

file.lisp.

Function: collect-all-text (doc-or-node) ¶

Return all the text from a node or document.

Package

common-doc.ops.

Source

text.lisp.

Function: collect-external-links (doc-or-node) ¶

Return a list of external links in the document.

Package

common-doc.ops.

Source

links.lisp.

Function: collect-figures (doc-or-node) ¶

Return a list of figures in the document.

Package

common-doc.ops.

Source

figures.lisp.

Function: collect-images (doc-or-node) ¶

Return a list of images in the document.

Package

common-doc.ops.

Source

figures.lisp.

Function: collect-tables (doc-or-node) ¶

Return a list of tables in the document.

Package

common-doc.ops.

Source

tables.lisp.

Function: dump (node &optional stream) ¶

Write the tree structure of the document tree to a stream.

Package

common-doc.

Source

print.lisp.

Function: dump-to-string (node) ¶

Write the tree structure of the document tree to a string.

Package

common-doc.

Source

print.lisp.

Function: fill-unique-refs (doc-or-node) ¶

Recur through a document, giving unique reference IDs to each section.

Package

common-doc.ops.

Source

unique-ref.lisp.

Function: find-node (tag-name) ¶

Find a node class by its tag name.

Package

common-doc.

Source

define.lisp.

Function: find-special-slots (class) ¶

Return a node class’ special slots.

Package

common-doc.

Source

define.lisp.

Function: find-tag (class) ¶

Return a node class’ tag name.

Package

common-doc.

Source

define.lisp.

Function: get-meta (node key) ¶

Find the value corresponding to @cl:param(key) in the node’s metadata. If not found, return @c(NIL).

Package

common-doc.

Source

metadata.lisp.

Function: (setf get-meta) (node key) ¶

Package

common-doc.

Source

metadata.lisp.

Function: make-block-quote (children &key metadata reference) ¶

Create a block quote node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-bold (children &key metadata reference) ¶

Create a bold node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-cell (children &key metadata reference) ¶

Create a cell from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-code (children &key metadata reference) ¶

Create an inline code node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-code-block (language children &key metadata reference) ¶

Create a code block node from its children and language.

Package

common-doc.

Source

constructors.lisp.

Function: make-content (children &key metadata reference) ¶

Create a content node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-definition (term definition &key metadata reference) ¶

Create a definition list item.

Package

common-doc.

Source

constructors.lisp.

Function: make-definition-list (children &key metadata reference) ¶

Create a definition list.

Package

common-doc.

Source

constructors.lisp.

Function: make-document (title &key children keywords &allow-other-keys) ¶

Create a document.

Package

common-doc.

Source

constructors.lisp.

Function: make-document-link (document reference children &key metadata) ¶

Create a document link from document and node references and its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-figure (image description &key metadata reference) ¶

Create a figure.

Package

common-doc.

Source

constructors.lisp.

Function: make-image (source &key description metadata reference) ¶

Create an image.

Package

common-doc.

Source

constructors.lisp.

Function: make-inline-quote (children &key metadata reference) ¶

Create an inline quote node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-italic (children &key metadata reference) ¶

Create an italicized node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-list-item (children &key metadata reference) ¶

Create a list item.

Package

common-doc.

Source

constructors.lisp.

Function: make-meta (pairs) ¶

Create a metadata table from a list of pairs. If the list is empty, return an empty metadata table.

Package

common-doc.

Source

metadata.lisp.

Function: make-ordered-list (children &key metadata reference) ¶

Create an ordered list.

Package

common-doc.

Source

constructors.lisp.

Function: make-paragraph (children &key metadata reference) ¶

Create a paragraph node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-row (cells &key metadata reference) ¶

Create a row from a list of cells.

Package

common-doc.

Source

constructors.lisp.

Function: make-section (title &key children reference metadata) ¶

Create a section from its title and children.

Package

common-doc.

Source

constructors.lisp.

Function: make-strikethrough (children &key metadata reference) ¶

Create an striked out node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-subscript (children &key metadata reference) ¶

Create a subscripted node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-superscript (children &key metadata reference) ¶

Create a superscripted node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-table (rows &key metadata reference) ¶

Create a table from a list of rows.

Package

common-doc.

Source

constructors.lisp.

Function: make-text (string &key metadata reference) ¶

Create a text node from the contents of a string.

Package

common-doc.

Source

constructors.lisp.

Function: make-underline (children &key metadata reference) ¶

Create an underlined node from its children.

Package

common-doc.

Source

constructors.lisp.

Function: make-unordered-list (children &key metadata reference) ¶

Create an unordered list.

Package

common-doc.

Source

constructors.lisp.

Function: make-web-link (uri children &key metadata reference) ¶

Create a web link.

Package

common-doc.

Source

constructors.lisp.

Function: relativize-pathname (pathname) ¶

If a pathname is inside @c(*base-directory*), return a relative pathname. Otherwise, return the pathname unchanged.

Package

common-doc.file.

Source

file.lisp.

Function: string-to-slug (string) ¶

Take a string, usually the name of a section, and create something that is more similar to an identifier, i.e. no spaces, same case, etc.

Package

common-doc.util.

Source

util.lisp.

Function: table-of-contents (doc-or-node &key max-depth) ¶

Extract a tree of document links representing the table of contents of a document. All the sections in the document must have references, so you should call fill-unique-refs first.

Package

common-doc.ops.

Source

toc.lisp.

---

6.1.4 Generic functions

Generic Reader: cells (object) ¶

Generic Writer: (setf cells) (object) ¶

Package

common-doc.

Methods

Reader Method: cells ((row row)) ¶

Writer Method: (setf cells) ((row row)) ¶

The cells in the row.

Source

classes.lisp.

Target Slot

cells.

Generic Reader: children (object) ¶

Generic Writer: (setf children) (object) ¶

Package

common-doc.

Methods

Reader Method: children ((document document)) ¶

Writer Method: (setf children) ((document document)) ¶

The document’s children nodes.

Source

classes.lisp.

Target Slot

children.

Reader Method: children ((definition-list definition-list)) ¶

Writer Method: (setf children) ((definition-list definition-list)) ¶

The list of @c(definition) instances.

Source

classes.lisp.

Target Slot

children.

Reader Method: children ((ordered-list ordered-list)) ¶

Writer Method: (setf children) ((ordered-list ordered-list)) ¶

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

Source

classes.lisp.

Target Slot

children.

Reader Method: children ((unordered-list unordered-list)) ¶

Writer Method: (setf children) ((unordered-list unordered-list)) ¶

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

Source

classes.lisp.

Target Slot

children.

Reader Method: children ((content-node content-node)) ¶

Writer Method: (setf children) ((content-node content-node)) ¶

The node’s children.

Source

classes.lisp.

Target Slot

children.

Generic Reader: created-on (object) ¶

Generic Writer: (setf created-on) (object) ¶

Package

common-doc.

Methods

Reader Method: created-on ((document document)) ¶

Writer Method: (setf created-on) ((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.

Target Slot

created-on.

Generic Reader: creator (object) ¶

Generic Writer: (setf creator) (object) ¶

Package

common-doc.

Methods

Reader Method: creator ((document document)) ¶

Writer Method: (setf creator) ((document document)) ¶

The creator of the document.

Source

classes.lisp.

Target Slot

creator.

Generic Reader: definition (object) ¶

Generic Writer: (setf definition) (object) ¶

Package

common-doc.

Methods

Reader Method: definition ((definition definition)) ¶

Writer Method: (setf definition) ((definition definition)) ¶

Defines the term.

Source

classes.lisp.

Target Slot

definition.

Generic Reader: description (object) ¶

Generic Writer: (setf description) (object) ¶

Package

common-doc.

Methods

Reader Method: description ((document document)) ¶

Writer Method: (setf description) ((document document)) ¶

A description of the document.

Source

classes.lisp.

Target Slot

description.

Reader Method: description ((figure figure)) ¶

Writer Method: (setf description) ((figure figure)) ¶

A description of the image.

Source

classes.lisp.

Target Slot

description.

Reader Method: description ((image image)) ¶

Writer Method: (setf description) ((image image)) ¶

A plain text description of the image.

Source

classes.lisp.

Target Slot

description.

Generic Reader: document-reference (object) ¶

Generic Writer: (setf document-reference) (object) ¶

Package

common-doc.

Methods

Reader Method: document-reference ((document-link document-link)) ¶

Writer Method: (setf document-reference) ((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.

Target Slot

document-reference.

Generic Function: emit-document (document-format document stream) ¶

Dump a CommonDoc document into a stream.

Package

common-doc.format.

Source

format.lisp.

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.

Method: emit-to-string ((format document-format) (document document)) ¶

Source

format.lisp.

Generic Function: expand-macro (node) ¶

Replace a macro node with a primitive node.

Package

common-doc.macro.

Source

macros.lisp.

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

common-doc.macro.

Source

macros.lisp.

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 Reader: footer (object) ¶

Generic Writer: (setf footer) (object) ¶

Package

common-doc.

Methods

Reader Method: footer ((row row)) ¶

Writer Method: (setf footer) ((row row)) ¶

The row footer.

Source

classes.lisp.

Target Slot

footer.

Generic Reader: header (object) ¶

Generic Writer: (setf header) (object) ¶

Package

common-doc.

Methods

Reader Method: header ((row row)) ¶

Writer Method: (setf header) ((row row)) ¶

The row header.

Source

classes.lisp.

Target Slot

header.

Generic Reader: image (object) ¶

Generic Writer: (setf image) (object) ¶

Package

common-doc.

Methods

Reader Method: image ((figure figure)) ¶

Writer Method: (setf image) ((figure figure)) ¶

The figure’s image.

Source

classes.lisp.

Target Slot

image.

Generic Reader: keywords (object) ¶

Generic Writer: (setf keywords) (object) ¶

Package

common-doc.

Methods

Reader Method: keywords ((document document)) ¶

Writer Method: (setf keywords) ((document document)) ¶

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

Source

classes.lisp.

Target Slot

keywords.

Generic Reader: language (object) ¶

Generic Writer: (setf language) (object) ¶

Package

common-doc.

Methods

Reader Method: language ((document document)) ¶

Writer Method: (setf language) ((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.

Target Slot

language.

Reader Method: language ((code-block code-block)) ¶

Writer Method: (setf language) ((code-block code-block)) ¶

The language of the code block’s contents.

Source

classes.lisp.

Target Slot

language.

Generic Reader: metadata (object) ¶

Generic Writer: (setf metadata) (object) ¶

Package

common-doc.

Methods

Reader Method: metadata ((document-node document-node)) ¶

Writer Method: (setf metadata) ((document-node document-node)) ¶

Node metadata.

Source

classes.lisp.

Target Slot

metadata.

Generic Reader: name (object) ¶

Generic Writer: (setf name) (object) ¶

Package

common-doc.macro.

Methods

Reader Method: name ((macro-node macro-node)) ¶

Writer Method: (setf name) ((macro-node macro-node)) ¶

The name of the macro.

Source

macros.lisp.

Target Slot

name.

Generic Reader: node (condition) ¶

Generic Writer: (setf node) (condition) ¶

Package

common-doc.error.

Methods

Reader Method: node ((condition no-macro-expander)) ¶

Writer Method: (setf node) ((condition no-macro-expander)) ¶

Source

error.lisp.

Target Slot

node.

Generic Function: node-equal (node-a node-b) ¶

Recursively check whether two nodes are equal.

Package

common-doc.ops.

Source

equality.lisp.

Methods

Method: node-equal ((node-a document-node) (node-b document-node)) ¶

Generic Reader: node-reference (object) ¶

Generic Writer: (setf node-reference) (object) ¶

Package

common-doc.

Methods

Reader Method: node-reference ((document-link document-link)) ¶

Writer Method: (setf node-reference) ((document-link document-link)) ¶

A reference ID for the linked node.

Source

classes.lisp.

Target Slot

node-reference.

Generic Function: node-specific-equal (node-a node-b) ¶

Use this method to make node equality more specific.

Package

common-doc.ops.

Source

equality.lisp.

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.

Generic Reader: publisher (object) ¶

Generic Writer: (setf publisher) (object) ¶

Package

common-doc.

Methods

Reader Method: publisher ((document document)) ¶

Writer Method: (setf publisher) ((document document)) ¶

The document’s publisher.

Source

classes.lisp.

Target Slot

publisher.

Generic Reader: reference (object) ¶

Generic Writer: (setf reference) (object) ¶

Package

common-doc.

Methods

Reader Method: reference ((document document)) ¶

Writer Method: (setf reference) ((document document)) ¶

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

Source

classes.lisp.

Target Slot

reference.

Reader Method: reference ((document-node document-node)) ¶

Writer Method: (setf reference) ((document-node document-node)) ¶

A unique string identifying the node.

Source

classes.lisp.

Target Slot

reference.

Generic Reader: rights (object) ¶

Generic Writer: (setf rights) (object) ¶

Package

common-doc.

Methods

Reader Method: rights ((document document)) ¶

Writer Method: (setf rights) ((document document)) ¶

Information on the document’s copyright.

Source

classes.lisp.

Target Slot

rights.

Generic Reader: rows (object) ¶

Generic Writer: (setf rows) (object) ¶

Package

common-doc.

Methods

Reader Method: rows ((table table)) ¶

Writer Method: (setf rows) ((table table)) ¶

The list of rows in a table.

Source

classes.lisp.

Target Slot

rows.

Generic Reader: source (object) ¶

Generic Writer: (setf source) (object) ¶

Package

common-doc.

Methods

Reader Method: source ((image image)) ¶

Writer Method: (setf source) ((image image)) ¶

The source where the image is stored.

Source

classes.lisp.

Target Slot

source.

Generic Reader: subject (object) ¶

Generic Writer: (setf subject) (object) ¶

Package

common-doc.

Methods

Reader Method: subject ((document document)) ¶

Writer Method: (setf subject) ((document document)) ¶

The subject the document deals with.

Source

classes.lisp.

Target Slot

subject.

Generic Reader: term (object) ¶

Generic Writer: (setf term) (object) ¶

Package

common-doc.

Methods

Reader Method: term ((definition definition)) ¶

Writer Method: (setf term) ((definition definition)) ¶

The definition term.

Source

classes.lisp.

Target Slot

term.

Generic Reader: text (object) ¶

Generic Writer: (setf text) (object) ¶

Package

common-doc.

Methods

Reader Method: text ((text-node text-node)) ¶

Writer Method: (setf text) ((text-node text-node)) ¶

The node’s text.

Source

classes.lisp.

Target Slot

text.

Generic Reader: title (object) ¶

Generic Writer: (setf title) (object) ¶

Package

common-doc.

Methods

Reader Method: title ((document document)) ¶

Writer Method: (setf title) ((document document)) ¶

The document’s title.

Source

classes.lisp.

Target Slot

title.

Reader Method: title ((section section)) ¶

Writer Method: (setf title) ((section section)) ¶

The section title.

Source

classes.lisp.

Target Slot

title.

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

common-doc.ops.

Source

traverse.lisp.

Methods

Method: traverse-document ((doc document) function &optional depth) ¶

Method: traverse-document ((cnode content-node) function &optional depth) ¶

Method: traverse-document ((node base-list) function &optional depth) ¶

Method: traverse-document ((dnode document-node) function &optional depth) ¶

Generic Reader: uri (object) ¶

Generic Writer: (setf uri) (object) ¶

Package

common-doc.

Methods

Reader Method: uri ((web-link web-link)) ¶

Writer Method: (setf uri) ((web-link web-link)) ¶

The URI of the external resource.

Source

classes.lisp.

Target Slot

uri.

Generic Reader: version (object) ¶

Generic Writer: (setf version) (object) ¶

Package

common-doc.

Methods

Reader Method: version ((document document)) ¶

Writer Method: (setf version) ((document document)) ¶

The document version.

Source

classes.lisp.

Target Slot

version.

---

6.1.5 Standalone methods

Method: print-object ((doc document) stream) ¶

Print a document.

Source

print.lisp.

Method: print-object ((node section) stream) ¶

Print a section.

Source

print.lisp.

Method: print-object ((node content-node) stream) ¶

Print an arbitrary content-node.

Source

print.lisp.

Method: print-object ((node text-node) stream) ¶

Print a text-node.

Source

print.lisp.

Method: print-object ((node document-link) stream) ¶

Print a text-node.

Source

print.lisp.

Method: print-object ((node base-list) stream) ¶

Print a list.

Source

print.lisp.

---

6.1.6 Conditions

Condition: common-doc-error ¶

The base class of all CommonDoc errors.

Package

common-doc.error.

Source

error.lisp.

Direct superclasses

simple-error.

Direct subclasses

macro-error.

Condition: macro-error ¶

The base class of all macro-related errors.

Package

common-doc.error.

Source

error.lisp.

Direct superclasses

common-doc-error.

Direct subclasses

no-macro-expander.

Condition: no-macro-expander ¶

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

Package

common-doc.error.

Source

error.lisp.

Direct superclasses

macro-error.

Direct methods

• (setf node).
• node.

Direct slots

Slot: node ¶

The node that couldn’t be expanded.

Initargs

:node

Readers

node.

Writers

(setf node).

---

6.1.7 Classes

Class: base-list ¶

The base class of all lists.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

document-node.

Direct subclasses

• definition-list.
• ordered-list.
• unordered-list.

Direct methods

• expand-macros.
• node-text.
• print-object.
• traverse-document.

Class: base-quote ¶

The base class of all quotes.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

content-node.

Direct subclasses

• block-quote.
• inline-quote.

Class: block-quote ¶

A block quote.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

base-quote.

Class: bold ¶

Text in this element is bold.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

markup.

Class: cell ¶

A cell in a table.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

content-node.

Class: code ¶

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

Package

common-doc.

Source

classes.lisp.

Direct superclasses

markup.

Class: code-block ¶

A block of code.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

content-node.

Direct methods

• (setf language).
• language.
• node-specific-equal.

Direct slots

Slot: language ¶

The language of the code block’s contents.

Type

(or null string)

Initargs

:language

Readers

language.

Writers

(setf language).

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

common-doc.

Source

classes.lisp.

Direct superclasses

document-node.

Direct subclasses

• base-quote.
• cell.
• code-block.
• link.
• list-item.
• macro-node.
• markup.
• paragraph.
• section.

Direct methods

• (setf children).
• children.
• expand-macros.
• node-text.
• print-object.
• toc-traverse.
• traverse-document.

Direct slots

Slot: children ¶

The node’s children.

Type

(trivial-types:proper-list common-doc:document-node)

Initargs

:children

Readers

children.

Writers

(setf children).

Class: define-meta-macro ¶

A metadata macro.

Package

common-doc.macro.

Source

macros.lisp.

Direct superclasses

macro-node.

Direct methods

• expand-macro.
• meta-macro-name.

Direct slots

Slot: name ¶

The macro’s name.

Type

string

Initargs

:name

Readers

meta-macro-name.

Writers

This slot is read-only.

Class: definition ¶

An item in a definition list.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

document-node.

Direct methods

• (setf definition).
• definition.
• expand-macros.
• node-specific-equal.
• node-text.
• (setf term).
• term.

Direct slots

Slot: term ¶

The definition term.

Type

(trivial-types:proper-list common-doc:document-node)

Initargs

:term

Readers

term.

Writers

(setf term).

Slot: definition ¶

Defines the term.

Type

(trivial-types:proper-list common-doc:document-node)

Initargs

:definition

Readers

definition.

Writers

(setf definition).

Class: definition-list ¶

A list of definitions.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

base-list.

Direct methods

• (setf children).
• children.

Direct slots

Slot: children ¶

The list of @c(definition) instances.

Type

(trivial-types:proper-list common-doc:definition)

Initargs

:children

Readers

children.

Writers

(setf children).

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

common-doc.

Source

classes.lisp.

Direct methods

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

Direct slots

Slot: children ¶

The document’s children nodes.

Type

(trivial-types:proper-list common-doc:document-node)

Initargs

:children

Readers

children.

Writers

(setf children).

Slot: title ¶

The document’s title.

Type

string

Initargs

:title

Readers

title.

Writers

(setf title).

Slot: creator ¶

The creator of the document.

Type

string

Initargs

:creator

Readers

creator.

Writers

(setf creator).

Slot: publisher ¶

The document’s publisher.

Type

string

Initargs

:publisher

Readers

publisher.

Writers

(setf publisher).

Slot: subject ¶

The subject the document deals with.

Type

string

Initargs

:subject

Readers

subject.

Writers

(setf subject).

Slot: description ¶

A description of the document.

Type

string

Initargs

:description

Readers

description.

Writers

(setf description).

Slot: keywords ¶

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

Type

(trivial-types:proper-list string)

Initargs

:keywords

Readers

keywords.

Writers

(setf keywords).

Slot: reference ¶

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

Type

string

Initargs

:reference

Readers

reference.

Writers

(setf reference).

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.

Writers

(setf language).

Slot: rights ¶

Information on the document’s copyright.

Type

string

Initargs

:rights

Readers

rights.

Writers

(setf rights).

Slot: version ¶

The document version.

Type

string

Initargs

:version

Readers

version.

Writers

(setf version).

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

Initform

(local-time:now)

Initargs

:created-on

Readers

created-on.

Writers

(setf created-on).

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.

Direct methods

• emit-to-string.
• emit-to-string.

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

common-doc.

Source

classes.lisp.

Direct superclasses

link.

Direct methods

• (setf document-reference).
• document-reference.
• (setf node-reference).
• node-reference.
• node-specific-equal.
• print-object.

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.

Writers

(setf document-reference).

Slot: node-reference ¶

A reference ID for the linked node.

Type

(or null string)

Initargs

:node-reference

Readers

node-reference.

Writers

(setf node-reference).

Class: document-node ¶

The base class of all document classes.

Package

common-doc.

Source

classes.lisp.

Direct subclasses

• base-list.
• content-node.
• definition.
• figure.
• image.
• row.
• table.
• text-node.

Direct methods

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

Direct slots

Slot: metadata ¶

Node metadata.

Type

(or null hash-table)

Initargs

:metadata

Readers

metadata.

Writers

(setf metadata).

Slot: reference ¶

A unique string identifying the node.

Type

(or null string)

Initargs

:reference

Readers

reference.

Writers

(setf reference).

Class: figure ¶

A figure, an image plus an annotation.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

document-node.

Direct methods

• (setf description).
• description.
• (setf image).
• image.
• node-specific-equal.
• node-text.

Direct slots

Slot: image ¶

The figure’s image.

Type

common-doc:image

Initargs

:image

Readers

image.

Writers

(setf image).

Slot: description ¶

A description of the image.

Type

(trivial-types:proper-list common-doc:document-node)

Initargs

:description

Readers

description.

Writers

(setf description).

Class: image ¶

An image.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

document-node.

Direct methods

• (setf description).
• description.
• node-specific-equal.
• node-text.
• (setf source).
• source.

Direct slots

Slot: source ¶

The source where the image is stored.

Type

string

Initargs

:source

Readers

source.

Writers

(setf source).

Slot: description ¶

A plain text description of the image.

Type

(or null string)

Initargs

:description

Readers

description.

Writers

(setf description).

Class: inline-quote ¶

A quote that occurs inside a paragraph in the document.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

base-quote.

Class: italic ¶

Text in this element is italicized.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

markup.

Class: link ¶

The base class for all links, internal and external.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

content-node.

Direct subclasses

• document-link.
• web-link.

Class: list-item ¶

The item in a non-definition list.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

content-node.

Class: macro-node ¶

A macro to be expanded.

Package

common-doc.macro.

Source

macros.lisp.

Direct superclasses

content-node.

Direct subclasses

define-meta-macro.

Direct methods

• expand-macro.
• (setf name).
• name.

Direct slots

Slot: name ¶

The name of the macro.

Type

string

Initargs

:name

Readers

name.

Writers

(setf name).

Class: markup ¶

The superclass of all inline markup elements.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

content-node.

Direct subclasses

• bold.
• code.
• italic.
• strikethrough.
• subscript.
• superscript.
• underline.

Class: ordered-list ¶

A list where the elements are ordered.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

base-list.

Direct methods

• (setf children).
• children.

Direct slots

Slot: children ¶

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

Type

(trivial-types:proper-list common-doc:list-item)

Initargs

:children

Readers

children.

Writers

(setf children).

Class: paragraph ¶

A paragraph.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

content-node.

Class: row ¶

A row in a table.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

document-node.

Direct methods

• (setf cells).
• cells.
• (setf footer).
• footer.
• (setf header).
• header.
• node-text.

Direct slots

Slot: header ¶

The row header.

Type

(trivial-types:proper-list common-doc:document-node)

Initargs

:header

Readers

header.

Writers

(setf header).

Slot: footer ¶

The row footer.

Type

(trivial-types:proper-list common-doc:document-node)

Initargs

:footer

Readers

footer.

Writers

(setf footer).

Slot: cells ¶

The cells in the row.

Type

(trivial-types:proper-list common-doc:cell)

Initargs

:cells

Readers

cells.

Writers

(setf cells).

Class: section ¶

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

Package

common-doc.

Source

classes.lisp.

Direct superclasses

content-node.

Direct methods

• node-specific-equal.
• node-text.
• print-object.
• (setf title).
• title.
• toc-traverse.

Direct slots

Slot: title ¶

The section title.

Type

(trivial-types:proper-list common-doc:document-node)

Initargs

:title

Readers

title.

Writers

(setf title).

Class: strikethrough ¶

Text in this element is striked out.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

markup.

Class: subscript ¶

Text in this element is subscripted relative to containing elements.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

markup.

Class: superscript ¶

Text in this element is superscripted relative to containing elements.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

markup.

Class: table ¶

A table.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

document-node.

Direct methods

• node-text.
• (setf rows).
• rows.

Direct slots

Slot: rows ¶

The list of rows in a table.

Type

(trivial-types:proper-list common-doc:row)

Initargs

:rows

Readers

rows.

Writers

(setf rows).

Class: text-node ¶

A node representing a bare string of text.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

document-node.

Direct methods

• node-specific-equal.
• node-text.
• print-object.
• (setf text).
• text.

Direct slots

Slot: text ¶

The node’s text.

Type

string

Initargs

:text

Readers

text.

Writers

(setf text).

Class: underline ¶

Text in this element is underlined.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

markup.

Class: unordered-list ¶

A list where the elements are unordered.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

base-list.

Direct methods

• (setf children).
• children.

Direct slots

Slot: children ¶

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

Type

(trivial-types:proper-list common-doc:list-item)

Initargs

:children

Readers

children.

Writers

(setf children).

Class: web-link ¶

An external link.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

link.

Direct methods

• node-specific-equal.
• (setf uri).
• uri.

Direct slots

Slot: uri ¶

The URI of the external resource.

Type

quri.uri:uri

Initargs

:uri

Readers

uri.

Writers

(setf uri).

---