The eazy-documentation Reference Manual

Table of Contents

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

The eazy-documentation Reference Manual

This is the eazy-documentation Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:57:45 2021 GMT+0.


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

1 Introduction

Eazy-Documentation img

Example page containing the documentation of eazy-documentation itself can be found here.

Another example for NUMCL library.

Command line interface can be installed via Roswell: ros install guicho271828/eazy-documentation

Usage: eazy-documentation file-or-system output [OPTIONS]

The output is a single file when the output has a html extension; otherwise it will be considered as a directory name. It comes with a CSS and an empty javascript file.

Options are specified as follows:

Options:

| keyword | description | |:----------------|:--------------------------------------------------------------------------| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be changed. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Requirements

texinfo and up-to-date pandoc (note: some package managers, e.g., Ubuntu's APT, provides a severely outdated version and results in a terrible output. Install the latest version from https://pandoc.org/installing.html )

Author, License, Copyright

Masataro Asai (guicho2.71828@gmail.com)

Licensed under LGPL v3.

Copyright (c) 2019 IBM Corporation


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

2 Systems

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


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

2.1 eazy-documentation

Author

Masataro Asai

Contact

guicho2.71828@gmail.com

License

LGPL

Description

One-shot solution to the CL documentation generator.

Version

0.1

Dependencies
Source

eazy-documentation.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 eazy-documentation.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/eazy-documentation-20210411-git/eazy-documentation.asd

Systems

eazy-documentation (system)


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

3.1.2 eazy-documentation/0package.lisp

Parent

eazy-documentation (system)

Location

0package.lisp

Packages

eazy-documentation

Internal Definitions

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

3.1.3 eazy-documentation/1common.lisp

Dependency

0package.lisp (file)

Parent

eazy-documentation (system)

Location

1common.lisp

Internal Definitions

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

3.1.4 eazy-documentation/1definition.lisp

Dependency

1common.lisp (file)

Parent

eazy-documentation (system)

Location

1definition.lisp

Internal Definitions

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

3.1.5 eazy-documentation/1raw-html.lisp

Dependency

1definition.lisp (file)

Parent

eazy-documentation (system)

Location

1raw-html.lisp

Exported Definitions

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

3.1.6 eazy-documentation/2extractor.lisp

Dependency

1raw-html.lisp (file)

Parent

eazy-documentation (system)

Location

2extractor.lisp

Internal Definitions

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

3.1.7 eazy-documentation/3emitter.lisp

Dependency

2extractor.lisp (file)

Parent

eazy-documentation (system)

Location

3emitter.lisp

Internal Definitions

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

3.1.8 eazy-documentation/4user.lisp

Dependency

3emitter.lisp (file)

Parent

eazy-documentation (system)

Location

4user.lisp

Exported Definitions
Internal Definitions

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

3.1.9 eazy-documentation/5template.lisp

Dependency

4user.lisp (file)

Parent

eazy-documentation (system)

Location

5template.lisp

Internal Definitions

eazy-template (class)


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

3.1.10 eazy-documentation/6main.lisp

Dependency

5template.lisp (file)

Parent

eazy-documentation (system)

Location

6main.lisp

Exported Definitions

main (function)


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

4 Packages

Packages are listed by definition order.


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

4.1 eazy-documentation

This package provides an easy way to extract documentations from
a lisp source code.

Advantages over the existing libraries:

* EAZY-DOCUMENTATION can generate documents from a single file or an ASDF system.
Run ‘(eazy-documentation:generate-html <file-or-system> "index.html")‘
No additional quirks are necessary.

* Extraction is heuristic and robust. It is easily automated and can handle
unknown user-defined macro whose name begins with DEF.

* As per Quickdocs, it respects the file and directory structure. Well-written, maintainable libraries have a great readability in the source code. This should be respected
and the documentation generator should respect this structure.

* It minimizes the clutter in the auto-generateded output by detecting and
grouping the similar documentation entries.
For example, these entries are grouped together:

* Functions with the same lambda-list and docstrings.
* Variables with the same docstrings.
* Any DEF-something macro entries with the same name and missing documentations.

* Typesetting and syntax highlighting of docstring is done by [Pandoc](https://pandoc.org/) which supports a wide range of language and
format support.

Run ‘curl -sSL https://get.haskellstack.org/ | sh && stack install pandoc‘
to install the latest Pandoc.

* The output is a common-doc object, thus easily pluggable to the existing emitter
for them.

Source

0package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Functions

Function: convert-file-to-ascii-string PIN
Package

eazy-documentation

Source

1raw-html.lisp (file)

Function: convert-file-to-html-string PIN
Package

eazy-documentation

Source

1raw-html.lisp (file)

Function: convert-string-to-ascii-string STRING MARKUP
Package

eazy-documentation

Source

1raw-html.lisp (file)

Function: convert-string-to-html-string STRING MARKUP
Package

eazy-documentation

Source

1raw-html.lisp (file)

Function: extract-definitions-from-file FILE &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

4user.lisp (file)

Function: extract-definitions-from-system SYSTEM &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

4user.lisp (file)

Function: generate-commondoc-from-file FILE &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

4user.lisp (file)

Function: generate-commondoc-from-system SYSTEM &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

4user.lisp (file)

Function: generate-html FILE-OR-SYSTEM *TARGET-PATHNAME* &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

4user.lisp (file)

Function: generate-html-from-dir DIR *TARGET-PATHNAME* &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

4user.lisp (file)

Function: generate-html-from-file FILE *TARGET-PATHNAME* &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

4user.lisp (file)

Function: generate-html-from-system SYSTEM *TARGET-PATHNAME* &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

4user.lisp (file)

Function: main &rest ARGV
Package

eazy-documentation

Source

6main.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *default-css*

A list of CSS stylesheet pathnames to be loaded in the html by default.

Package

eazy-documentation

Source

3emitter.lisp (file)

Special Variable: *default-fonts*

A list of strings for Google font name

Package

eazy-documentation

Source

3emitter.lisp (file)

Special Variable: *default-js*

A list of JavaScript pathnames to be loaded in the html by default.

Package

eazy-documentation

Source

3emitter.lisp (file)

Special Variable: *deferred-tasks*

A list of thunks. Each thunk contains code to extract the docstring after loading the system. This variable is mainly used for parsing (setf (documentation ...)) forms
because the docstring may not be available in the macro expansion time unlike macros such as DEFUN.

Package

eazy-documentation

Source

2extractor.lisp (file)

Special Variable: *defs*
Package

eazy-documentation

Source

2extractor.lisp (file)

Special Variable: *ids*
Package

eazy-documentation

Source

3emitter.lisp (file)

Special Variable: *local-root*
Package

eazy-documentation

Source

1common.lisp (file)

Special Variable: *old-macroexpand-hook*
Package

eazy-documentation

Source

2extractor.lisp (file)

Special Variable: *remote-root*
Package

eazy-documentation

Source

1common.lisp (file)

Special Variable: *supported-extensions*

the list of supported extensions scraped by eazy-documentation

Package

eazy-documentation

Source

4user.lisp (file)

Special Variable: *target-pathname*
Package

eazy-documentation

Source

4user.lisp (file)

Special Variable: +doc+
Package

eazy-documentation

Source

1common.lisp (file)

Special Variable: +ignore+

Declare statement that says ignorable for the keyword arguments in +keywords+.

Package

eazy-documentation

Source

1common.lisp (file)

Special Variable: +keywords+

The list of keyword argument list shared by several functions.

Package

eazy-documentation

Source

1common.lisp (file)


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

5.2.2 Functions

Function: add-def &rest INITARGS &key DOCTYPE NAME ARGS DOCSTRING FILE
Package

eazy-documentation

Source

2extractor.lisp (file)

Function: augment-args-from-dir DIR &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

4user.lisp (file)

Function: augment-args-from-file FILE &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Supply missing command-line arguments using file information

Package

eazy-documentation

Source

4user.lisp (file)

Function: augment-args-from-system SYSTEM &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Supply missing command-line arguments using system information

Package

eazy-documentation

Source

4user.lisp (file)

Function: basename PATHNAME

path/to/dir/file -> file

Package

eazy-documentation

Source

1common.lisp (file)

Function: call-with-extracting-definitions FN
Package

eazy-documentation

Source

2extractor.lisp (file)

Function: classes &rest CLASSES
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: collect-static-files DIR &key NAME-PATTERN EXTENSIONS
Package

eazy-documentation

Source

4user.lisp (file)

Function: copy-destination SRC DIR
Package

eazy-documentation

Source

1common.lisp (file)

Function: copy-to-dir SRC DIR &optional FORCE
Package

eazy-documentation

Source

1common.lisp (file)

Function: def= A B

Compare the name and the doctype. Returns true when they are both EQ.

Package

eazy-documentation

Source

1definition.lisp (file)

Function: def~ A B

Compare the name (and its package), doctype, file, args, docstring. Returns true when they look same according to a heuristic rule.

Package

eazy-documentation

Source

1definition.lisp (file)

Function: def~doc A B

Compare the file and docstring.
Returns true when they are both missing or EQUAL.

Package

eazy-documentation

Source

1definition.lisp (file)

Function: dirname PATHNAME

path/to/dir/file -> path/to/dir

use uiop:pathname-directory-pathanme when you need path/to/dir/

Package

eazy-documentation

Source

1common.lisp (file)

Function: div ELEMENT-OR-ELEMENTS &rest ARGS
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: entry-status DEFS
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: expand-extracting-definitions EXPANDER FORM ENV
Package

eazy-documentation

Source

2extractor.lisp (file)

Function: extract-definitions FORM
Package

eazy-documentation

Source

2extractor.lisp (file)

Function: extract-definitions-from-dir DIR &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

4user.lisp (file)

Function: extract-definitions-from-static-files STATIC-FILES
Package

eazy-documentation

Source

4user.lisp (file)

Function: fdiv ELEMENT-OR-ELEMENTS

force making a div – make-content may omit them if it lacks classes

Package

eazy-documentation

Source

3emitter.lisp (file)

Function: generate-commondoc DEFS &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

3emitter.lisp (file)

Function: generate-commondoc-main DEFS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

3emitter.lisp (file)

Function: insert-docstring DEF ENTRY MARKUP MULTI-P
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: left A B
Package

eazy-documentation

Source

1definition.lisp (file)

Function: list+ &rest ARGS
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: list-all-define-macros &aux ACC

Print a list of all macros in the current lisp image whose name starts with DEF.

Package

eazy-documentation

Source

0package.lisp (file)

Function: local-enough-namestring FILE
Package

eazy-documentation

Source

1common.lisp (file)

Function: make-doc-entry ENTRIES DEF MARKUP
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: make-entry DEFS MODE &aux DEF
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: merge-slot FROM TO SLOT &optional FN
Package

eazy-documentation

Source

1definition.lisp (file)

Function: natural-language-string-p STRING

Heuristic decision to prune non-docstring

Package

eazy-documentation

Source

2extractor.lisp (file)

Function: note FORMAT-STRING &rest ARGS

A custom format variant for printing a note while eazy-documentation is processing a file.

Package

eazy-documentation

Source

0package.lisp (file)

Function: par STRING &rest CLASSES
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: parse-def FORM &aux ACC
Package

eazy-documentation

Source

2extractor.lisp (file)

Function: parse-key-arg ARG
Package

eazy-documentation

Source

1common.lisp (file)

Function: parse-setf ARGS
Package

eazy-documentation

Source

2extractor.lisp (file)

Function: print-args DEF
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: print-package DEF
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: process-black-white-list DEFS BLACKLIST WHITELIST EXTERNAL-ONLY
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: remote-enough-namestring FILE
Package

eazy-documentation

Source

1common.lisp (file)

Function: remove-macro-lambda-list-keywords LAMBDA-LIST

remove &whole and &env from a lambda list

Package

eazy-documentation

Source

2extractor.lisp (file)

Function: render-html NODE PATHNAME &rest ARGS &key TITLE HEADER FOOTER WHITELIST BLACKLIST EXTERNAL-ONLY TOC MAX-DEPTH TEMPLATE-CLASS CSS-LIST JS-LIST FONT-LIST CLEAN (REMOTE-ROOT *REMOTE-ROOT*) (LOCAL-ROOT *LOCAL-ROOT*) RELATIVE STATIC-FILES MARKUP &allow-other-keys

Options:

| keyword | description | |:—————-|:————————————————————————–| | :title | Documentation title | | :header | The header inserted after the title | | :footer | The footer inserted at the bottom | | :markup | Markup langage used in the docstring, should be supported by pandoc. | | | | | :whitelist | Whitelist of the package designators for the symbols being documented | | :blacklist | Blacklist of the package designators for the symbols being documented | | :external-only | Generate entries for external symbols only | | | | | :toc | Generate a table of contents (toc) | | :max-depth | The maximum depth of a toc | | | | | :template-class | COMMON-HTML template class, no need to be chanded. | | :css-list | List of CSS scripts to be added to the template. | | :js-list | List of Javascripts to be added to the template. | | :font-list | List of Google fonts to be added to the template. | | :clean | Overwrite CSS/JS in the target directory | | | | | :remote-root | Used to generate a weblink. Example: https://github.com/<name>/<proj> | | :local-root | Used to generate a weblink. Example: /home/<user>/lisp/<proj>/blob/master | | :relative | When non-nil, the output is relative to the value of local-root. | | :static-files | List of static README files etc. |

Package

eazy-documentation

Source

3emitter.lisp (file)

Function: safe-name DEF
Package

eazy-documentation

Source

1definition.lisp (file)

Function: span STRING &rest CLASSES
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: span-id NAME &rest CLASSES

Create a span element with an id based on SYM.

Package

eazy-documentation

Source

3emitter.lisp (file)

Function: strip/ FILENAME
Package

eazy-documentation

Source

4user.lisp (file)

Function: symbol-package-name-class SYM
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: symbol-status SYM
Package

eazy-documentation

Source

3emitter.lisp (file)

Function: table-of-contents DOC-OR-NODE &key MAX-DEPTH

Extract a tree of document links representing the table of contents of a document. All the sections in the document must have references, so you should call fill-unique-refs first.

Completely rewritten from common-html because it infers the depth incorrectly.

Package

eazy-documentation

Source

3emitter.lisp (file)


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

5.2.3 Generic functions

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

eazy-documentation

Methods
Method: args (DEF def)

automatically generated reader method

Source

1definition.lisp (file)

Method: (setf args) NEW-VALUE (DEF def)

automatically generated writer method

Source

1definition.lisp (file)

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

eazy-documentation

Methods
Method: docstring (DEF def)

automatically generated reader method

Source

1definition.lisp (file)

Method: (setf docstring) NEW-VALUE (DEF def)

automatically generated writer method

Source

1definition.lisp (file)

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

eazy-documentation

Methods
Method: doctype (DEF def)

automatically generated reader method

Source

1definition.lisp (file)

Method: (setf doctype) NEW-VALUE (DEF def)

automatically generated writer method

Source

1definition.lisp (file)

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

eazy-documentation

Methods
Method: file (DEF def)

automatically generated reader method

Source

1definition.lisp (file)

Method: (setf file) NEW-VALUE (DEF def)

automatically generated writer method

Source

1definition.lisp (file)

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

eazy-documentation

Methods
Method: name (DEF def)

automatically generated reader method

Source

1definition.lisp (file)

Method: (setf name) NEW-VALUE (DEF def)

automatically generated writer method

Source

1definition.lisp (file)


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

5.2.4 Classes

Class: def ()

Instances represententing a documentation entry.

Package

eazy-documentation

Source

1definition.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • file (method)
  • file (method)
  • docstring (method)
  • docstring (method)
  • args (method)
  • args (method)
  • name (method)
  • name (method)
  • doctype (method)
  • doctype (method)
Direct slots
Slot: doctype
Type

symbol

Initargs

:doctype

Readers

doctype (generic function)

Writers

(setf doctype) (generic function)

Slot: name
Type

eazy-documentation::name

Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: args
Type

list

Initargs

:args

Readers

args (generic function)

Writers

(setf args) (generic function)

Slot: docstring
Type

string

Initargs

:docstring

Readers

docstring (generic function)

Writers

(setf docstring) (generic function)

Slot: file
Type

pathname

Initargs

:file

Initform

(or *compile-file-pathname* *load-pathname*)

Readers

file (generic function)

Writers

(setf file) (generic function)

Class: eazy-template ()
Package

eazy-documentation

Source

5template.lisp (file)

Direct superclasses

template (class)

Direct methods
  • render-section (method)
  • render (method)
Direct slots
Slot: css-list
Type

list

Initargs

:css-list

Initform

eazy-documentation::*default-css*

Slot: font-list
Type

list

Initargs

:font-list

Initform

eazy-documentation::*default-fonts*

Slot: js-list
Type

list

Initargs

:js-list

Initform

eazy-documentation::*default-js*


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

5.2.5 Types

Type: name ()
Package

eazy-documentation

Source

1definition.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   E   F   L  
Index Entry  Section

E
eazy-documentation.asd: The eazy-documentation․asd file
eazy-documentation/0package.lisp: The eazy-documentation/0package․lisp file
eazy-documentation/1common.lisp: The eazy-documentation/1common․lisp file
eazy-documentation/1definition.lisp: The eazy-documentation/1definition․lisp file
eazy-documentation/1raw-html.lisp: The eazy-documentation/1raw-html․lisp file
eazy-documentation/2extractor.lisp: The eazy-documentation/2extractor․lisp file
eazy-documentation/3emitter.lisp: The eazy-documentation/3emitter․lisp file
eazy-documentation/4user.lisp: The eazy-documentation/4user․lisp file
eazy-documentation/5template.lisp: The eazy-documentation/5template․lisp file
eazy-documentation/6main.lisp: The eazy-documentation/6main․lisp file

F
File, Lisp, eazy-documentation.asd: The eazy-documentation․asd file
File, Lisp, eazy-documentation/0package.lisp: The eazy-documentation/0package․lisp file
File, Lisp, eazy-documentation/1common.lisp: The eazy-documentation/1common․lisp file
File, Lisp, eazy-documentation/1definition.lisp: The eazy-documentation/1definition․lisp file
File, Lisp, eazy-documentation/1raw-html.lisp: The eazy-documentation/1raw-html․lisp file
File, Lisp, eazy-documentation/2extractor.lisp: The eazy-documentation/2extractor․lisp file
File, Lisp, eazy-documentation/3emitter.lisp: The eazy-documentation/3emitter․lisp file
File, Lisp, eazy-documentation/4user.lisp: The eazy-documentation/4user․lisp file
File, Lisp, eazy-documentation/5template.lisp: The eazy-documentation/5template․lisp file
File, Lisp, eazy-documentation/6main.lisp: The eazy-documentation/6main․lisp file

L
Lisp File, eazy-documentation.asd: The eazy-documentation․asd file
Lisp File, eazy-documentation/0package.lisp: The eazy-documentation/0package․lisp file
Lisp File, eazy-documentation/1common.lisp: The eazy-documentation/1common․lisp file
Lisp File, eazy-documentation/1definition.lisp: The eazy-documentation/1definition․lisp file
Lisp File, eazy-documentation/1raw-html.lisp: The eazy-documentation/1raw-html․lisp file
Lisp File, eazy-documentation/2extractor.lisp: The eazy-documentation/2extractor․lisp file
Lisp File, eazy-documentation/3emitter.lisp: The eazy-documentation/3emitter․lisp file
Lisp File, eazy-documentation/4user.lisp: The eazy-documentation/4user․lisp file
Lisp File, eazy-documentation/5template.lisp: The eazy-documentation/5template․lisp file
Lisp File, eazy-documentation/6main.lisp: The eazy-documentation/6main․lisp file

Jump to:   E   F   L  

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

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   I   L   M   N   P   R   S   T  
Index Entry  Section

(
(setf args): Internal generic functions
(setf args): Internal generic functions
(setf docstring): Internal generic functions
(setf docstring): Internal generic functions
(setf doctype): Internal generic functions
(setf doctype): Internal generic functions
(setf file): Internal generic functions
(setf file): Internal generic functions
(setf name): Internal generic functions
(setf name): Internal generic functions

A
add-def: Internal functions
args: Internal generic functions
args: Internal generic functions
augment-args-from-dir: Internal functions
augment-args-from-file: Internal functions
augment-args-from-system: Internal functions

B
basename: Internal functions

C
call-with-extracting-definitions: Internal functions
classes: Internal functions
collect-static-files: Internal functions
convert-file-to-ascii-string: Exported functions
convert-file-to-html-string: Exported functions
convert-string-to-ascii-string: Exported functions
convert-string-to-html-string: Exported functions
copy-destination: Internal functions
copy-to-dir: Internal functions

D
def=: Internal functions
def~: Internal functions
def~doc: Internal functions
dirname: Internal functions
div: Internal functions
docstring: Internal generic functions
docstring: Internal generic functions
doctype: Internal generic functions
doctype: Internal generic functions

E
entry-status: Internal functions
expand-extracting-definitions: Internal functions
extract-definitions: Internal functions
extract-definitions-from-dir: Internal functions
extract-definitions-from-file: Exported functions
extract-definitions-from-static-files: Internal functions
extract-definitions-from-system: Exported functions

F
fdiv: Internal functions
file: Internal generic functions
file: Internal generic functions
Function, add-def: Internal functions
Function, augment-args-from-dir: Internal functions
Function, augment-args-from-file: Internal functions
Function, augment-args-from-system: Internal functions
Function, basename: Internal functions
Function, call-with-extracting-definitions: Internal functions
Function, classes: Internal functions
Function, collect-static-files: Internal functions
Function, convert-file-to-ascii-string: Exported functions
Function, convert-file-to-html-string: Exported functions
Function, convert-string-to-ascii-string: Exported functions
Function, convert-string-to-html-string: Exported functions
Function, copy-destination: Internal functions
Function, copy-to-dir: Internal functions
Function, def=: Internal functions
Function, def~: Internal functions
Function, def~doc: Internal functions
Function, dirname: Internal functions
Function, div: Internal functions
Function, entry-status: Internal functions
Function, expand-extracting-definitions: Internal functions
Function, extract-definitions: Internal functions
Function, extract-definitions-from-dir: Internal functions
Function, extract-definitions-from-file: Exported functions
Function, extract-definitions-from-static-files: Internal functions
Function, extract-definitions-from-system: Exported functions
Function, fdiv: Internal functions
Function, generate-commondoc: Internal functions
Function, generate-commondoc-from-file: Exported functions
Function, generate-commondoc-from-system: Exported functions
Function, generate-commondoc-main: Internal functions
Function, generate-html: Exported functions
Function, generate-html-from-dir: Exported functions
Function, generate-html-from-file: Exported functions
Function, generate-html-from-system: Exported functions
Function, insert-docstring: Internal functions
Function, left: Internal functions
Function, list+: Internal functions
Function, list-all-define-macros: Internal functions
Function, local-enough-namestring: Internal functions
Function, main: Exported functions
Function, make-doc-entry: Internal functions
Function, make-entry: Internal functions
Function, merge-slot: Internal functions
Function, natural-language-string-p: Internal functions
Function, note: Internal functions
Function, par: Internal functions
Function, parse-def: Internal functions
Function, parse-key-arg: Internal functions
Function, parse-setf: Internal functions
Function, print-args: Internal functions
Function, print-package: Internal functions
Function, process-black-white-list: Internal functions
Function, remote-enough-namestring: Internal functions
Function, remove-macro-lambda-list-keywords: Internal functions
Function, render-html: Internal functions
Function, safe-name: Internal functions
Function, span: Internal functions
Function, span-id: Internal functions
Function, strip/: Internal functions
Function, symbol-package-name-class: Internal functions
Function, symbol-status: Internal functions
Function, table-of-contents: Internal functions

G
generate-commondoc: Internal functions
generate-commondoc-from-file: Exported functions
generate-commondoc-from-system: Exported functions
generate-commondoc-main: Internal functions
generate-html: Exported functions
generate-html-from-dir: Exported functions
generate-html-from-file: Exported functions
generate-html-from-system: Exported functions
Generic Function, (setf args): Internal generic functions
Generic Function, (setf docstring): Internal generic functions
Generic Function, (setf doctype): Internal generic functions
Generic Function, (setf file): Internal generic functions
Generic Function, (setf name): Internal generic functions
Generic Function, args: Internal generic functions
Generic Function, docstring: Internal generic functions
Generic Function, doctype: Internal generic functions
Generic Function, file: Internal generic functions
Generic Function, name: Internal generic functions

I
insert-docstring: Internal functions

L
left: Internal functions
list+: Internal functions
list-all-define-macros: Internal functions
local-enough-namestring: Internal functions

M
main: Exported functions
make-doc-entry: Internal functions
make-entry: Internal functions
merge-slot: Internal functions
Method, (setf args): Internal generic functions
Method, (setf docstring): Internal generic functions
Method, (setf doctype): Internal generic functions
Method, (setf file): Internal generic functions
Method, (setf name): Internal generic functions
Method, args: Internal generic functions
Method, docstring: Internal generic functions
Method, doctype: Internal generic functions
Method, file: Internal generic functions
Method, name: Internal generic functions

N
name: Internal generic functions
name: Internal generic functions
natural-language-string-p: Internal functions
note: Internal functions

P
par: Internal functions
parse-def: Internal functions
parse-key-arg: Internal functions
parse-setf: Internal functions
print-args: Internal functions
print-package: Internal functions
process-black-white-list: Internal functions

R
remote-enough-namestring: Internal functions
remove-macro-lambda-list-keywords: Internal functions
render-html: Internal functions

S
safe-name: Internal functions
span: Internal functions
span-id: Internal functions
strip/: Internal functions
symbol-package-name-class: Internal functions
symbol-status: Internal functions

T
table-of-contents: Internal functions

Jump to:   (  
A   B   C   D   E   F   G   I   L   M   N   P   R   S   T  

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

A.3 Variables

Jump to:   *   +  
A   C   D   F   J   N   S  
Index Entry  Section

*
*default-css*: Internal special variables
*default-fonts*: Internal special variables
*default-js*: Internal special variables
*deferred-tasks*: Internal special variables
*defs*: Internal special variables
*ids*: Internal special variables
*local-root*: Internal special variables
*old-macroexpand-hook*: Internal special variables
*remote-root*: Internal special variables
*supported-extensions*: Internal special variables
*target-pathname*: Internal special variables

+
+doc+: Internal special variables
+ignore+: Internal special variables
+keywords+: Internal special variables

A
args: Internal classes

C
css-list: Internal classes

D
docstring: Internal classes
doctype: Internal classes

F
file: Internal classes
font-list: Internal classes

J
js-list: Internal classes

N
name: Internal classes

S
Slot, args: Internal classes
Slot, css-list: Internal classes
Slot, docstring: Internal classes
Slot, doctype: Internal classes
Slot, file: Internal classes
Slot, font-list: Internal classes
Slot, js-list: Internal classes
Slot, name: Internal classes
Special Variable, *default-css*: Internal special variables
Special Variable, *default-fonts*: Internal special variables
Special Variable, *default-js*: Internal special variables
Special Variable, *deferred-tasks*: Internal special variables
Special Variable, *defs*: Internal special variables
Special Variable, *ids*: Internal special variables
Special Variable, *local-root*: Internal special variables
Special Variable, *old-macroexpand-hook*: Internal special variables
Special Variable, *remote-root*: Internal special variables
Special Variable, *supported-extensions*: Internal special variables
Special Variable, *target-pathname*: Internal special variables
Special Variable, +doc+: Internal special variables
Special Variable, +ignore+: Internal special variables
Special Variable, +keywords+: Internal special variables

Jump to:   *   +  
A   C   D   F   J   N   S  

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

A.4 Data types

Jump to:   C   D   E   N   P   S   T  
Index Entry  Section

C
Class, def: Internal classes
Class, eazy-template: Internal classes

D
def: Internal classes

E
eazy-documentation: The eazy-documentation system
eazy-documentation: The eazy-documentation package
eazy-template: Internal classes

N
name: Internal types

P
Package, eazy-documentation: The eazy-documentation package

S
System, eazy-documentation: The eazy-documentation system

T
Type, name: Internal types

Jump to:   C   D   E   N   P   S   T