This is the adp-github Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:12:04 2024 GMT+0.
adp-github/adp-github.asdadp-github/src/package.lispadp-github/src/tags.lispadp-github/src/pprint-dispatch.lispadp-github/src/redirection.lispadp-github/src/adp-github.lispadp-github/src/elements.lispadp-github/src/printer.lispadp-github/src/functions.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).
src/package.lisp (file).
src (module).
Modules are listed depth-first from the system components tree.
adp-github/srcsrc/package.lisp (file).
adp-github (system).
tags.lisp (file).
pprint-dispatch.lisp (file).
redirection.lisp (file).
adp-github.lisp (file).
elements.lisp (file).
printer.lisp (file).
functions.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/tags.lispadp-github/src/pprint-dispatch.lispadp-github/src/redirection.lispadp-github/src/adp-github.lispadp-github/src/elements.lispadp-github/src/printer.lispadp-github/src/functions.lispadp-github/src/tags.lispsrc (module).
ensure-tag-table (function).
get-tag-symbols-impl (function).
get-tag-value-impl (function).
(setf get-tag-value-impl) (function).
make-tag (function).
make-tags-container (function).
tag (class).
tag-symbol (reader method).
tag-type (reader method).
tags-tag-value (function).
(setf tags-tag-value) (function).
adp-github/src/pprint-dispatch.lispsrc (module).
*adp-pprint-dispatch* (special variable).
*argument-pprint-dispatch* (special variable).
argument-symbol-pprint-function (function).
convert-string-case (function).
custom-symbol-pprint-function (function).
make-argument-pprint-dispatch (function).
make-custom-pprint-dispatch (function).
shortest-string (function).
adp-github/src/redirection.lispsrc (module).
*redirections* (special variable).
add-redirection (function).
redirect-path (function).
adp-github/src/adp-github.lisptags.lisp (file).
pprint-dispatch.lisp (file).
src (module).
*tags* (special variable).
export-content (method).
post-process-file (method).
post-process-system (method).
pre-process-file (method).
pre-process-system (method).
*export-file* (special variable).
*files* (special variable).
*process-file* (special variable).
*process-system* (special variable).
*unique-ids* (special variable).
adp-github-op (class).
component-relative-pathname (function).
export-element (generic function).
file-target-absolute-pathname (function).
file-target-relative-pathname (function).
get-tag-symbols (function).
get-tag-value (function).
(setf get-tag-value) (function).
scribble (class).
src-to-target-pathname (function).
adp-github/src/elements.lisptags.lisp (file).
src (module).
bold (class).
cell (class).
class-description (class).
class-glossary (class).
emphasis (class).
enumerate (class).
example (class).
function-description (class).
function-glossary (class).
header (class).
image (class).
italic (class).
item (class).
itemize (class).
link (class).
mini-table-of-contents (class).
package-description (class).
quoted (class).
row (class).
subheader (class).
subsubheader (class).
system-description (class).
table (class).
table-of-contents (class).
table-of-functions (class).
text (class).
variable-description (class).
variable-glossary (class).
cell-elements (reader method).
(setf cell-elements) (writer method).
class-reference (class).
code-block-elements (reader method).
code-block-lang (reader method).
code-of-block (class).
description (class).
description-package (reader method).
description-symbol (reader method).
description-system (reader method).
description-tag (reader method).
description-tag (reader method).
description-tag (reader method).
description-target-location (reader method).
description-target-location (reader method).
description-target-location (reader method).
enumerate-items (reader method).
example-code (reader method).
example-output (reader method).
example-results (reader method).
function-reference (class).
glossary (class).
glossary-descriptions (reader method).
header-elements (reader method).
header-ref-text-elements (reader method).
header-reference (class).
header-tag (reader method).
header-target-location (reader method).
header-type (class).
header-user-tag-p (reader method).
image-alt-text (reader method).
image-path (reader method).
image-scale (reader method).
inline-code (class).
item-elements (reader method).
itemize-items (reader method).
link-address (reader method).
link-elements (reader method).
package-reference (class).
quote-elements (reader method).
row-cells (reader method).
(setf row-cells) (writer method).
select-output-file-type (class).
symbol-reference (class).
system-reference (class).
table-of-classes (class).
table-of-variables (class).
table-rows (reader method).
(setf table-rows) (writer method).
text-decorator (class).
text-decorator-elements (reader method).
text-elements (reader method).
text-reference (class).
text-reference-tag (reader method).
variable-reference (class).
adp-github/src/printer.lispadp-github.lisp (file).
elements.lisp (file).
tags.lisp (file).
src (module).
*context* (special variable).
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).
content-to-string (function).
convert-to-github-header-anchor (function).
define-header-process-method (macro).
define-system-description-function (macro).
direct-slots-itemize (function).
escape-characters (function).
escape-html-characters (function).
escape-md-characters (function).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
export-element (method).
file-headers (function).
function-description-anchor (function).
function-description-arguments (function).
function-description-docstring (function).
function-description-title (function).
generic-description-title (function).
header-deep-level (function).
macro-description-title (function).
make-itemize-table (function).
make-itemize-toc (function).
make-itemize-tocl (function).
make-itemize-tof (function).
make-itemize-tov (function).
make-toc-deep-levels (function).
package-description-anchor (function).
package-description-docstring (function).
package-description-exported-symbols (function).
package-description-nicknames (function).
package-description-title (function).
process-itemize (function).
project-headers (function).
safe-call (function).
slot-allocation-item (function).
slot-name-item (function).
slot-properties-itemize (function).
slot-readers-item (function).
slot-writers-item (function).
split-symbols (function).
symbol-github-name (function).
symbol-macro-p (function).
symbol-to-maybe-reference (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).
tag-to-string (function).
variable-description-anchor (function).
variable-description-docstring (function).
variable-description-title (function).
verbatim-content-to-string (function).
adp-github/src/functions.lispadp-github.lisp (file).
elements.lisp (file).
tags.lisp (file).
src (module).
bold (function).
cell (function).
class-description (macro).
class-glossary (macro).
code (function).
code-block (function).
cref (macro).
emphasis (function).
enumerate (function).
example (macro).
fref (macro).
function-description (macro).
function-glossary (macro).
header (macro).
href (macro).
image (function).
italic (function).
item (function).
itemize (function).
link (function).
mini-table-of-contents (function).
package-description (macro).
pref (macro).
quoted (function).
row (function).
select-output-file (function).
sref (macro).
subheader (macro).
subsubheader (macro).
system-description (macro).
table (function).
table-of-contents (function).
table-of-functions (function).
text (function).
variable-description (macro).
variable-glossary (macro).
vref (macro).
define-header-function (macro).
define-reference-function (macro).
define-text-decorator (macro).
ensure-relative-pathname (function).
get-keyword-parameter (function).
make-unique-tag (function).
remove-keyword-parameters (function).
table-of-classes (function).
table-of-variables (function).
with-key-params (macro).
Packages are listed by definition order.
adp-githubadpgh
alexandria.
common-lisp.
*tags* (special variable).
bold (function).
bold (class).
cell (function).
cell (class).
class-description (macro).
class-description (class).
class-glossary (macro).
class-glossary (class).
code (function).
code-block (function).
cref (macro).
emphasis (function).
emphasis (class).
enumerate (function).
enumerate (class).
example (macro).
example (class).
fref (macro).
function-description (macro).
function-description (class).
function-glossary (macro).
function-glossary (class).
header (macro).
header (class).
href (macro).
image (function).
image (class).
italic (function).
italic (class).
item (function).
item (class).
itemize (function).
itemize (class).
link (function).
link (class).
mini-table-of-contents (function).
mini-table-of-contents (class).
package-description (macro).
package-description (class).
pref (macro).
quoted (function).
quoted (class).
row (function).
row (class).
select-output-file (function).
sref (macro).
subheader (macro).
subheader (class).
subsubheader (macro).
subsubheader (class).
system-description (macro).
system-description (class).
table (function).
table (class).
table-of-contents (function).
table-of-contents (class).
table-of-functions (function).
table-of-functions (class).
text (function).
text (class).
variable-description (macro).
variable-description (class).
variable-glossary (macro).
variable-glossary (class).
vref (macro).
*adp-pprint-dispatch* (special variable).
*argument-pprint-dispatch* (special variable).
*context* (special variable).
*export-file* (special variable).
*files* (special variable).
*process-file* (special variable).
*process-system* (special variable).
*redirections* (special variable).
*unique-ids* (special variable).
add-redirection (function).
adp-github-op (class).
argument-symbol-pprint-function (function).
cell-elements (generic reader).
(setf cell-elements) (generic writer).
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-reference (class).
code-block-elements (generic reader).
code-block-lang (generic reader).
code-of-block (class).
component-relative-pathname (function).
content-to-string (function).
convert-string-case (function).
convert-to-github-header-anchor (function).
custom-symbol-pprint-function (function).
define-header-function (macro).
define-header-process-method (macro).
define-reference-function (macro).
define-system-description-function (macro).
define-text-decorator (macro).
description (class).
description-package (generic reader).
description-symbol (generic reader).
description-system (generic reader).
description-tag (generic reader).
description-target-location (generic reader).
direct-slots-itemize (function).
ensure-relative-pathname (function).
ensure-tag-table (function).
enumerate-items (generic reader).
escape-characters (function).
escape-html-characters (function).
escape-md-characters (function).
example-code (generic reader).
example-output (generic reader).
example-results (generic reader).
export-element (generic function).
file-headers (function).
file-target-absolute-pathname (function).
file-target-relative-pathname (function).
function-description-anchor (function).
function-description-arguments (function).
function-description-docstring (function).
function-description-title (function).
function-reference (class).
generic-description-title (function).
get-keyword-parameter (function).
get-tag-symbols (function).
get-tag-symbols-impl (function).
get-tag-value (function).
(setf get-tag-value) (function).
get-tag-value-impl (function).
(setf get-tag-value-impl) (function).
glossary (class).
glossary-descriptions (generic reader).
header-deep-level (function).
header-elements (generic reader).
header-ref-text-elements (generic reader).
header-reference (class).
header-tag (generic reader).
header-target-location (generic reader).
header-type (class).
header-user-tag-p (generic reader).
image-alt-text (generic reader).
image-path (generic reader).
image-scale (generic reader).
inline-code (class).
item-elements (generic reader).
itemize-items (generic reader).
link-address (generic reader).
link-elements (generic reader).
macro-description-title (function).
make-argument-pprint-dispatch (function).
make-custom-pprint-dispatch (function).
make-itemize-table (function).
make-itemize-toc (function).
make-itemize-tocl (function).
make-itemize-tof (function).
make-itemize-tov (function).
make-tag (function).
make-tags-container (function).
make-toc-deep-levels (function).
make-unique-tag (function).
package-description-anchor (function).
package-description-docstring (function).
package-description-exported-symbols (function).
package-description-nicknames (function).
package-description-title (function).
package-reference (class).
process-itemize (function).
project-headers (function).
quote-elements (generic reader).
redirect-path (function).
remove-keyword-parameters (function).
row-cells (generic reader).
(setf row-cells) (generic writer).
safe-call (function).
scribble (class).
select-output-file-type (class).
shortest-string (function).
slot-allocation-item (function).
slot-name-item (function).
slot-properties-itemize (function).
slot-readers-item (function).
slot-writers-item (function).
split-symbols (function).
src-to-target-pathname (function).
symbol-github-name (function).
symbol-macro-p (function).
symbol-reference (class).
symbol-to-maybe-reference (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).
system-reference (class).
table-of-classes (function).
table-of-classes (class).
table-of-variables (function).
table-of-variables (class).
table-rows (generic reader).
(setf table-rows) (generic writer).
tag (class).
tag-symbol (generic reader).
tag-to-string (function).
tag-type (generic reader).
tags-tag-value (function).
(setf tags-tag-value) (function).
text-decorator (class).
text-decorator-elements (generic reader).
text-elements (generic reader).
text-reference (class).
text-reference-tag (generic reader).
variable-description-anchor (function).
variable-description-docstring (function).
variable-description-title (function).
variable-reference (class).
verbatim-content-to-string (function).
with-key-params (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) that represents the class. A class description also creates a class tag that can be used with cref.
Inserts a class glossary. It will insert all the available class descriptions. They are gathered from the external symbols of a given package. The argument pkg must be a package descriptor.
Inserts a class reference. I. e. a hyperlink to a class description.
Inserts an example. It is like code-block, but evaluates the code (common lisp only) and prints its output and returned values.
Inserts a function reference. I. e. a hyperlink to a function description.
Inserts a function description. It must receive the function name (a symbol) that represents the function. A function description also creates a function tag that can be used with fref.
Inserts a function glossary. It will insert all the available function descriptions. They are gathered from the external symbols of a given package. The argument pkg must be a package descriptor.
Inserts a header. Also, a keyword :tag can be supplied to be used as a header tag.
Inserts a header reference. I. e. a hyperlink to a header.
Inserts a package description. It must receive a package descriptor that represents the package. A package description also creates a package tag that can be used with pref.
Inserts a package reference. I. e. a hyperlink to a package description.
Inserts a system reference. I. e. a hyperlink to a system description.
Inserts a subheader. Also, a keyword :tag can be supplied to be used as a header tag.
Inserts a subsubheader. Also, a keyword :tag can be supplied to be used as a header tag.
Inserts a system description. It must receive a system description that represents the system. A system description also creates a system tag that can be used with sref.
Inserts a variable description. It must receive the variable name (a symbol) that represents the variable. A variable description also creates a variable tag that can be used with vref.
Inserts a variable glossary. It will insert all the available variable descriptions. They are gathered from the external symbols of a given package. The argument pkg must be a package descriptor.
Inserts a variable reference. I. e. a hyperlink to a variable description.
Inserts text with bold style.
The cells are the components of a row. All the elements will be inserted inside a cell table.
Inserts text with code style.
Inserts a code of block. It can receive the keyword :lang, a string that specifies the language to be used. The rest of elements will be inserted inside a block of code.
Inserts text with emphasis style.
Inserts a enumerated lists. It can contain items or sublist. The elements must be items, itemizes or enumerates.
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 element if it is used inside an itemize or enumerate.
Inserts a list. It can contains items or sublists. The elements must be 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.
Inserts a table of contents with the headers, subheaders and subsubheaders of the current file.
Inserts quoted text.
The rows are the components of a table. The elements must be cells.
Selects the output file. The pathname is always relative to the system’s root directory.
Inserts a table. The elements must be rows.
Inserts a table of contents with the headers and subheaders of every generated file.
Inserts a table of function. It is a list with references to all the functions that has a description inserted somewhere.
Intended for using in lisp mode files or define custom functions. Just inserts every argument.
adp-github-op) files system) ¶adp.
adp-github-op) f) ¶adp.
adp-github-op) s) ¶adp.
adp-github-op) f) ¶adp.
adp-github-op) s) ¶adp.
Represent a bold element.
Represents a cell in a table.
list
:elements
Represent a emphasis element.
list
:items
This slot is read-only.
Represents an example.
Represent a header element.
Represents an image.
(or string pathname)
:path
This slot is read-only.
string
:alt-text
This slot is read-only.
real
:scale
This slot is read-only.
Represent a italic element.
Represents an item in a list of items.
list
:elements
This slot is read-only.
list
:items
This slot is read-only.
Represents a web link.
Represents a mini table of contents.
common-lisp.
package
:package
This slot is read-only.
adp-github::tag
:tag
This slot is read-only.
pathname
:target-location
This slot is read-only.
Represents a quote.
list
:elements
This slot is read-only.
Represents a row of cells in a table.
list
:cells
Represent a subheader element.
Represent a subsubheader element.
asdf/system:system
:system
This slot is read-only.
adp-github::tag
:tag
This slot is read-only.
pathname
:target-location
This slot is read-only.
Represents a table.
vector
:rows
Represents a table of contents.
Represents a table of functions.
Represents a text element.
list
:elements
This slot is read-only.
Contains the current context where the text has to be printed.
Table of redirections. I.e, maps a path with a new path selected by the user.
Inserts a new redirection or updates it if SRC-PATH is already in the table.
Return a custom pprint function to print symbols.
Given a path, relative or absolute, treats it as if it is relative to the system’s root directory and returns an actual absolute pathname.
Returns the hash table of tags of a given type.
Return the header-type elements of a file.
Return the level of deepness of a header.
Makes a tag.
Return a vector of deepness levels the headers must have in a table of contents.
Return the header-type elements of a project.
Returns the redirected path or the path itself if PATH is not in the table. Also returns whether a redirection has been found.
Checks if a package and a function in that package exists.
Return the shortest string from a list.
Inserts a table of classes. It is a list with references to all the classes that has a description inserted somewhere.
Inserts a table of variables. It is a list with references to all the variables that has a description inserted somewhere.
Retreives the value of a tag or nil if tag does not exist.
Adds or updates a tag.
code-of-block)) ¶automatically generated reader method
code-of-block)) ¶automatically generated reader method
lang.
package-description)) ¶automatically generated reader method
description)) ¶automatically generated reader method
system-description)) ¶automatically generated reader method
system-description)) ¶automatically generated reader method
tag.
package-description)) ¶automatically generated reader method
tag.
description)) ¶automatically generated reader method
tag.
system-description)) ¶automatically generated reader method
package-description)) ¶automatically generated reader method
description)) ¶automatically generated reader method
system-description) stream) ¶package-description) stream) ¶class-description) stream) ¶variable-description) stream) ¶function-description) stream) ¶code-of-block) stream) ¶inline-code) stream) ¶table-of-classes) stream) ¶table-of-variables) stream) ¶table-of-functions) stream) ¶mini-table-of-contents) stream) ¶table-of-contents) stream) ¶system-reference) stream) ¶package-reference) stream) ¶symbol-reference) stream) ¶header-reference) stream) ¶subsubheader) stream) ¶select-output-file-type) stream) ¶string) stream) ¶header-type)) ¶automatically generated reader method
header-reference)) ¶automatically generated reader method
header-type)) ¶automatically generated reader method
tag.
header-type)) ¶automatically generated reader method
header-type)) ¶automatically generated reader method
text-decorator)) ¶automatically generated reader method
text-reference)) ¶automatically generated reader method
tag.
adp-op.
asdf/action.
:class
(quote #:adp-github-op-prepare-op)
Represent a type reference element.
Represetns a code block.
common-lisp.
symbol
:symbol
This slot is read-only.
adp-github::tag
:tag
This slot is read-only.
pathname
:target-location
This slot is read-only.
Represent a function reference element.
:descriptions
This slot is read-only.
Represent a header reference element.
list
:text-elements
This slot is read-only.
Represents a header type element.
list
:elements
This slot is read-only.
boolean
:user-tag-p
This slot is read-only.
adp-github::tag
:tag
This slot is read-only.
pathname
:target-location
This slot is read-only.
Represents an inline element.
Represent a variable reference element.
scribble-source-file.
common-lisp.
"scrbl"
Represents a symbol reference.
Represent a variable reference element.
Represents a table of classes.
Represents a table of variables.
common-lisp.
symbol
:symbol
This slot is read-only.
list
:elements
This slot is read-only.
Represent a text reference element.
adp-github::tag
:tag
This slot is read-only.
Represent a variable reference element.
| Jump to: | (
A B C D E F G H I L M P Q R S T V W |
|---|
| Jump to: | (
A B C D E F G H I L M P Q R S T V W |
|---|
| Jump to: | *
A C D E I L O P R S T U |
|---|
| Jump to: | *
A C D E I L O P R S T U |
|---|
| Jump to: | A B C D E F G H I L M P Q R S T V |
|---|
| Jump to: | A B C D E F G H I L M P Q R S T V |
|---|