The common-doc Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The common-doc Reference Manual

This is the common-doc Reference Manual, version 0.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:37:47 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

CommonDoc

Build Status Coverage Status Quicklisp badge

A framework for representing and manipulating documents as CLOS objects.

See the documentation.

Libraries

License

Copyright (c) 2014-2015 Fernando Borretti

Licensed under the MIT License.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 common-doc

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

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

Description

A framework for representing and manipulating documents as CLOS objects.

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
Source

common-doc.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 common-doc/src

Parent

common-doc (system)

Location

src/

Components

Previous: , Up: Modules   [Contents][Index]

3.2 common-doc/src/operations

Dependency

util.lisp (file)

Parent

src (module)

Location

src/operations/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 common-doc.asd

Location

common-doc.asd

Systems

common-doc (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 common-doc/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 common-doc/src/define.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/define.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 common-doc/src/error.lisp

Dependency

define.lisp (file)

Parent

src (module)

Location

src/error.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 common-doc/src/file.lisp

Dependency

error.lisp (file)

Parent

src (module)

Location

src/file.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 common-doc/src/classes.lisp

Dependency

file.lisp (file)

Parent

src (module)

Location

src/classes.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 common-doc/src/metadata.lisp

Dependency

classes.lisp (file)

Parent

src (module)

Location

src/metadata.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 common-doc/src/constructors.lisp

Dependency

metadata.lisp (file)

Parent

src (module)

Location

src/constructors.lisp

Exported Definitions
Internal Definitions

construct (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 common-doc/src/macros.lisp

Dependency

constructors.lisp (file)

Parent

src (module)

Location

src/macros.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 common-doc/src/format.lisp

Dependency

macros.lisp (file)

Parent

src (module)

Location

src/format.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 common-doc/src/util.lisp

Dependency

format.lisp (file)

Parent

src (module)

Location

src/util.lisp

Exported Definitions

string-to-slug (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

operations (module)

Location

src/operations/traverse.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

traverse.lisp (file)

Parent

operations (module)

Location

src/operations/figures.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

figures.lisp (file)

Parent

operations (module)

Location

src/operations/tables.lisp

Exported Definitions

collect-tables (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

tables.lisp (file)

Parent

operations (module)

Location

src/operations/links.lisp

Exported Definitions

collect-external-links (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

links.lisp (file)

Parent

operations (module)

Location

src/operations/text.lisp

Exported Definitions

collect-all-text (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

text.lisp (file)

Parent

operations (module)

Location

src/operations/unique-ref.lisp

Exported Definitions

fill-unique-refs (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

unique-ref.lisp (file)

Parent

operations (module)

Location

src/operations/toc.lisp

Exported Definitions

table-of-contents (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependency

toc.lisp (file)

Parent

operations (module)

Location

src/operations/equality.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.20 common-doc/src/print.lisp

Dependency

operations (module)

Parent

src (module)

Location

src/print.lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 common-doc.ops

Common operations on CommonDoc documents.

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 common-doc.util

CommonDoc utilities.

Source

packages.lisp (file)

Use List
Exported Definitions

string-to-slug (function)


Next: , Previous: , Up: Packages   [Contents][Index]

5.3 common-doc.macro

CommonDoc macros.

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.4 common-doc.format

CommonDoc input/output formats.

Source

packages.lisp (file)

Use List
Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.5 common-doc.file

File-related operations for CommonDoc.

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.6 common-doc.error

CommonDoc errors.

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

Previous: , Up: Packages   [Contents][Index]

5.7 common-doc

CommonDoc classes and and accessors.

Source

packages.lisp (file)

Use List
Used By List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

Macro: define-node NAME (&rest SUPERCLASSES) SLOTS &rest CLASS-OPTIONS

Define a CommonDoc node.

Package

common-doc

Source

define.lisp (file)

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 (file)

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 (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 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 (file)

Function: collect-all-text DOC-OR-NODE

Return all the text from a node or document.

Package

common-doc.ops

Source

text.lisp (file)

Function: collect-external-links DOC-OR-NODE

Return a list of external links in the document.

Package

common-doc.ops

Source

links.lisp (file)

Function: collect-figures DOC-OR-NODE

Return a list of figures in the document.

Package

common-doc.ops

Source

figures.lisp (file)

Function: collect-images DOC-OR-NODE

Return a list of images in the document.

Package

common-doc.ops

Source

figures.lisp (file)

Function: collect-tables DOC-OR-NODE

Return a list of tables in the document.

Package

common-doc.ops

Source

tables.lisp (file)

Function: dump NODE &optional STREAM

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

Package

common-doc

Source

print.lisp (file)

Function: dump-to-string NODE

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

Package

common-doc

Source

print.lisp (file)

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 (file)

Function: find-node TAG-NAME

Find a node class by its tag name.

Package

common-doc

Source

define.lisp (file)

Function: find-special-slots CLASS

Return a node class’ special slots.

Package

common-doc

Source

define.lisp (file)

Function: find-tag CLASS

Return a node class’ tag name.

Package

common-doc

Source

define.lisp (file)

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 (file)

Writer

(setf get-meta) (function)

Function: (setf get-meta) VALUE NODE KEY
Package

common-doc

Source

metadata.lisp (file)

Reader

get-meta (function)

Function: make-block-quote CHILDREN &key METADATA REFERENCE

Create a block quote node from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-bold CHILDREN &key METADATA REFERENCE

Create a bold node from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-cell CHILDREN &key METADATA REFERENCE

Create a cell from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-code CHILDREN &key METADATA REFERENCE

Create an inline code node from its children.

Package

common-doc

Source

constructors.lisp (file)

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 (file)

Function: make-content CHILDREN &key METADATA REFERENCE

Create a content node from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-definition TERM DEFINITION &key METADATA REFERENCE

Create a definition list item.

Package

common-doc

Source

constructors.lisp (file)

Function: make-definition-list CHILDREN &key METADATA REFERENCE

Create a definition list.

Package

common-doc

Source

constructors.lisp (file)

Function: make-document TITLE &key CHILDREN KEYWORDS &allow-other-keys

Create a document.

Package

common-doc

Source

constructors.lisp (file)

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 (file)

Function: make-figure IMAGE DESCRIPTION &key METADATA REFERENCE

Create a figure.

Package

common-doc

Source

constructors.lisp (file)

Function: make-image SOURCE &key DESCRIPTION METADATA REFERENCE

Create an image.

Package

common-doc

Source

constructors.lisp (file)

Function: make-inline-quote CHILDREN &key METADATA REFERENCE

Create an inline quote node from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-italic CHILDREN &key METADATA REFERENCE

Create an italicized node from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-list-item CHILDREN &key METADATA REFERENCE

Create a list item.

Package

common-doc

Source

constructors.lisp (file)

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 (file)

Function: make-ordered-list CHILDREN &key METADATA REFERENCE

Create an ordered list.

Package

common-doc

Source

constructors.lisp (file)

Function: make-paragraph CHILDREN &key METADATA REFERENCE

Create a paragraph node from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-row CELLS &key METADATA REFERENCE

Create a row from a list of cells.

Package

common-doc

Source

constructors.lisp (file)

Function: make-section TITLE &key CHILDREN REFERENCE METADATA

Create a section from its title and children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-strikethrough CHILDREN &key METADATA REFERENCE

Create an striked out node from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-subscript CHILDREN &key METADATA REFERENCE

Create a subscripted node from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-superscript CHILDREN &key METADATA REFERENCE

Create a superscripted node from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-table ROWS &key METADATA REFERENCE

Create a table from a list of rows.

Package

common-doc

Source

constructors.lisp (file)

Function: make-text STRING &key METADATA REFERENCE

Create a text node from the contents of a string.

Package

common-doc

Source

constructors.lisp (file)

Function: make-underline CHILDREN &key METADATA REFERENCE

Create an underlined node from its children.

Package

common-doc

Source

constructors.lisp (file)

Function: make-unordered-list CHILDREN &key METADATA REFERENCE

Create an unordered list.

Package

common-doc

Source

constructors.lisp (file)

Function: make-web-link URI CHILDREN &key METADATA REFERENCE

Create a web link.

Package

common-doc

Source

constructors.lisp (file)

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 (file)

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 (file)

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 (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Generic functions

Generic Function: cells OBJECT
Generic Function: (setf cells) NEW-VALUE OBJECT
Package

common-doc

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

The cells in the row.

Source

classes.lisp (file)

Generic Function: children OBJECT
Generic Function: (setf children) NEW-VALUE OBJECT
Package

common-doc

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

The document’s children nodes.

Source

classes.lisp (file)

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

The list of @c(definition) instances.

Source

classes.lisp (file)

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

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

Source

classes.lisp (file)

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

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

Source

classes.lisp (file)

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

The node’s children.

Source

classes.lisp (file)

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

common-doc

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

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

Source

classes.lisp (file)

Generic Function: creator OBJECT
Generic Function: (setf creator) NEW-VALUE OBJECT
Package

common-doc

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

The creator of the document.

Source

classes.lisp (file)

Generic Function: definition OBJECT
Generic Function: (setf definition) NEW-VALUE OBJECT
Package

common-doc

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

Defines the term.

Source

classes.lisp (file)

Generic Function: description OBJECT
Generic Function: (setf description) NEW-VALUE OBJECT
Package

common-doc

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

A description of the document.

Source

classes.lisp (file)

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

A description of the image.

Source

classes.lisp (file)

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

A plain text description of the image.

Source

classes.lisp (file)

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

common-doc

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

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

Source

classes.lisp (file)

Generic Function: emit-document DOCUMENT-FORMAT DOCUMENT STREAM

Dump a CommonDoc document into a stream.

Package

common-doc.format

Source

format.lisp (file)

Generic Function: emit-to-string FORMAT DOCUMENT
Package

common-doc.format

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

format.lisp (file)

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

format.lisp (file)

Generic Function: expand-macro NODE

Replace a macro node with a primitive node.

Package

common-doc.macro

Source

macros.lisp (file)

Methods
Method: expand-macro (NODE define-meta-macro)

Define the metadata macro, and return an empty text node.

Method: expand-macro (MACRO macro-node)
Method: expand-macro (NODE document-node)

The default macroexpansion: Do nothing.

Generic Function: expand-macros NODE

Recursively expand all macros in ‘node‘.

Package

common-doc.macro

Source

macros.lisp (file)

Methods
Method: expand-macros (DOC document)

Expand the macros in a document.

Method: expand-macros (NODE content-node)

Expand the macros in a node with children.

Method: expand-macros (NODE definition)

Expand the macros in a definition.

Method: expand-macros (NODE base-list)

Expand the macros in a base list.

Method: expand-macros (NODE document-node)

The default macroexpansion.

Generic Function: footer OBJECT
Generic Function: (setf footer) NEW-VALUE OBJECT
Package

common-doc

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

The row footer.

Source

classes.lisp (file)

Generic Function: header OBJECT
Generic Function: (setf header) NEW-VALUE OBJECT
Package

common-doc

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

The row header.

Source

classes.lisp (file)

Generic Function: image OBJECT
Generic Function: (setf image) NEW-VALUE OBJECT
Package

common-doc

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

The figure’s image.

Source

classes.lisp (file)

Generic Function: keywords OBJECT
Generic Function: (setf keywords) NEW-VALUE OBJECT
Package

common-doc

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

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

Source

classes.lisp (file)

Generic Function: language OBJECT
Generic Function: (setf language) NEW-VALUE OBJECT
Package

common-doc

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

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

Source

classes.lisp (file)

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

The language of the code block’s contents.

Source

classes.lisp (file)

Generic Function: metadata OBJECT
Generic Function: (setf metadata) NEW-VALUE OBJECT
Package

common-doc

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

Node metadata.

Source

classes.lisp (file)

Generic Function: name OBJECT
Generic Function: (setf name) NEW-VALUE OBJECT
Package

common-doc.macro

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

The name of the macro.

Source

macros.lisp (file)

Generic Function: node CONDITION
Generic Function: (setf node) NEW-VALUE CONDITION
Package

common-doc.error

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

error.lisp (file)

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

Recursively check whether two nodes are equal.

Package

common-doc.ops

Source

equality.lisp (file)

Methods
Method: node-equal (NODE-A document-node) (NODE-B document-node)
Generic Function: node-reference OBJECT
Generic Function: (setf node-reference) NEW-VALUE OBJECT
Package

common-doc

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

A reference ID for the linked node.

Source

classes.lisp (file)

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

Use this method to make node equality more specific.

Package

common-doc.ops

Source

equality.lisp (file)

Methods
Method: node-specific-equal (SECTION-A section) (SECTION-B section)
Method: node-specific-equal (FIGURE-A figure) (FIGURE-B figure)
Method: node-specific-equal (IMAGE-A image) (IMAGE-B image)
Method: node-specific-equal (DEFINITION-A definition) (DEFINITION-B definition)
Method: node-specific-equal (LINK-A web-link) (LINK-B web-link)
Method: node-specific-equal (LINK-A document-link) (LINK-B document-link)
Method: node-specific-equal (CODE-A code-block) (CODE-B code-block)
Method: node-specific-equal (TEXT-A text-node) (TEXT-B text-node)
Method: node-specific-equal (NODE-A document-node) (NODE-B document-node)

By default, return true.

Generic Function: parse-document DOCUMENT-FORMAT INPUT

Parse an input into a CommonDoc document.

Package

common-doc.format

Source

format.lisp (file)

Generic Function: publisher OBJECT
Generic Function: (setf publisher) NEW-VALUE OBJECT
Package

common-doc

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

The document’s publisher.

Source

classes.lisp (file)

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

common-doc

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

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

Source

classes.lisp (file)

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

A unique string identifying the node.

Source

classes.lisp (file)

Generic Function: rights OBJECT
Generic Function: (setf rights) NEW-VALUE OBJECT
Package

common-doc

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

Information on the document’s copyright.

Source

classes.lisp (file)

Generic Function: rows OBJECT
Generic Function: (setf rows) NEW-VALUE OBJECT
Package

common-doc

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

The list of rows in a table.

Source

classes.lisp (file)

Generic Function: source OBJECT
Generic Function: (setf source) NEW-VALUE OBJECT
Package

common-doc

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

The source where the image is stored.

Source

classes.lisp (file)

Generic Function: subject OBJECT
Generic Function: (setf subject) NEW-VALUE OBJECT
Package

common-doc

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

The subject the document deals with.

Source

classes.lisp (file)

Generic Function: term OBJECT
Generic Function: (setf term) NEW-VALUE OBJECT
Package

common-doc

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

The definition term.

Source

classes.lisp (file)

Generic Function: text OBJECT
Generic Function: (setf text) NEW-VALUE OBJECT
Package

common-doc

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

The node’s text.

Source

classes.lisp (file)

Generic Function: title OBJECT
Generic Function: (setf title) NEW-VALUE OBJECT
Package

common-doc

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

The document’s title.

Source

classes.lisp (file)

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

The section title.

Source

classes.lisp (file)

Generic Function: traverse-document NODE FUNCTION &optional DEPTH

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

Package

common-doc.ops

Source

traverse.lisp (file)

Methods
Method: traverse-document (DOC document) FUNCTION &optional DEPTH
Method: traverse-document (CNODE content-node) FUNCTION &optional DEPTH
Method: traverse-document (DNODE document-node) FUNCTION &optional DEPTH
Generic Function: uri OBJECT
Generic Function: (setf uri) NEW-VALUE OBJECT
Package

common-doc

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

The URI of the external resource.

Source

classes.lisp (file)

Generic Function: version OBJECT
Generic Function: (setf version) NEW-VALUE OBJECT
Package

common-doc

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

The document version.

Source

classes.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.5 Conditions

Condition: common-doc-error ()

The base class of all CommonDoc errors.

Package

common-doc.error

Source

error.lisp (file)

Direct superclasses

simple-error (condition)

Direct subclasses

macro-error (condition)

Condition: macro-error ()

The base class of all macro-related errors.

Package

common-doc.error

Source

error.lisp (file)

Direct superclasses

common-doc-error (condition)

Direct subclasses

no-macro-expander (condition)

Condition: no-macro-expander ()

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

Package

common-doc.error

Source

error.lisp (file)

Direct superclasses

macro-error (condition)

Direct methods
  • node (method)
  • node (method)
Direct slots
Slot: node

The node that couldn’t be expanded.

Initargs

:node

Readers

node (generic function)

Writers

(setf node) (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.6 Classes

Class: base-list ()

The base class of all lists.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct subclasses
Direct methods
Class: base-quote ()

The base class of all quotes.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Direct subclasses
Class: block-quote ()

A block quote.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

base-quote (class)

Class: bold ()

Text in this element is bold.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

markup (class)

Class: cell ()

A cell in a table.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Class: code ()

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

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

markup (class)

Class: code-block ()

A block of code.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Direct methods
Direct slots
Slot: language

The language of the code block’s contents.

Type

(or null string)

Initargs

:language

Readers

language (generic function)

Writers

(setf language) (generic function)

Class: content-node ()

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

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

document-node (class)

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 (generic function)

Writers

(setf children) (generic function)

Class: define-meta-macro ()

A metadata macro.

Package

common-doc.macro

Source

macros.lisp (file)

Direct superclasses

macro-node (class)

Direct methods
Direct slots
Slot: name

The macro’s name.

Type

string

Initargs

:name

Readers

meta-macro-name (generic function)

Class: definition ()

An item in a definition list.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods
Direct slots
Slot: term

The definition term.

Type

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

Initargs

:term

Readers

term (generic function)

Writers

(setf term) (generic function)

Slot: definition

Defines the term.

Type

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

Initargs

:definition

Readers

definition (generic function)

Writers

(setf definition) (generic function)

Class: definition-list ()

A list of definitions.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

base-list (class)

Direct methods
Direct slots
Slot: children

The list of @c(definition) instances.

Type

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

Initargs

:children

Readers

children (generic function)

Writers

(setf children) (generic function)

Class: document ()

A document.

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

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: children

The document’s children nodes.

Type

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

Initargs

:children

Readers

children (generic function)

Writers

(setf children) (generic function)

Slot: title

The document’s title.

Type

string

Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Slot: creator

The creator of the document.

Type

string

Initargs

:creator

Readers

creator (generic function)

Writers

(setf creator) (generic function)

Slot: publisher

The document’s publisher.

Type

string

Initargs

:publisher

Readers

publisher (generic function)

Writers

(setf publisher) (generic function)

Slot: subject

The subject the document deals with.

Type

string

Initargs

:subject

Readers

subject (generic function)

Writers

(setf subject) (generic function)

Slot: description

A description of the document.

Type

string

Initargs

:description

Readers

description (generic function)

Writers

(setf description) (generic function)

Slot: keywords

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

Type

(trivial-types:proper-list string)

Initargs

:keywords

Readers

keywords (generic function)

Writers

(setf keywords) (generic function)

Slot: reference

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

Type

string

Initargs

:reference

Readers

reference (generic function)

Writers

(setf reference) (generic function)

Slot: language

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

Type

string

Initargs

:language

Readers

language (generic function)

Writers

(setf language) (generic function)

Slot: rights

Information on the document’s copyright.

Type

string

Initargs

:rights

Readers

rights (generic function)

Writers

(setf rights) (generic function)

Slot: version

The document version.

Type

string

Initargs

:version

Readers

version (generic function)

Writers

(setf version) (generic function)

Slot: created-on

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

Type

local-time:timestamp

Initargs

:created-on

Initform

(local-time:now)

Readers

created-on (generic function)

Writers

(setf created-on) (generic function)

Class: document-format ()

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

Package

common-doc.format

Source

format.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
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 (file)

Direct superclasses

link (class)

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 (generic function)

Writers

(setf document-reference) (generic function)

Slot: node-reference

A reference ID for the linked node.

Type

(or null string)

Initargs

:node-reference

Readers

node-reference (generic function)

Writers

(setf node-reference) (generic function)

Class: document-node ()

The base class of all document classes.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: metadata

Node metadata.

Type

(or null hash-table)

Initargs

:metadata

Readers

metadata (generic function)

Writers

(setf metadata) (generic function)

Slot: reference

A unique string identifying the node.

Type

(or null string)

Initargs

:reference

Readers

reference (generic function)

Writers

(setf reference) (generic function)

Class: figure ()

A figure, an image plus an annotation.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods
Direct slots
Slot: image

The figure’s image.

Type

common-doc:image

Initargs

:image

Readers

image (generic function)

Writers

(setf image) (generic function)

Slot: description

A description of the image.

Type

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

Initargs

:description

Readers

description (generic function)

Writers

(setf description) (generic function)

Class: image ()

An image.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods
Direct slots
Slot: source

The source where the image is stored.

Type

string

Initargs

:source

Readers

source (generic function)

Writers

(setf source) (generic function)

Slot: description

A plain text description of the image.

Type

(or null string)

Initargs

:description

Readers

description (generic function)

Writers

(setf description) (generic function)

Class: inline-quote ()

A quote that occurs inside a paragraph in the document.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

base-quote (class)

Class: italic ()

Text in this element is italicized.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

markup (class)

Class: link ()

The base class for all links, internal and external.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Direct subclasses
Class: list-item ()

The item in a non-definition list.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Class: macro-node ()

A macro to be expanded.

Package

common-doc.macro

Source

macros.lisp (file)

Direct superclasses

content-node (class)

Direct subclasses

define-meta-macro (class)

Direct methods
Direct slots
Slot: name

The name of the macro.

Type

string

Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Class: markup ()

The superclass of all inline markup elements.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Direct subclasses
Class: ordered-list ()

A list where the elements are ordered.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

base-list (class)

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 (generic function)

Writers

(setf children) (generic function)

Class: paragraph ()

A paragraph.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Class: row ()

A row in a table.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods
Direct slots
Slot: header

The row header.

Type

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

Initargs

:header

Readers

header (generic function)

Writers

(setf header) (generic function)

Slot: footer

The row footer.

Type

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

Initargs

:footer

Readers

footer (generic function)

Writers

(setf footer) (generic function)

Slot: cells

The cells in the row.

Type

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

Initargs

:cells

Readers

cells (generic function)

Writers

(setf cells) (generic function)

Class: section ()

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

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

content-node (class)

Direct methods
Direct slots
Slot: title

The section title.

Type

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

Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Class: strikethrough ()

Text in this element is striked out.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

markup (class)

Class: subscript ()

Text in this element is subscripted relative to containing elements.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

markup (class)

Class: superscript ()

Text in this element is superscripted relative to containing elements.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

markup (class)

Class: table ()

A table.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

document-node (class)

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 (generic function)

Writers

(setf rows) (generic function)

Class: text-node ()

A node representing a bare string of text.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

document-node (class)

Direct methods
Direct slots
Slot: text

The node’s text.

Type

string

Initargs

:text

Readers

text (generic function)

Writers

(setf text) (generic function)

Class: underline ()

Text in this element is underlined.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

markup (class)

Class: unordered-list ()

A list where the elements are unordered.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

base-list (class)

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 (generic function)

Writers

(setf children) (generic function)

Class: web-link ()

An external link.

Package

common-doc

Source

classes.lisp (file)

Direct superclasses

link (class)

Direct methods
Direct slots
Slot: uri

The URI of the external resource.

Type

quri.uri:uri

Initargs

:uri

Readers

uri (generic function)

Writers

(setf uri) (generic function)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *meta-macros*

A hash table of metadata macros to their definition.

Package

common-doc.macro

Source

macros.lisp (file)

Special Variable: *node-slots*
Package

common-doc

Source

define.lisp (file)

Special Variable: *registry*

A hash table from tag names to node classes.

Package

common-doc

Source

define.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Functions

Function: %expand-macros NODE
Package

common-doc.macro

Source

macros.lisp (file)

Function: construct CLASS CHILDREN METADATA REFERENCE

Instantiate a class with children and metadata.

Package

common-doc

Source

constructors.lisp (file)

Function: extract NODE
Package

common-doc.ops

Source

toc.lisp (file)

Function: filter-depth NODE MAX-DEPTH

Remove all nodes deeper than max-depth.

Package

common-doc.ops

Source

toc.lisp (file)

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

Check whether two hash tables are equal.

Package

common-doc.ops

Source

equality.lisp (file)

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

Check whether two hash tables have the same keys.

Package

common-doc.ops

Source

equality.lisp (file)

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

common-doc.ops

Source

equality.lisp (file)

Function: un-nest NODE

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

Package

common-doc.ops

Source

toc.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Generic functions

Generic Function: meta-macro-name OBJECT
Package

common-doc.macro

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

The macro’s name.

Source

macros.lisp (file)

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

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 (file)

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 (file)

Generic Function: node-text NODE

Extract a string with all the text inside a node.

Package

common-doc.ops

Source

text.lisp (file)

Methods
Method: node-text (DOC document)

Extract text from a document.

Method: node-text (SECTION section)

Extract text from a section.

Method: node-text (TABLE table)

Extract text from a table.

Method: node-text (ROW row)

Extract text from a row of cells.

Method: node-text (FIG figure)

Extract the description from a figure.

Method: node-text (IMAGE image)

Extract the description from an image.

Method: node-text (DEF definition)

Extract text from a definition.

Method: node-text (TEXT text-node)

Extract text from a text node.

Method: node-text (LIST list)

Extract text from a list of nodes.

Method: node-text (NODE base-list)

Extract text from a content node.

Method: node-text (NODE content-node)

Extract text from a content node.

Generic Function: toc-traverse NODE

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

Package

common-doc.ops

Source

toc.lisp (file)

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

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
common-doc.asd: The common-doc<dot>asd file
common-doc/src: The common-doc/src module
common-doc/src/classes.lisp: The common-doc/src/classes<dot>lisp file
common-doc/src/constructors.lisp: The common-doc/src/constructors<dot>lisp file
common-doc/src/define.lisp: The common-doc/src/define<dot>lisp file
common-doc/src/error.lisp: The common-doc/src/error<dot>lisp file
common-doc/src/file.lisp: The common-doc/src/file<dot>lisp file
common-doc/src/format.lisp: The common-doc/src/format<dot>lisp file
common-doc/src/macros.lisp: The common-doc/src/macros<dot>lisp file
common-doc/src/metadata.lisp: The common-doc/src/metadata<dot>lisp file
common-doc/src/operations: The common-doc/src/operations module
common-doc/src/operations/equality.lisp: The common-doc/src/operations/equality<dot>lisp file
common-doc/src/operations/figures.lisp: The common-doc/src/operations/figures<dot>lisp file
common-doc/src/operations/links.lisp: The common-doc/src/operations/links<dot>lisp file
common-doc/src/operations/tables.lisp: The common-doc/src/operations/tables<dot>lisp file
common-doc/src/operations/text.lisp: The common-doc/src/operations/text<dot>lisp file
common-doc/src/operations/toc.lisp: The common-doc/src/operations/toc<dot>lisp file
common-doc/src/operations/traverse.lisp: The common-doc/src/operations/traverse<dot>lisp file
common-doc/src/operations/unique-ref.lisp: The common-doc/src/operations/unique-ref<dot>lisp file
common-doc/src/packages.lisp: The common-doc/src/packages<dot>lisp file
common-doc/src/print.lisp: The common-doc/src/print<dot>lisp file
common-doc/src/util.lisp: The common-doc/src/util<dot>lisp file

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

L
Lisp File, common-doc.asd: The common-doc<dot>asd file
Lisp File, common-doc/src/classes.lisp: The common-doc/src/classes<dot>lisp file
Lisp File, common-doc/src/constructors.lisp: The common-doc/src/constructors<dot>lisp file
Lisp File, common-doc/src/define.lisp: The common-doc/src/define<dot>lisp file
Lisp File, common-doc/src/error.lisp: The common-doc/src/error<dot>lisp file
Lisp File, common-doc/src/file.lisp: The common-doc/src/file<dot>lisp file
Lisp File, common-doc/src/format.lisp: The common-doc/src/format<dot>lisp file
Lisp File, common-doc/src/macros.lisp: The common-doc/src/macros<dot>lisp file
Lisp File, common-doc/src/metadata.lisp: The common-doc/src/metadata<dot>lisp file
Lisp File, common-doc/src/operations/equality.lisp: The common-doc/src/operations/equality<dot>lisp file
Lisp File, common-doc/src/operations/figures.lisp: The common-doc/src/operations/figures<dot>lisp file
Lisp File, common-doc/src/operations/links.lisp: The common-doc/src/operations/links<dot>lisp file
Lisp File, common-doc/src/operations/tables.lisp: The common-doc/src/operations/tables<dot>lisp file
Lisp File, common-doc/src/operations/text.lisp: The common-doc/src/operations/text<dot>lisp file
Lisp File, common-doc/src/operations/toc.lisp: The common-doc/src/operations/toc<dot>lisp file
Lisp File, common-doc/src/operations/traverse.lisp: The common-doc/src/operations/traverse<dot>lisp file
Lisp File, common-doc/src/operations/unique-ref.lisp: The common-doc/src/operations/unique-ref<dot>lisp file
Lisp File, common-doc/src/packages.lisp: The common-doc/src/packages<dot>lisp file
Lisp File, common-doc/src/print.lisp: The common-doc/src/print<dot>lisp file
Lisp File, common-doc/src/util.lisp: The common-doc/src/util<dot>lisp file

M
Module, common-doc/src: The common-doc/src module
Module, common-doc/src/operations: The common-doc/src/operations module

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

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: Internal functions

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

A
absolute-path: Exported functions

C
cells: Exported generic functions
cells: Exported generic functions
children: Exported generic functions
children: Exported generic functions
children: Exported generic functions
children: Exported generic functions
children: Exported generic functions
children: Exported generic functions
collect-all-text: Exported functions
collect-external-links: Exported functions
collect-figures: Exported functions
collect-images: Exported functions
collect-tables: Exported functions
construct: Internal functions
created-on: Exported generic functions
created-on: Exported generic functions
creator: Exported generic functions
creator: Exported generic functions

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

E
emit-document: Exported generic functions
emit-to-string: Exported generic functions
emit-to-string: Exported generic functions
emit-to-string: Exported generic functions
expand-macro: Exported generic functions
expand-macro: Exported generic functions
expand-macro: Exported generic functions
expand-macro: Exported generic functions
expand-macros: Exported generic functions
expand-macros: Exported generic functions
expand-macros: Exported generic functions
expand-macros: Exported generic functions
expand-macros: Exported generic functions
expand-macros: Exported generic functions
extract: Internal functions

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

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

H
hash-table-equal: Internal functions
hash-table-key-equal: Internal functions
header: Exported generic functions
header: Exported generic functions

I
image: Exported generic functions
image: Exported generic functions

K
keywords: Exported generic functions
keywords: Exported generic functions

L
language: Exported generic functions
language: Exported generic functions
language: Exported generic functions

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

N
name: Exported generic functions
name: Exported generic functions
node: Exported generic functions
node: Exported generic functions
node-children-equal: Internal generic functions
node-children-equal: Internal generic functions
node-equal: Exported generic functions
node-equal: Exported generic functions
node-list-equal: Internal functions
node-metadata-equal: Internal generic functions
node-metadata-equal: Internal generic functions
node-reference: Exported generic functions
node-reference: Exported generic functions
node-specific-equal: Exported generic functions
node-specific-equal: Exported generic functions
node-specific-equal: Exported generic functions
node-specific-equal: Exported generic functions
node-specific-equal: Exported generic functions
node-specific-equal: Exported generic functions
node-specific-equal: Exported generic functions
node-specific-equal: Exported generic functions
node-specific-equal: Exported generic functions
node-specific-equal: Exported generic functions
node-text: Internal generic functions
node-text: Internal generic functions
node-text: Internal generic functions
node-text: Internal generic functions
node-text: Internal generic functions
node-text: Internal generic functions
node-text: Internal generic functions
node-text: Internal generic functions
node-text: Internal generic functions
node-text: Internal generic functions
node-text: Internal generic functions
node-text: Internal generic functions

P
parse-document: Exported generic functions
publisher: Exported generic functions
publisher: Exported generic functions

R
reference: Exported generic functions
reference: Exported generic functions
reference: Exported generic functions
relativize-pathname: Exported functions
rights: Exported generic functions
rights: Exported generic functions
rows: Exported generic functions
rows: Exported generic functions

S
source: Exported generic functions
source: Exported generic functions
string-to-slug: Exported functions
subject: Exported generic functions
subject: Exported generic functions

T
table-of-contents: Exported functions
term: Exported generic functions
term: Exported generic functions
text: Exported generic functions
text: Exported generic functions
title: Exported generic functions
title: Exported generic functions
title: Exported generic functions
toc-traverse: Internal generic functions
toc-traverse: Internal generic functions
toc-traverse: Internal generic functions
toc-traverse: Internal generic functions
toc-traverse: Internal generic functions
toc-traverse: Internal generic functions
traverse-document: Exported generic functions
traverse-document: Exported generic functions
traverse-document: Exported generic functions
traverse-document: Exported generic functions

U
un-nest: Internal functions
uri: Exported generic functions
uri: Exported generic functions

V
version: Exported generic functions
version: Exported generic functions

W
with-document-traversal: Exported macros

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

Next: , Previous: , Up: Indexes   [Contents][Index]

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*: Exported special variables
*meta-macros*: Internal special variables
*node-slots*: Internal special variables
*registry*: Internal special variables

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

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

F
footer: Exported classes

H
header: Exported classes

I
image: Exported classes

K
keywords: Exported classes

L
language: Exported classes
language: Exported classes

M
metadata: Exported classes

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

P
publisher: Exported classes

R
reference: Exported classes
reference: Exported classes
rights: Exported classes
rows: Exported classes

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

T
term: Exported classes
text: Exported classes
title: Exported classes
title: Exported classes

U
uri: Exported classes

V
version: Exported classes

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

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

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

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

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

D
define-meta-macro: Exported classes
definition: Exported classes
definition-list: Exported classes
document: Exported classes
document-format: Exported classes
document-link: Exported classes
document-node: Exported classes

F
figure: Exported classes

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

L
link: Exported classes
list-item: Exported classes

M
macro-error: Exported conditions
macro-node: Exported classes
markup: Exported classes

N
no-macro-expander: Exported conditions

O
ordered-list: Exported classes

P
Package, common-doc: The common-doc package
Package, common-doc.error: The common-doc<dot>error package
Package, common-doc.file: The common-doc<dot>file package
Package, common-doc.format: The common-doc<dot>format package
Package, common-doc.macro: The common-doc<dot>macro package
Package, common-doc.ops: The common-doc<dot>ops package
Package, common-doc.util: The common-doc<dot>util package
paragraph: Exported classes

R
row: Exported classes

S
section: Exported classes
strikethrough: Exported classes
subscript: Exported classes
superscript: Exported classes
System, common-doc: The common-doc system

T
table: Exported classes
text-node: Exported classes

U
underline: Exported classes
unordered-list: Exported classes

W
web-link: Exported classes

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