The manifest Reference Manual

Table of Contents

The manifest Reference Manual

This is the manifest Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 12:26:12 2020 GMT+0.

1 Introduction

Manifest is a system for semi-automatically documenting Common Lisp
packages. (A manifest tells you what's in a package. Also this system
makes manifest a bunch of information that is actually present in a
Lisp system.) The basic premise is that every exported symbol in a
package should be documented.

To check it out, after loading the system, evaluate (start) and point
your browser at the URL it returns.

2 Systems

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

2.1 manifest

Description

A system for semi-automatically documenting Common Lisp packages.

Dependencies

• alexandria
• closer-mop
• toot
• puri
• split-sequence
• monkeylib-html

Source

manifest.asd (file)

Components

• packages.lisp (file)
• manifest.lisp (file)
• quicklisp.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 manifest.asd

Location

manifest.asd

Systems

manifest (system)

3.1.2 manifest/packages.lisp

Parent

manifest (system)

Location

packages.lisp

Packages

manifest

3.1.3 manifest/manifest.lisp

Dependency

packages.lisp (file)

Parent

manifest (system)

Location

manifest.lisp

Exported Definitions

• start (function)
• stop (function)

Internal Definitions

• *categories* (special variable)
• *inverting-readtable* (special variable)
• *manifest-server* (special variable)
• *possible-readme-types* (special variable)
• automatic-p (function)
• case-invert-name (function)
• define-category (macro)
• docs-for (generic function)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• documentation-templates (function)
• exported-p (function)
• find-readme (function)
• function-p (function)
• generic-function-p (function)
• gf-docs (function)
• has-exported-symbols-p (function)
• index-page (function)
• is (generic function)
• is (method)
• is (method)
• is (method)
• is (method)
• is (method)
• is (method)
• is (method)
• is (method)
• macro-p (function)
• make-handler (function)
• manifest (function)
• name< (function)
• names (function)
• needs-documentation (function)
• package-page (function)
• pluralization (generic function)
• pluralization (method)
• pluralization (method)
• public-packages (function)
• readme-text (function)
• variable-p (function)

3.1.4 manifest/quicklisp.lisp

Dependency

packages.lisp (file)

Parent

manifest (system)

Location

quicklisp.lisp

Internal Definitions

• quicklisp-install (function)
• quicklisp-page (function)
• system-descriptions (function)

4 Packages

Packages are listed by definition order.

4.1 manifest

Source

packages.lisp (file)

Use List

• com.gigamonkeys.utilities
• toot
• monkeylib-html
• closer-common-lisp

Exported Definitions

• start (function)
• stop (function)

Internal Definitions

• *categories* (special variable)
• *inverting-readtable* (special variable)
• *manifest-server* (special variable)
• *possible-readme-types* (special variable)
• automatic-p (function)
• case-invert-name (function)
• define-category (macro)
• docs-for (generic function)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• docs-for (method)
• documentation-templates (function)
• exported-p (function)
• find-readme (function)
• function-p (function)
• generic-function-p (function)
• gf-docs (function)
• has-exported-symbols-p (function)
• index-page (function)
• is (generic function)
• is (method)
• is (method)
• is (method)
• is (method)
• is (method)
• is (method)
• is (method)
• is (method)
• macro-p (function)
• make-handler (function)
• manifest (function)
• name< (function)
• names (function)
• needs-documentation (function)
• package-page (function)
• pluralization (generic function)
• pluralization (method)
• pluralization (method)
• public-packages (function)
• quicklisp-install (function)
• quicklisp-page (function)
• readme-text (function)
• system-descriptions (function)
• variable-p (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: start &key PORT

Start the manifest server and return the URL to browse. By default picks a random unused port or you can specify a port with the :port keyword argument.

Package

manifest

Source

manifest.lisp (file)

Function: stop &optional SERVER

Stop the manifest server, defaulting to *manifest-server*.

Package

manifest

Source

manifest.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *categories*

Package

manifest

Source

manifest.lisp (file)

Special Variable: *inverting-readtable*

Package

manifest

Source

manifest.lisp (file)

Special Variable: *manifest-server*

Package

manifest

Source

manifest.lisp (file)

Special Variable: *possible-readme-types*

Package

manifest

Source

manifest.lisp (file)

5.2.2 Macros

Macro: define-category NAME (SYMBOL WHAT) &body BODY

Package

manifest

Source

manifest.lisp (file)

5.2.3 Functions

Function: automatic-p DOCSTRING

Package

manifest

Source

manifest.lisp (file)

Function: case-invert-name NAME

Invert case of names so we can use nice lowercase names in URLs in a true Common Lisp while still working in Allegro’s mlisp.

Package

manifest

Source

manifest.lisp (file)

Function: documentation-templates PACKAGE

Package

manifest

Source

manifest.lisp (file)

Function: exported-p SYM

Package

manifest

Source

manifest.lisp (file)

Function: find-readme PACKAGE-NAME

Package

manifest

Source

manifest.lisp (file)

Function: function-p NAME

Package

manifest

Source

manifest.lisp (file)

Function: generic-function-p NAME

Package

manifest

Source

manifest.lisp (file)

Function: gf-docs NAME

Package

manifest

Source

manifest.lisp (file)

Function: has-exported-symbols-p PACKAGE

Package

manifest

Source

manifest.lisp (file)

Function: index-page REQUEST

Package

manifest

Source

manifest.lisp (file)

Function: macro-p NAME

Package

manifest

Source

manifest.lisp (file)

Function: make-handler &optional ROOT-DIR

Package

manifest

Source

manifest.lisp (file)

Function: manifest REQUEST

Package

manifest

Source

manifest.lisp (file)

Function: name< N1 N2

Package

manifest

Source

manifest.lisp (file)

Function: names PACKAGE WHAT

Package

manifest

Source

manifest.lisp (file)

Function: needs-documentation PACKAGE

Package

manifest

Source

manifest.lisp (file)

Function: package-page REQUEST

Package

manifest

Source

manifest.lisp (file)

Function: public-packages ()

Package

manifest

Source

manifest.lisp (file)

Function: quicklisp-install REQUEST

Package

manifest

Source

quicklisp.lisp (file)

Function: quicklisp-page REQUEST

Package

manifest

Source

quicklisp.lisp (file)

Function: readme-text PACKAGE-NAME

Package

manifest

Source

manifest.lisp (file)

Function: system-descriptions ()

Temporary hack until Xach provides a way to get this programatically from Quicklisp.

Package

manifest

Source

quicklisp.lisp (file)

Function: variable-p NAME

Package

manifest

Source

manifest.lisp (file)

5.2.4 Generic functions

Generic Function: docs-for SYMBOL WHAT

Package

manifest

Source

manifest.lisp (file)

Methods

Method: docs-for SYMBOL (WHAT (eql slot-accessor))

Method: docs-for SYMBOL (WHAT (eql constant))

Method: docs-for SYMBOL (WHAT (eql variable))

Method: docs-for SYMBOL (WHAT (eql condition))

Method: docs-for SYMBOL (WHAT (eql class))

Method: docs-for SYMBOL (WHAT (eql generic-function))

Method: docs-for SYMBOL (WHAT (eql macro))

Method: docs-for SYMBOL (WHAT (eql function))

Generic Function: is SYMBOL WHAT

Package

manifest

Source

manifest.lisp (file)

Methods

Method: is SYMBOL (WHAT (eql slot-accessor))

Method: is SYMBOL (WHAT (eql constant))

Method: is SYMBOL (WHAT (eql variable))

Method: is SYMBOL (WHAT (eql condition))

Method: is SYMBOL (WHAT (eql class))

Method: is SYMBOL (WHAT (eql generic-function))

Method: is SYMBOL (WHAT (eql macro))

Method: is SYMBOL (WHAT (eql function))

Generic Function: pluralization WHAT

Package

manifest

Source

manifest.lisp (file)

Methods

Method: pluralization (WHAT (eql class))

Method: pluralization WHAT

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types