This is the markup Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:15:31 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
markupmarkup provides a reader-macro to read HTML/XML tags inside of Common Lisp code
Arnold Noronha <arnold@tdrhq.com>
Apache License, Version 2.0
0.0.1
str (system).
alexandria (system).
named-readtables (system).
trivial-gray-streams (system).
stream.lisp (file).
tags.lisp (file).
markup.lisp (file).
optimizer.lisp (file).
walk.lisp (file).
all.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
markup/markup.asdmarkup/stream.lispmarkup/tags.lispmarkup/markup.lispmarkup/optimizer.lispmarkup/walk.lispmarkup/all.lispmarkup/stream.lispmarkup (system).
stream-peek-char (method).
stream-read-char (method).
stream-unread-char (method).
wrap-stream (function).
%unread-char (reader method).
(setf %unread-char) (writer method).
history-stream (reader method).
markup-stream (class).
read-so-far (function).
stream-delegate (reader method).
markup/tags.lispstream.lisp (file).
markup (system).
*standard-names* (special variable).
*void-tags* (special variable).
markup/markup.lisptags.lisp (file).
markup (system).
+empty+ (constant).
abstract-xml-tag (class).
deftag (macro).
enable-reader (macro).
format-attr-val (method).
get-attr (method).
make-merge-tag (function).
make-xml-tag (function).
merge-tag (function).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
read-xml (method).
read-xml (method).
read-xml-from-string (function).
undefined-markup-tag-condition (condition).
unescaped (function).
write-html (function).
write-html-to-stream (generic function).
write-xml (function).
write-xml-to-stream (function).
xml-merge-tag (structure).
xml-merge-tag-children (reader).
(setf xml-merge-tag-children) (writer).
xml-tag (class).
xml-tag-attributes (reader method).
(setf xml-tag-attributes) (writer method).
xml-tag-children (reader method).
(setf xml-tag-children) (writer method).
xml-tag-name (reader method).
(setf xml-tag-name) (writer method).
xml-tag-p (function).
%deftag (macro).
*standard-name-cache* (special variable).
*void-tag-cache* (special variable).
+escape-map+ (special variable).
+escape-minimal-map+ (special variable).
copy-xml-merge-tag (function).
deftag-symbol (function).
deftag-value (function).
escaped-string (class).
escaped-string-content (reader method).
(setf escaped-string-content) (writer method).
get-markup-fn (function).
html-parse-error (condition).
last-few-chars (function).
make-escape-map (function).
make-escaped (function).
make-toplevel-node (macro).
make-xml-merge-tag (function).
print-escaped-text (function).
print-escaped-text-minimal (function).
read-attr-key (function).
read-attr-val (function).
read-attributes (function).
read-comment (function).
read-string-from-xml (function).
read-tag (function).
read-whitespace (function).
read-xml-after-bracket (function).
read-xml-toplevel (function).
standard-name? (function).
tag-name (reader method).
(setf tag-name) (writer method).
unescaped-string (class).
unescaped-string-content (reader method).
(setf unescaped-string-content) (writer method).
void-tag? (function).
whitespacep (function).
write-attribute-pair (method).
write-attribute-value (method).
write-attributes (function).
xml-merge-tag-p (function).
markup/optimizer.lispmarkup.lisp (file).
markup (system).
optimize-markup (method).
optimize-markup (method).
print-object (method).
write-html-to-stream (method).
write-html-to-stream (method).
xml-tag-attributes (method).
(setf xml-tag-attributes) (method).
xml-tag-children (method).
(setf xml-tag-children) (method).
xml-tag-name (method).
%write-html-to-stream (method).
*disable-optimizer* (special variable).
attr-name (reader method).
body (reader method).
(setf body) (writer method).
delegate (function).
fast-writer (reader method).
lambda-builder-stream (class).
lazy-xml-tag (class).
make-lazy-xml-tag (macro).
register (reader method).
register (reader method).
register (reader method).
register-tag (class).
render-register (condition).
render-register-attr (condition).
standard-names (reader method).
write-attribute-pair (method).
xml-tag-builder (reader method).
markup/walk.lispoptimizer.lisp (file).
markup (system).
Packages are listed by definition order.
markup/tagscommon-lisp.
*standard-names* (special variable).
*void-tags* (special variable).
markup/streamcommon-lisp.
wrap-stream (function).
%unread-char (generic reader).
(setf %unread-char) (generic writer).
history-stream (generic reader).
markup-stream (class).
read-so-far (function).
stream-delegate (generic reader).
markup/optimizercommon-lisp.
%write-html-to-stream (generic function).
*disable-optimizer* (special variable).
attr-name (generic reader).
body (generic reader).
(setf body) (generic writer).
delegate (function).
fast-writer (generic reader).
lambda-builder-stream (class).
lazy-xml-tag (class).
make-lazy-xml-tag (macro).
register (generic reader).
register-tag (class).
render-register (condition).
render-register-attr (condition).
standard-names (generic reader).
xml-tag-builder (generic reader).
markup/markupcommon-lisp.
editor-hints.named-readtables.
+empty+ (constant).
abstract-xml-tag (class).
deftag (macro).
enable-reader (macro).
format-attr-val (generic function).
get-attr (generic function).
make-merge-tag (function).
make-xml-tag (function).
merge-tag (function).
optimize-markup (generic function).
read-xml (generic function).
read-xml-from-string (function).
undefined-markup-tag-condition (condition).
unescaped (function).
write-html (function).
write-html-to-stream (generic function).
write-xml (function).
write-xml-to-stream (function).
xml-merge-tag (structure).
xml-merge-tag-children (reader).
(setf xml-merge-tag-children) (writer).
xml-tag (class).
xml-tag-attributes (generic function).
(setf xml-tag-attributes) (generic function).
xml-tag-children (generic function).
(setf xml-tag-children) (generic function).
xml-tag-name (generic function).
(setf xml-tag-name) (generic writer).
xml-tag-p (function).
%deftag (macro).
*standard-name-cache* (special variable).
*void-tag-cache* (special variable).
+escape-map+ (special variable).
+escape-minimal-map+ (special variable).
copy-xml-merge-tag (function).
deftag-symbol (function).
deftag-value (function).
escaped-string (class).
escaped-string-content (generic reader).
(setf escaped-string-content) (generic writer).
get-markup-fn (function).
html-parse-error (condition).
last-few-chars (function).
make-escape-map (function).
make-escaped (function).
make-toplevel-node (macro).
make-xml-merge-tag (function).
print-escaped-text (function).
print-escaped-text-minimal (function).
read-attr-key (function).
read-attr-val (function).
read-attributes (function).
read-comment (function).
read-string-from-xml (function).
read-tag (function).
read-whitespace (function).
read-xml-after-bracket (function).
read-xml-toplevel (function).
standard-name? (function).
tag-name (generic reader).
(setf tag-name) (generic writer).
unescaped-string (class).
unescaped-string-content (generic reader).
(setf unescaped-string-content) (generic writer).
void-tag? (function).
whitespacep (function).
write-attribute-pair (generic function).
write-attribute-value (generic function).
write-attributes (function).
xml-merge-tag-p (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
If you use this as an attribute value, it will render as an empty attribute. For instance, you might have something like this:
<input required=(if (required-p) +empty+ nil) />
Define a new XML tag that.
Tags are namespaced so you if you define a tag foo in namespace bar
you can refer to it as <bar:foo>...</bar:foo>.
The lambda-list has a very specific syntax: it must be: ([children [&key attr*]).
If children is provided, it will be filled with the list of all
child tags while parsing. For instance <bar:foo>x<h1>y</h1></bar:foo>, will
set children as ("x" <h1>y</h1>).
abstract-xml-tag) &rest args &key &allow-other-keys) ¶abstract-xml-tag) name) ¶markup-stream) char) ¶Walk the tree, giving you the option to transform each element
abstract-xml-tag) fn) ¶list) fn) ¶xml-merge-tag) fn) ¶escaped-string) fn) ¶unescaped-string) fn) ¶string) fn) ¶register-tag) stream) ¶lazy-xml-tag) stream) ¶escaped-string) stream) ¶unescaped-string) stream) ¶(eql nil)) stream) ¶xml-merge-tag) stream) ¶string) stream) ¶abstract-xml-tag) stream) ¶integer) stream) ¶abstract-xml-tag)) ¶abstract-xml-tag)) ¶abstract-xml-tag)) ¶abstract-xml-tag)) ¶abstract-xml-tag)) ¶lazy-xml-tag) stream) ¶undefined-markup-tag-condition) out) ¶xml-merge-tag) stream) ¶abstract-xml-tag) stream) ¶html-parse-error) stream) ¶unescaped-string) stream) ¶markup-stream)) ¶sb-gray.
markup-stream)) ¶sb-gray.
markup-stream) ch) ¶sb-gray.
error.
:name
structure-object.
(or null cons)
(or null cons)
:attributes
(or null cons)
:children
symbol
(quote markup/markup::dummy)
:name
markup-stream)) ¶automatically generated reader method
markup-stream)) ¶automatically generated writer method
xml-tag) (stream lambda-builder-stream)) ¶render-register-attr)) ¶name.
lambda-builder-stream)) ¶automatically generated reader method
body.
lambda-builder-stream)) ¶automatically generated writer method
body.
escaped-string)) ¶automatically generated reader method
escaped-string)) ¶automatically generated writer method
lazy-xml-tag)) ¶A lambda function, when called with a
stream will very efficiently write the tree to the
stream. This function will only work if you didn’t
attempt to introspect the node.
markup-stream)) ¶automatically generated reader method
register-tag)) ¶automatically generated reader method
render-register-attr)) ¶render-register)) ¶lazy-xml-tag)) ¶A list of all symbols that are
assumed to be standard names. At compilation time,
the FAST-WRITER might detect that these symbols are
not overriden.. If at render time we detect that one
of the symbols are overriden, then we’ll fallback to
the slow path. This should be very very rare.
markup-stream)) ¶automatically generated reader method
undefined-markup-tag-condition)) ¶undefined-markup-tag-condition)) ¶name.
unescaped-string)) ¶automatically generated reader method
unescaped-string)) ¶automatically generated writer method
register-tag) stream) ¶Writes the attribute value, including if needed
lazy-xml-tag)) ¶automatically generated reader method
condition.
condition.
:content
A fake ’stream’. We’ll try to write a fake xml-tree
into this, but instead of writing the actual contents, we’ll write
the instructions required to reproduce this efficiently.
:builder
This slot is read-only.
A list of all symbols that are
assumed to be standard names. At compilation time,
the FAST-WRITER might detect that these symbols are
not overriden.. If at render time we detect that one
of the symbols are overriden, then we’ll fallback to
the slow path. This should be very very rare.
:standard-names
This slot is read-only.
A lambda function, when called with a
stream will very efficiently write the tree to the
stream. This function will only work if you didn’t
attempt to introspect the node.
:fast-writer
This slot is read-only.
fundamental-character-stream.
:delegate
This slot is read-only.
common-lisp.
(make-string-output-stream)
This slot is read-only.
:content
| Jump to: | %
(
A B C D E F G H L M O P R S T U V W X |
|---|
| Jump to: | %
(
A B C D E F G H L M O P R S T U V W X |
|---|
| Jump to: | *
+
A B C D F H L M N R S U X |
|---|
| Jump to: | *
+
A B C D F H L M N R S U X |
|---|
| Jump to: | A C E F H L M O P R S T U W X |
|---|
| Jump to: | A C E F H L M O P R S T U W X |
|---|