The codex Reference Manual

Table of Contents

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

The codex Reference Manual

This is the codex Reference Manual, version 0.2, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:45:08 2018 GMT+0.


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

1 Introduction

Codex

Build Status Coverage Status

A documentation system for Common Lisp.

Overview

Codex generates documentation. You just write docstrings as usual, only using 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

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.


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

2.1 codex

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

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

Description

A documentation system for Common Lisp.

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
Source

codex.asd (file)

Component

src (module)


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

2.2 codex-templates

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

License

MIT

Description

Templates for Codex.

Version

0.1

Dependencies
Source

codex-templates.asd (file)

Component

templates (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 codex/src

Parent

codex (system)

Location

src/

Components

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

3.2 codex-templates/templates

Parent

codex-templates (system)

Location

templates/

Components

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

3.3 codex-templates/templates/static

Dependency

templates.lisp (file)

Parent

templates (module)

Location

templates/static/

Components

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

3.4 codex-templates/templates/minima

Dependency

static (module)

Parent

templates (module)

Location

templates/minima/

Components

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

3.5 codex-templates/templates/gamma

Dependency

minima (module)

Parent

templates (module)

Location

templates/gamma/

Components

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

3.6 codex-templates/templates/traditional

Dependency

gamma (module)

Parent

templates (module)

Location

/home/quickbuilder/quicklisp/dists/quicklisp/software/codex-20180228-git/templates/traditional/ (not found)

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 codex.asd

Location

codex.asd

Systems

codex (system)


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

4.1.2 codex-templates.asd

Location

codex-templates.asd

Systems

codex-templates (system)


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

4.1.3 codex/src/error.lisp

Parent

src (module)

Location

src/error.lisp

Packages

codex.error

Exported Definitions

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

4.1.4 codex/src/markup.lisp

Dependency

error.lisp (file)

Parent

src (module)

Location

src/markup.lisp

Packages

codex.markup

Exported Definitions

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

4.1.5 codex/src/manifest.lisp

Dependency

markup.lisp (file)

Parent

src (module)

Location

src/manifest.lisp

Packages
Exported Definitions
Internal Definitions

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

4.1.6 codex/src/macro.lisp

Dependency

manifest.lisp (file)

Parent

src (module)

Location

src/macro.lisp

Packages

codex.macro

Exported Definitions
Internal Definitions

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

4.1.7 codex/src/codex.lisp

Dependency

macro.lisp (file)

Parent

src (module)

Location

src/codex.lisp

Packages

codex

Exported Definitions
Internal Definitions

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

4.1.8 codex/src/quickstart.lisp

Dependency

codex.lisp (file)

Parent

src (module)

Location

src/quickstart.lisp

Exported Definitions

quickstart (function)

Internal Definitions

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

4.1.9 codex-templates/templates/templates.lisp

Parent

templates (module)

Location

templates/templates.lisp

Packages

codex.tmpl

Exported Definitions
Internal Definitions

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

4.2 Other


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

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

Parent

static (module)

Location

templates/static/nodes.css


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

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

Parent

static (module)

Location

templates/static/reset.css


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

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

Parent

minima (module)

Location

templates/minima/base.html


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

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

Parent

minima (module)

Location

templates/minima/document.html


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

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

Parent

minima (module)

Location

templates/minima/section.html


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

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

Parent

minima (module)

Location

templates/minima/style.css


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

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

Parent

gamma (module)

Location

templates/gamma/base.html


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

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

Parent

gamma (module)

Location

templates/gamma/document.html


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

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

Parent

gamma (module)

Location

templates/gamma/section.html


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

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

Parent

gamma (module)

Location

templates/gamma/style.css


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

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

Parent

traditional (module)

Location

/home/quickbuilder/quicklisp/dists/quicklisp/software/codex-20180228-git/templates/traditional/base.html (not found)


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

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

Parent

traditional (module)

Location

/home/quickbuilder/quicklisp/dists/quicklisp/software/codex-20180228-git/templates/traditional/document.html (not found)


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

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

Parent

traditional (module)

Location

/home/quickbuilder/quicklisp/dists/quicklisp/software/codex-20180228-git/templates/traditional/section.html (not found)


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

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

Parent

traditional (module)

Location

/home/quickbuilder/quicklisp/dists/quicklisp/software/codex-20180228-git/templates/traditional/style.css (not found)


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

5 Packages

Packages are listed by definition order.


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

5.1 codex.error

Codex errors.

Source

error.lisp (file)

Use List

common-lisp

Exported Definitions

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

5.2 codex.markup

Parsing files and docstrings.

Source

markup.lisp (file)

Use List

common-lisp

Exported Definitions

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

5.3 codex-manifest-user

The package in which Codex manifests are read.

Source

manifest.lisp (file)

Use List

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

5.4 codex.manifest

Parsing Codex manifest files.

Source

manifest.lisp (file)

Use List

common-lisp

Used By List

codex-manifest-user

Exported Definitions
Internal Definitions

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

5.5 codex.macro

CommonDoc macros for Codex.

Source

macro.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5.6 codex

The main interface.

Source

codex.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5.7 codex.tmpl

Codex template definitions.

Source

templates.lisp (file)

Use 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: *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 (file)

Special Variable: *default-manifest-pathname*

The pathname of the Codex manifest in a system.

Package

codex.manifest

Source

manifest.lisp (file)

Special Variable: *index*

The current Docparser index.

Package

codex.macro

Source

macro.lisp (file)

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

Special Variable: *template-database*

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

Package

codex.tmpl

Source

templates.lisp (file)


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

6.1.2 Functions

Function: document SYSTEM-NAME &key SKIP-UNDOCUMENTED

Generate documentation for a system. @c(skip-undocumented) overrides @c(*skip-undocumented*)

Package

codex

Source

codex.lisp (file)

Function: find-template TEMPLATE-NAME

Find a template by name.

Package

codex.tmpl

Source

templates.lisp (file)

Function: parse-manifest PATHNAME

Parse a manifest from a pathname.

Package

codex.manifest

Source

manifest.lisp (file)

Function: parse-string STRING

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

Package

codex.markup

Source

markup.lisp (file)

Function: quickstart SYSTEM-NAME

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

Package

codex

Source

quickstart.lisp (file)

Function: system-manifest-pathname SYSTEM-NAME

Return the absolute pathname to a system’s Codex manifest.

Package

codex.manifest

Source

manifest.lisp (file)


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

6.1.3 Generic functions

Generic Function: document-authors OBJECT
Package

codex.manifest

Methods
Method: document-authors (DOCUMENT document)

A list of the document’s authors.

Source

manifest.lisp (file)

Generic Function: document-output-format OBJECT
Package

codex.manifest

Methods
Method: document-output-format (DOCUMENT document)

The document’s output format.

Source

manifest.lisp (file)

Generic Function: document-sources OBJECT
Package

codex.manifest

Methods
Method: document-sources (DOCUMENT document)

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

Source

manifest.lisp (file)

Generic Function: document-title OBJECT
Package

codex.manifest

Methods
Method: document-title (DOCUMENT document)

The document’s title.

Source

manifest.lisp (file)

Generic Function: format-name CONDITION
Package

codex.error

Methods
Method: format-name (CONDITION unsupported-output-format)
Source

error.lisp (file)

Generic Function: manifest-documents OBJECT
Package

codex.manifest

Methods
Method: manifest-documents (MANIFEST manifest)

A list of documents.

Source

manifest.lisp (file)

Generic Function: manifest-markup-format OBJECT
Package

codex.manifest

Methods
Method: manifest-markup-format (MANIFEST manifest)

The markup format used in docstrings.

Source

manifest.lisp (file)

Generic Function: manifest-systems OBJECT
Package

codex.manifest

Methods
Method: manifest-systems (MANIFEST manifest)

A list of systems to document.

Source

manifest.lisp (file)

Generic Function: message CONDITION
Package

codex.error

Methods
Method: message (CONDITION template-error)
Source

error.lisp (file)

Method: message (CONDITION manifest-error)
Source

error.lisp (file)

Generic Function: node CONDITION
Package

codex.error

Methods
Method: node (CONDITION no-docstring)
Source

error.lisp (file)

Generic Function: output-html-template OBJECT
Package

codex.manifest

Methods
Method: output-html-template (HTML html)

The name of the HTML template.

Source

manifest.lisp (file)

Generic Function: output-html-template-options OBJECT
Package

codex.manifest

Methods
Method: output-html-template-options (HTML html)

A property list of template initargs.

Source

manifest.lisp (file)

Generic Function: system-name CONDITION
Package

codex.error

Methods
Method: system-name (CONDITION manifest-error)
Source

error.lisp (file)

Generic Function: template-name CONDITION
Package

codex.error

Methods
Method: template-name (CONDITION template-error)
Source

error.lisp (file)


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

6.1.4 Conditions

Condition: codex-error ()

The base class of all Codex errors.

Package

codex.error

Source

error.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses
Condition: manifest-error ()

Signalled when there is an error parsing a manifest file.

Package

codex.error

Source

error.lisp (file)

Direct superclasses

codex-error (condition)

Direct methods
Direct slots
Slot: system-name

The name of the system.

Initargs

:system-name

Readers

system-name (generic function)

Slot: message

The error message.

Initargs

:message

Readers

message (generic function)

Condition: no-docstring ()

Signalled when a node has no docstring.

Package

codex.error

Source

error.lisp (file)

Direct superclasses

codex-error (condition)

Direct methods

node (method)

Direct slots
Slot: node

The node without docstring.

Initargs

:node

Readers

node (generic function)

Condition: template-error ()

Signalled by errors related to templates.

Package

codex.error

Source

error.lisp (file)

Direct superclasses

codex-error (condition)

Direct methods
Direct slots
Slot: template-name

The template name.

Initargs

:template-name

Readers

template-name (generic function)

Slot: message

The error message.

Initargs

:message

Readers

message (generic function)

Condition: unsupported-output-format ()

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

Package

codex.error

Source

error.lisp (file)

Direct superclasses

codex-error (condition)

Direct methods

format-name (method)

Direct slots
Slot: format-name

The name of the output format.

Initargs

:format-name

Readers

format-name (generic function)


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

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

Direct superclasses

codex-template (class)

Direct subclasses
Direct methods
  • render-section (method)
  • render (method)
Class: cl-doc ()

Insert documentation of a node.

Package

codex.macro

Source

macro.lisp (file)

Direct superclasses

macro-node (class)

Direct methods

expand-macro (method)

Class: codex-template ()

Codex templates.

Package

codex.tmpl

Source

templates.lisp (file)

Direct superclasses

template (class)

Direct subclasses

built-in-template (class)

Direct methods
Direct slots
Slot: output-directory

The directory where the output will be produced.

Type

pathname

Initargs

:output-directory

Readers

output-directory (generic function)

Slot: options

A plist of template options.

Type

trivial-types:property-list

Initargs

:options

Readers

options (generic function)

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

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: document-title

The document’s title.

Type

string

Initargs

:title

Readers

document-title (generic function)

Slot: document-authors

A list of the document’s authors.

Type

(trivial-types:proper-list string)

Initargs

:authors

Readers

document-authors (generic function)

Slot: output-format

The document’s output format.

Type

codex.manifest:output-format

Initargs

:output-format

Readers

document-output-format (generic function)

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

Class: html ()

The base class of HTML formats.

Package

codex.manifest

Source

manifest.lisp (file)

Direct superclasses

output-format (class)

Direct subclasses
Direct methods
Direct slots
Slot: html-template

The name of the HTML template.

Type

keyword

Initargs

:template-name

Readers

output-html-template (generic function)

Slot: template-options

A property list of template initargs.

Type

trivial-types:property-list

Initargs

:template-options

Readers

output-html-template-options (generic function)

Class: manifest ()

Manifest options.

Package

codex.manifest

Source

manifest.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: markup-format

The markup format used in docstrings.

Type

keyword

Initargs

:markup-format

Readers

manifest-markup-format (generic function)

Slot: systems

A list of systems to document.

Type

(trivial-types:proper-list keyword)

Initargs

:systems

Readers

manifest-systems (generic function)

Slot: documents

A list of documents.

Type

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

Initargs

:documents

Readers

manifest-documents (generic function)

Class: multi-html ()

Multi-file HTML output.

Package

codex.manifest

Source

manifest.lisp (file)

Direct superclasses

html (class)

Class: output-format ()

The base class of all output formats.

Package

codex.manifest

Source

manifest.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

html (class)

Class: param ()

An argument of an operator.

Package

codex.macro

Source

macro.lisp (file)

Direct superclasses

macro-node (class)

Direct methods

expand-macro (method)

Class: single-html ()

Single-file HTML output.

Package

codex.manifest

Source

manifest.lisp (file)

Direct superclasses

html (class)

Class: spec ()

Add a link to the Common Lisp HyperSpec.

Package

codex.macro

Source

macro.lisp (file)

Direct superclasses

macro-node (class)

Direct methods

expand-macro (method)

Class: with-package ()

Set the current package to use in the body.

Package

codex.macro

Source

macro.lisp (file)

Direct superclasses

macro-node (class)

Direct methods
Direct slots
Slot: name

The package’s name.

Type

string

Readers

package-macro-name (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: *current-package-name*

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

Package

codex.macro

Source

macro.lisp (file)

Special Variable: *undocumented-list*

List of undocumented nodes

Package

codex

Source

codex.lisp (file)

Special Variable: +manifest-template+
Package

codex

Source

quickstart.lisp (file)

Special Variable: +manual-template+
Package

codex

Source

quickstart.lisp (file)

Special Variable: +templates-directory+
Package

codex.tmpl

Source

templates.lisp (file)

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


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

6.2.2 Macros

Macro: define-built-in-template NAME &key DOCUMENT-TEMPLATE SECTION-TEMPLATE STATIC-FILES DOCUMENTATION
Package

codex.tmpl

Source

templates.lisp (file)


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

6.2.3 Functions

Function: build-document DOCUMENT DIRECTORY

Build a document.

Package

codex

Source

codex.lisp (file)

Function: build-manifest MANIFEST DIRECTORY

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

Package

codex

Source

codex.lisp (file)

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

Function: clean-author-name AUTHOR
Package

codex

Source

quickstart.lisp (file)

Function: copy-images DOCUMENT DIRECTORY

Copy all the images from a CommonDoc document.

Package

codex

Source

codex.lisp (file)

Function: docstring-node NODE

Create a node representing a node’s docstring.

Package

codex.macro

Source

macro.lisp (file)

Function: expand-operator-node NODE CLASS-NAME

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

Package

codex.macro

Source

macro.lisp (file)

Function: expand-record-node CLASS NODE
Package

codex.macro

Source

macro.lisp (file)

Function: find-node TYPE SYMBOL REST
Package

codex.macro

Source

macro.lisp (file)

Function: find-node-type-by-name NAME
Package

codex.macro

Source

macro.lisp (file)

Function: list-to-code-node CLASS LIST
Package

codex.macro

Source

macro.lisp (file)

Function: load-document DOCUMENT DIRECTORY

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

Package

codex

Source

codex.lisp (file)

Function: make-class-metadata CLASS

Create metadata for HTML classes.

Package

codex.macro

Source

macro.lisp (file)

Function: make-doc-node CLASSES &rest CHILDREN
Package

codex.macro

Source

macro.lisp (file)

Function: no-method-found NAME LAMBDA-LIST
Package

codex.macro

Source

macro.lisp (file)

Function: no-method-lambda-list NAME
Package

codex.macro

Source

macro.lisp (file)

Function: no-such-type NAME
Package

codex.macro

Source

macro.lisp (file)

Function: node-not-found SYMBOL
Package

codex.macro

Source

macro.lisp (file)

Function: parse-document DOCUMENT-PLIST

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

Package

codex.manifest

Source

manifest.lisp (file)

Function: parse-output-format PLIST

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

Package

codex.manifest

Source

manifest.lisp (file)

Function: print-undocumented UNDOCUMENTED
Package

codex

Source

codex.lisp (file)

Function: read-manifest PATHNAME

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

Package

codex.manifest

Source

manifest.lisp (file)

Function: static-output-directory BUILT-IN-TEMPLATE
Package

codex.tmpl

Source

templates.lisp (file)

Function: undocumented-handler C

Handle undocumented nodes

Package

codex

Source

codex.lisp (file)

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


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

6.2.4 Generic functions

Generic Function: document-template TEMPLATE
Package

codex.tmpl

Source

templates.lisp (file)

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

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.

Source

macro.lisp (file)

Generic Function: options OBJECT
Package

codex.tmpl

Methods
Method: options (CODEX-TEMPLATE codex-template)

A plist of template options.

Source

templates.lisp (file)

Generic Function: output-directory OBJECT
Package

codex.tmpl

Methods
Method: output-directory (CODEX-TEMPLATE codex-template)

The directory where the output will be produced.

Source

templates.lisp (file)

Generic Function: package-macro-name OBJECT
Package

codex.macro

Methods
Method: package-macro-name (WITH-PACKAGE with-package)

The package’s name.

Source

macro.lisp (file)

Generic Function: section-template TEMPLATE
Package

codex.tmpl

Source

templates.lisp (file)

Methods
Method: section-template (TEMPLATE gamma)
Method: section-template (TEMPLATE minima)
Generic Function: static-files TEMPLATE
Package

codex.tmpl

Source

templates.lisp (file)

Methods
Method: static-files (TEMPLATE gamma)
Method: static-files (TEMPLATE minima)

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

6.2.5 Classes

Class: gamma ()

Modern template.

Package

codex.tmpl

Source

templates.lisp (file)

Direct superclasses

built-in-template (class)

Direct methods
Class: minima ()

Minimalist template.

Package

codex.tmpl

Source

templates.lisp (file)

Direct superclasses

built-in-template (class)

Direct methods

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M   O  
Index Entry  Section

C
codex-templates.asd: The codex-templates<dot>asd file
codex-templates/templates: The codex-templates/templates module
codex-templates/templates/gamma: The codex-templates/templates/gamma module
codex-templates/templates/gamma/base.html: The codex-templates/templates/gamma/base<dot>html file
codex-templates/templates/gamma/document.html: The codex-templates/templates/gamma/document<dot>html file
codex-templates/templates/gamma/section.html: The codex-templates/templates/gamma/section<dot>html file
codex-templates/templates/gamma/style.css: The codex-templates/templates/gamma/style<dot>css file
codex-templates/templates/minima: The codex-templates/templates/minima module
codex-templates/templates/minima/base.html: The codex-templates/templates/minima/base<dot>html file
codex-templates/templates/minima/document.html: The codex-templates/templates/minima/document<dot>html file
codex-templates/templates/minima/section.html: The codex-templates/templates/minima/section<dot>html file
codex-templates/templates/minima/style.css: The codex-templates/templates/minima/style<dot>css file
codex-templates/templates/static: The codex-templates/templates/static module
codex-templates/templates/static/nodes.css: The codex-templates/templates/static/nodes<dot>css file
codex-templates/templates/static/reset.css: The codex-templates/templates/static/reset<dot>css file
codex-templates/templates/templates.lisp: The codex-templates/templates/templates<dot>lisp file
codex-templates/templates/traditional: The codex-templates/templates/traditional module
codex-templates/templates/traditional/base.html: The codex-templates/templates/traditional/base<dot>html file
codex-templates/templates/traditional/document.html: The codex-templates/templates/traditional/document<dot>html file
codex-templates/templates/traditional/section.html: The codex-templates/templates/traditional/section<dot>html file
codex-templates/templates/traditional/style.css: The codex-templates/templates/traditional/style<dot>css file
codex.asd: The codex<dot>asd file
codex/src: The codex/src module
codex/src/codex.lisp: The codex/src/codex<dot>lisp file
codex/src/error.lisp: The codex/src/error<dot>lisp file
codex/src/macro.lisp: The codex/src/macro<dot>lisp file
codex/src/manifest.lisp: The codex/src/manifest<dot>lisp file
codex/src/markup.lisp: The codex/src/markup<dot>lisp file
codex/src/quickstart.lisp: The codex/src/quickstart<dot>lisp file

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

L
Lisp File, codex-templates.asd: The codex-templates<dot>asd file
Lisp File, codex-templates/templates/templates.lisp: The codex-templates/templates/templates<dot>lisp file
Lisp File, codex.asd: The codex<dot>asd file
Lisp File, codex/src/codex.lisp: The codex/src/codex<dot>lisp file
Lisp File, codex/src/error.lisp: The codex/src/error<dot>lisp file
Lisp File, codex/src/macro.lisp: The codex/src/macro<dot>lisp file
Lisp File, codex/src/manifest.lisp: The codex/src/manifest<dot>lisp file
Lisp File, codex/src/markup.lisp: The codex/src/markup<dot>lisp file
Lisp File, codex/src/quickstart.lisp: The codex/src/quickstart<dot>lisp file

M
Module, codex-templates/templates: The codex-templates/templates module
Module, codex-templates/templates/gamma: The codex-templates/templates/gamma module
Module, codex-templates/templates/minima: The codex-templates/templates/minima module
Module, codex-templates/templates/static: The codex-templates/templates/static module
Module, codex-templates/templates/traditional: The codex-templates/templates/traditional module
Module, codex/src: The codex/src module

O
Other File, codex-templates/templates/gamma/base.html: The codex-templates/templates/gamma/base<dot>html file
Other File, codex-templates/templates/gamma/document.html: The codex-templates/templates/gamma/document<dot>html file
Other File, codex-templates/templates/gamma/section.html: The codex-templates/templates/gamma/section<dot>html file
Other File, codex-templates/templates/gamma/style.css: The codex-templates/templates/gamma/style<dot>css file
Other File, codex-templates/templates/minima/base.html: The codex-templates/templates/minima/base<dot>html file
Other File, codex-templates/templates/minima/document.html: The codex-templates/templates/minima/document<dot>html file
Other File, codex-templates/templates/minima/section.html: The codex-templates/templates/minima/section<dot>html file
Other File, codex-templates/templates/minima/style.css: The codex-templates/templates/minima/style<dot>css file
Other File, codex-templates/templates/static/nodes.css: The codex-templates/templates/static/nodes<dot>css file
Other File, codex-templates/templates/static/reset.css: The codex-templates/templates/static/reset<dot>css file
Other File, codex-templates/templates/traditional/base.html: The codex-templates/templates/traditional/base<dot>html file
Other File, codex-templates/templates/traditional/document.html: The codex-templates/templates/traditional/document<dot>html file
Other File, codex-templates/templates/traditional/section.html: The codex-templates/templates/traditional/section<dot>html file
Other File, codex-templates/templates/traditional/style.css: The codex-templates/templates/traditional/style<dot>css file

Jump to:   C   F   L   M   O  

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

A.2 Functions

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

B
build-document: Internal functions
build-manifest: Internal functions

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

D
define-built-in-template: Internal macros
docstring-node: Internal functions
document: Exported functions
document-authors: Exported generic functions
document-authors: Exported generic functions
document-output-format: Exported generic functions
document-output-format: Exported generic functions
document-sources: Exported generic functions
document-sources: Exported generic functions
document-template: Internal generic functions
document-template: Internal generic functions
document-template: Internal generic functions
document-title: Exported generic functions
document-title: Exported generic functions

E
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-node: Internal generic functions
expand-operator-node: Internal functions
expand-record-node: Internal functions

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

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

L
list-to-code-node: Internal functions
load-document: Internal functions

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

N
name-node: Internal generic functions
name-node: Internal generic functions
no-method-found: Internal functions
no-method-lambda-list: Internal functions
no-such-type: Internal functions
node: Exported generic functions
node: Exported generic functions
node-not-found: Internal functions

O
options: Internal generic functions
options: Internal generic functions
output-directory: Internal generic functions
output-directory: Internal generic functions
output-html-template: Exported generic functions
output-html-template: Exported generic functions
output-html-template-options: Exported generic functions
output-html-template-options: Exported generic functions

P
package-macro-name: Internal generic functions
package-macro-name: Internal generic functions
parse-document: Internal functions
parse-manifest: Exported functions
parse-output-format: Internal functions
parse-string: Exported functions
print-undocumented: Internal functions

Q
quickstart: Exported functions

R
read-manifest: Internal functions

S
section-template: Internal generic functions
section-template: Internal generic functions
section-template: Internal generic functions
static-files: Internal generic functions
static-files: Internal generic functions
static-files: Internal generic functions
static-output-directory: Internal functions
system-manifest-pathname: Exported functions
system-name: Exported generic functions
system-name: Exported generic functions

T
template-name: Exported generic functions
template-name: Exported generic functions

U
undocumented-handler: Internal functions
url-for-symbol: Internal functions

Jump to:   B   C   D   E   F   G   L   M   N   O   P   Q   R   S   T   U  

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

A.3 Variables

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

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

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

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

F
format-name: Exported conditions

H
html-template: Exported classes

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

N
name: Exported classes
node: Exported conditions

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

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

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

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

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

A.4 Data types

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

B
built-in-template: Exported classes

C
cl-doc: Exported classes
Class, built-in-template: Exported classes
Class, cl-doc: Exported classes
Class, codex-template: Exported classes
Class, document: Exported classes
Class, gamma: Internal classes
Class, html: Exported classes
Class, manifest: Exported classes
Class, minima: Internal classes
Class, multi-html: Exported classes
Class, output-format: Exported classes
Class, param: Exported classes
Class, single-html: Exported classes
Class, spec: Exported classes
Class, with-package: Exported classes
codex: The codex system
codex: The codex package
codex-error: Exported conditions
codex-manifest-user: The codex-manifest-user package
codex-template: Exported classes
codex-templates: The codex-templates system
codex.error: The codex<dot>error package
codex.macro: The codex<dot>macro package
codex.manifest: The codex<dot>manifest package
codex.markup: The codex<dot>markup package
codex.tmpl: The codex<dot>tmpl package
Condition, codex-error: Exported conditions
Condition, manifest-error: Exported conditions
Condition, no-docstring: Exported conditions
Condition, template-error: Exported conditions
Condition, unsupported-output-format: Exported conditions

D
document: Exported classes

G
gamma: Internal classes

H
html: Exported classes

M
manifest: Exported classes
manifest-error: Exported conditions
minima: Internal classes
multi-html: Exported classes

N
no-docstring: Exported conditions

O
output-format: Exported classes

P
Package, codex: The codex package
Package, codex-manifest-user: The codex-manifest-user package
Package, codex.error: The codex<dot>error package
Package, codex.macro: The codex<dot>macro package
Package, codex.manifest: The codex<dot>manifest package
Package, codex.markup: The codex<dot>markup package
Package, codex.tmpl: The codex<dot>tmpl package
param: Exported classes

S
single-html: Exported classes
spec: Exported classes
System, codex: The codex system
System, codex-templates: The codex-templates system

T
template-error: Exported conditions

U
unsupported-output-format: Exported conditions

W
with-package: Exported classes

Jump to:   B   C   D   G   H   M   N   O   P   S   T   U   W