This is the adp-github Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 03:10:42 2025 GMT+0.
adp-github/adp-github.asdadp-github/src/package.lispadp-github/src/pprint-dispatch.lispadp-github/src/tags.lispadp-github/src/adp-github.lispadp-github/src/system.lispadp-github/src/files.lispadp-github/src/elements.lispadp-github/src/adp-elements/output-file.lispadp-github/src/adp-elements/value.lispadp-github/src/adp-elements/title.lispadp-github/src/adp-elements/text.lispadp-github/src/adp-elements/reference.lispadp-github/src/adp-elements/table.lispadp-github/src/adp-elements/list.lispadp-github/src/adp-elements/toc.lispadp-github/src/adp-elements/image.lispadp-github/src/adp-elements/link.lispadp-github/src/adp-elements/quote.lispadp-github/src/adp-elements/code-block.lispadp-github/src/adp-elements/example.lispadp-github/src/adp-elements/description.lispadp-github/src/adp-elements/glossary.lispThe main system appears first, followed by any subsystem dependency.
adp-githubADP extension to generate github markdown files.
Héctor Galbis Sanchis
MIT
alexandria (system).
closer-mop (system).
adp (system).
trivial-arguments (system).
hyperspec (system).
cl-ppcre (system).
src (module).
Modules are listed depth-first from the system components tree.
adp-github/srcadp-github (system).
package.lisp (file).
pprint-dispatch.lisp (file).
tags.lisp (file).
adp-github.lisp (file).
system.lisp (file).
files.lisp (file).
elements.lisp (file).
adp-elements (module).
adp-github/src/adp-elementselements.lisp (file).
src (module).
output-file.lisp (file).
value.lisp (file).
title.lisp (file).
text.lisp (file).
reference.lisp (file).
table.lisp (file).
list.lisp (file).
toc.lisp (file).
image.lisp (file).
link.lisp (file).
quote.lisp (file).
code-block.lisp (file).
example.lisp (file).
description.lisp (file).
glossary.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
adp-github/adp-github.asdadp-github/src/package.lispadp-github/src/pprint-dispatch.lispadp-github/src/tags.lispadp-github/src/adp-github.lispadp-github/src/system.lispadp-github/src/files.lispadp-github/src/elements.lispadp-github/src/adp-elements/output-file.lispadp-github/src/adp-elements/value.lispadp-github/src/adp-elements/title.lispadp-github/src/adp-elements/text.lispadp-github/src/adp-elements/reference.lispadp-github/src/adp-elements/table.lispadp-github/src/adp-elements/list.lispadp-github/src/adp-elements/toc.lispadp-github/src/adp-elements/image.lispadp-github/src/adp-elements/link.lispadp-github/src/adp-elements/quote.lispadp-github/src/adp-elements/code-block.lispadp-github/src/adp-elements/example.lispadp-github/src/adp-elements/description.lispadp-github/src/adp-elements/glossary.lispadp-github/src/package.lispsrc (module).
with-writing-package (macro).
adp-github/src/pprint-dispatch.lisppackage.lisp (file).
src (module).
*adp-pprint-dispatch* (special variable).
*custom-symbol-pprint-dispatch* (special variable).
*default-pprint-dispatch* (special variable).
*print-gensym-numbers* (special variable).
*print-shortest-package* (special variable).
custom-symbol-pprint-function (function).
get-shortest-package-name (function).
make-custom-symbol-pprint-dispatch (function).
remove-numbers-tail (function).
shortest-string (function).
with-adp-pprint-dispatch (macro).
with-custom-symbol-pprint-dispatch (macro).
with-symbol-parts (macro).
adp-github/src/tags.lisppprint-dispatch.lisp (file).
src (module).
*tags* (special variable).
ensure-tag-type-container (function).
get-tags-of-type (function).
get-tags-value (function).
(setf get-tags-value) (function).
make-unique-tag (function).
tag-to-string (function).
with-tags (macro).
adp-github/src/adp-github.lisptags.lisp (file).
src (module).
export-content (method).
adp-github (class).
scribble (class).
adp-github/src/system.lispadp-github.lisp (file).
src (module).
*current-system* (special variable).
enough-system-pathname (function).
merge-system-pathname (function).
process-system (function).
with-current-system (macro).
adp-github/src/files.lispsystem.lisp (file).
src (module).
*current-file* (special variable).
*file-target-pathnames* (special variable).
ensure-target-pathname-directories (function).
file-pathname-to-target-pathname (function).
get-current-file (function).
get-current-file-pathname (function).
get-current-file-target-pathname (function).
(setf get-current-file-target-pathname) (function).
get-file-target-pathname (function).
initialize-current-target-pathname (function).
print-file (function).
print-file-error (condition).
process-file (function).
process-file-error (condition).
process-files (function).
set-user-pathname-as-target-pathname (function).
user-pathname-to-target-pathname (function).
with-current-file (macro).
with-file-target-pathnames (macro).
adp-github/src/elements.lispfiles.lisp (file).
src (module).
*print-context* (special variable).
format-adp-html (function).
format-adp-md (function).
format-adp-nil (function).
format-api-html (function).
format-api-md (function).
format-api-nil (function).
format-lisp-html (function).
format-lisp-md (function).
format-lisp-nil (function).
located-element (class).
print-element (generic function).
process-element (generic function).
process-error (condition).
process-scribble-element (function).
adp-github/src/adp-elements/output-file.lispadp-elements (module).
output-file (function).
output-file (class).
print-element (method).
process-element (method).
adp-github/src/adp-elements/value.lispadp-elements (module).
escape-html-text (function).
escape-md-text (function).
escape-text (function).
print-element (method).
print-element (method).
adp-github/src/adp-elements/title.lispadp-elements (module).
subsubtitle (macro).
subtitle (macro).
title (macro).
title (class).
title* (macro).
print-element (method).
process-element (method).
title*% (function).
adp-github/src/adp-elements/text.lispadp-elements (module).
define-text-decorator (macro).
print-element (method).
adp-github/src/adp-elements/reference.lispadp-elements (module).
clref% (function).
cref% (function).
define-tag-reference (macro).
fref% (function).
pref% (function).
print-element (method).
reference (class).
reference-text (function).
sref% (function).
tref% (function).
vref% (function).
adp-github/src/adp-elements/table.lispadp-elements (module).
print-element (method).
print-element (method).
print-element (method).
adp-github/src/adp-elements/list.lispadp-elements (module).
print-element (method).
print-element (method).
print-element (method).
print-list (function).
adp-github/src/adp-elements/toc.lispadp-elements (module).
table-of-classes (function).
table-of-contents (macro).
table-of-contents (class).
table-of-functions (function).
table-of-variables (function).
file-titles (function).
get-file-description-items (function).
make-reference-itemize (function).
make-toc-levels (function).
make-toc-list (function).
print-element (method).
print-element (method).
suitable-title (function).
table-of-contents% (function).
table-of-symbols (class).
adp-github/src/adp-elements/image.lispadp-elements (module).
print-element (method).
adp-github/src/adp-elements/link.lispadp-elements (module).
print-element (method).
adp-github/src/adp-elements/quote.lispadp-elements (module).
print-element (method).
adp-github/src/adp-elements/code-block.lispadp-elements (module).
code-block (function).
code-block (class).
print-element (method).
adp-github/src/adp-elements/example.lispadp-elements (module).
print-element (method).
adp-github/src/adp-elements/description.lispadp-elements (module).
class-description (macro).
class-description (class).
function-description (macro).
function-description (class).
package-description (macro).
package-description (class).
system-description (macro).
system-description (class).
variable-description (macro).
variable-description (class).
class-description% (function).
class-description-anchor (function).
class-description-direct-slots (function).
class-description-direct-subclasses (function).
class-description-direct-superclasses (function).
class-description-docstring (function).
class-description-metaclass (function).
class-description-precedence-list (function).
class-description-title (function).
class-direct-slots-itemize (function).
code-class (function).
code-symbol (function).
define-system-description-function (macro).
description (class).
direct-slots-itemize (function).
function-description% (function).
function-description-anchor (function).
function-description-arguments (function).
function-description-docstring (function).
function-description-title (function).
generic-description-title (function).
join-by-element (function).
macro-description-title (function).
package-description% (function).
package-description-anchor (function).
package-description-docstring (function).
package-description-exported-symbols (function).
package-description-nicknames (function).
package-description-title (function).
print-element (method).
print-element (method).
print-element (method).
print-element (method).
print-element (method).
process-element (method).
process-element (method).
process-element (method).
process-element (method).
process-element (method).
slot-allocation-item (function).
slot-documentation-item (function).
slot-name-item (function).
slot-properties-itemize (function).
slot-readers-item (function).
slot-writers-item (function).
system-description% (function).
system-description-anchor (function).
system-description-author (function).
system-description-defsystem-depends-on (function).
system-description-depends-on (function).
system-description-docstring (function).
system-description-homepage (function).
system-description-license (function).
system-description-mail (function).
system-description-title (function).
variable-description% (function).
variable-description-anchor (function).
variable-description-docstring (function).
variable-description-title (function).
adp-github/src/adp-elements/glossary.lispadp-elements (module).
class-glossary (macro).
class-glossary (class).
function-glossary (macro).
function-glossary (class).
variable-glossary (macro).
variable-glossary (class).
class-glossary% (function).
function-glossary% (function).
glossary (class).
print-element (method).
process-element (method).
variable-glossary% (function).
Packages are listed by definition order.
adp-githubThe main package of adp-github.
adpgh
alexandria.
common-lisp.
bold (function).
cell (function).
cell (class).
class-description (macro).
class-description (class).
class-glossary (macro).
class-glossary (class).
clref (macro).
code (function).
code-block (function).
code-block (class).
cref (macro).
emphasis (function).
enumerate (function).
enumerate (class).
example (function).
example (class).
fref (macro).
function-description (macro).
function-description (class).
function-glossary (macro).
function-glossary (class).
image (function).
image (class).
italic (function).
item (function).
item (class).
itemize (function).
itemize (class).
link (function).
link (class).
output-file (function).
output-file (class).
package-description (macro).
package-description (class).
pref (macro).
quoted (function).
quoted (class).
row (function).
row (class).
sref (macro).
subsubtitle (macro).
subtitle (macro).
system-description (macro).
system-description (class).
table (function).
table (class).
table-of-classes (function).
table-of-contents (macro).
table-of-contents (class).
table-of-functions (function).
table-of-variables (function).
text (function).
text (class).
title (macro).
title (class).
title* (macro).
tref (macro).
variable-description (macro).
variable-description (class).
variable-glossary (macro).
variable-glossary (class).
vref (macro).
*adp-pprint-dispatch* (special variable).
*current-file* (special variable).
*current-system* (special variable).
*custom-symbol-pprint-dispatch* (special variable).
*default-pprint-dispatch* (special variable).
*file-target-pathnames* (special variable).
*print-context* (special variable).
*print-gensym-numbers* (special variable).
*print-shortest-package* (special variable).
*tags* (special variable).
adp-github (class).
class-description% (function).
class-description-anchor (function).
class-description-direct-slots (function).
class-description-direct-subclasses (function).
class-description-direct-superclasses (function).
class-description-docstring (function).
class-description-metaclass (function).
class-description-precedence-list (function).
class-description-title (function).
class-direct-slots-itemize (function).
class-glossary% (function).
clref% (function).
code-class (function).
code-symbol (function).
cref% (function).
custom-symbol-pprint-function (function).
define-system-description-function (macro).
define-tag-reference (macro).
define-text-decorator (macro).
description (class).
direct-slots-itemize (function).
enough-system-pathname (function).
ensure-tag-type-container (function).
ensure-target-pathname-directories (function).
escape-html-text (function).
escape-md-text (function).
escape-text (function).
file-pathname-to-target-pathname (function).
file-titles (function).
format-adp-html (function).
format-adp-md (function).
format-adp-nil (function).
format-api-html (function).
format-api-md (function).
format-api-nil (function).
format-lisp-html (function).
format-lisp-md (function).
format-lisp-nil (function).
fref% (function).
function-description% (function).
function-description-anchor (function).
function-description-arguments (function).
function-description-docstring (function).
function-description-title (function).
function-glossary% (function).
generic-description-title (function).
get-current-file (function).
get-current-file-pathname (function).
get-current-file-target-pathname (function).
(setf get-current-file-target-pathname) (function).
get-file-description-items (function).
get-file-target-pathname (function).
get-shortest-package-name (function).
get-tags-of-type (function).
get-tags-value (function).
(setf get-tags-value) (function).
glossary (class).
initialize-current-target-pathname (function).
join-by-element (function).
located-element (class).
macro-description-title (function).
make-custom-symbol-pprint-dispatch (function).
make-reference-itemize (function).
make-toc-levels (function).
make-toc-list (function).
make-unique-tag (function).
merge-system-pathname (function).
package-description% (function).
package-description-anchor (function).
package-description-docstring (function).
package-description-exported-symbols (function).
package-description-nicknames (function).
package-description-title (function).
pref% (function).
print-element (generic function).
print-file (function).
print-file-error (condition).
print-list (function).
process-element (generic function).
process-error (condition).
process-file (function).
process-file-error (condition).
process-files (function).
process-scribble-element (function).
process-system (function).
reference (class).
reference-text (function).
remove-numbers-tail (function).
scribble (class).
set-user-pathname-as-target-pathname (function).
shortest-string (function).
slot-allocation-item (function).
slot-documentation-item (function).
slot-name-item (function).
slot-properties-itemize (function).
slot-readers-item (function).
slot-writers-item (function).
sref% (function).
suitable-title (function).
system-description% (function).
system-description-anchor (function).
system-description-author (function).
system-description-defsystem-depends-on (function).
system-description-depends-on (function).
system-description-docstring (function).
system-description-homepage (function).
system-description-license (function).
system-description-mail (function).
system-description-title (function).
table-of-contents% (function).
table-of-symbols (class).
tag-to-string (function).
title*% (function).
tref% (function).
user-pathname-to-target-pathname (function).
variable-description% (function).
variable-description-anchor (function).
variable-description-docstring (function).
variable-description-title (function).
variable-glossary% (function).
vref% (function).
with-adp-pprint-dispatch (macro).
with-current-file (macro).
with-current-system (macro).
with-custom-symbol-pprint-dispatch (macro).
with-file-target-pathnames (macro).
with-symbol-parts (macro).
with-tags (macro).
with-writing-package (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Inserts a class description.
It must receive the class name (a symbol, not evaluated).
The keyword :tag can be used to create an explicit tag that can be referenced with cref.
The tag must be a symbol (not evaluated).
Inserts a class glossary.
It will insert all the available class descriptions from the external symbols of
the given package PKG.
The argument PKG must be a package descriptor (not evaluated).
Inserts a hyperlink to the Common Lisp Hyperspec for a given symbol (not evaluated).
Inserts a reference to a class.
NAME must be a symbol (not evaluated).
Inserts a reference to a function.
NAME must be a symbol (not evaluated).
Inserts a function description.
It must receive the function name (a symbol, not evaluated).
The keyword :tag can be used to create an explicit tag that can be referenced with fref.
The tag must be a symbol (not evaluated).
Inserts a function glossary.
It will insert all the available function descriptions from the external symbols of
the given package PKG.
The argument PKG must be a package descriptor (not evaluated).
Inserts a function description.
It must receive a package descriptor (not evaluated).
The keyword :tag can be used to create an explicit tag that can be referenced with pref.
The tag must be a symbol (not evaluated).
Inserts a reference to a package.
NAME must be a package descriptor (not evaluated).
Makes a reference object to a system.
Returns a title of level 2.
It can be referenced if a TAG is specified (not evaluated). If TOC is NIL it won’t appear at any table of contents.
Returns a subtitle of level 1.
It can be referenced if a TAG is specified (not evaluated). If TOC is NIL it won’t appear at any table of contents.
Inserts a system description.
It must receive a system descriptor (not evaluated).
The keyword :tag can be used to create an explicit tag that can be referenced with sref.
The tag must be a symbol (not evaluated).
Inserts a table of contents with the titles of the current file.
MIN-LEVEL and MAX-LEVEL can be used to control what kind of titles should appear.
INCLUDE is a list with title tags forcing them to appear in the table of contents (not evaluated).
EXCLUDE is a list with title tags forcing them to not appear in the table of contents (not evaluated).
INCLUDE and EXCLUDE cannot share any tags.
Inserts a title of level 0.
It can be referenced if a TAG is specified (not evaluated). If TOC is NIL it won’t appear at any table of contents.
Inserts a title of a given LEVEL.
It can be referenced with tref if a TAG is specified.
If TOC is NIL it won’t appear at any table of contents.
The LEVEL specifies the title level. 0 is a title, 1 is a subtitle, etc.
Inserts a reference to a title.
NAME must be a symbol (not evaluated).
Inserts a variable description.
It must receive the variable name (a symbol, not evaluated).
The keyword :tag can be used to create an explicit tag that can be referenced with vref.
The tag must be a symbol (not evaluated).
Inserts a variable glossary.
It will insert all the available variable descriptions from the external symbols of
the given package PKG.
The argument PKG must be a package descriptor (not evaluated).
Inserts a reference to a variable.
NAME must be a symbol (not evaluated).
Inserts text with bold style.
Inserts a cell.
Cells can only be used inside a table row.
Inserts text with code style.
Inserts a block of code.
It can receive the keyword :lang, a string that specifies the language to be used. The rest of elements will be inserted in the block.
Inserts text with emphasis style.
Inserts an enumerated list.
It can contains items or sublists, i.e., items, itemizes or enumerates.
Inserts an example.
It is like code-block, but evaluates the code (common lisp only) and prints its output and returned values.
Inserts an image.
It must receive the path to the image (relative to the project’s root directory). Optionally, it can receive an alternative text description and the scale size of the image.
Inserts text with italic style.
Inserts an item if it is used inside an itemize or enumerate.
Inserts a bulleted list.
It can contains items or sublists, i.e., items, itemizes or enumerates.
Inserts a link.
It must receive the keyword :address.
The rest of the elements will form the name of the link.
Specifies the output file of the current scribble file.
The pathname is considered always relative to the project’s root directory. It doesn’t print anything.
Inserts quoted text.
Inserts a row.
Rows can only be used inside a table.
Inserts a table.
The elements must be rows and rows can only contain cells..
Inserts references to function descriptions from the current file.
Inserts references to function descriptions from the current file.
Inserts references to function descriptions from the current file.
Inserts text.
Text admits different styles:
- nil : Regular text.
- :bold : Bold text.
- :italic : Italic text.
- :emphasis : Bold and italic text.
- :code : Inline code text.
Represents a cell in a table.
:elements
Represetns a code block.
Represents an example.
Represents an image.
Represents an item in a list of items.
:elements
Represents a web link.
common-lisp.
:pathname
Represents a quote.
:elements
Represents a row of cells in a table.
:cells
Represents a table.
:rows
Represents a table of contents.
Default pprint dispatch of ADP.
The current file being processed.
The current system being processed.
Custom symbol pprint dispatch of ADP.
The default pprint dispatch.
The target pathnames for each file.
Specifies the context of the text. Valid values are :md, :html or NIL.
Indicates if the last numbers of an uninterned symbol must be printed.
Indicates if the symbol package to print must the shortest name or nickname.
The tags container.
Defines a tag reference function.
Establishes the pprint dispatch for printing in the ADP style.
Evaluates body with the binding of *current-file*.
Evaluates body with the binding of *current-system*.
Establishes custom symbol pprint dispatch.
Evaluates the BOPY with a fresh hash table of files and target pathnames.
Evaluates the BODY with a fresh tags container.
Given a PATHNAME under the system’s directory, returns a relative pathname to it. An error is thrown if PATHNAME is not under the SYSTEM’s root directory.
Returns a hash table for agiven keyword type.
Creates the needed directories to store the current target file.
Escapes sensitive html characters.
Escapes sensitive markdown characters.
Escapes the text for the current context.
Given a pathname of a system’s file, returns its target pathname.
Return the header-type elements of a file.
Returns the current file.
Returns the current file’s pathname.
Returns the current target pathname.
Sets the current target pathname.
Returns the target pathname of a given file.
Returns the tags container of the given TYPE as a hash-table.
Return the value associated with a symbol and a type.
Assigns the value associated with a symbol and a type. Raises an error if tag is already defined.
Initializes the target pathname for the current file.
Return a list of levels for the given titles.
Makes a list from a bunch of titles.
Returns a unique symbol tag.
Given a relative PATHNAME, merges it with the SYSTEM’s root directory.
Prints a list (itemize or enumerate)
Processes the files.
Processes the system and its files.
Return the text to be shown in the link.
Sets a user pathname as the current target pathname.
Test if a TITLE can be placed in TOC.
Returns the string representation of a tag.
Given a user supplied pathname, returns its target pathname.
Prints an element.
system-description)) ¶package-description)) ¶class-description)) ¶variable-description)) ¶function-description)) ¶code-block)) ¶table-of-symbols)) ¶table-of-contents)) ¶The rest of elements respect the print variables.
string)) ¶By default, strings are princ-ed.
output-file)) ¶Process an element.
system-description)) ¶package-description)) ¶class-description)) ¶variable-description)) ¶function-description)) ¶output-file)) ¶located-element)) ¶adp-system.
Base class for all descriptions.
:descriptions
An element that stores its location.
| Jump to: | (
B C D E F G I J L M O P Q R S T U V W |
|---|
| Jump to: | (
B C D E F G I J L M O P Q R S T U V W |
|---|
| Jump to: | *
A C D E F G I L M O P R S T |
|---|
| Jump to: | *
A C D E F G I L M O P R S T |
|---|
| Jump to: | A C D E F G I L M O P Q R S T V |
|---|
| Jump to: | A C D E F G I L M O P Q R S T V |
|---|