This is the scribble Reference Manual, version 1.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 07:21:59 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
scribbleSyntax extensions akin to Racket’s Scribble and Bigloo’s Skribe
Francois-Rene Rideau
MIT
Scribble offers two syntax extensions allowing you to very nicely
mix text markup data and Lisp code. One syntax is a port to CL of Racket’s Scribble syntax,
and the other is a port to CL of Bigloo’s Skribe syntax.
1.0.2
meta (system).
ptc (system).
fare-utils (system)., at least version "1.0.0.5"
fare-memoization (system).
fare-quasiquote-readtable (system)., at least version "0.9.6"
package.lisp (file).
utilities.lisp (file).
stream-line-column.lisp (file).
racket.lisp (file).
skribe.lisp (file).
readtables.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
scribble/scribble.asdscribble/package.lispscribble/utilities.lispscribble/stream-line-column.lispscribble/racket.lispscribble/skribe.lispscribble/readtables.lispscribble/utilities.lisppackage.lisp (file).
scribble (system).
*lf* (special variable).
ascii-punctuation-char-p (function).
buffered-input (class).
expect-char (function).
expect-string (function).
expected-char-p (function).
flush-buffer (generic function).
input-buffer (reader method).
input-stream (reader method).
mirror-char (function).
mirror-string (function).
peek-char* (generic function).
read-char* (generic function).
read-paren-list (function).
read-to-char (function).
simple-parse-error (function).
simple-parse-error (condition).
skip-whitespace-return-column (function).
trim-ending-spaces (function).
unbalanced-paren (function).
unread-char* (generic function).
unread-string (function).
scribble/stream-line-column.lisppackage.lisp (file).
scribble (system).
char-crlf-p (function).
combine-column-modifiers (function).
read-stream-to-pos (function).
stream-line-column-harder (function).
string-column-modifier (function).
to-next-tab (function).
$columns-per-tab (special variable).
adjust-stream-forward-to-char (function).
ceiling-align (function).
scribble/racket.lisputilities.lisp (file).
scribble (system).
disable-scribble-at-syntax (function).
enable-scribble-at-syntax (function).
reenable-scribble-at-syntax (function).
*scribble-at-readtable* (special variable).
do-enable-scribble-at-syntax (function).
forbidden-pipe-macro (function).
parse-at-string (function).
parse-at-syntax (function).
read-at-syntax (function).
scribble/skribe.lisputilities.lisp (file).
scribble (system).
*scribble-cons* (special variable).
*scribble-default-head* (special variable).
*scribble-list* (special variable).
*scribble-package* (special variable).
*scribble-preprocess* (special variable).
*scribble-preprocessor* (special variable).
configure-scribble (function).
configure-scribble-for-araneida (function).
configure-scribble-for-htmlgen (function).
configure-scribble-for-lml2 (function).
configure-scribble-for-tml (function).
configure-scribble-for-who (function).
configure-scribble-for-yaclml (function).
default-scribble-cons (function).
default-scribble-list (function).
disable-scribble-syntax (function).
disable-sub-scribble-syntax (function).
enable-scribble-syntax (function).
enable-sub-scribble-syntax (function).
pp (function).
reenable-scribble-syntax (function).
reenable-sub-scribble-syntax (function).
with-preprocessor (macro).
*saved-readtables* (special variable).
*scribble-readtable* (special variable).
*sub-scribble-readtable* (special variable).
do-enable-scribble-syntax (function).
do-scribble-list (function).
parse-bracket (function).
pop-readtable (function).
push-readtable (function).
read-skribe-bracket (function).
scribble-cons (function).
scribble-cons-with-list-head (function).
scribble-list (function).
scribble-preprocess (function).
spacing-character (type).
within-package (macro).
within-scribble-package (macro).
scribble/readtables.lispracket.lisp (file).
skribe.lisp (file).
scribble (system).
Packages are listed by definition order.
scribblecommon-lisp.
editor-hints.named-readtables.
fare-quasiquote.
fare-utils.
meta.
proper-tail-calls.
uiop/driver.
*scribble-cons* (special variable).
*scribble-default-head* (special variable).
*scribble-list* (special variable).
*scribble-package* (special variable).
*scribble-preprocess* (special variable).
*scribble-preprocessor* (special variable).
char-crlf-p (function).
combine-column-modifiers (function).
configure-scribble (function).
configure-scribble-for-araneida (function).
configure-scribble-for-htmlgen (function).
configure-scribble-for-lml2 (function).
configure-scribble-for-tml (function).
configure-scribble-for-who (function).
configure-scribble-for-yaclml (function).
default-scribble-cons (function).
default-scribble-list (function).
disable-scribble-at-syntax (function).
disable-scribble-syntax (function).
disable-sub-scribble-syntax (function).
enable-scribble-at-syntax (function).
enable-scribble-syntax (function).
enable-sub-scribble-syntax (function).
pp (function).
read-stream-to-pos (function).
reenable-scribble-at-syntax (function).
reenable-scribble-syntax (function).
reenable-sub-scribble-syntax (function).
stream-line-column-harder (function).
string-column-modifier (function).
to-next-tab (function).
with-preprocessor (macro).
$columns-per-tab (special variable).
*lf* (special variable).
*saved-readtables* (special variable).
*scribble-at-readtable* (special variable).
*scribble-readtable* (special variable).
*sub-scribble-readtable* (special variable).
adjust-stream-forward-to-char (function).
ascii-punctuation-char-p (function).
buffered-input (class).
ceiling-align (function).
do-enable-scribble-at-syntax (function).
do-enable-scribble-syntax (function).
do-scribble-list (function).
expect-char (function).
expect-string (function).
expected-char-p (function).
flush-buffer (generic function).
forbidden-pipe-macro (function).
input-buffer (generic reader).
input-stream (generic reader).
mirror-char (function).
mirror-string (function).
parse-at-string (function).
parse-at-syntax (function).
parse-bracket (function).
peek-char* (generic function).
pop-readtable (function).
push-readtable (function).
read-at-syntax (function).
read-char* (generic function).
read-paren-list (function).
read-skribe-bracket (function).
read-to-char (function).
scribble-cons (function).
scribble-cons-with-list-head (function).
scribble-list (function).
scribble-preprocess (function).
simple-parse-error (function).
simple-parse-error (condition).
skip-whitespace-return-column (function).
spacing-character (type).
trim-ending-spaces (function).
unbalanced-paren (function).
unread-char* (generic function).
unread-string (function).
within-package (macro).
within-scribble-package (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Scribble customization parameter: you can change it so as to define what scribble returns from the head and body of text in bracket-colon syntax
Scribble customization parameter: assuming default scribble-list behavior, modify the head of the form returned to combine at runtime the multiple components of the bracketed text being parsed
Scribble customization parameter: you can change it so as to define what scribble returns from the list of components in parsed bracketed text
if not NIL, the package in which Scribble will read the head of text in bracket-colon syntax
set this variable to NIL to disable Scribble wrapping of strings
into preprocessing forms, to T to enable run-time preprocessing, or to a symbol or function
to enable compile-time preprocessing
run-time preprocessor of strings by Scribble. Used when *SCRIBBLE-PREPROCESS* is T.
Form to define local Scribble preprocessor
Is this character CR (ASCII 13) or LF (ASCII 10)?
Given the UNALIGNED1 and ALIGNED1 column modifiers of a first string,
and the UNALIGNED2 and ALIGNED2 column modifiers of a second string, return as
two values the UNALIGNED and ALIGNED column modifiers of their concatenation.
This will make Scribble work with the patched version of araneida’s original html.lisp function that I used in CTO and that handles ’list correctly. Hopefully my patch will be integrated into the main upstream darcs repository.
This is meant to make Scribble work with AllegroServe’s HTMLGEN from Franz, Inc. – a least if I read the spec correctly.
This makes Scribble work with LML2 by kmr, which is based on Franz’s HTMLGEN.
tml, previously known as htout, is tfeb’s package. This is a wild guess from reading the docs. Please modify to actually suit the package.
WHO is an optimized html generation package by Edi Weitz.
Its keyword semantics is very Scribe-like.
I wrote this reading the docs, but didn’t test it.
yaclml is yet another common lisp markup language. The author wrote this support, but didn’t test it.
Default behavior for returning components of bracketed text
Default preprocessing of Scribble strings: compile-time identity.
Globally, locally or lexically alter the binding of symbol-function scribble:pp
in your macros so as to customize the behavior of preprocessing
Read the contents of a file stream from current position to endpos excluded
Extract the column we are at from the stream.
Ask the implementation gently, but if it won’t tell,
reconstitute the data by reading previous characters
until we reach a beginning of line or of the who file.
Return two values describing the effect of the STRING on column position:
1- UNALIGNED-ADJUSTMENT, which is NIL if there is a newline,
but if there isn’t, is an integer number of characters preceding any TAB.
2- ALIGNED-ADJUSTMENT, which is the number of columns following a newline,
or the number of columns following the first tab if there is one but no newline,
or NIL if there were neither newline nor tab
Given a COLUMN and the COLUMNS-PER-TAB (defaulting to $COLUMNS-PER-TAB, return the column of the next tab, as reached a #tab character
Number of columns in a text tab
do stuff while binding *package* to package if not NIL at runtime
Synchronize a file STREAM to the next valid character position.
UTF-8 encoding may make the current file-position invalid, but by repeatedly
trying to read a char at successive positions, we will consume all the
’wrong’ bytes until we eventually reach a point where a character can be read
or we reach EOF.
Round the INTEGER up to a multiple of the DIVISOR
Combine components of bracketed text at runtime with *scribble-default-head*
buffered-input)) ¶buffered-input)) ¶automatically generated reader method
buffered-input)) ¶automatically generated reader method
buffered-input)) ¶stream)) ¶buffered-input)) ¶stream)) ¶buffered-input) char) ¶stream) char) ¶parse-error.
simple-error.
| Jump to: | A C D E F G I M P R S T U W |
|---|
| Jump to: | A C D E F G I M P R S T U W |
|---|
| Jump to: | $
*
B S |
|---|
| Jump to: | $
*
B S |
|---|
| Jump to: | B C F P R S T U |
|---|
| Jump to: | B C F P R S T U |
|---|