The manifest Reference Manual

Table of Contents

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

The manifest Reference Manual

This is the manifest Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:13:40 2018 GMT+0.


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

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.

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 manifest

Description

A system for semi-automatically documenting Common Lisp packages.

Dependencies
Source

manifest.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 manifest.asd

Location

manifest.asd

Systems

manifest (system)


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

3.1.2 manifest/packages.lisp

Parent

manifest (system)

Location

packages.lisp

Packages

manifest


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

3.1.3 manifest/manifest.lisp

Dependency

packages.lisp (file)

Parent

manifest (system)

Location

manifest.lisp

Exported Definitions
Internal Definitions

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

3.1.4 manifest/quicklisp.lisp

Dependency

packages.lisp (file)

Parent

manifest (system)

Location

quicklisp.lisp

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 manifest

Source

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


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

5.2 Internal definitions


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

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)


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

5.2.2 Macros

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

manifest

Source

manifest.lisp (file)


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

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)


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

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

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, manifest.asd: The manifest<dot>asd file
File, Lisp, manifest/manifest.lisp: The manifest/manifest<dot>lisp file
File, Lisp, manifest/packages.lisp: The manifest/packages<dot>lisp file
File, Lisp, manifest/quicklisp.lisp: The manifest/quicklisp<dot>lisp file

L
Lisp File, manifest.asd: The manifest<dot>asd file
Lisp File, manifest/manifest.lisp: The manifest/manifest<dot>lisp file
Lisp File, manifest/packages.lisp: The manifest/packages<dot>lisp file
Lisp File, manifest/quicklisp.lisp: The manifest/quicklisp<dot>lisp file

M
manifest.asd: The manifest<dot>asd file
manifest/manifest.lisp: The manifest/manifest<dot>lisp file
manifest/packages.lisp: The manifest/packages<dot>lisp file
manifest/quicklisp.lisp: The manifest/quicklisp<dot>lisp file

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   A   C   D   E   F   G   H   I   M   N   P   Q   R   S   V  
Index Entry  Section

A
automatic-p: Internal functions

C
case-invert-name: Internal functions

D
define-category: Internal macros
docs-for: Internal generic functions
docs-for: Internal generic functions
docs-for: Internal generic functions
docs-for: Internal generic functions
docs-for: Internal generic functions
docs-for: Internal generic functions
docs-for: Internal generic functions
docs-for: Internal generic functions
docs-for: Internal generic functions
documentation-templates: Internal functions

E
exported-p: Internal functions

F
find-readme: Internal functions
Function, automatic-p: Internal functions
Function, case-invert-name: Internal functions
Function, documentation-templates: Internal functions
Function, exported-p: Internal functions
Function, find-readme: Internal functions
Function, function-p: Internal functions
Function, generic-function-p: Internal functions
Function, gf-docs: Internal functions
Function, has-exported-symbols-p: Internal functions
Function, index-page: Internal functions
Function, macro-p: Internal functions
Function, make-handler: Internal functions
Function, manifest: Internal functions
Function, name<: Internal functions
Function, names: Internal functions
Function, needs-documentation: Internal functions
Function, package-page: Internal functions
Function, public-packages: Internal functions
Function, quicklisp-install: Internal functions
Function, quicklisp-page: Internal functions
Function, readme-text: Internal functions
Function, start: Exported functions
Function, stop: Exported functions
Function, system-descriptions: Internal functions
Function, variable-p: Internal functions
function-p: Internal functions

G
Generic Function, docs-for: Internal generic functions
Generic Function, is: Internal generic functions
Generic Function, pluralization: Internal generic functions
generic-function-p: Internal functions
gf-docs: Internal functions

H
has-exported-symbols-p: Internal functions

I
index-page: Internal functions
is: Internal generic functions
is: Internal generic functions
is: Internal generic functions
is: Internal generic functions
is: Internal generic functions
is: Internal generic functions
is: Internal generic functions
is: Internal generic functions
is: Internal generic functions

M
Macro, define-category: Internal macros
macro-p: Internal functions
make-handler: Internal functions
manifest: Internal functions
Method, docs-for: Internal generic functions
Method, docs-for: Internal generic functions
Method, docs-for: Internal generic functions
Method, docs-for: Internal generic functions
Method, docs-for: Internal generic functions
Method, docs-for: Internal generic functions
Method, docs-for: Internal generic functions
Method, docs-for: Internal generic functions
Method, is: Internal generic functions
Method, is: Internal generic functions
Method, is: Internal generic functions
Method, is: Internal generic functions
Method, is: Internal generic functions
Method, is: Internal generic functions
Method, is: Internal generic functions
Method, is: Internal generic functions
Method, pluralization: Internal generic functions
Method, pluralization: Internal generic functions

N
name<: Internal functions
names: Internal functions
needs-documentation: Internal functions

P
package-page: Internal functions
pluralization: Internal generic functions
pluralization: Internal generic functions
pluralization: Internal generic functions
public-packages: Internal functions

Q
quicklisp-install: Internal functions
quicklisp-page: Internal functions

R
readme-text: Internal functions

S
start: Exported functions
stop: Exported functions
system-descriptions: Internal functions

V
variable-p: Internal functions

Jump to:   A   C   D   E   F   G   H   I   M   N   P   Q   R   S   V  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*categories*: Internal special variables
*inverting-readtable*: Internal special variables
*manifest-server*: Internal special variables
*possible-readme-types*: Internal special variables

S
Special Variable, *categories*: Internal special variables
Special Variable, *inverting-readtable*: Internal special variables
Special Variable, *manifest-server*: Internal special variables
Special Variable, *possible-readme-types*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   M   P   S  
Index Entry  Section

M
manifest: The manifest system
manifest: The manifest package

P
Package, manifest: The manifest package

S
System, manifest: The manifest system

Jump to:   M   P   S