The common-doc Reference Manual

This is the common-doc Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:53:19 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 common-doc

A framework for representing and manipulating documents as CLOS objects.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

Home Page

https://github.com/CommonDoc/common-doc

Source Control

(GIT git@github.com:CommonDoc/common-doc.git)

Bug Tracker

https://github.com/CommonDoc/common-doc/issues

License

MIT

Long Description

# CommonDoc

[![Build Status](https://travis-ci.org/CommonDoc/common-doc.svg?branch=master)](https://travis-ci.org/CommonDoc/common-doc)
[![Coverage Status](https://coveralls.io/repos/CommonDoc/common-doc/badge.svg?branch=master)](https://coveralls.io/r/CommonDoc/common-doc?branch=master)
[![Quicklisp badge](http://quickdocs.org/badge/common-doc.svg)](http://quickdocs.org/common-doc/)

A framework for representing and manipulating documents as CLOS objects.

See the [documentation](http://commondoc.github.io/docs/overview.html).

# Libraries

* [CommonHTML](https://github.com/CommonDoc/common-html) [![Build Status](https://travis-ci.org/CommonDoc/common-html.svg?branch=master)](https://travis-ci.org/CommonDoc/common-html) * [VerTeX](https://github.com/CommonDoc/vertex) [![Build Status](https://travis-ci.org/CommonDoc/vertex.svg?branch=master)](https://travis-ci.org/CommonDoc/vertex)
* [Codex](https://github.com/CommonDoc/codex) [![Build Status](https://travis-ci.org/CommonDoc/codex.svg?branch=master)](https://travis-ci.org/CommonDoc/codex)
* [ParenML](https://github.com/CommonDoc/parenml) [![Build Status](https://travis-ci.org/CommonDoc/parenml.svg?branch=master)](https://travis-ci.org/CommonDoc/parenml)
* [Thorn](https://github.com/CommonDoc/thorn) [![Build Status](https://travis-ci.org/CommonDoc/thorn.svg?branch=master)](https://travis-ci.org/CommonDoc/thorn)

# License

Copyright (c) 2014-2015 Fernando Borretti

Licensed under the MIT License.

Version

0.2

Dependencies
  • trivial-types (system).
  • local-time (system).
  • quri (system).
  • anaphora (system).
  • alexandria (system).
  • closer-mop (system).
Source

common-doc.asd.

Child Component

src (module).


3 Modules

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


3.1 common-doc/src

Source

common-doc.asd.

Parent Component

common-doc (system).

Child Components

3.2 common-doc/src/operations

Dependency

util.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Child Components

4 Files

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


4.1 Lisp


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

4.1.3 common-doc/src/define.lisp

Dependency

packages.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 common-doc/src/error.lisp

Dependency

define.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

4.1.5 common-doc/src/file.lisp

Dependency

error.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

4.1.6 common-doc/src/classes.lisp

Dependency

file.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

4.1.7 common-doc/src/metadata.lisp

Dependency

classes.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

4.1.8 common-doc/src/constructors.lisp

Dependency

metadata.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface
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
Internals

4.1.10 common-doc/src/format.lisp

Dependency

macros.lisp (file).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

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

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

Dependency

traverse.lisp (file).

Source

common-doc.asd.

Parent Component

operations (module).

Public Interface

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

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

Dependency

toc.lisp (file).

Source

common-doc.asd.

Parent Component

operations (module).

Public Interface
Internals

4.1.20 common-doc/src/print.lisp

Dependency

operations (module).

Source

common-doc.asd.

Parent Component

src (module).

Public Interface

5 Packages

Packages are listed by definition order.


5.1 common-doc.util

CommonDoc utilities.

Source

packages.lisp.

Use List
Public Interface

string-to-slug (function).


5.2 common-doc

CommonDoc classes and and accessors.

Source

packages.lisp.

Use List
  • anaphora.
  • common-lisp.
  • trivial-types.
Used By List
Public Interface
Internals

5.3 common-doc.file

File-related operations for CommonDoc.

Source

packages.lisp.

Use List

common-lisp.

Public Interface

5.4 common-doc.error

CommonDoc errors.

Source

packages.lisp.

Use List

common-lisp.

Public Interface

5.5 common-doc.ops

Common operations on CommonDoc documents.

Source

packages.lisp.

Use List
Public Interface
Internals

5.6 common-doc.macro

CommonDoc macros.

Source

packages.lisp.

Use List

common-lisp.

Public Interface
Internals

5.7 common-doc.format

CommonDoc input/output formats.

Source

packages.lisp.

Use List
Public Interface

6 Definitions

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


6.1 Public Interface


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.

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.

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.

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.

Package

common-doc.

Methods

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
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
Direct methods
Class: base-quote

The base class of all quotes.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

content-node.

Direct subclasses
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
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
Direct methods
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
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
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
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
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

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
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
Direct methods
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
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
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.

The base class for all links, internal and external.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

content-node.

Direct subclasses
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
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
Class: ordered-list

A list where the elements are ordered.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

base-list.

Direct methods
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
Direct slots
Slot: header

The row header.

Type

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

Initargs

:header

Readers

header.

Writers

(setf header).

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

An external link.

Package

common-doc.

Source

classes.lisp.

Direct superclasses

link.

Direct methods
Direct slots
Slot: uri

The URI of the external resource.

Type

quri.uri:uri

Initargs

:uri

Readers

uri.

Writers

(setf uri).


6.2 Internals


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.

Special Variable: *node-slots*
Package

common-doc.

Source

define.lisp.

Special Variable: *registry*

A hash table from tag names to node classes.

Package

common-doc.

Source

define.lisp.


6.2.2 Ordinary functions

Function: %expand-macros (node)
Package

common-doc.macro.

Source

macros.lisp.

Function: construct (class children metadata reference)

Instantiate a class with children and metadata.

Package

common-doc.

Source

constructors.lisp.

Function: extract (node)
Package

common-doc.ops.

Source

toc.lisp.

Function: filter-depth (node max-depth)

Remove all nodes deeper than max-depth.

Package

common-doc.ops.

Source

toc.lisp.

Function: hash-table-equal (table-a table-b)

Check whether two hash tables are equal.

Package

common-doc.ops.

Source

equality.lisp.

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.

Function: node-list-equal (list-a list-b)
Package

common-doc.ops.

Source

equality.lisp.

Function: un-nest (node)

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

Package

common-doc.ops.

Source

toc.lisp.


6.2.3 Generic functions

Generic Reader: meta-macro-name (object)
Package

common-doc.macro.

Methods
Reader Method: meta-macro-name ((define-meta-macro define-meta-macro))

The macro’s name.

Source

macros.lisp.

Target Slot

name.

Generic Function: node-children-equal (node-a node-b)
Package

common-doc.ops.

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.

Generic Function: node-metadata-equal (node-a node-b)
Package

common-doc.ops.

Methods
Method: node-metadata-equal ((node-a document-node) (node-b document-node))

Check whether two nodes have the same metadata.

Source

equality.lisp.

Generic Function: node-text (node)

Extract a string with all the text inside a node.

Package

common-doc.ops.

Source

text.lisp.

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

common-doc.ops.

Source

toc.lisp.

Methods
Method: toc-traverse ((doc document))
Method: toc-traverse ((node content-node))
Method: toc-traverse ((sec section))
Method: toc-traverse ((list list))
Method: toc-traverse (obj)

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   C   D   E   F   G   H   I   K   L   M   N   P   R   S   T   U   V   W  
Index Entry  Section

%
%expand-macros: Private ordinary functions

(
(setf cells): Public generic functions
(setf cells): Public generic functions
(setf children): Public generic functions
(setf children): Public generic functions
(setf children): Public generic functions
(setf children): Public generic functions
(setf children): Public generic functions
(setf children): Public generic functions
(setf created-on): Public generic functions
(setf created-on): Public generic functions
(setf creator): Public generic functions
(setf creator): Public generic functions
(setf definition): Public generic functions
(setf definition): Public generic functions
(setf description): Public generic functions
(setf description): Public generic functions
(setf description): Public generic functions
(setf description): Public generic functions
(setf document-reference): Public generic functions
(setf document-reference): Public generic functions
(setf footer): Public generic functions
(setf footer): Public generic functions
(setf get-meta): Public ordinary functions
(setf header): Public generic functions
(setf header): Public generic functions
(setf image): Public generic functions
(setf image): Public generic functions
(setf keywords): Public generic functions
(setf keywords): Public generic functions
(setf language): Public generic functions
(setf language): Public generic functions
(setf language): Public generic functions
(setf metadata): Public generic functions
(setf metadata): Public generic functions
(setf name): Public generic functions
(setf name): Public generic functions
(setf node): Public generic functions
(setf node): Public generic functions
(setf node-reference): Public generic functions
(setf node-reference): Public generic functions
(setf publisher): Public generic functions
(setf publisher): Public generic functions
(setf reference): Public generic functions
(setf reference): Public generic functions
(setf reference): Public generic functions
(setf rights): Public generic functions
(setf rights): Public generic functions
(setf rows): Public generic functions
(setf rows): Public generic functions
(setf source): Public generic functions
(setf source): Public generic functions
(setf subject): Public generic functions
(setf subject): Public generic functions
(setf term): Public generic functions
(setf term): Public generic functions
(setf text): Public generic functions
(setf text): Public generic functions
(setf title): Public generic functions
(setf title): Public generic functions
(setf title): Public generic functions
(setf uri): Public generic functions
(setf uri): Public generic functions
(setf version): Public generic functions
(setf version): Public generic functions

A
absolute-path: Public ordinary functions

C
cells: Public generic functions
cells: Public generic functions
children: Public generic functions
children: Public generic functions
children: Public generic functions
children: Public generic functions
children: Public generic functions
children: Public generic functions
collect-all-text: Public ordinary functions
collect-external-links: Public ordinary functions
collect-figures: Public ordinary functions
collect-images: Public ordinary functions
collect-tables: Public ordinary functions
construct: Private ordinary functions
created-on: Public generic functions
created-on: Public generic functions
creator: Public generic functions
creator: Public generic functions

D
define-node: Public macros
definition: Public generic functions
definition: Public generic functions
description: Public generic functions
description: Public generic functions
description: Public generic functions
description: Public generic functions
do-meta: Public macros
document-reference: Public generic functions
document-reference: Public generic functions
dump: Public ordinary functions
dump-to-string: Public ordinary functions

E
emit-document: Public generic functions
emit-to-string: Public generic functions
emit-to-string: Public generic functions
emit-to-string: Public generic functions
expand-macro: Public generic functions
expand-macro: Public generic functions
expand-macro: Public generic functions
expand-macro: Public generic functions
expand-macros: Public generic functions
expand-macros: Public generic functions
expand-macros: Public generic functions
expand-macros: Public generic functions
expand-macros: Public generic functions
expand-macros: Public generic functions
extract: Private ordinary functions

F
fill-unique-refs: Public ordinary functions
filter-depth: Private ordinary functions
find-node: Public ordinary functions
find-special-slots: Public ordinary functions
find-tag: Public ordinary functions
footer: Public generic functions
footer: Public generic functions
Function, %expand-macros: Private ordinary functions
Function, (setf get-meta): Public ordinary functions
Function, absolute-path: Public ordinary functions
Function, collect-all-text: Public ordinary functions
Function, collect-external-links: Public ordinary functions
Function, collect-figures: Public ordinary functions
Function, collect-images: Public ordinary functions
Function, collect-tables: Public ordinary functions
Function, construct: Private ordinary functions
Function, dump: Public ordinary functions
Function, dump-to-string: Public ordinary functions
Function, extract: Private ordinary functions
Function, fill-unique-refs: Public ordinary functions
Function, filter-depth: Private ordinary functions
Function, find-node: Public ordinary functions
Function, find-special-slots: Public ordinary functions
Function, find-tag: Public ordinary functions
Function, get-meta: Public ordinary functions
Function, hash-table-equal: Private ordinary functions
Function, hash-table-key-equal: Private ordinary functions
Function, make-block-quote: Public ordinary functions
Function, make-bold: Public ordinary functions
Function, make-cell: Public ordinary functions
Function, make-code: Public ordinary functions
Function, make-code-block: Public ordinary functions
Function, make-content: Public ordinary functions
Function, make-definition: Public ordinary functions
Function, make-definition-list: Public ordinary functions
Function, make-document: Public ordinary functions
Function, make-document-link: Public ordinary functions
Function, make-figure: Public ordinary functions
Function, make-image: Public ordinary functions
Function, make-inline-quote: Public ordinary functions
Function, make-italic: Public ordinary functions
Function, make-list-item: Public ordinary functions
Function, make-meta: Public ordinary functions
Function, make-ordered-list: Public ordinary functions
Function, make-paragraph: Public ordinary functions
Function, make-row: Public ordinary functions
Function, make-section: Public ordinary functions
Function, make-strikethrough: Public ordinary functions
Function, make-subscript: Public ordinary functions
Function, make-superscript: Public ordinary functions
Function, make-table: Public ordinary functions
Function, make-text: Public ordinary functions
Function, make-underline: Public ordinary functions
Function, make-unordered-list: Public ordinary functions
Function, make-web-link: Public ordinary functions
Function, node-list-equal: Private ordinary functions
Function, relativize-pathname: Public ordinary functions
Function, string-to-slug: Public ordinary functions
Function, table-of-contents: Public ordinary functions
Function, un-nest: Private ordinary functions

G
Generic Function, (setf cells): Public generic functions
Generic Function, (setf children): Public generic functions
Generic Function, (setf created-on): Public generic functions
Generic Function, (setf creator): Public generic functions
Generic Function, (setf definition): Public generic functions
Generic Function, (setf description): Public generic functions
Generic Function, (setf document-reference): Public generic functions
Generic Function, (setf footer): Public generic functions
Generic Function, (setf header): Public generic functions
Generic Function, (setf image): Public generic functions
Generic Function, (setf keywords): Public generic functions
Generic Function, (setf language): Public generic functions
Generic Function, (setf metadata): Public generic functions
Generic Function, (setf name): Public generic functions
Generic Function, (setf node): Public generic functions
Generic Function, (setf node-reference): Public generic functions
Generic Function, (setf publisher): Public generic functions
Generic Function, (setf reference): Public generic functions
Generic Function, (setf rights): Public generic functions
Generic Function, (setf rows): Public generic functions
Generic Function, (setf source): Public generic functions
Generic Function, (setf subject): Public generic functions
Generic Function, (setf term): Public generic functions
Generic Function, (setf text): Public generic functions
Generic Function, (setf title): Public generic functions
Generic Function, (setf uri): Public generic functions
Generic Function, (setf version): Public generic functions
Generic Function, cells: Public generic functions
Generic Function, children: Public generic functions
Generic Function, created-on: Public generic functions
Generic Function, creator: Public generic functions
Generic Function, definition: Public generic functions
Generic Function, description: Public generic functions
Generic Function, document-reference: Public generic functions
Generic Function, emit-document: Public generic functions
Generic Function, emit-to-string: Public generic functions
Generic Function, expand-macro: Public generic functions
Generic Function, expand-macros: Public generic functions
Generic Function, footer: Public generic functions
Generic Function, header: Public generic functions
Generic Function, image: Public generic functions
Generic Function, keywords: Public generic functions
Generic Function, language: Public generic functions
Generic Function, meta-macro-name: Private generic functions
Generic Function, metadata: Public generic functions
Generic Function, name: Public generic functions
Generic Function, node: Public generic functions
Generic Function, node-children-equal: Private generic functions
Generic Function, node-equal: Public generic functions
Generic Function, node-metadata-equal: Private generic functions
Generic Function, node-reference: Public generic functions
Generic Function, node-specific-equal: Public generic functions
Generic Function, node-text: Private generic functions
Generic Function, parse-document: Public generic functions
Generic Function, publisher: Public generic functions
Generic Function, reference: Public generic functions
Generic Function, rights: Public generic functions
Generic Function, rows: Public generic functions
Generic Function, source: Public generic functions
Generic Function, subject: Public generic functions
Generic Function, term: Public generic functions
Generic Function, text: Public generic functions
Generic Function, title: Public generic functions
Generic Function, toc-traverse: Private generic functions
Generic Function, traverse-document: Public generic functions
Generic Function, uri: Public generic functions
Generic Function, version: Public generic functions
get-meta: Public ordinary functions

H
hash-table-equal: Private ordinary functions
hash-table-key-equal: Private ordinary functions
header: Public generic functions
header: Public generic functions

I
image: Public generic functions
image: Public generic functions

K
keywords: Public generic functions
keywords: Public generic functions

L
language: Public generic functions
language: Public generic functions
language: Public generic functions

M
Macro, define-node: Public macros
Macro, do-meta: Public macros
Macro, with-document-traversal: Public macros
make-block-quote: Public ordinary functions
make-bold: Public ordinary functions
make-cell: Public ordinary functions
make-code: Public ordinary functions
make-code-block: Public ordinary functions
make-content: Public ordinary functions
make-definition: Public ordinary functions
make-definition-list: Public ordinary functions
make-document: Public ordinary functions
make-document-link: Public ordinary functions
make-figure: Public ordinary functions
make-image: Public ordinary functions
make-inline-quote: Public ordinary functions
make-italic: Public ordinary functions
make-list-item: Public ordinary functions
make-meta: Public ordinary functions
make-ordered-list: Public ordinary functions
make-paragraph: Public ordinary functions
make-row: Public ordinary functions
make-section: Public ordinary functions
make-strikethrough: Public ordinary functions
make-subscript: Public ordinary functions
make-superscript: Public ordinary functions
make-table: Public ordinary functions
make-text: Public ordinary functions
make-underline: Public ordinary functions
make-unordered-list: Public ordinary functions
make-web-link: Public ordinary functions
meta-macro-name: Private generic functions
meta-macro-name: Private generic functions
metadata: Public generic functions
metadata: Public generic functions
Method, (setf cells): Public generic functions
Method, (setf children): Public generic functions
Method, (setf children): Public generic functions
Method, (setf children): Public generic functions
Method, (setf children): Public generic functions
Method, (setf children): Public generic functions
Method, (setf created-on): Public generic functions
Method, (setf creator): Public generic functions
Method, (setf definition): Public generic functions
Method, (setf description): Public generic functions
Method, (setf description): Public generic functions
Method, (setf description): Public generic functions
Method, (setf document-reference): Public generic functions
Method, (setf footer): Public generic functions
Method, (setf header): Public generic functions
Method, (setf image): Public generic functions
Method, (setf keywords): Public generic functions
Method, (setf language): Public generic functions
Method, (setf language): Public generic functions
Method, (setf metadata): Public generic functions
Method, (setf name): Public generic functions
Method, (setf node): Public generic functions
Method, (setf node-reference): Public generic functions
Method, (setf publisher): Public generic functions
Method, (setf reference): Public generic functions
Method, (setf reference): Public generic functions
Method, (setf rights): Public generic functions
Method, (setf rows): Public generic functions
Method, (setf source): Public generic functions
Method, (setf subject): Public generic functions
Method, (setf term): Public generic functions
Method, (setf text): Public generic functions
Method, (setf title): Public generic functions
Method, (setf title): Public generic functions
Method, (setf uri): Public generic functions
Method, (setf version): Public generic functions
Method, cells: Public generic functions
Method, children: Public generic functions
Method, children: Public generic functions
Method, children: Public generic functions
Method, children: Public generic functions
Method, children: Public generic functions
Method, created-on: Public generic functions
Method, creator: Public generic functions
Method, definition: Public generic functions
Method, description: Public generic functions
Method, description: Public generic functions
Method, description: Public generic functions
Method, document-reference: Public generic functions
Method, emit-to-string: Public generic functions
Method, emit-to-string: Public generic functions
Method, expand-macro: Public generic functions
Method, expand-macro: Public generic functions
Method, expand-macro: Public generic functions
Method, expand-macros: Public generic functions
Method, expand-macros: Public generic functions
Method, expand-macros: Public generic functions
Method, expand-macros: Public generic functions
Method, expand-macros: Public generic functions
Method, footer: Public generic functions
Method, header: Public generic functions
Method, image: Public generic functions
Method, keywords: Public generic functions
Method, language: Public generic functions
Method, language: Public generic functions
Method, meta-macro-name: Private generic functions
Method, metadata: Public generic functions
Method, name: Public generic functions
Method, node: Public generic functions
Method, node-children-equal: Private generic functions
Method, node-equal: Public generic functions
Method, node-metadata-equal: Private generic functions
Method, node-reference: Public generic functions
Method, node-specific-equal: Public generic functions
Method, node-specific-equal: Public generic functions
Method, node-specific-equal: Public generic functions
Method, node-specific-equal: Public generic functions
Method, node-specific-equal: Public generic functions
Method, node-specific-equal: Public generic functions
Method, node-specific-equal: Public generic functions
Method, node-specific-equal: Public generic functions
Method, node-specific-equal: Public generic functions
Method, node-text: Private generic functions
Method, node-text: Private generic functions
Method, node-text: Private generic functions
Method, node-text: Private generic functions
Method, node-text: Private generic functions
Method, node-text: Private generic functions
Method, node-text: Private generic functions
Method, node-text: Private generic functions
Method, node-text: Private generic functions
Method, node-text: Private generic functions
Method, node-text: Private generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, publisher: Public generic functions
Method, reference: Public generic functions
Method, reference: Public generic functions
Method, rights: Public generic functions
Method, rows: Public generic functions
Method, source: Public generic functions
Method, subject: Public generic functions
Method, term: Public generic functions
Method, text: Public generic functions
Method, title: Public generic functions
Method, title: Public generic functions
Method, toc-traverse: Private generic functions
Method, toc-traverse: Private generic functions
Method, toc-traverse: Private generic functions
Method, toc-traverse: Private generic functions
Method, toc-traverse: Private generic functions
Method, traverse-document: Public generic functions
Method, traverse-document: Public generic functions
Method, traverse-document: Public generic functions
Method, traverse-document: Public generic functions
Method, uri: Public generic functions
Method, version: Public generic functions

N
name: Public generic functions
name: Public generic functions
node: Public generic functions
node: Public generic functions
node-children-equal: Private generic functions
node-children-equal: Private generic functions
node-equal: Public generic functions
node-equal: Public generic functions
node-list-equal: Private ordinary functions
node-metadata-equal: Private generic functions
node-metadata-equal: Private generic functions
node-reference: Public generic functions
node-reference: Public generic functions
node-specific-equal: Public generic functions
node-specific-equal: Public generic functions
node-specific-equal: Public generic functions
node-specific-equal: Public generic functions
node-specific-equal: Public generic functions
node-specific-equal: Public generic functions
node-specific-equal: Public generic functions
node-specific-equal: Public generic functions
node-specific-equal: Public generic functions
node-specific-equal: Public generic functions
node-text: Private generic functions
node-text: Private generic functions
node-text: Private generic functions
node-text: Private generic functions
node-text: Private generic functions
node-text: Private generic functions
node-text: Private generic functions
node-text: Private generic functions
node-text: Private generic functions
node-text: Private generic functions
node-text: Private generic functions
node-text: Private generic functions

P
parse-document: Public generic functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
publisher: Public generic functions
publisher: Public generic functions

R
reference: Public generic functions
reference: Public generic functions
reference: Public generic functions
relativize-pathname: Public ordinary functions
rights: Public generic functions
rights: Public generic functions
rows: Public generic functions
rows: Public generic functions

S
source: Public generic functions
source: Public generic functions
string-to-slug: Public ordinary functions
subject: Public generic functions
subject: Public generic functions

T
table-of-contents: Public ordinary functions
term: Public generic functions
term: Public generic functions
text: Public generic functions
text: Public generic functions
title: Public generic functions
title: Public generic functions
title: Public generic functions
toc-traverse: Private generic functions
toc-traverse: Private generic functions
toc-traverse: Private generic functions
toc-traverse: Private generic functions
toc-traverse: Private generic functions
toc-traverse: Private generic functions
traverse-document: Public generic functions
traverse-document: Public generic functions
traverse-document: Public generic functions
traverse-document: Public generic functions
traverse-document: Public generic functions

U
un-nest: Private ordinary functions
uri: Public generic functions
uri: Public generic functions

V
version: Public generic functions
version: Public generic functions

W
with-document-traversal: Public macros


A.3 Variables

Jump to:   *  
C   D   F   H   I   K   L   M   N   P   R   S   T   U   V  
Index Entry  Section

*
*base-directory*: Public special variables
*meta-macros*: Private special variables
*node-slots*: Private special variables
*registry*: Private special variables

C
cells: Public classes
children: Public classes
children: Public classes
children: Public classes
children: Public classes
children: Public classes
created-on: Public classes
creator: Public classes

D
definition: Public classes
description: Public classes
description: Public classes
description: Public classes
document-reference: Public classes

F
footer: Public classes

H
header: Public classes

I
image: Public classes

K
keywords: Public classes

L
language: Public classes
language: Public classes

M
metadata: Public classes

N
name: Public classes
name: Public classes
node: Public conditions
node-reference: Public classes

P
publisher: Public classes

R
reference: Public classes
reference: Public classes
rights: Public classes
rows: Public classes

S
Slot, cells: Public classes
Slot, children: Public classes
Slot, children: Public classes
Slot, children: Public classes
Slot, children: Public classes
Slot, children: Public classes
Slot, created-on: Public classes
Slot, creator: Public classes
Slot, definition: Public classes
Slot, description: Public classes
Slot, description: Public classes
Slot, description: Public classes
Slot, document-reference: Public classes
Slot, footer: Public classes
Slot, header: Public classes
Slot, image: Public classes
Slot, keywords: Public classes
Slot, language: Public classes
Slot, language: Public classes
Slot, metadata: Public classes
Slot, name: Public classes
Slot, name: Public classes
Slot, node: Public conditions
Slot, node-reference: Public classes
Slot, publisher: Public classes
Slot, reference: Public classes
Slot, reference: Public classes
Slot, rights: Public classes
Slot, rows: Public classes
Slot, source: Public classes
Slot, subject: Public classes
Slot, term: Public classes
Slot, text: Public classes
Slot, title: Public classes
Slot, title: Public classes
Slot, uri: Public classes
Slot, version: Public classes
source: Public classes
Special Variable, *base-directory*: Public special variables
Special Variable, *meta-macros*: Private special variables
Special Variable, *node-slots*: Private special variables
Special Variable, *registry*: Private special variables
subject: Public classes

T
term: Public classes
text: Public classes
title: Public classes
title: Public classes

U
uri: Public classes

V
version: Public classes


A.4 Data types

Jump to:   B   C   D   E   F   I   L   M   N   O   P   R   S   T   U   W  
Index Entry  Section

B
base-list: Public classes
base-quote: Public classes
block-quote: Public classes
bold: Public classes

C
cell: Public classes
Class, base-list: Public classes
Class, base-quote: Public classes
Class, block-quote: Public classes
Class, bold: Public classes
Class, cell: Public classes
Class, code: Public classes
Class, code-block: Public classes
Class, content-node: Public classes
Class, define-meta-macro: Public classes
Class, definition: Public classes
Class, definition-list: Public classes
Class, document: Public classes
Class, document-format: Public classes
Class, document-link: Public classes
Class, document-node: Public classes
Class, figure: Public classes
Class, image: Public classes
Class, inline-quote: Public classes
Class, italic: Public classes
Class, link: Public classes
Class, list-item: Public classes
Class, macro-node: Public classes
Class, markup: Public classes
Class, ordered-list: Public classes
Class, paragraph: Public classes
Class, row: Public classes
Class, section: Public classes
Class, strikethrough: Public classes
Class, subscript: Public classes
Class, superscript: Public classes
Class, table: Public classes
Class, text-node: Public classes
Class, underline: Public classes
Class, unordered-list: Public classes
Class, web-link: Public classes
classes.lisp: The common-doc/src/classes․lisp file
code: Public classes
code-block: Public classes
common-doc: The common-doc system
common-doc: The common-doc package
common-doc-error: Public conditions
common-doc.asd: The common-doc/common-doc․asd file
common-doc.error: The common-doc․error package
common-doc.file: The common-doc․file package
common-doc.format: The common-doc․format package
common-doc.macro: The common-doc․macro package
common-doc.ops: The common-doc․ops package
common-doc.util: The common-doc․util package
Condition, common-doc-error: Public conditions
Condition, macro-error: Public conditions
Condition, no-macro-expander: Public conditions
constructors.lisp: The common-doc/src/constructors․lisp file
content-node: Public classes

D
define-meta-macro: Public classes
define.lisp: The common-doc/src/define․lisp file
definition: Public classes
definition-list: Public classes
document: Public classes
document-format: Public classes
document-link: Public classes
document-node: Public classes

E
equality.lisp: The common-doc/src/operations/equality․lisp file
error.lisp: The common-doc/src/error․lisp file

F
figure: Public classes
figures.lisp: The common-doc/src/operations/figures․lisp file
File, classes.lisp: The common-doc/src/classes․lisp file
File, common-doc.asd: The common-doc/common-doc․asd file
File, constructors.lisp: The common-doc/src/constructors․lisp file
File, define.lisp: The common-doc/src/define․lisp file
File, equality.lisp: The common-doc/src/operations/equality․lisp file
File, error.lisp: The common-doc/src/error․lisp file
File, figures.lisp: The common-doc/src/operations/figures․lisp file
File, file.lisp: The common-doc/src/file․lisp file
File, format.lisp: The common-doc/src/format․lisp file
File, links.lisp: The common-doc/src/operations/links․lisp file
File, macros.lisp: The common-doc/src/macros․lisp file
File, metadata.lisp: The common-doc/src/metadata․lisp file
File, packages.lisp: The common-doc/src/packages․lisp file
File, print.lisp: The common-doc/src/print․lisp file
File, tables.lisp: The common-doc/src/operations/tables․lisp file
File, text.lisp: The common-doc/src/operations/text․lisp file
File, toc.lisp: The common-doc/src/operations/toc․lisp file
File, traverse.lisp: The common-doc/src/operations/traverse․lisp file
File, unique-ref.lisp: The common-doc/src/operations/unique-ref․lisp file
File, util.lisp: The common-doc/src/util․lisp file
file.lisp: The common-doc/src/file․lisp file
format.lisp: The common-doc/src/format․lisp file

I
image: Public classes
inline-quote: Public classes
italic: Public classes

L
link: Public classes
links.lisp: The common-doc/src/operations/links․lisp file
list-item: Public classes

M
macro-error: Public conditions
macro-node: Public classes
macros.lisp: The common-doc/src/macros․lisp file
markup: Public classes
metadata.lisp: The common-doc/src/metadata․lisp file
Module, operations: The common-doc/src/operations module
Module, src: The common-doc/src module

N
no-macro-expander: Public conditions

O
operations: The common-doc/src/operations module
ordered-list: Public classes

P
Package, common-doc: The common-doc package
Package, common-doc.error: The common-doc․error package
Package, common-doc.file: The common-doc․file package
Package, common-doc.format: The common-doc․format package
Package, common-doc.macro: The common-doc․macro package
Package, common-doc.ops: The common-doc․ops package
Package, common-doc.util: The common-doc․util package
packages.lisp: The common-doc/src/packages․lisp file
paragraph: Public classes
print.lisp: The common-doc/src/print․lisp file

R
row: Public classes

S
section: Public classes
src: The common-doc/src module
strikethrough: Public classes
subscript: Public classes
superscript: Public classes
System, common-doc: The common-doc system

T
table: Public classes
tables.lisp: The common-doc/src/operations/tables․lisp file
text-node: Public classes
text.lisp: The common-doc/src/operations/text․lisp file
toc.lisp: The common-doc/src/operations/toc․lisp file
traverse.lisp: The common-doc/src/operations/traverse․lisp file

U
underline: Public classes
unique-ref.lisp: The common-doc/src/operations/unique-ref․lisp file
unordered-list: Public classes
util.lisp: The common-doc/src/util․lisp file

W
web-link: Public classes