This is the spinneret Reference Manual, version 3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:46:18 2024 GMT+0.
spinneret/spinneret.asdspinneret/package.lispspinneret/special.lispspinneret/stream.lispspinneret/syntax.lispspinneret/tags.lispspinneret/spinneret.lispspinneret/run.lispspinneret/functions.lispspinneret/compile.lispspinneret/deftag.lispspinneret/dynamic.lispspinneret/interpret.lispspinneret/ps.lispThe main system appears first, followed by any subsystem dependency.
spinneretCommon Lisp HTML5 generator.
Paul M. Rodriguez <pmr@ruricolist.com>
MIT
3.0
parenscript (system).
alexandria (system).
cl-ppcre (system).
global-vars (system).
serapeum (system).
trivia (system).
trivial-gray-streams (system).
in-nomine (system).
package.lisp (file).
special.lisp (file).
stream.lisp (file).
syntax.lisp (file).
tags.lisp (file).
spinneret.lisp (file).
run.lisp (file).
functions.lisp (file).
compile.lisp (file).
deftag.lisp (file).
dynamic.lisp (file).
interpret.lisp (file).
ps.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
spinneret/spinneret.asdspinneret/package.lispspinneret/special.lispspinneret/stream.lispspinneret/syntax.lispspinneret/tags.lispspinneret/spinneret.lispspinneret/run.lispspinneret/functions.lispspinneret/compile.lispspinneret/deftag.lispspinneret/dynamic.lispspinneret/interpret.lispspinneret/ps.lispspinneret/special.lisppackage.lisp (file).
spinneret (system).
*always-quote* (special variable).
*fill-column* (special variable).
*html* (special variable).
*html-charset* (special variable).
*html-lang* (special variable).
*html-path* (special variable).
*html-style* (special variable).
*suppress-inserted-spaces* (special variable).
*depth* (special variable).
*indent* (special variable).
*pending-space* (special variable).
*pre* (special variable).
get-indent (function).
spinneret/stream.lispspecial.lisp (file).
spinneret (system).
html-stream (class).
stream-advance-to-column (method).
stream-finish-output (method).
stream-force-output (method).
stream-fresh-line (method).
stream-line-column (reader method).
stream-start-line-p (method).
stream-terpri (method).
stream-write-char (method).
stream-write-char (method).
stream-write-string (method).
elastic-newline (generic function).
ensure-html-stream (generic function).
fire-elastic-newline (method).
fire-elastic-newline (method).
html-stream-column (generic function).
html-stream.base-stream (generic function).
html-stream? (generic function).
make-html-stream (function).
newline (function).
spinneret/syntax.lispstream.lisp (file).
spinneret (system).
escape-string (function).
+storage-for-deflex-var-cdata-end+ (constant).
+storage-for-deflex-var-cdata-start+ (constant).
+storage-for-deflex-var-no-break-space+ (constant).
cdata-end (symbol macro).
cdata-start (symbol macro).
escape-attribute-value (function).
escape-cdata (function).
escape-comment (function).
escape-string-char (function).
escape-to-stream (function).
escape-to-string (function).
escape-with-table (function).
index (type).
must-quote? (function).
needs-quotes? (function).
no-break-space (symbol macro).
remove-substring (function).
whitespace (function).
spinneret/tags.lispsyntax.lisp (file).
spinneret (system).
*unvalidated-attribute-prefixes* (special variable).
*interpret* (special variable).
aria-attribute? (function).
boolean? (function).
embedded? (function).
global-attribute? (function).
inline? (function).
invalid? (function).
keyword-set (macro).
literal? (function).
needs-close? (function).
paragraph? (function).
parse-permitted-attributes-alist (function).
pcen-char? (function).
permitted-attributes (function).
preformatted? (function).
pseudotag-expand (function).
pseudotag-expander (function).
tokenized-attribute? (function).
unmatched? (function).
unvalidated-attribute? (function).
valid-attribute? (function).
valid-custom-element-name? (function).
valid? (function).
void? (function).
spinneret/spinneret.lisptags.lisp (file).
spinneret (system).
get-html-path (function).
no-such-tag (condition).
spinneret-error (condition).
with-html (macro).
with-html-string (macro).
spinneret/run.lispspinneret.lisp (file).
spinneret (system).
html (compiler macro).
html (generic function).
html-length (generic function).
make-load-form (method).
print-object (method).
%constructor= (method).
buffer-space (function).
call/words (function).
cancel-space (function).
catch-output (macro).
cdata (function).
comment (function).
constructor-values/generic (method).
copy-escaped-string (function).
do-words (macro).
doctype (function).
escape-value (function).
escaped-string (function).
escaped-string (structure).
escaped-string-value (reader).
fast-format (compiler macro).
fast-format (function).
fill-text (function).
flush-space (function).
format-attribute-value (function).
format-attributes-plain (function).
format-attributes-pretty/block (function).
format-attributes-pretty/inline (function).
format-attributes-with (function).
format-text (function).
heading-depth (function).
heading-depth-heading (function).
html-length* (function).
make-cdata (function).
make-comment (function).
make-doctype (function).
make-head (function).
make-html (function).
maybe-wrap (function).
read-only-struct-slot-names (method).
with-space (macro).
without-trailing-space (macro).
write-raw (function).
xss-escape (function).
spinneret/functions.lisprun.lisp (file).
spinneret (system).
*tags-pkg* (special variable).
a (function).
abbr (function).
address (function).
animate (function).
animatemotion (function).
animatetransform (function).
area (function).
article (function).
aside (function).
audio (function).
b (function).
base (function).
bdi (function).
bdo (function).
blockquote (function).
body (function).
br (function).
button (function).
canvas (function).
caption (function).
circle (function).
cite (function).
clippath (function).
code (function).
col (function).
colgroup (function).
command (function).
cursor (function).
custom-elt-fn (function).
data (function).
datalist (function).
dd (function).
define-all-tags (macro).
define-tag (macro).
defs (function).
del (function).
desc (function).
details (function).
dfn (function).
dialog (function).
div (function).
dl (function).
dt (function).
dynamic-tag* (function).
ellipse (function).
em (function).
embed (function).
feblend (function).
fecolormatrix (function).
fecomponenttransfer (function).
fecomposite (function).
feconvolvematrix (function).
fediffuselighting (function).
fedisplacementmap (function).
fedistantlight (function).
fedropshadow (function).
feflood (function).
fefunca (function).
fefuncb (function).
fefuncg (function).
fefuncr (function).
fegaussianblur (function).
feimage (function).
femerge (function).
femergenode (function).
femorphology (function).
feoffset (function).
fepointlight (function).
fespecularlighting (function).
fespotlight (function).
fetile (function).
feturbulence (function).
fieldset (function).
figcaption (function).
figure (function).
filter (function).
font (function).
font-face (function).
font-face-format (function).
font-face-name (function).
font-face-src (function).
font-face-uri (function).
footer (function).
foreignobject (function).
form (function).
g (function).
glyph (function).
glyphref (function).
h1 (function).
h2 (function).
h3 (function).
h4 (function).
h5 (function).
h6 (function).
head (function).
header (function).
hgroup (function).
hkern (function).
hr (function).
html (function).
i (function).
iframe (function).
image (function).
img (function).
input (function).
ins (function).
kbd (function).
keygen (function).
label (function).
legend (function).
li (function).
line (function).
lineargradient (function).
link (function).
main (function).
map (function).
mark (function).
marker (function).
mask (function).
math (function).
menu (function).
meta (function).
metadata (function).
meter (function).
missing-glyph (function).
mpath (function).
nav (function).
noscript (function).
object (function).
ol (function).
optgroup (function).
option (function).
output (function).
p (function).
param (function).
path (function).
pattern (function).
picture (function).
polygon (function).
polyline (function).
pre (function).
progress (function).
q (function).
radialgradient (function).
rect (function).
resolve-tag-embedded-attributes (function).
rp (function).
rt (function).
ruby (function).
s (function).
samp (function).
script (function).
section (function).
select (function).
set (function).
small (function).
source (function).
span (function).
stop (function).
strong (function).
style (function).
sub (function).
summary (function).
sup (function).
svg (function).
switch (function).
symbol (function).
table (function).
tag-close (function).
tag-fn (function).
tag-open (function).
tbody (function).
td (function).
template (function).
text (function).
textarea (function).
textpath (function).
tfoot (function).
th (function).
thead (function).
time (function).
title (function).
tr (function).
track (function).
tref (function).
tspan (function).
u (function).
ul (function).
use (function).
var (function).
video (function).
view (function).
vkern (function).
wbr (function).
spinneret/compile.lispfunctions.lisp (file).
spinneret (system).
dissect-tag (function).
dotted-list? (function).
escape-attrs (function).
join-tokens (compiler macro).
join-tokens (function).
live-deftag-form? (function).
parse-as-markdown (function).
parse-html (function).
simplify-tokenized-attributes (function).
tag-parts (function).
tag-thunk-name (function).
tokenized-attributes-plist (function).
trim-ends (function).
with-custom-element (macro).
with-tag (macro).
wrap-body-as-stack-thunk (function).
spinneret/deftag.lispcompile.lisp (file).
spinneret (system).
deftag (macro).
allow-other-keys (function).
deftag-boundp (function).
deftag-expand (function).
deftag-makunbound (function).
deftag-type (type).
deftag/keyword (macro).
deftag/macro (macro).
extract-lambda-list-keywords (function).
lambda-list-vars (function).
parse-deftag-body (function).
splice-allow-other-keys (function).
symbol-deftag (function).
(setf symbol-deftag) (function).
unbound-deftag (condition).
spinneret/dynamic.lispdeftag.lisp (file).
spinneret (system).
dynamic-tag (macro).
expand-dynamic-tag (function).
expand-h* (function).
h* (macro).
spinneret/interpret.lispdynamic.lisp (file).
spinneret (system).
interpret-html-tree (function).
spinneret/ps.lispinterpret.lisp (file).
spinneret (system).
*ie-attr-props* (special variable).
*props* (special variable).
data-attr-prop (function).
data-attr? (function).
event? (function).
intersperse (function).
make-attr-setter (function).
Packages are listed by definition order.
spinneretcommon-lisp.
*always-quote* (special variable).
*fill-column* (special variable).
*html* (special variable).
*html-charset* (special variable).
*html-lang* (special variable).
*html-path* (special variable).
*html-style* (special variable).
*suppress-inserted-spaces* (special variable).
*unvalidated-attribute-prefixes* (special variable).
deftag (macro).
dynamic-tag (macro).
escape-string (function).
get-html-path (function).
html (compiler macro).
html (generic function).
html-length (generic function).
html-stream (class).
interpret-html-tree (function).
no-such-tag (condition).
spinneret-error (condition).
with-html (macro).
with-html-string (macro).
*depth* (special variable).
*ie-attr-props* (special variable).
*indent* (special variable).
*interpret* (special variable).
*pending-space* (special variable).
*pre* (special variable).
*props* (special variable).
*tags-pkg* (special variable).
+storage-for-deflex-var-cdata-end+ (constant).
+storage-for-deflex-var-cdata-start+ (constant).
+storage-for-deflex-var-no-break-space+ (constant).
allow-other-keys (function).
aria-attribute? (function).
boolean? (function).
buffer-space (function).
call/words (function).
cancel-space (function).
catch-output (macro).
cdata (function).
cdata-end (symbol macro).
cdata-start (symbol macro).
comment (function).
copy-escaped-string (function).
custom-elt-fn (function).
data-attr-prop (function).
data-attr? (function).
define-all-tags (macro).
define-tag (macro).
deftag-boundp (function).
deftag-expand (function).
deftag-makunbound (function).
deftag-type (type).
deftag/keyword (macro).
deftag/macro (macro).
dissect-tag (function).
do-words (macro).
doctype (function).
dotted-list? (function).
dynamic-tag* (function).
elastic-newline (generic function).
embedded? (function).
ensure-html-stream (generic function).
escape-attribute-value (function).
escape-attrs (function).
escape-cdata (function).
escape-comment (function).
escape-string-char (function).
escape-to-stream (function).
escape-to-string (function).
escape-value (function).
escape-with-table (function).
escaped-string (function).
escaped-string (structure).
escaped-string-value (reader).
event? (function).
expand-dynamic-tag (function).
expand-h* (function).
extract-lambda-list-keywords (function).
fast-format (compiler macro).
fast-format (function).
fill-text (function).
fire-elastic-newline (generic function).
flush-space (function).
format-attribute-value (function).
format-attributes-plain (function).
format-attributes-pretty/block (function).
format-attributes-pretty/inline (function).
format-attributes-with (function).
format-text (function).
get-indent (function).
global-attribute? (function).
h* (macro).
heading-depth (function).
heading-depth-heading (function).
html-length* (function).
html-stream-column (generic function).
html-stream.base-stream (generic function).
html-stream? (generic function).
index (type).
inline? (function).
intersperse (function).
invalid? (function).
join-tokens (compiler macro).
join-tokens (function).
keyword-set (macro).
lambda-list-vars (function).
literal? (function).
live-deftag-form? (function).
make-attr-setter (function).
make-cdata (function).
make-comment (function).
make-doctype (function).
make-head (function).
make-html (function).
make-html-stream (function).
maybe-wrap (function).
must-quote? (function).
needs-close? (function).
needs-quotes? (function).
newline (function).
no-break-space (symbol macro).
paragraph? (function).
parse-as-markdown (function).
parse-deftag-body (function).
parse-html (function).
parse-permitted-attributes-alist (function).
pcen-char? (function).
permitted-attributes (function).
preformatted? (function).
pseudotag-expand (function).
pseudotag-expander (function).
remove-substring (function).
resolve-tag-embedded-attributes (function).
simplify-tokenized-attributes (function).
splice-allow-other-keys (function).
symbol-deftag (function).
(setf symbol-deftag) (function).
tag-close (function).
tag-fn (function).
tag-open (function).
tag-parts (function).
tag-thunk-name (function).
tokenized-attribute? (function).
tokenized-attributes-plist (function).
trim-ends (function).
unbound-deftag (condition).
unmatched? (function).
unvalidated-attribute? (function).
valid-attribute? (function).
valid-custom-element-name? (function).
valid? (function).
void? (function).
whitespace (function).
with-custom-element (macro).
with-space (macro).
with-tag (macro).
without-trailing-space (macro).
wrap-body-as-stack-thunk (function).
write-raw (function).
xss-escape (function).
spinneret.taga (function).
abbr (function).
address (function).
animate (function).
animatemotion (function).
animatetransform (function).
area (function).
article (function).
aside (function).
audio (function).
b (function).
base (function).
bdi (function).
bdo (function).
blockquote (function).
body (function).
br (function).
button (function).
canvas (function).
caption (function).
circle (function).
cite (function).
clippath (function).
code (function).
col (function).
colgroup (function).
command (function).
cursor (function).
data (function).
datalist (function).
dd (function).
defs (function).
del (function).
desc (function).
details (function).
dfn (function).
dialog (function).
div (function).
dl (function).
dt (function).
ellipse (function).
em (function).
embed (function).
feblend (function).
fecolormatrix (function).
fecomponenttransfer (function).
fecomposite (function).
feconvolvematrix (function).
fediffuselighting (function).
fedisplacementmap (function).
fedistantlight (function).
fedropshadow (function).
feflood (function).
fefunca (function).
fefuncb (function).
fefuncg (function).
fefuncr (function).
fegaussianblur (function).
feimage (function).
femerge (function).
femergenode (function).
femorphology (function).
feoffset (function).
fepointlight (function).
fespecularlighting (function).
fespotlight (function).
fetile (function).
feturbulence (function).
fieldset (function).
figcaption (function).
figure (function).
filter (function).
font (function).
font-face (function).
font-face-format (function).
font-face-name (function).
font-face-src (function).
font-face-uri (function).
footer (function).
foreignobject (function).
form (function).
g (function).
glyph (function).
glyphref (function).
h1 (function).
h2 (function).
h3 (function).
h4 (function).
h5 (function).
h6 (function).
head (function).
header (function).
hgroup (function).
hkern (function).
hr (function).
html (function).
i (function).
iframe (function).
image (function).
img (function).
input (function).
ins (function).
kbd (function).
keygen (function).
label (function).
legend (function).
li (function).
line (function).
lineargradient (function).
link (function).
main (function).
map (function).
mark (function).
marker (function).
mask (function).
math (function).
menu (function).
meta (function).
metadata (function).
meter (function).
missing-glyph (function).
mpath (function).
nav (function).
noscript (function).
object (function).
ol (function).
optgroup (function).
option (function).
output (function).
p (function).
param (function).
path (function).
pattern (function).
picture (function).
polygon (function).
polyline (function).
pre (function).
progress (function).
q (function).
radialgradient (function).
rect (function).
rp (function).
rt (function).
ruby (function).
s (function).
samp (function).
script (function).
section (function).
select (function).
set (function).
small (function).
source (function).
span (function).
stop (function).
strong (function).
style (function).
sub (function).
summary (function).
sup (function).
svg (function).
switch (function).
symbol (function).
table (function).
tbody (function).
td (function).
template (function).
text (function).
textarea (function).
textpath (function).
tfoot (function).
th (function).
thead (function).
time (function).
title (function).
tr (function).
track (function).
tref (function).
tspan (function).
u (function).
ul (function).
use (function).
var (function).
video (function).
view (function).
vkern (function).
wbr (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Add quotes to all attributes.
Column at which to wrap text.
This is always measured from the start of the tag.
Output stream for HTML generation.
List (in ascending order) of parent nodes.
How should we pretty-print HTML?
When set to non-nil, spaces will never be inserted automatically.
A list of prefixes for attributes that should not be validated.
Define NAME as a tag.
If NAME is not a keyword, it will also be defined as a macro with an
implicit ‘with-html’.
Interpret BODY as HTML. Consult README.txt for the syntax.
Like WITH-HTML, but capture the output as a string.
Escape STRING as HTML.
Return a copy of *HTML-PATH*.
This is necessary because *HTML-PATH* itself is stack-allocated.
Interpet TREE as HTML.
The syntax used is roughly that of Spinneret.
Handle writing OBJECT as HTML (for side-effects only).
symbol)) ¶number)) ¶character)) ¶escaped-string)) ¶escaped-string)) ¶string)) ¶string)) ¶null)) ¶null)) ¶The length of X when printed as an HTML string.
This is provided so you can give Spinneret the information it needs to make reasonable decisions about line wrapping.
escaped-string) &optional env) ¶escaped-string) stream) ¶html-stream) c) ¶sb-gray.
html-stream)) ¶sb-gray.
html-stream)) ¶sb-gray.
html-stream)) ¶sb-gray.
html-stream)) ¶automatically generated reader method
sb-gray.
col.
html-stream)) ¶sb-gray.
html-stream)) ¶sb-gray.
html-stream) char) ¶sb-gray.
html-stream) (char (eql #\newline))) ¶sb-gray.
html-stream) string &optional start end) ¶sb-gray.
:name
error.
fundamental-character-output-stream.
elastic-newline.
ensure-html-stream.
fire-elastic-newline.
fire-elastic-newline.
html-stream-column.
html-stream.base-stream.
html-stream?.
stream-advance-to-column.
stream-finish-output.
stream-force-output.
stream-fresh-line.
stream-line-column.
stream-start-line-p.
stream-terpri.
stream-write-char.
stream-write-char.
stream-write-string.
(integer 0 *)
0
This slot is read-only.
(integer 0 *)
0
character
#\newline
boolean
stream
:base-stream
This slot is read-only.
Depth of the tag being output.
Base case for a deftag that does not define a macro.
A deftag that also defined a macro.
Function that implements ‘do-words’.
Copy an instance of ESCAPED-STRING, optionally overriding some or all of its slots.
Automatically defined boundp function.
Automatically defined makunbound function.
Dissect a tag like ‘:div.class#id’ into the tag itself and a plist of attributes.
Dynamically select a tag at runtime. Note that TAG must be a known tag.
Get the actual keywords from the lambda list.
Like ‘format’, but bind ‘*print-pretty*’ to nil.
Format ATTRS, uses the unary function PRINT-BOOLEAN to print Boolean attributes, and the binary function PRINT-VALUE to print ordinary attributes.
Return the current dynamic heading depth.
This follows the convention for the XHTML <h/> element, where the top
level is level 1, inside the first section is level 2, and so forth.
If FORM starts with a deftag, return non-nil.
Placeholder, load spinneret/cl-markdown system if you want to expand markdown.
Is CHAR a valid character for a Potential Custom Element Name?
Return an alist of the tokenized attributes (like :class) and a plist of the regular attributes.
Automatically defined reader function.
Signals UNBOUND-DEFTAG if the value is not found in the namespace.
When DEFAULT is supplied and the symbol is not bound, the default value is automatically set.
Automatically defined writer function.
Parse a form into an element, attributes, and a body. Provided the form qualifies as a tag, the element is the car, the attributes are all the following key-value pairs, and the body is what remains.
Produce a helpful name for a thunk from NAME and ATTRS.
When possible, join tokenized attributes at compile time.
Does TAG satisfy the requirements for a custom element name?
Possibly escape ARG for use with FORMAT.
We don’t want to leave ourselves open to XSS, but we also want to be able to use directives like ~c, ~d, ~{~} &c.
html-stream)) ¶html-stream)) ¶stream)) ¶html-stream) (char character)) ¶html-stream) (char (eql #\newline))) ¶html-stream)) ¶automatically generated reader method
col.
stream)) ¶html-stream)) ¶automatically generated reader method
stream)) ¶html-stream)) ¶escaped-string) (o2 escaped-string)) ¶serapeum.
escaped-string)) ¶serapeum.
escaped-string)) ¶serapeum.
%read-only-struct.
string
(alexandria:required-argument (quote spinneret::value))
This slot is read-only.
| Jump to: | %
(
A B C D E F G H I J K L M N O P Q R S T U V W X |
|---|
| Jump to: | %
(
A B C D E F G H I J K L M N O P Q R S T U V W X |
|---|
| Jump to: | *
+
B C E L N S V |
|---|
| Jump to: | *
+
B C E L N S V |
|---|
| Jump to: | C D E F H I N P R S T U |
|---|
| Jump to: | C D E F H I N P R S T U |
|---|