4.1.1 codex/codex.asd

Source

codex.asd.

Parent Component

codex (system).

ASDF Systems

codex.

---

4.1.2 codex-templates/codex-templates.asd

Source

codex-templates.asd.

Parent Component

codex-templates (system).

ASDF Systems

codex-templates.

---

4.1.3 codex/src/error.lisp

Source

codex.asd.

Parent Component

src (module).

Packages

codex.error.

Public Interface

• codex-error (condition).
• format-name (reader method).
• manifest-error (condition).
• message (reader method).
• message (reader method).
• no-docstring (condition).
• node (reader method).
• system-name (reader method).
• template-error (condition).
• template-name (reader method).
• unsupported-output-format (condition).

---

4.1.4 codex/src/markup.lisp

Dependency

error.lisp (file).

Source

codex.asd.

Parent Component

src (module).

Packages

codex.markup.

Public Interface

• *current-markup-format* (special variable).
• parse-string (function).

---

4.1.5 codex/src/manifest.lisp

Dependency

markup.lisp (file).

Source

codex.asd.

Parent Component

src (module).

Packages

• codex-manifest-user.
• codex.manifest.

Public Interface

• *default-manifest-pathname* (special variable).
• document (class).
• document-authors (reader method).
• document-output-format (reader method).
• document-sources (reader method).
• document-title (reader method).
• html (class).
• manifest (class).
• manifest-documents (reader method).
• manifest-markup-format (reader method).
• manifest-systems (reader method).
• multi-html (class).
• output-format (class).
• output-html-template (reader method).
• output-html-template-options (reader method).
• parse-manifest (function).
• single-html (class).
• system-manifest-pathname (function).

Internals

• parse-document (function).
• parse-output-format (function).
• read-manifest (function).

---

4.1.6 codex/src/macro.lisp

Dependency

manifest.lisp (file).

Source

codex.asd.

Parent Component

src (module).

Packages

codex.macro.

Public Interface

• *index* (special variable).
• cl-doc (class).
• expand-macro (method).
• expand-macro (method).
• expand-macro (method).
• expand-macro (method).
• param (class).
• spec (class).
• with-package (class).

Internals

• *current-package-name* (special variable).
• +type-name-to-class-map+ (special variable).
• check-node-docstring (function).
• docstring-node (function).
• expand-node (generic function).
• expand-operator-node (function).
• expand-record-node (function).
• find-node (function).
• find-node-type-by-name (function).
• list-to-code-node (function).
• make-class-metadata (function).
• make-doc-node (function).
• name-node (method).
• no-method-found (function).
• no-method-lambda-list (function).
• no-such-type (function).
• node-not-found (function).
• package-macro-name (reader method).
• url-for-symbol (function).
• write-to-code-node (function).

---

4.1.7 codex/src/codex.lisp

Dependency

macro.lisp (file).

Source

codex.asd.

Parent Component

src (module).

Packages

codex.

Public Interface

• *skip-undocumented* (special variable).
• document (function).

Internals

• *undocumented-list* (special variable).
• build-document (function).
• build-manifest (function).
• copy-images (function).
• load-document (function).
• print-undocumented (function).
• undocumented-handler (function).

---

4.1.8 codex/src/quickstart.lisp

Dependency

codex.lisp (file).

Source

codex.asd.

Parent Component

src (module).

Public Interface

quickstart (function).

Internals

• +manifest-template+ (special variable).
• +manual-template+ (special variable).
• clean-author-name (function).

---

4.1.9 codex-templates/templates/templates.lisp

Source

codex-templates.asd.

Parent Component

templates (module).

Packages

codex.tmpl.

Public Interface

• *template-database* (special variable).
• built-in-template (class).
• codex-template (class).
• find-template (function).
• initialize-instance (method).
• render (method).
• render-section (method).

Internals

• +templates-directory+ (special variable).
• define-built-in-template (macro).
• document-template (generic function).
• gamma (class).
• minima (class).
• options (reader method).
• output-directory (reader method).
• section-template (generic function).
• static-files (generic function).
• static-output-directory (function).

---

4.2.1 codex-templates/templates/static/nodes.css

Source

codex-templates.asd.

Parent Component

static (module).

---

4.2.2 codex-templates/templates/static/reset.css

Source

codex-templates.asd.

Parent Component

static (module).

---

4.2.3 codex-templates/templates/minima/base.html

Source

codex-templates.asd.

Parent Component

minima (module).

---

4.2.4 codex-templates/templates/minima/document.html

Source

codex-templates.asd.

Parent Component

minima (module).

---

4.2.5 codex-templates/templates/minima/section.html

Source

codex-templates.asd.

Parent Component

minima (module).

---

4.2.6 codex-templates/templates/minima/style.css

Source

codex-templates.asd.

Parent Component

minima (module).

---

4.2.7 codex-templates/templates/gamma/base.html

Source

codex-templates.asd.

Parent Component

gamma (module).

---

4.2.8 codex-templates/templates/gamma/document.html

Source

codex-templates.asd.

Parent Component

gamma (module).

---

4.2.9 codex-templates/templates/gamma/section.html

Source

codex-templates.asd.

Parent Component

gamma (module).

---

4.2.10 codex-templates/templates/gamma/style.css

Source

codex-templates.asd.

Parent Component

gamma (module).

---

4.2.11 codex-templates/templates/traditional/base.html

Source

codex-templates.asd.

Parent Component

traditional (module).

---

4.2.12 codex-templates/templates/traditional/document.html

Source

codex-templates.asd.

Parent Component

traditional (module).

---

4.2.13 codex-templates/templates/traditional/section.html

Source

codex-templates.asd.

Parent Component

traditional (module).

---

4.2.14 codex-templates/templates/traditional/style.css

Source

codex-templates.asd.

Parent Component

traditional (module).

---

6.1.1 Special variables

Special Variable: *current-markup-format* ¶

The name of the markup format that will be used to parse docstrings and files. This is a keyword that is passed to Pandocl.

Package

codex.markup.

Source

markup.lisp.

Special Variable: *default-manifest-pathname* ¶

The pathname of the Codex manifest in a system.

Package

codex.manifest.

Source

manifest.lisp.

Special Variable: *index* ¶

The current Docparser index.

Package

codex.macro.

Source

macro.lisp.

Special Variable: *skip-undocumented* ¶

If this variable is not NIL, do not call a debugger when undocumented node is found.

Package

codex.

Source

codex.lisp.

Special Variable: *template-database* ¶

A hash table of table names (Keywords) to template classes.

Package

codex.tmpl.

Source

templates.lisp.

---

6.1.2 Ordinary functions

Function: document (system-name &key skip-undocumented manifest-path) ¶

Generate documentation for a system. @c(skip-undocumented) overrides @c(*skip-undocumented*) @c(manifest-path) overrides @c(*default-manifest-pathname*) which is @c(#p"docs/manifest.lisp")

Package

codex.

Source

codex.lisp.

Function: find-template (template-name) ¶

Find a template by name.

Package

codex.tmpl.

Source

templates.lisp.

Function: parse-manifest (pathname) ¶

Parse a manifest from a pathname.

Package

codex.manifest.

Source

manifest.lisp.

Function: parse-string (string) ¶

Parse a docstring into a documentation node using the current markup format.

Package

codex.markup.

Source

markup.lisp.

Function: quickstart (system-name) ¶

Create a documentation folder, manifest, and a sample file for the given system.

Package

codex.

Source

quickstart.lisp.

Function: system-manifest-pathname (system-name &key manifest-path) ¶

Return the absolute pathname to a system’s Codex manifest. @c(manifest-path) overrides @c(*default-manifest-pathname*) which is @c(#p"docs/manifest.lisp")

Package

codex.manifest.

Source

manifest.lisp.

---

6.1.3 Generic functions

Generic Reader: document-authors (object) ¶

Package

codex.manifest.

Methods

Reader Method: document-authors ((document document)) ¶

A list of the document’s authors.

Source

manifest.lisp.

Target Slot

document-authors.

Generic Reader: document-output-format (object) ¶

Package

codex.manifest.

Methods

Reader Method: document-output-format ((document document)) ¶

The document’s output format.

Source

manifest.lisp.

Target Slot

output-format.

Generic Reader: document-sources (object) ¶

Package

codex.manifest.

Methods

Reader Method: document-sources ((document document)) ¶

A list of pathnames to source files to build the document from.

Source

manifest.lisp.

Target Slot

document-sources.

Generic Reader: document-title (object) ¶

Package

codex.manifest.

Methods

Reader Method: document-title ((document document)) ¶

The document’s title.

Source

manifest.lisp.

Target Slot

document-title.

Generic Reader: format-name (condition) ¶

Package

codex.error.

Methods

Reader Method: format-name ((condition unsupported-output-format)) ¶

Source

error.lisp.

Target Slot

format-name.

Generic Reader: manifest-documents (object) ¶

Package

codex.manifest.

Methods

Reader Method: manifest-documents ((manifest manifest)) ¶

A list of documents.

Source

manifest.lisp.

Target Slot

documents.

Generic Reader: manifest-markup-format (object) ¶

Package

codex.manifest.

Methods

Reader Method: manifest-markup-format ((manifest manifest)) ¶

The markup format used in docstrings.

Source

manifest.lisp.

Target Slot

markup-format.

Generic Reader: manifest-systems (object) ¶

Package

codex.manifest.

Methods

Reader Method: manifest-systems ((manifest manifest)) ¶

A list of systems to document.

Source

manifest.lisp.

Target Slot

systems.

Generic Reader: message (condition) ¶

Package

codex.error.

Methods

Reader Method: message ((condition template-error)) ¶

Source

error.lisp.

Target Slot

message.

Reader Method: message ((condition manifest-error)) ¶

Source

error.lisp.

Target Slot

message.

Generic Reader: node (condition) ¶

Package

codex.error.

Methods

Reader Method: node ((condition no-docstring)) ¶

Source

error.lisp.

Target Slot

node.

Generic Reader: output-html-template (object) ¶

Package

codex.manifest.

Methods

Reader Method: output-html-template ((html html)) ¶

The name of the HTML template.

Source

manifest.lisp.

Target Slot

html-template.

Generic Reader: output-html-template-options (object) ¶

Package

codex.manifest.

Methods

Reader Method: output-html-template-options ((html html)) ¶

A property list of template initargs.

Source

manifest.lisp.

Target Slot

template-options.

Generic Reader: system-name (condition) ¶

Package

codex.error.

Methods

Reader Method: system-name ((condition manifest-error)) ¶

Source

error.lisp.

Target Slot

system-name.

Generic Reader: template-name (condition) ¶

Package

codex.error.

Methods

Reader Method: template-name ((condition template-error)) ¶

Source

error.lisp.

Target Slot

template-name.

---

6.1.4 Standalone methods

Method: expand-macro ((node spec)) ¶

Package

common-doc.macro.

Source

macro.lisp.

Method: expand-macro ((node param)) ¶

Package

common-doc.macro.

Source

macro.lisp.

Method: expand-macro ((node cl-doc)) ¶

Package

common-doc.macro.

Source

macro.lisp.

Method: expand-macro ((node with-package)) ¶

Package

common-doc.macro.

Source

macro.lisp.

Method: initialize-instance :after ((tmpl codex-template) &key) ¶

Copy the template’s static files to the output directory

Source

templates.lisp.

Method: render ((tmpl built-in-template) (document document) content-string) ¶

Render a built-in document template.

Package

common-html.template.

Source

templates.lisp.

Method: render-section ((tmpl built-in-template) (document document) (section section) content-string) ¶

Render a built-in section template.

Package

common-html.template.

Source

templates.lisp.

---

6.1.5 Conditions

Condition: codex-error ¶

The base class of all Codex errors.

Package

codex.error.

Source

error.lisp.

Direct superclasses

condition.

Direct subclasses

• manifest-error.
• no-docstring.
• template-error.
• unsupported-output-format.

Condition: manifest-error ¶

Signalled when there is an error parsing a manifest file.

Package

codex.error.

Source

error.lisp.

Direct superclasses

codex-error.

Direct methods

• message.
• system-name.

Direct slots

Slot: system-name ¶

The name of the system.

Initargs

:system-name

Readers

system-name.

Writers

This slot is read-only.

Slot: message ¶

The error message.

Initargs

:message

Readers

message.

Writers

This slot is read-only.

Condition: no-docstring ¶

Signalled when a node has no docstring.

Package

codex.error.

Source

error.lisp.

Direct superclasses

codex-error.

Direct methods

node.

Direct slots

Slot: node ¶

The node without docstring.

Initargs

:node

Readers

node.

Writers

This slot is read-only.

Condition: template-error ¶

Signalled by errors related to templates.

Package

codex.error.

Source

error.lisp.

Direct superclasses

codex-error.

Direct methods

• message.
• template-name.

Direct slots

Slot: template-name ¶

The template name.

Initargs

:template-name

Readers

template-name.

Writers

This slot is read-only.

Slot: message ¶

The error message.

Initargs

:message

Readers

message.

Writers

This slot is read-only.

Condition: unsupported-output-format ¶

Signalled when Codex doesn’t know the output format a document specifies.

Package

codex.error.

Source

error.lisp.

Direct superclasses

codex-error.

Direct methods

format-name.

Direct slots

Slot: format-name ¶

The name of the output format.

Initargs

:format-name

Readers

format-name.

Writers

This slot is read-only.

---

6.1.6 Classes

Class: built-in-template ¶

A convenience subclass for Codex built-in templates. These
slots are not built into the default codex-template class, since users might define their own templates without using this machinery.

Package

codex.tmpl.

Source

templates.lisp.

Direct superclasses

codex-template.

Direct subclasses

• gamma.
• minima.

Direct methods

• render.
• render-section.

Class: cl-doc ¶

Insert documentation of a node.

Package

codex.macro.

Source

macro.lisp.

Direct superclasses

macro-node.

Direct methods

expand-macro.

Class: codex-template ¶

Codex templates.

Package

codex.tmpl.

Source

templates.lisp.

Direct superclasses

template.

Direct subclasses

built-in-template.

Direct methods

• initialize-instance.
• options.
• output-directory.

Direct slots

Slot: output-directory ¶

The directory where the output will be produced.

Type

pathname

Initargs

:output-directory

Readers

output-directory.

Writers

This slot is read-only.

Slot: options ¶

A plist of template options.

Type

trivial-types:property-list

Initargs

:options

Readers

options.

Writers

This slot is read-only.

Class: document ¶

A Codex document. Project manifests can define multiple documents, e.g. a manual, a tutorial, an advanced manual.

Package

codex.manifest.

Source

manifest.lisp.

Direct methods

• document-authors.
• document-output-format.
• document-sources.
• document-title.

Direct slots

Slot: document-title ¶

The document’s title.

Type

string

Initargs

:title

Readers

document-title.

Writers

This slot is read-only.

Slot: document-authors ¶

A list of the document’s authors.

Type

(trivial-types:proper-list string)

Initargs

:authors

Readers

document-authors.

Writers

This slot is read-only.

Slot: output-format ¶

The document’s output format.

Type

codex.manifest:output-format

Initargs

:output-format

Readers

document-output-format.

Writers

This slot is read-only.

Slot: document-sources ¶

A list of pathnames to source files to build the document from.

Type

(trivial-types:proper-list pathname)

Initargs

:sources

Readers

document-sources.

Writers

This slot is read-only.

Class: html ¶

The base class of HTML formats.

Package

codex.manifest.

Source

manifest.lisp.

Direct superclasses

output-format.

Direct subclasses

• multi-html.
• single-html.

Direct methods

• output-html-template.
• output-html-template-options.

Direct slots

Slot: html-template ¶

The name of the HTML template.

Type

keyword

Initargs

:template-name

Readers

output-html-template.

Writers

This slot is read-only.

Slot: template-options ¶

A property list of template initargs.

Type

trivial-types:property-list

Initargs

:template-options

Readers

output-html-template-options.

Writers

This slot is read-only.

Class: manifest ¶

Manifest options.

Package

codex.manifest.

Source

manifest.lisp.

Direct methods

• manifest-documents.
• manifest-markup-format.
• manifest-systems.

Direct slots

Slot: markup-format ¶

The markup format used in docstrings.

Type

keyword

Initargs

:markup-format

Readers

manifest-markup-format.

Writers

This slot is read-only.

Slot: systems ¶

A list of systems to document.

Type

(trivial-types:proper-list keyword)

Initargs

:systems

Readers

manifest-systems.

Writers

This slot is read-only.

Slot: documents ¶

A list of documents.

Type

(trivial-types:proper-list codex.manifest:document)

Initargs

:documents

Readers

manifest-documents.

Writers

This slot is read-only.

Class: multi-html ¶

Multi-file HTML output.

Package

codex.manifest.

Source

manifest.lisp.

Direct superclasses

html.

Class: output-format ¶

The base class of all output formats.

Package

codex.manifest.

Source

manifest.lisp.

Direct subclasses

html.

Class: param ¶

An argument of an operator.

Package

codex.macro.

Source

macro.lisp.

Direct superclasses

macro-node.

Direct methods

expand-macro.

Class: single-html ¶

Single-file HTML output.

Package

codex.manifest.

Source

manifest.lisp.

Direct superclasses

html.

Class: spec ¶

Add a link to the Common Lisp HyperSpec.

Package

codex.macro.

Source

macro.lisp.

Direct superclasses

macro-node.

Direct methods

expand-macro.

Class: with-package ¶

Set the current package to use in the body.

Package

codex.macro.

Source

macro.lisp.

Direct superclasses

macro-node.

Direct methods

• expand-macro.
• package-macro-name.

Direct slots

Slot: name ¶

The package’s name.

Type

string

Readers

package-macro-name.

Writers

This slot is read-only.

---

6.2.1 Special variables

Special Variable: *current-package-name* ¶

The name of the current package. Set by the with-package macro.

Package

codex.macro.

Source

macro.lisp.

Special Variable: *undocumented-list* ¶

List of undocumented nodes

Package

codex.

Source

codex.lisp.

Special Variable: +manifest-template+ ¶

Package

codex.

Source

quickstart.lisp.

Special Variable: +manual-template+ ¶

Package

codex.

Source

quickstart.lisp.

Special Variable: +templates-directory+ ¶

Package

codex.tmpl.

Source

templates.lisp.

Special Variable: +type-name-to-class-map+ ¶

Associate the string names of Docparser classes to the corresponding docparser class names.

Package

codex.macro.

Source

macro.lisp.

---

6.2.2 Macros

Macro: define-built-in-template (name &key document-template section-template static-files documentation) ¶

Package

codex.tmpl.

Source

templates.lisp.

---

6.2.3 Ordinary functions

Function: build-document (document directory) ¶

Build a document.

Package

codex.

Source

codex.lisp.

Function: build-manifest (manifest directory) ¶

Build a manifest. Return a list of nodes which do not have a docstring.

Package

codex.

Source

codex.lisp.

Function: check-node-docstring (node) ¶

Check and return the node’s docstring.
If there is none, codex.error:no-docstring condition is signalled.

Package

codex.macro.

Source

macro.lisp.

Function: clean-author-name (author) ¶

Package

codex.

Source

quickstart.lisp.

Function: copy-images (document directory) ¶

Copy all the images from a CommonDoc document.

Package

codex.

Source

codex.lisp.

Function: docstring-node (node) ¶

Create a node representing a node’s docstring.

Package

codex.macro.

Source

macro.lisp.

Function: expand-operator-node (node class-name) ¶

Expand a generic operator node. Called by more specific methods.

Package

codex.macro.

Source

macro.lisp.

Function: expand-record-node (class node) ¶

Package

codex.macro.

Source

macro.lisp.

Function: find-node (type symbol rest) ¶

Package

codex.macro.

Source

macro.lisp.

Function: find-node-type-by-name (name) ¶

Package

codex.macro.

Source

macro.lisp.

Function: list-to-code-node (class list) ¶

Package

codex.macro.

Source

macro.lisp.

Function: load-document (document directory) ¶

Load a CommonDoc document from the sources of a Codex document.

Package

codex.

Source

codex.lisp.

Function: make-class-metadata (class) ¶

Create metadata for HTML classes.

Package

codex.macro.

Source

macro.lisp.

Function: make-doc-node (classes &rest children) ¶

Package

codex.macro.

Source

macro.lisp.

Function: no-method-found (name lambda-list) ¶

Package

codex.macro.

Source

macro.lisp.

Function: no-method-lambda-list (name) ¶

Package

codex.macro.

Source

macro.lisp.

Function: no-such-type (name) ¶

Package

codex.macro.

Source

macro.lisp.

Function: node-not-found (symbol) ¶

Package

codex.macro.

Source

macro.lisp.

Function: parse-document (document-plist) ¶

Parse a manifest’s document plist into a document object.

Package

codex.manifest.

Source

manifest.lisp.

Function: parse-output-format (plist) ¶

Create an instance of an output-format class from a plist.

Package

codex.manifest.

Source

manifest.lisp.

Function: print-undocumented (undocumented) ¶

Package

codex.

Source

codex.lisp.

Function: read-manifest (pathname) ¶

Read a manifest file into an S-expression using the :codex-manifest-user package.

Package

codex.manifest.

Source

manifest.lisp.

Function: static-output-directory (built-in-template) ¶

Package

codex.tmpl.

Source

templates.lisp.

Function: undocumented-handler (c) ¶

Handle undocumented nodes

Package

codex.

Source

codex.lisp.

Function: url-for-symbol (symbol-name) ¶

Return the Hyperspec or l1sp.org URL for a symbol in the CL package.

Package

codex.macro.

Source

macro.lisp.

Function: write-to-code-node (class obj) ¶

Package

codex.macro.

Source

macro.lisp.

---

6.2.4 Generic functions

Generic Function: document-template (template) ¶

Package

codex.tmpl.

Source

templates.lisp.

Methods

Method: document-template ((template gamma)) ¶

Method: document-template ((template minima)) ¶

Generic Function: expand-node (node) ¶

Turn a Docparser node into a CommonDoc one.

Package

codex.macro.

Source

macro.lisp.

Methods

Method: expand-node (node) ¶

When expanding an unsupported node, rather than generate an error, simply create an error message.

Method: expand-node ((node type-node)) ¶

Expand a type node.

Method: expand-node ((node documentation-node)) ¶

Backup method when someone has created a subclass of documentation-node that’s not explicitly supported by this.

Method: expand-node ((node variable-node)) ¶

Expand a variable node.

Method: expand-node ((node condition-node)) ¶

Expand a condition definition node.

Method: expand-node ((node class-node)) ¶

Expand a class definition node.

Method: expand-node ((node struct-node)) ¶

Expand a structure definition node.

Method: expand-node ((node class-slot-node)) ¶

Expand a class slot node.

Method: expand-node ((node struct-slot-node)) ¶

Expand a structure slot node. This doesn’t have any docstrings.

Method: expand-node ((node operator-node)) ¶

Backup method when someone has created a subclass of operator-node that’s not explicitly supported by this method.

Method: expand-node ((node method-node)) ¶

Expand a method node.

Method: expand-node ((node generic-function-node)) ¶

Expand a generic function node.

Method: expand-node ((node macro-node)) ¶

Expand a macro node.

Method: expand-node ((node function-node)) ¶

Expand a function node.

Generic Function: name-node (node) ¶

Package

codex.macro.

Methods

Method: name-node (node) ¶

Create a node representing the name of a node. If it is a setf operation, "setf " is automatically prepended before the name text.

Source

macro.lisp.

Generic Reader: options (object) ¶

Package

codex.tmpl.

Methods

Reader Method: options ((codex-template codex-template)) ¶

A plist of template options.

Source

templates.lisp.

Target Slot

options.

Generic Reader: output-directory (object) ¶

Package

codex.tmpl.

Methods

Reader Method: output-directory ((codex-template codex-template)) ¶

The directory where the output will be produced.

Source

templates.lisp.

Target Slot

output-directory.

Generic Reader: package-macro-name (object) ¶

Package

codex.macro.

Methods

Reader Method: package-macro-name ((with-package with-package)) ¶

The package’s name.

Source

macro.lisp.

Target Slot

name.

Generic Function: section-template (template) ¶

Package

codex.tmpl.

Source

templates.lisp.

Methods

Method: section-template ((template gamma)) ¶

Method: section-template ((template minima)) ¶

Generic Function: static-files (template) ¶

Package

codex.tmpl.

Source

templates.lisp.

Methods

Method: static-files ((template gamma)) ¶

Method: static-files ((template minima)) ¶

---

6.2.5 Classes

Class: gamma ¶

Modern template.

Package

codex.tmpl.

Source

templates.lisp.

Direct superclasses

built-in-template.

Direct methods

• document-template.
• section-template.
• static-files.

Class: minima ¶

Minimalist template.

Package

codex.tmpl.

Source

templates.lisp.

Direct superclasses

built-in-template.

Direct methods

• document-template.
• section-template.
• static-files.

---