The codex Reference Manual

This is the codex Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:05:46 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 codex

A documentation system for Common Lisp.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

Home Page

https://github.com/CommonDoc/codex

Source Control

(GIT git@github.com:CommonDoc/codex.git)

Bug Tracker

https://github.com/CommonDoc/codex/issues

License

MIT

Long Description

# Codex

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

A documentation system for Common Lisp.

# Overview

**Codex** generates documentation. You just write docstrings as usual, only
using [Scriba][scriba] syntax, append a couple of extra files (A few tutorials
and what have you), and Codex creates beautiful online documentation, and in the
near future, PDF manuals.

See the [documentation][docs]

# License

Copyright (c) 2014-2015 Fernando Borretti

Licensed under the MIT License.

[scriba]: https://github.com/CommonDoc/scriba
[docs]: http://commondoc.github.io/codex/docs/overview.html

Version

0.2

Dependencies
  • docparser (system).
  • common-doc (system).
  • common-doc-contrib (system).
  • pandocl (system).
  • codex-templates (system).
  • cl-slug (system).
  • cl-ppcre (system).
  • alexandria (system).
Source

codex.asd.

Child Component

src (module).


2.2 codex-templates

Templates for Codex.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

License

MIT

Version

0.1

Dependencies
  • common-html (system).
  • djula (system).
  • trivial-types (system).
Source

codex-templates.asd.

Child Component

templates (module).


3 Modules

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


3.1 codex/src

Source

codex.asd.

Parent Component

codex (system).

Child Components

3.2 codex-templates/templates

Source

codex-templates.asd.

Parent Component

codex-templates (system).

Child Components

3.3 codex-templates/templates/static

Dependency

templates.lisp (file).

Source

codex-templates.asd.

Parent Component

templates (module).

Child Components

3.4 codex-templates/templates/minima

Dependency

static (module).

Source

codex-templates.asd.

Parent Component

templates (module).

Child Components

3.5 codex-templates/templates/gamma

Dependency

minima (module).

Source

codex-templates.asd.

Parent Component

templates (module).

Child Components

3.6 codex-templates/templates/traditional

Dependency

gamma (module).

Source

codex-templates.asd.

Parent Component

templates (module).

Child Components

4 Files

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


4.1 Lisp


4.1.1 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

4.1.4 codex/src/markup.lisp

Dependency

error.lisp (file).

Source

codex.asd.

Parent Component

src (module).

Packages

codex.markup.

Public Interface

4.1.5 codex/src/manifest.lisp

Dependency

markup.lisp (file).

Source

codex.asd.

Parent Component

src (module).

Packages
Public Interface
Internals

4.1.6 codex/src/macro.lisp

Dependency

manifest.lisp (file).

Source

codex.asd.

Parent Component

src (module).

Packages

codex.macro.

Public Interface
Internals

4.1.7 codex/src/codex.lisp

Dependency

macro.lisp (file).

Source

codex.asd.

Parent Component

src (module).

Packages

codex.

Public Interface
Internals

4.1.8 codex/src/quickstart.lisp

Dependency

codex.lisp (file).

Source

codex.asd.

Parent Component

src (module).

Public Interface

quickstart (function).

Internals

4.1.9 codex-templates/templates/templates.lisp

Source

codex-templates.asd.

Parent Component

templates (module).

Packages

codex.tmpl.

Public Interface
Internals

4.2 Static


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


5 Packages

Packages are listed by definition order.


5.1 codex.manifest

Parsing Codex manifest files.

Source

manifest.lisp.

Use List

common-lisp.

Used By List

codex-manifest-user.

Public Interface
Internals

5.2 codex.error

Codex errors.

Source

error.lisp.

Use List

common-lisp.

Public Interface

5.3 codex

The main interface.

Source

codex.lisp.

Use List

common-lisp.

Public Interface
Internals

5.4 codex.tmpl

Codex template definitions.

Source

templates.lisp.

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

5.5 codex.markup

Parsing files and docstrings.

Source

markup.lisp.

Use List

common-lisp.

Public Interface

5.6 codex.macro

CommonDoc macros for Codex.

Source

macro.lisp.

Use List

common-lisp.

Public Interface
Internals

5.7 codex-manifest-user

The package in which Codex manifests are read.

Source

manifest.lisp.

Use List

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *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
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
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
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
Direct methods
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
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
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
Direct methods
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
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
Direct slots
Slot: name

The package’s name.

Type

string

Readers

package-macro-name.

Writers

This slot is read-only.


6.2 Internals


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
Class: minima

Minimalist template.

Package

codex.tmpl.

Source

templates.lisp.

Direct superclasses

built-in-template.

Direct methods

Appendix A Indexes


A.1 Concepts


A.2 Functions

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

B
build-document: Private ordinary functions
build-manifest: Private ordinary functions

C
check-node-docstring: Private ordinary functions
clean-author-name: Private ordinary functions
copy-images: Private ordinary functions

D
define-built-in-template: Private macros
docstring-node: Private ordinary functions
document: Public ordinary functions
document-authors: Public generic functions
document-authors: Public generic functions
document-output-format: Public generic functions
document-output-format: Public generic functions
document-sources: Public generic functions
document-sources: Public generic functions
document-template: Private generic functions
document-template: Private generic functions
document-template: Private generic functions
document-title: Public generic functions
document-title: Public generic functions

E
expand-macro: Public standalone methods
expand-macro: Public standalone methods
expand-macro: Public standalone methods
expand-macro: Public standalone methods
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-node: Private generic functions
expand-operator-node: Private ordinary functions
expand-record-node: Private ordinary functions

F
find-node: Private ordinary functions
find-node-type-by-name: Private ordinary functions
find-template: Public ordinary functions
format-name: Public generic functions
format-name: Public generic functions
Function, build-document: Private ordinary functions
Function, build-manifest: Private ordinary functions
Function, check-node-docstring: Private ordinary functions
Function, clean-author-name: Private ordinary functions
Function, copy-images: Private ordinary functions
Function, docstring-node: Private ordinary functions
Function, document: Public ordinary functions
Function, expand-operator-node: Private ordinary functions
Function, expand-record-node: Private ordinary functions
Function, find-node: Private ordinary functions
Function, find-node-type-by-name: Private ordinary functions
Function, find-template: Public ordinary functions
Function, list-to-code-node: Private ordinary functions
Function, load-document: Private ordinary functions
Function, make-class-metadata: Private ordinary functions
Function, make-doc-node: Private ordinary functions
Function, no-method-found: Private ordinary functions
Function, no-method-lambda-list: Private ordinary functions
Function, no-such-type: Private ordinary functions
Function, node-not-found: Private ordinary functions
Function, parse-document: Private ordinary functions
Function, parse-manifest: Public ordinary functions
Function, parse-output-format: Private ordinary functions
Function, parse-string: Public ordinary functions
Function, print-undocumented: Private ordinary functions
Function, quickstart: Public ordinary functions
Function, read-manifest: Private ordinary functions
Function, static-output-directory: Private ordinary functions
Function, system-manifest-pathname: Public ordinary functions
Function, undocumented-handler: Private ordinary functions
Function, url-for-symbol: Private ordinary functions
Function, write-to-code-node: Private ordinary functions

G
Generic Function, document-authors: Public generic functions
Generic Function, document-output-format: Public generic functions
Generic Function, document-sources: Public generic functions
Generic Function, document-template: Private generic functions
Generic Function, document-title: Public generic functions
Generic Function, expand-node: Private generic functions
Generic Function, format-name: Public generic functions
Generic Function, manifest-documents: Public generic functions
Generic Function, manifest-markup-format: Public generic functions
Generic Function, manifest-systems: Public generic functions
Generic Function, message: Public generic functions
Generic Function, name-node: Private generic functions
Generic Function, node: Public generic functions
Generic Function, options: Private generic functions
Generic Function, output-directory: Private generic functions
Generic Function, output-html-template: Public generic functions
Generic Function, output-html-template-options: Public generic functions
Generic Function, package-macro-name: Private generic functions
Generic Function, section-template: Private generic functions
Generic Function, static-files: Private generic functions
Generic Function, system-name: Public generic functions
Generic Function, template-name: Public generic functions

I
initialize-instance: Public standalone methods

L
list-to-code-node: Private ordinary functions
load-document: Private ordinary functions

M
Macro, define-built-in-template: Private macros
make-class-metadata: Private ordinary functions
make-doc-node: Private ordinary functions
manifest-documents: Public generic functions
manifest-documents: Public generic functions
manifest-markup-format: Public generic functions
manifest-markup-format: Public generic functions
manifest-systems: Public generic functions
manifest-systems: Public generic functions
message: Public generic functions
message: Public generic functions
message: Public generic functions
Method, document-authors: Public generic functions
Method, document-output-format: Public generic functions
Method, document-sources: Public generic functions
Method, document-template: Private generic functions
Method, document-template: Private generic functions
Method, document-title: Public generic functions
Method, expand-macro: Public standalone methods
Method, expand-macro: Public standalone methods
Method, expand-macro: Public standalone methods
Method, expand-macro: Public standalone methods
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, expand-node: Private generic functions
Method, format-name: Public generic functions
Method, initialize-instance: Public standalone methods
Method, manifest-documents: Public generic functions
Method, manifest-markup-format: Public generic functions
Method, manifest-systems: Public generic functions
Method, message: Public generic functions
Method, message: Public generic functions
Method, name-node: Private generic functions
Method, node: Public generic functions
Method, options: Private generic functions
Method, output-directory: Private generic functions
Method, output-html-template: Public generic functions
Method, output-html-template-options: Public generic functions
Method, package-macro-name: Private generic functions
Method, render: Public standalone methods
Method, render-section: Public standalone methods
Method, section-template: Private generic functions
Method, section-template: Private generic functions
Method, static-files: Private generic functions
Method, static-files: Private generic functions
Method, system-name: Public generic functions
Method, template-name: Public generic functions

N
name-node: Private generic functions
name-node: Private generic functions
no-method-found: Private ordinary functions
no-method-lambda-list: Private ordinary functions
no-such-type: Private ordinary functions
node: Public generic functions
node: Public generic functions
node-not-found: Private ordinary functions

O
options: Private generic functions
options: Private generic functions
output-directory: Private generic functions
output-directory: Private generic functions
output-html-template: Public generic functions
output-html-template: Public generic functions
output-html-template-options: Public generic functions
output-html-template-options: Public generic functions

P
package-macro-name: Private generic functions
package-macro-name: Private generic functions
parse-document: Private ordinary functions
parse-manifest: Public ordinary functions
parse-output-format: Private ordinary functions
parse-string: Public ordinary functions
print-undocumented: Private ordinary functions

Q
quickstart: Public ordinary functions

R
read-manifest: Private ordinary functions
render: Public standalone methods
render-section: Public standalone methods

S
section-template: Private generic functions
section-template: Private generic functions
section-template: Private generic functions
static-files: Private generic functions
static-files: Private generic functions
static-files: Private generic functions
static-output-directory: Private ordinary functions
system-manifest-pathname: Public ordinary functions
system-name: Public generic functions
system-name: Public generic functions

T
template-name: Public generic functions
template-name: Public generic functions

U
undocumented-handler: Private ordinary functions
url-for-symbol: Private ordinary functions

W
write-to-code-node: Private ordinary functions


A.3 Variables

Jump to:   *   +  
D   F   H   M   N   O   S   T  
Index Entry  Section

*
*current-markup-format*: Public special variables
*current-package-name*: Private special variables
*default-manifest-pathname*: Public special variables
*index*: Public special variables
*skip-undocumented*: Public special variables
*template-database*: Public special variables
*undocumented-list*: Private special variables

+
+manifest-template+: Private special variables
+manual-template+: Private special variables
+templates-directory+: Private special variables
+type-name-to-class-map+: Private special variables

D
document-authors: Public classes
document-sources: Public classes
document-title: Public classes
documents: Public classes

F
format-name: Public conditions

H
html-template: Public classes

M
markup-format: Public classes
message: Public conditions
message: Public conditions

N
name: Public classes
node: Public conditions

O
options: Public classes
output-directory: Public classes
output-format: Public classes

S
Slot, document-authors: Public classes
Slot, document-sources: Public classes
Slot, document-title: Public classes
Slot, documents: Public classes
Slot, format-name: Public conditions
Slot, html-template: Public classes
Slot, markup-format: Public classes
Slot, message: Public conditions
Slot, message: Public conditions
Slot, name: Public classes
Slot, node: Public conditions
Slot, options: Public classes
Slot, output-directory: Public classes
Slot, output-format: Public classes
Slot, system-name: Public conditions
Slot, systems: Public classes
Slot, template-name: Public conditions
Slot, template-options: Public classes
Special Variable, *current-markup-format*: Public special variables
Special Variable, *current-package-name*: Private special variables
Special Variable, *default-manifest-pathname*: Public special variables
Special Variable, *index*: Public special variables
Special Variable, *skip-undocumented*: Public special variables
Special Variable, *template-database*: Public special variables
Special Variable, *undocumented-list*: Private special variables
Special Variable, +manifest-template+: Private special variables
Special Variable, +manual-template+: Private special variables
Special Variable, +templates-directory+: Private special variables
Special Variable, +type-name-to-class-map+: Private special variables
system-name: Public conditions
systems: Public classes

T
template-name: Public conditions
template-options: Public classes


A.4 Data types

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

B
base.html: The codex-templates/templates/minima/base․html file
base.html: The codex-templates/templates/gamma/base․html file
base.html: The codex-templates/templates/traditional/base․html file
built-in-template: Public classes

C
cl-doc: Public classes
Class, built-in-template: Public classes
Class, cl-doc: Public classes
Class, codex-template: Public classes
Class, document: Public classes
Class, gamma: Private classes
Class, html: Public classes
Class, manifest: Public classes
Class, minima: Private classes
Class, multi-html: Public classes
Class, output-format: Public classes
Class, param: Public classes
Class, single-html: Public classes
Class, spec: Public classes
Class, with-package: Public classes
codex: The codex system
codex: The codex package
codex-error: Public conditions
codex-manifest-user: The codex-manifest-user package
codex-template: Public classes
codex-templates: The codex-templates system
codex-templates.asd: The codex-templates/codex-templates․asd file
codex.asd: The codex/codex․asd file
codex.error: The codex․error package
codex.lisp: The codex/src/codex․lisp file
codex.macro: The codex․macro package
codex.manifest: The codex․manifest package
codex.markup: The codex․markup package
codex.tmpl: The codex․tmpl package
Condition, codex-error: Public conditions
Condition, manifest-error: Public conditions
Condition, no-docstring: Public conditions
Condition, template-error: Public conditions
Condition, unsupported-output-format: Public conditions

D
document: Public classes
document.html: The codex-templates/templates/minima/document․html file
document.html: The codex-templates/templates/gamma/document․html file
document.html: The codex-templates/templates/traditional/document․html file

E
error.lisp: The codex/src/error․lisp file

F
File, base.html: The codex-templates/templates/minima/base․html file
File, base.html: The codex-templates/templates/gamma/base․html file
File, base.html: The codex-templates/templates/traditional/base․html file
File, codex-templates.asd: The codex-templates/codex-templates․asd file
File, codex.asd: The codex/codex․asd file
File, codex.lisp: The codex/src/codex․lisp file
File, document.html: The codex-templates/templates/minima/document․html file
File, document.html: The codex-templates/templates/gamma/document․html file
File, document.html: The codex-templates/templates/traditional/document․html file
File, error.lisp: The codex/src/error․lisp file
File, macro.lisp: The codex/src/macro․lisp file
File, manifest.lisp: The codex/src/manifest․lisp file
File, markup.lisp: The codex/src/markup․lisp file
File, nodes.css: The codex-templates/templates/static/nodes․css file
File, quickstart.lisp: The codex/src/quickstart․lisp file
File, reset.css: The codex-templates/templates/static/reset․css file
File, section.html: The codex-templates/templates/minima/section․html file
File, section.html: The codex-templates/templates/gamma/section․html file
File, section.html: The codex-templates/templates/traditional/section․html file
File, style.css: The codex-templates/templates/minima/style․css file
File, style.css: The codex-templates/templates/gamma/style․css file
File, style.css: The codex-templates/templates/traditional/style․css file
File, templates.lisp: The codex-templates/templates/templates․lisp file

G
gamma: The codex-templates/templates/gamma module
gamma: Private classes

H
html: Public classes

M
macro.lisp: The codex/src/macro․lisp file
manifest: Public classes
manifest-error: Public conditions
manifest.lisp: The codex/src/manifest․lisp file
markup.lisp: The codex/src/markup․lisp file
minima: The codex-templates/templates/minima module
minima: Private classes
Module, gamma: The codex-templates/templates/gamma module
Module, minima: The codex-templates/templates/minima module
Module, src: The codex/src module
Module, static: The codex-templates/templates/static module
Module, templates: The codex-templates/templates module
Module, traditional: The codex-templates/templates/traditional module
multi-html: Public classes

N
no-docstring: Public conditions
nodes.css: The codex-templates/templates/static/nodes․css file

O
output-format: Public classes

P
Package, codex: The codex package
Package, codex-manifest-user: The codex-manifest-user package
Package, codex.error: The codex․error package
Package, codex.macro: The codex․macro package
Package, codex.manifest: The codex․manifest package
Package, codex.markup: The codex․markup package
Package, codex.tmpl: The codex․tmpl package
param: Public classes

Q
quickstart.lisp: The codex/src/quickstart․lisp file

R
reset.css: The codex-templates/templates/static/reset․css file

S
section.html: The codex-templates/templates/minima/section․html file
section.html: The codex-templates/templates/gamma/section․html file
section.html: The codex-templates/templates/traditional/section․html file
single-html: Public classes
spec: Public classes
src: The codex/src module
static: The codex-templates/templates/static module
style.css: The codex-templates/templates/minima/style․css file
style.css: The codex-templates/templates/gamma/style․css file
style.css: The codex-templates/templates/traditional/style․css file
System, codex: The codex system
System, codex-templates: The codex-templates system

T
template-error: Public conditions
templates: The codex-templates/templates module
templates.lisp: The codex-templates/templates/templates․lisp file
traditional: The codex-templates/templates/traditional module

U
unsupported-output-format: Public conditions

W
with-package: Public classes