This is the qbook Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:22:26 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
Modules are listed depth-first from the system components tree.
qbook/srcqbook (system).
code-analysis.lisp (file).
html.lisp (file).
stylesheets.lisp (file).
latex.lisp (file).
packages.lisp (file).
publish-op.lisp (file).
qbook.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
qbook/qbook.asdqbook/src/code-analysis.lispqbook/src/html.lispqbook/src/stylesheets.lispqbook/src/latex.lispqbook/src/packages.lispqbook/src/publish-op.lispqbook/src/qbook.lispqbook/src/code-analysis.lisppackages.lisp (file).
qbook.lisp (file).
src (module).
(setf body) (writer method).
body (reader method).
(setf name) (writer method).
name (reader method).
*code-info-collectors* (special variable).
*known-elements* (special variable).
analyse-code-part (function).
class-slot-descriptor (class).
defclass-descriptor (function).
defclass-descriptor (class).
defcode-info-collector (macro).
defconstant-descriptor (function).
defconstant-descriptor (class).
defgeneric-descriptor (function).
defgeneric-descriptor (class).
defmacro-descriptor (function).
defmacro-descriptor (class).
defmethod-descriptor (function).
defmethod-descriptor (class).
defparameter-descriptor (function).
defun-descriptor (function).
defun-descriptor (class).
defvar-descriptor (function).
descriptor (class).
docstring (reader method).
(setf docstring) (writer method).
docstring-first-sentence (generic function).
find-descriptor (function).
global-variable-descriptor (class).
label-prefix (reader method).
(setf label-prefix) (writer method).
lambda-list (reader method).
(setf lambda-list) (writer method).
make-slot-descriptor (function).
pretty-label-prefix (reader method).
(setf pretty-label-prefix) (writer method).
qualifier (reader method).
(setf qualifier) (writer method).
register-descriptor (function).
slots (reader method).
(setf slots) (writer method).
subseq-first-sentence (function).
supers (reader method).
(setf supers) (writer method).
qbook/src/html.lisppackages.lisp (file).
qbook.lisp (file).
stylesheets.lisp (file).
src (module).
generate (method).
html-generator (class).
*book* (special variable).
*generator* (special variable).
<qbook-page (macro).
effective-name (function).
generate-index (function).
generate-permuted-index (function).
generate-section (function).
generate-table-of-contents (function).
html-name (method).
html-name (method).
make-anchor-link (method).
make-anchor-link (method).
make-anchor-name (method).
make-anchor-name (method).
make-anchor-name (method).
num-lines (function).
output-directory (reader method).
(setf output-directory) (writer method).
publish (function).
write-code (function).
write-code-descriptor (generic function).
write-comment (function).
qbook/src/stylesheets.lisppackages.lisp (file).
src (module).
*print.css* (special variable).
*style.css* (special variable).
qbook/src/latex.lisppackages.lisp (file).
qbook.lisp (file).
src (module).
generate (method).
latex-generator (class).
*latex-stream* (special variable).
\command (function).
generate-part (generic function).
listings (reader method).
(setf listings) (writer method).
output-file (reader method).
(setf output-file) (writer method).
write-latex-escaped (function).
qbook/src/publish-op.lisppackages.lisp (file).
qbook.lisp (file).
src (module).
operation-done-p (method).
perform (method).
perform (method).
publish-op (class).
generator (reader method).
(setf generator) (writer method).
input-file (reader method).
(setf input-file) (writer method).
input-files (method).
qbook/src/qbook.lisppackages.lisp (file).
src (module).
(setf form) (writer method).
form (reader method).
print-object (method).
print-object (method).
print-object (method).
publish-qbook (function).
all-code-parts (method).
book (class).
book-indexes-sorted (method).
bulid-indexes (function).
code-part (class).
code-part-p (generic function).
collect-code-info (function).
comment-part (class).
comment-part-p (generic function).
compare-descriptor-names (function).
contents (reader method).
(setf contents) (writer method).
convert-to-sections (function).
depth (reader method).
(setf depth) (writer method).
descriptor (reader method).
(setf descriptor) (writer method).
end-position (reader method).
(setf end-position) (writer method).
generator (class).
heading-part (class).
heading-part-p (generic function).
heading-text-p (function).
indexes (reader method).
(setf indexes) (writer method).
make-part-reader (function).
make-qbook-readtable (function).
next-part (reader method).
(setf next-part) (writer method).
origin-file (reader method).
(setf origin-file) (writer method).
output-file (reader method).
(setf output-file) (writer method).
permutated-global-index (method).
post-process (function).
post-process-navigation (function).
prev-part (reader method).
(setf prev-part) (writer method).
process-directive (generic function).
process-directives (function).
qbook-semicolon-reader (function).
read-source-file (function).
read-whitespace (function).
real-comment-p (function).
sort-descriptors (function).
sort-parts-with-descriptors (function).
source-file-part (class).
start-position (reader method).
(setf start-position) (writer method).
text (reader method).
(setf text) (writer method).
title (reader method).
title (reader method).
(setf title) (writer method).
(setf title) (writer method).
up-part (reader method).
(setf up-part) (writer method).
whitespace-part (class).
whitespacep (function).
Packages are listed by definition order.
it.bese.qbookqbook
cl-ppcre.
common-lisp.
it.bese.arnesi.
it.bese.yaclml.
iterate.
html-generator (class).
latex-generator (class).
publish-op (class).
publish-qbook (function).
*book* (special variable).
*code-info-collectors* (special variable).
*generator* (special variable).
*known-elements* (special variable).
*latex-stream* (special variable).
*print.css* (special variable).
*style.css* (special variable).
<qbook-page (macro).
\command (function).
all-code-parts (generic function).
analyse-code-part (function).
book (class).
book-indexes-sorted (generic function).
bulid-indexes (function).
class-slot-descriptor (class).
code-part (class).
code-part-p (generic function).
collect-code-info (function).
comment-part (class).
comment-part-p (generic function).
compare-descriptor-names (function).
contents (generic reader).
(setf contents) (generic writer).
convert-to-sections (function).
defclass-descriptor (function).
defclass-descriptor (class).
defcode-info-collector (macro).
defconstant-descriptor (function).
defconstant-descriptor (class).
defgeneric-descriptor (function).
defgeneric-descriptor (class).
defmacro-descriptor (function).
defmacro-descriptor (class).
defmethod-descriptor (function).
defmethod-descriptor (class).
defparameter-descriptor (function).
defun-descriptor (function).
defun-descriptor (class).
defvar-descriptor (function).
depth (generic reader).
(setf depth) (generic writer).
descriptor (generic reader).
(setf descriptor) (generic writer).
descriptor (class).
docstring (generic reader).
(setf docstring) (generic writer).
docstring-first-sentence (generic function).
effective-name (function).
end-position (generic reader).
(setf end-position) (generic writer).
find-descriptor (function).
generate-index (function).
generate-part (generic function).
generate-permuted-index (function).
generate-section (function).
generate-table-of-contents (function).
generator (generic reader).
(setf generator) (generic writer).
generator (class).
global-variable-descriptor (class).
heading-part (class).
heading-part-p (generic function).
heading-text-p (function).
html-name (generic function).
indexes (generic reader).
(setf indexes) (generic writer).
input-file (generic reader).
(setf input-file) (generic writer).
input-files (generic function).
label-prefix (generic reader).
(setf label-prefix) (generic writer).
lambda-list (generic reader).
(setf lambda-list) (generic writer).
listings (generic reader).
(setf listings) (generic writer).
make-anchor-link (generic function).
make-anchor-name (generic function).
make-part-reader (function).
make-qbook-readtable (function).
make-slot-descriptor (function).
next-part (generic reader).
(setf next-part) (generic writer).
num-lines (function).
origin-file (generic reader).
(setf origin-file) (generic writer).
output-directory (generic reader).
(setf output-directory) (generic writer).
output-file (generic reader).
(setf output-file) (generic writer).
permutated-global-index (generic function).
post-process (function).
post-process-navigation (function).
pretty-label-prefix (generic reader).
(setf pretty-label-prefix) (generic writer).
prev-part (generic reader).
(setf prev-part) (generic writer).
process-directive (generic function).
process-directives (function).
publish (function).
qbook-semicolon-reader (function).
qualifier (generic reader).
(setf qualifier) (generic writer).
read-source-file (function).
read-whitespace (function).
real-comment-p (function).
register-descriptor (function).
slots (generic reader).
(setf slots) (generic writer).
sort-descriptors (function).
sort-parts-with-descriptors (function).
source-file-part (class).
start-position (generic reader).
(setf start-position) (generic writer).
subseq-first-sentence (function).
supers (generic reader).
(setf supers) (generic writer).
text (generic reader).
(setf text) (generic writer).
title (generic reader).
(setf title) (generic writer).
up-part (generic reader).
(setf up-part) (generic writer).
whitespace-part (class).
whitespacep (function).
write-code (function).
write-code-descriptor (generic function).
write-comment (function).
write-latex-escaped (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Convert FILE-NAME into a qbook html file named OUTPUT-FILE with title TITLE.
defun-descriptor)) ¶automatically generated writer method
it.bese.arnesi.
body.
defun-descriptor)) ¶automatically generated reader method
it.bese.arnesi.
body.
code-part)) ¶automatically generated writer method
it.bese.arnesi.
form.
code-part)) ¶automatically generated reader method
it.bese.arnesi.
form.
html-generator)) ¶iterate.
latex-generator)) ¶iterate.
descriptor)) ¶automatically generated writer method
it.bese.arnesi.
name.
descriptor)) ¶automatically generated reader method
it.bese.arnesi.
name.
publish-op) component) ¶asdf/action.
publish-op) component) ¶asdf/action.
publish-op) (system system)) ¶asdf/action.
heading-part) stream) ¶whitespace-part) stream) ¶source-file-part) stream) ¶:output-directory
The alternative (destined for hard copy) HTML stylesheet.
The default stylesheet for qbook generated html documentation.
comment-part)) ¶heading-part)) ¶automatically generated reader method
heading-part)) ¶automatically generated writer method
descriptor)) ¶automatically generated reader method
descriptor)) ¶automatically generated writer method
Returns the first sentence of DESCRIPTOR’s
docstring. Returns at most LIMIT characters (if the first
sentence is longer than LIMIT characters it will be simply
truncated. If DESCRIPTOR’s docstring is NIL this function
returns nil.
descriptor) &optional limit) ¶source-file-part)) ¶automatically generated reader method
source-file-part)) ¶automatically generated writer method
comment-part) (generator latex-generator)) ¶heading-part) (generator latex-generator)) ¶whitespace-part) (generator latex-generator)) ¶code-part) (generator latex-generator)) ¶publish-op)) ¶automatically generated reader method
publish-op)) ¶automatically generated writer method
heading-part)) ¶defmethod-descriptor)) ¶descriptor)) ¶publish-op)) ¶automatically generated reader method
publish-op)) ¶automatically generated writer method
publish-op) (system system)) ¶descriptor)) ¶automatically generated reader method
descriptor)) ¶automatically generated writer method
defun-descriptor)) ¶automatically generated reader method
defun-descriptor)) ¶automatically generated writer method
latex-generator)) ¶latex-generator)) ¶When non-NIL, generate listings with LaTeX listings package. When string, push \ltset{this string} in the preamble.
descriptor)) ¶heading-part)) ¶defmethod-descriptor)) ¶descriptor)) ¶heading-part)) ¶automatically generated reader method
heading-part)) ¶automatically generated writer method
source-file-part)) ¶automatically generated reader method
source-file-part)) ¶automatically generated writer method
html-generator)) ¶automatically generated reader method
html-generator)) ¶automatically generated writer method
latex-generator)) ¶automatically generated reader method
source-file-part)) ¶automatically generated reader method
latex-generator)) ¶automatically generated writer method
source-file-part)) ¶automatically generated writer method
descriptor)) ¶automatically generated reader method
descriptor)) ¶automatically generated writer method
heading-part)) ¶automatically generated reader method
heading-part)) ¶automatically generated writer method
comment-part)) ¶source-file-part)) ¶defmethod-descriptor)) ¶automatically generated reader method
defmethod-descriptor)) ¶automatically generated writer method
defclass-descriptor)) ¶automatically generated reader method
defclass-descriptor)) ¶automatically generated writer method
source-file-part)) ¶automatically generated reader method
source-file-part)) ¶automatically generated writer method
defclass-descriptor)) ¶automatically generated reader method
defclass-descriptor)) ¶automatically generated writer method
source-file-part)) ¶automatically generated reader method
text.
source-file-part)) ¶automatically generated writer method
text.
heading-part)) ¶automatically generated reader method
heading-part)) ¶automatically generated writer method
defclass-descriptor) part) ¶descriptor) part) ¶descriptor) part) ¶| Initarg | Value |
|---|---|
:label-prefix | constant |
:pretty-label-prefix | constant |
| Initarg | Value |
|---|---|
:label-prefix | generic function |
:pretty-label-prefix | generic function |
| Initarg | Value |
|---|---|
:label-prefix | macro |
:pretty-label-prefix | macro |
| Initarg | Value |
|---|---|
:label-prefix | method |
:pretty-label-prefix | method |
:qualifier
| Initarg | Value |
|---|---|
:label-prefix | function |
:pretty-label-prefix | function |
:lambda-list
:docstring
:label-prefix
:pretty-label-prefix
:title
| Initarg | Value |
|---|---|
:label-prefix | variable |
:pretty-label-prefix | variable |
:start-position
:end-position
:origin-file
| Jump to: | (
<
\
A B C D E F G H I L M N O P Q R S T U W |
|---|
| Jump to: | (
<
\
A B C D E F G H I L M N O P Q R S T U W |
|---|
| Jump to: | *
B C D E F G I L N O P Q S T U |
|---|
| Jump to: | *
B C D E F G I L N O P Q S T U |
|---|
| Jump to: | B C D F G H I L M P Q S W |
|---|
| Jump to: | B C D F G H I L M P Q S W |
|---|