The manifest Reference Manual

This is the manifest Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:02:09 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 manifest

A system for semi-automatically documenting Common Lisp packages.

Dependencies
  • alexandria (system).
  • closer-mop (system).
  • toot (system).
  • puri (system).
  • split-sequence (system).
  • monkeylib-html (system).
Source

manifest.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 manifest/manifest.asd

Source

manifest.asd.

Parent Component

manifest (system).

ASDF Systems

manifest.


3.1.2 manifest/packages.lisp

Source

manifest.asd.

Parent Component

manifest (system).

Packages

manifest.


3.1.3 manifest/manifest.lisp

Dependency

packages.lisp (file).

Source

manifest.asd.

Parent Component

manifest (system).

Public Interface
Internals

3.1.4 manifest/quicklisp.lisp

Dependency

packages.lisp (file).

Source

manifest.asd.

Parent Component

manifest (system).

Internals

4 Packages

Packages are listed by definition order.


4.1 manifest

Source

packages.lisp.

Use List
  • closer-common-lisp.
  • com.gigamonkeys.utilities.
  • monkeylib-html.
  • toot.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary 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.

Function: stop (&optional server)

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

Package

manifest.

Source

manifest.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *categories*
Package

manifest.

Source

manifest.lisp.

Special Variable: *inverting-readtable*
Package

manifest.

Source

manifest.lisp.

Special Variable: *manifest-server*
Package

manifest.

Source

manifest.lisp.

Special Variable: *possible-readme-types*
Package

manifest.

Source

manifest.lisp.


5.2.2 Macros

Macro: define-category (name (symbol what) &body body)
Package

manifest.

Source

manifest.lisp.


5.2.3 Ordinary functions

Function: automatic-p (docstring)
Package

manifest.

Source

manifest.lisp.

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.

Function: documentation-templates (package)
Package

manifest.

Source

manifest.lisp.

Function: exported-p (sym)
Package

manifest.

Source

manifest.lisp.

Function: find-readme (package-name)
Package

manifest.

Source

manifest.lisp.

Function: function-p (name)
Package

manifest.

Source

manifest.lisp.

Function: generic-function-p (name)
Package

manifest.

Source

manifest.lisp.

Function: gf-docs (name)
Package

manifest.

Source

manifest.lisp.

Function: has-exported-symbols-p (package)
Package

manifest.

Source

manifest.lisp.

Function: index-page (request)
Package

manifest.

Source

manifest.lisp.

Function: macro-p (name)
Package

manifest.

Source

manifest.lisp.

Function: make-handler (&optional root-dir)
Package

manifest.

Source

manifest.lisp.

Function: manifest (request)
Package

manifest.

Source

manifest.lisp.

Function: name< (n1 n2)
Package

manifest.

Source

manifest.lisp.

Function: names (package what)
Package

manifest.

Source

manifest.lisp.

Function: needs-documentation (package)
Package

manifest.

Source

manifest.lisp.

Function: package-page (request)
Package

manifest.

Source

manifest.lisp.

Function: public-packages ()
Package

manifest.

Source

manifest.lisp.

Function: quicklisp-install (request)
Package

manifest.

Source

quicklisp.lisp.

Function: quicklisp-page (request)
Package

manifest.

Source

quicklisp.lisp.

Function: readme-text (package-name)
Package

manifest.

Source

manifest.lisp.

Function: system-descriptions ()

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

Package

manifest.

Source

quicklisp.lisp.

Function: variable-p (name)
Package

manifest.

Source

manifest.lisp.


5.2.4 Generic functions

Generic Function: docs-for (symbol what)
Package

manifest.

Source

manifest.lisp.

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.

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.

Methods
Method: pluralization ((what (eql :class)))
Method: pluralization (what)

Appendix A Indexes


A.1 Concepts


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: Private ordinary functions

C
case-invert-name: Private ordinary functions

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

E
exported-p: Private ordinary functions

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

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

H
has-exported-symbols-p: Private ordinary functions

I
index-page: Private ordinary functions
is: Private generic functions
is: Private generic functions
is: Private generic functions
is: Private generic functions
is: Private generic functions
is: Private generic functions
is: Private generic functions
is: Private generic functions
is: Private generic functions

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

N
name<: Private ordinary functions
names: Private ordinary functions
needs-documentation: Private ordinary functions

P
package-page: Private ordinary functions
pluralization: Private generic functions
pluralization: Private generic functions
pluralization: Private generic functions
public-packages: Private ordinary functions

Q
quicklisp-install: Private ordinary functions
quicklisp-page: Private ordinary functions

R
readme-text: Private ordinary functions

S
start: Public ordinary functions
stop: Public ordinary functions
system-descriptions: Private ordinary functions

V
variable-p: Private ordinary functions