This is the exscribe Reference Manual, version 0.96.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Jul 15 05:00:29 2024 GMT+0.
exscribe/exscribe.asdexscribe/packages.lispexscribe/macros.lispexscribe/specials.lispexscribe/scheme-compat.lispexscribe/exscribe.lispexscribe/exscribe-data.lispexscribe/bibliography.lispexscribe/html-dumper.lispexscribe/exscribe-html.lispexscribe/exscribe-txt.lispThe main system appears first, followed by any subsystem dependency.
exscribeProgrammatically create HTML documents from a high-level syntax
Francois-Rene Rideau
MIT
Exscribe helps you author documents and produce HTML output,
using a high-level syntax (Scribble) completely integrated with the CL syntax.
It notably features proper support for footnotes, table-of-contents, bibliography.
0.96.1
scribble (system)., at least version "1.0.0"
fare-utils (system)., at least version "1.0.0"
trivia.quasiquote (system).
alexandria (system).
fare-memoization (system).
fare-scripts/rescript (system).
quri (system).
packages.lisp (file).
macros.lisp (file).
specials.lisp (file).
scheme-compat.lisp (file).
exscribe.lisp (file).
exscribe-data.lisp (file).
bibliography.lisp (file).
html-dumper.lisp (file).
exscribe-html.lisp (file).
exscribe-txt.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
exscribe/exscribe.asdexscribe/packages.lispexscribe/macros.lispexscribe/specials.lispexscribe/scheme-compat.lispexscribe/exscribe.lispexscribe/exscribe-data.lispexscribe/bibliography.lispexscribe/html-dumper.lispexscribe/exscribe-html.lispexscribe/exscribe-txt.lispexscribe/macros.lisppackages.lisp (file).
exscribe (system).
define-markup (macro).
define-markup-macro (macro).
lambda-markup (macro).
xxtime (macro).
*argument-syntax* (special variable).
*lambda-markup-list-keywords* (special variable).
*xtime* (special variable).
decode-key-spec (function).
decode-optional-spec (function).
do-define-markup (function).
key-spec-p (function).
keyword->symbol (function).
optional-spec-p (function).
processing-keys (function).
scribe-style-keyword-arg-p (function).
symbol->keyword (function).
exscribe/specials.lispmacros.lisp (file).
exscribe (system).
*background* (special variable).
*bibliography* (special variable).
*bibliography-header* (special variable).
*bibliography-location* (special variable).
*bibliography-options* (special variable).
*document* (special variable).
*document-title* (special variable).
*exscribe-document-hook* (special variable).
*exscribe-mode* (special variable).
*exscribe-path* (special variable).
*exscribe-verbose* (special variable).
*exscribe-version* (special variable).
*footer* (special variable).
*footnote-counter* (special variable).
*footnotes* (special variable).
*footnotes-header* (special variable).
*foreground* (special variable).
*generate-label-counter* (special variable).
*header* (special variable).
*postprocess-hooks* (special variable).
*section-counter* (special variable).
*section-name* (special variable).
*section-title-background* (special variable).
*sections-by-label* (special variable).
*subsection-counter* (special variable).
*subsection-name* (special variable).
*subsubsection-counter* (special variable).
*subsubsection-name* (special variable).
*title-background* (special variable).
*toc* (special variable).
*exscribe-directory* (special variable).
exscribe/scheme-compat.lispspecials.lisp (file).
exscribe (system).
*scribe-background* (symbol macro).
*scribe-footer* (symbol macro).
*scribe-foreground* (symbol macro).
*scribe-format* (symbol macro).
*scribe-header* (symbol macro).
*scribe-tbackground* (symbol macro).
begin (macro).
define (macro).
define-macro (macro).
display (function).
else (special variable).
eq? (function).
equal? (function).
eqv? (function).
file-exists? (function).
for-each (function).
integer? (function).
keyword->string (function).
keyword? (function).
list? (function).
modulo (function).
null? (function).
number->string (function).
number? (function).
pair? (function).
remainder (function).
set! (macro).
set-scheme-macro-characters (function).
string->symbol (function).
string-append (function).
string-length (function).
string? (function).
substring (function).
symbol->string (function).
symbol? (function).
zero? (function).
*scheme-false* (special variable).
*scheme-true* (special variable).
*scribe-sbackground* (symbol macro).
current-input-port (symbol macro).
current-output-port (symbol macro).
defalias (macro).
defaliases (macro).
defmalias (macro).
defmaliases (macro).
defvalias (macro).
defvaliases (macro).
defxalias (macro).
defxaliases (macro).
make-function-definition (function).
process-scheme-formals (function).
exscribe/exscribe.lispscheme-compat.lisp (file).
exscribe (system).
add-exscribe-path (function).
ensure-exscribe (function).
init-exscribe (function).
klist (function).
style (macro).
*exscribe-initialized* (special variable).
*latest-style-date* (special variable).
*loaded-styles* (special variable).
*mode-suffixes* (special variable).
call-with-exscribe-environment (function).
compile-and-load-file (function).
enable-debugging (function).
entry-point (function).
exscribe-load-document (function).
exscribe-load-file (function).
exscribe-load-style (function).
file-newer-p (function).
file-optimization (function).
find-exscribe-file (function).
find-file-in-path (function).
help (function).
main (function).
maybe-error (function).
on-error (macro).
process-command-line (function).
process-file (function).
process-many (function).
recreate-user-package (function).
repl (function).
reset-exscribe (function).
set-exscribe-mode (function).
style-optimization (function).
with-exscribe-environment (macro).
exscribe/exscribe-data.lispexscribe.lisp (file).
exscribe (system).
*list (function).
*list* (function).
*trusted-hosts* (special variable).
a (function).
address (function).
author (function).
blockquote (function).
body (function).
bold (function).
br (function).
br* (function).
brlist (function).
center (function).
code (function).
color (function).
copy-tag (function).
ctag (function).
div (function).
document (function).
emph (function).
enumerate (function).
font (function).
footnote (function).
form (function).
h1 (function).
h2 (function).
h3 (function).
h4 (function).
h5 (function).
h6 (function).
head (function).
hr (function).
hrule (function).
html (function).
id (function).
image (function).
img (function).
input (function).
item (function).
itemize (function).
make-close-tag (function).
make-document (function).
make-open-tag (function).
make-xml-tag (function).
otag (function).
p (function).
pre (function).
ref (function).
replace-cons! (function).
replace-tag! (function).
section (function).
small (function).
spaced* (function).
spacedlist (function).
span (function).
sub (function).
subsection (function).
subsubsection (function).
sup (function).
table (function).
table-of-contents (function).
tag (function).
tag-attr (function).
tag-contents (macro).
td (function).
th (function).
title (function).
tr (function).
tt (function).
underline (function).
url-trusted-p (function).
walking-document (macro).
xtag (function).
*todo-list* (special variable).
define-header-tag (macro).
define-header-tags (macro).
defsimpletag (macro).
defsimpletags (macro).
deftag (macro).
document-walk-further (function).
make-tag (macro).
exscribe/bibliography.lispexscribe-data.lisp (file).
exscribe (system).
bib-sort/author (function).
bibliography (function).
get-bib-entry (function).
make-bib-table (function).
print-bibliography (function).
process-bibliography (function).
sort-bibliography (function).
allocate-bib-entry (function).
bib-add! (function).
init-bib-entry (function).
make-bib-entry (function).
make-bib-fields (function).
merge-bib-entry (function).
exscribe/html-dumper.lisppackages.lisp (file).
exscribe (system).
html (function).
html-close-tag (function).
html-escape (function).
html-escape-stream (function).
html-stream (function).
html-string (function).
dolist-html-stream (function).
empty-element-p (function).
html-attr (function).
html-attr-stream (function).
html-escape-tag-stream (function).
html-keyword (function).
html-node-p (function).
html-open-tag (function).
html-reserved-p (function).
html-stream-element (function).
exscribe/exscribe-html.lispexscribe-data.lisp (file).
bibliography.lisp (file).
html-dumper.lisp (file).
exscribe (system).
*footnote-style* (special variable).
*make-author-hook* (special variable).
*make-title-hook* (special variable).
footnote-style (function).
sc (function).
bib-ref-name (function).
compute-bib-ref (function).
compute-toc (function).
display-bibliography (function).
dump-document (function).
edit-footnote (function).
edited-footnote (function).
find-first-paragraph (function).
generate-label (function).
href-attributes (function).
init (function).
make-author (function).
make-footnote (function).
make-section (function).
make-subsection (function).
make-subsubsection (function).
make-title (function).
make-toc (function).
make-xsection (function).
postprocess-document (function).
prepare-bib-ref (function).
process-document (function).
show-bib-entry (function).
title-font (function).
exscribe/exscribe-txt.lispexscribe-data.lisp (file).
exscribe (system).
extract-text (function).
normalize-text (function).
init (function).
process-document (function).
Packages are listed by definition order.
exscribe-htmlhtml-dumperexscribescheme-makeupexscribe-dataexscribe-userscheme-compatexscribe-txtexscribe-htmlHTML backend for exscribe
common-lisp.
exscribe.
exscribe-data.
fare-quasiquote.
html-dumper.
trivia.level2.
bib-ref-name (function).
compute-bib-ref (function).
compute-toc (function).
display-bibliography (function).
dump-document (function).
edit-footnote (function).
edited-footnote (function).
find-first-paragraph (function).
generate-label (function).
href-attributes (function).
init (function).
make-author (function).
make-footnote (function).
make-section (function).
make-subsection (function).
make-subsubsection (function).
make-title (function).
make-toc (function).
make-xsection (function).
postprocess-document (function).
prepare-bib-ref (function).
process-document (function).
show-bib-entry (function).
title-font (function).
html-dumperHTML dumping functions
common-lisp.
html (function).
html-close-tag (function).
html-escape (function).
html-escape-stream (function).
html-stream (function).
html-string (function).
dolist-html-stream (function).
empty-element-p (function).
html-attr (function).
html-attr-stream (function).
html-escape-tag-stream (function).
html-keyword (function).
html-node-p (function).
html-open-tag (function).
html-reserved-p (function).
html-stream-element (function).
exscribecore infrastructure for exscribe
alexandria.
common-lisp.
fare-quasiquote.
fare-utils.
quri.
scribble.
trivia.level2.
uiop/driver.
*background* (special variable).
*bibliography* (special variable).
*bibliography-header* (special variable).
*bibliography-location* (special variable).
*bibliography-options* (special variable).
*document* (special variable).
*document-title* (special variable).
*exscribe-document-hook* (special variable).
*exscribe-mode* (special variable).
*exscribe-path* (special variable).
*exscribe-verbose* (special variable).
*exscribe-version* (special variable).
*footer* (special variable).
*footnote-counter* (special variable).
*footnote-style* (special variable).
*footnotes* (special variable).
*footnotes-header* (special variable).
*foreground* (special variable).
*generate-label-counter* (special variable).
*header* (special variable).
*list (function).
*postprocess-hooks* (special variable).
*section-counter* (special variable).
*section-name* (special variable).
*section-title-background* (special variable).
*sections-by-label* (special variable).
*subsection-counter* (special variable).
*subsection-name* (special variable).
*subsubsection-counter* (special variable).
*subsubsection-name* (special variable).
*title-background* (special variable).
*toc* (special variable).
add-exscribe-path (function).
define-markup (macro).
define-markup-macro (macro).
document (function).
ensure-exscribe (function).
footnote-style (function).
html (function).
init-exscribe (function).
klist (function).
lambda-markup (macro).
style (macro).
xxtime (macro).
*argument-syntax* (special variable).
*exscribe-initialized* (special variable).
*lambda-markup-list-keywords* (special variable).
*latest-style-date* (special variable).
*loaded-styles* (special variable).
*mode-suffixes* (special variable).
*xtime* (special variable).
call-with-exscribe-environment (function).
compile-and-load-file (function).
decode-key-spec (function).
decode-optional-spec (function).
do-define-markup (function).
enable-debugging (function).
entry-point (function).
exscribe-load-document (function).
exscribe-load-file (function).
exscribe-load-style (function).
file-newer-p (function).
file-optimization (function).
find-exscribe-file (function).
find-file-in-path (function).
help (function).
key-spec-p (function).
keyword->symbol (function).
main (function).
maybe-error (function).
on-error (macro).
optional-spec-p (function).
process-command-line (function).
process-file (function).
process-many (function).
processing-keys (function).
recreate-user-package (function).
repl (function).
reset-exscribe (function).
scribe-style-keyword-arg-p (function).
set-exscribe-mode (function).
style-optimization (function).
symbol->keyword (function).
with-exscribe-environment (macro).
scheme-makeupa poor emulation of Scheme in CL.
Meant to leverage simple code with Scheme syntax,
not to actually implement deep Scheme semantics.
common-lisp.
*scribe-background* (symbol macro).
*scribe-footer* (symbol macro).
*scribe-foreground* (symbol macro).
*scribe-format* (symbol macro).
*scribe-header* (symbol macro).
*scribe-tbackground* (symbol macro).
begin (macro).
define (macro).
define-macro (macro).
display (function).
else (special variable).
eq? (function).
equal? (function).
eqv? (function).
file-exists? (function).
for-each (function).
integer? (function).
keyword->string (function).
keyword? (function).
list? (function).
modulo (function).
null? (function).
number->string (function).
number? (function).
pair? (function).
remainder (function).
set! (macro).
string->symbol (function).
string-append (function).
string-length (function).
string? (function).
substring (function).
symbol->string (function).
symbol? (function).
zero? (function).
exscribe-datainternal data representation for exscribe
common-lisp.
exscribe.
fare-quasiquote.
quri.
trivia.level2.
*list* (function).
*make-author-hook* (special variable).
*make-title-hook* (special variable).
*trusted-hosts* (special variable).
a (function).
address (function).
author (function).
bib-sort/author (function).
bibliography (function).
blockquote (function).
body (function).
bold (function).
br (function).
br* (function).
brlist (function).
center (function).
code (function).
color (function).
copy-tag (function).
ctag (function).
div (function).
emph (function).
enumerate (function).
font (function).
footnote (function).
form (function).
get-bib-entry (function).
h1 (function).
h2 (function).
h3 (function).
h4 (function).
h5 (function).
h6 (function).
head (function).
hr (function).
hrule (function).
id (function).
image (function).
img (function).
input (function).
item (function).
itemize (function).
make-bib-table (function).
make-close-tag (function).
make-document (function).
make-open-tag (function).
make-xml-tag (function).
otag (function).
p (function).
pre (function).
print-bibliography (function).
process-bibliography (function).
ref (function).
replace-cons! (function).
replace-tag! (function).
sc (function).
section (function).
small (function).
sort-bibliography (function).
spaced* (function).
spacedlist (function).
span (function).
sub (function).
subsection (function).
subsubsection (function).
sup (function).
table (function).
table-of-contents (function).
tag (function).
tag-attr (function).
tag-contents (macro).
td (function).
th (function).
title (function).
tr (function).
tt (function).
underline (function).
url-trusted-p (function).
walking-document (macro).
xtag (function).
*exscribe-directory* (special variable).
*todo-list* (special variable).
allocate-bib-entry (function).
bib-add! (function).
define-header-tag (macro).
define-header-tags (macro).
defsimpletag (macro).
defsimpletags (macro).
deftag (macro).
document-walk-further (function).
init-bib-entry (function).
make-bib-entry (function).
make-bib-fields (function).
make-tag (macro).
merge-bib-entry (function).
exscribe-usercommon-lisp.
exscribe.
exscribe-data.
exscribe-html.
fare-quasiquote.
fare-scripts/rescript.
quri.
scheme-makeup.
trivia.level2.
scheme-compatinnards of the Scheme in CL emulation
alexandria.
common-lisp.
fare-quasiquote.
fare-utils.
scheme-makeup.
trivia.level2.
uiop/driver.
set-scheme-macro-characters (function).
*scheme-false* (special variable).
*scheme-true* (special variable).
*scribe-sbackground* (symbol macro).
current-input-port (symbol macro).
current-output-port (symbol macro).
defalias (macro).
defaliases (macro).
defmalias (macro).
defmaliases (macro).
defvalias (macro).
defvaliases (macro).
defxalias (macro).
defxaliases (macro).
make-function-definition (function).
process-scheme-formals (function).
exscribe-txtText backend for exscribe
common-lisp.
exscribe.
exscribe-data.
fare-quasiquote.
trivia.level2.
extract-text (function).
normalize-text (function).
init (function).
process-document (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
main text background color
The current document
The current document’s title
The current output mode used by exscribe
The search path for exscribe style files
counter for footnotes
place-holder for footnotes being currently processed
main text foreground color
counter for various generated labels
header for the current document body
functions to run after a first pass on the document
counter for sections
name of current section
section title background color
mapping from names to sections
counter for subsections
name of current subsection
counter for subsubsections
name of current subsubsection
header title background color
table of contents
Extract text strings from a node.
Print supplied argument as HTML.
has exscribe already been initialized?
compiles and load specified SOURCE file, if either required by keyword
argument FORCE-RECOMPILE, or not yet existing, or not up-to-date.
Keyword argument VERBOSE specifies whether to be verbose.
Returns two values: the fasl path, and T if the file was (re)compiled
Returns true if NEW-FILE is strictly newer than OLD-FILE.
| Jump to: | *
A B C D E F G H I K L M N O P R S T U W X Z |
|---|
| Jump to: | *
A B C D E F G H I K L M N O P R S T U W X Z |
|---|
| Jump to: | *
C E S |
|---|
| Jump to: | *
C E S |
|---|
| Jump to: | B E F H M P S |
|---|
| Jump to: | B E F H M P S |
|---|