This is the buildnode Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 11:42:16 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
buildnodeTool for building up an xml dom nicely.
http://www.acceleration.net
BSD
cxml (system).
alexandria (system).
iterate (system).
flexi-streams (system).
split-sequence (system).
swank (system).
cl-interpol (system).
collectors (system).
closure-html (system).
cl-ppcre (system).
symbol-munger (system).
src (module).
Modules are listed depth-first from the system components tree.
buildnode/srcbuildnode (system).
packages.lisp (file).
dom-walker.lisp (file).
buildnode.lisp (file).
tags (module).
buildnode/src/tagsbuildnode.lisp (file).
src (module).
tags.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
buildnode/buildnode.asdbuildnode/src/packages.lispbuildnode/src/dom-walker.lispbuildnode/src/buildnode.lispbuildnode/src/tags/tags.lispbuildnode/src/dom-walker.lisppackages.lisp (file).
src (module).
dom-walk (generic function).
compute-attributes (function).
buildnode/src/buildnode.lispdom-walker.lisp (file).
src (module).
*cdata-script-blocks* (special variable).
*document* (special variable).
*html-compatibility-mode* (special variable).
*namespace-prefix-map* (special variable).
add-children (function).
add-css-class (generic function).
add-css-class-helper (function).
add-css-classes (generic function).
append-nodes (function).
characters (method).
create-complete-element (function).
css-classes (generic function).
document-to-string (function).
end-document (method).
get-attribute (generic function).
inner-html (function).
insert-children (function).
insert-html-string (function).
insert-nodes (function).
join-text (function).
make-output-sink (function).
make-scoped-dom-builder (function).
push-new-attribute (function).
push-new-attributes (function).
remove-all-children (generic function).
remove-attribute (generic function).
remove-attributes (function).
remove-css-class (generic function).
remove-css-classes (generic function).
scoped-dom-builder (class).
set-attribute (generic function).
set-attributes (function).
start-document (method).
start-document (method).
text-of-dom-snippet (generic function).
unescaped (method).
with-document (macro).
with-document-to-file (macro).
with-html-document (macro).
with-html-document-to-file (macro).
with-html-document-to-string (macro).
with-html-snippet (macro).
with-html5-document (macro).
with-html5-document-to-file (macro).
with-html5-document-to-string (macro).
with-html5-snippet (macro).
with-xhtml-document (macro).
with-xhtml-document-to-file (macro).
with-xhtml-frameset-document (macro).
with-xhtml-snippet (macro).
write-doc-to-file (function).
write-document (function).
%buffer-xml-output (function).
%enstream (function).
%merge-conts (function).
%walk-dom-cont (function).
%with-snippet (macro).
*snippet-output-stream* (special variable).
*xhtml1-transitional-extid* (special variable).
+common-white-space-trimbag+ (special variable).
attribute-uri (function).
buffer-xml-output (macro).
calc-complete-tagname (function).
clause-for-in-dom-1 (macro).
clause-for-in-dom-children-3 (macro).
clause-for-in-dom-parents-2 (macro).
depth-first-nodes (function).
document-of (function).
eval-always (macro).
flatten-children (function).
get-namespace-from-prefix (function).
get-prefix (function).
html-output? (generic function).
html-whitespace-remover (class).
html5-capable-character-output-sink (function).
html5-capable-character-output-sink (class).
prepare-attribute-name (function).
prepare-attribute-value (function).
trim-and-nullify (function).
trim-and-nullify! (macro).
trim-whitespace (function).
write-document-to-character-stream (function).
write-document-to-octet-stream (function).
write-normalized-document-to-sink (function).
xmls-to-dom-snippet (function).
buildnode/src/tags/tags.lisptags (module).
?processing-instruction (function).
?xml-stylesheet (function).
cdata (function).
def-tag-node (macro).
dom-comment (function).
script-block (function).
stylesheet-block (function).
*tags-indentation-hints* (special variable).
do-def-tag-node (function).
make-script-block-fn (function).
make-script-fn (function).
Packages are listed by definition order.
net.acceleration.buildnodebuildnode
common-lisp.
cxml.
iterate.
*cdata-script-blocks* (special variable).
*document* (special variable).
*html-compatibility-mode* (special variable).
*namespace-prefix-map* (special variable).
?processing-instruction (function).
?xml-stylesheet (function).
add-children (function).
add-css-class (generic function).
add-css-class-helper (function).
add-css-classes (generic function).
append-nodes (function).
cdata (function).
create-complete-element (function).
css-classes (generic function).
def-tag-node (macro).
document-to-string (function).
dom-comment (function).
dom-walk (generic function).
get-attribute (generic function).
inner-html (function).
insert-children (function).
insert-html-string (function).
insert-nodes (function).
join-text (function).
make-output-sink (function).
make-scoped-dom-builder (function).
push-new-attribute (function).
push-new-attributes (function).
remove-all-children (generic function).
remove-attribute (generic function).
remove-attributes (function).
remove-css-class (generic function).
remove-css-classes (generic function).
scoped-dom-builder (class).
script-block (function).
set-attribute (generic function).
set-attributes (function).
stylesheet-block (function).
text-of-dom-snippet (generic function).
with-document (macro).
with-document-to-file (macro).
with-html-document (macro).
with-html-document-to-file (macro).
with-html-document-to-string (macro).
with-html-snippet (macro).
with-html5-document (macro).
with-html5-document-to-file (macro).
with-html5-document-to-string (macro).
with-html5-snippet (macro).
with-xhtml-document (macro).
with-xhtml-document-to-file (macro).
with-xhtml-frameset-document (macro).
with-xhtml-snippet (macro).
write-doc-to-file (function).
write-document (function).
%buffer-xml-output (function).
%enstream (function).
%merge-conts (function).
%walk-dom-cont (function).
%with-snippet (macro).
*snippet-output-stream* (special variable).
*tags-indentation-hints* (special variable).
*xhtml1-transitional-extid* (special variable).
+common-white-space-trimbag+ (special variable).
attribute-uri (function).
buffer-xml-output (macro).
calc-complete-tagname (function).
clause-for-in-dom-1 (macro).
clause-for-in-dom-children-3 (macro).
clause-for-in-dom-parents-2 (macro).
compute-attributes (function).
depth-first-nodes (function).
do-def-tag-node (function).
document-of (function).
eval-always (macro).
flatten-children (function).
get-namespace-from-prefix (function).
get-prefix (function).
html-output? (generic function).
html-whitespace-remover (class).
html5-capable-character-output-sink (function).
html5-capable-character-output-sink (class).
make-script-block-fn (function).
make-script-fn (function).
prepare-attribute-name (function).
prepare-attribute-value (function).
trim-and-nullify (function).
trim-and-nullify! (macro).
trim-whitespace (function).
write-document-to-character-stream (function).
write-document-to-octet-stream (function).
write-normalized-document-to-sink (function).
xmls-to-dom-snippet (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Should script blocks have a cdata?
A variable that holds the current document that is being built. see with-document.
Defines a tag function in the package with the name and prefix specified
for example: :net.acceleration.xul "box" "xul" will create a function #’box in the :net.acceleration.xul
lisp namespace. When this function is called it will create a ’xul:box’ node in the xmlns provided in the namespace param
(with-document ( a bunch of child nodes of the document )) –> cxml:dom document Creates an environment in which the special variable *document* is available a document is necessary to create dom nodes and the document the nodes end up on must be the document on which they were created. At the end of the form, the complete document is returned
Creates a document block with-document upon which to add the chillins (southern for children). When the document is complete, it is written out to the specified file.
(with-html-document ( a bunch of child nodes of the document )) –> cxml:dom document
Creates an environment in which the special variable *document* is available
a document is necessary to create dom nodes and the document the nodes end up on
must be the document on which they were created. At the end of the form, the
complete document is returned.
This sets the doctype to be html 4.01 strict.
Creates an html-document, writes out the results to filename
trys to output a string containing all
builds a little piece of html-dom and renders that to a string / stream
(with-html5-document ( a bunch of child nodes of the document )) –> cxml:dom document
Creates an environment in which the special variable *document* is available
a document is necessary to create dom nodes and the document the nodes end up on
must be the document on which they were created. At the end of the form, the
complete document is returned.
This sets the doctype to be html5 compatible <!DOCTYPE html>.
Creates an html-document, writes out the results to filename
trys to output a string containing all
builds a little piece of html-dom and renders that to a string / stream
(with-xhtml-document ( a bunch of child nodes of the document )) –> cxml:dom document
Creates an environment in which the special variable *document* is available
a document is necessary to create dom nodes and the document the nodes end up on
must be the document on which they were created. At the end of the form, the
complete document is returned.
This sets the doctype to be xhtml transitional.
Creates a document block with-document upon which to add the chillins (southern for children). When the document is complete, it is written out to the specified file.
(with-xhtml-document ( a bunch of child nodes of the document )) –> cxml:dom document
Creates an environment in which the special variable *document* is available
a document is necessary to create dom nodes and the document the nodes end up on
must be the document on which they were created. At the end of the form, the
complete document is returned.
This sets the doctype to be xhtml transitional.
builds a little piece of xhtml-dom and renders that to a string / stream
adds an xml-stylesheet processing instruction to the cxml:dom document bound to the special variable *document*
adds some kids to an element and return that element alias for append-nodes
appends a bunch of dom-nodes (chillins) to the location specified alias of add-children
Creates an xml element out of all the necessary components.
If the tagname does not contain a prefix, then one is added based on the namespace-prefix map.
Return a string representation of a document.
Insert a dom comment into the current *document*
insert a bunch of dom-nodes (kids) to the location specified alias for insert-nodes
Parses a string containing a well formed html snippet
into dom nodes inside of a newly created node.
(Based loosely around the idea of setting the javascript innerHTML property)
Will wrap the input in a tag (which is neccessary from CXMLs perspective)
can validate the html against a DTD if one is passed, can use
*xhtml1-transitional-extid* for example.
insert a bunch of dom-nodes (chillins) to the location specified alias of insert-children
Like joins trees of lists strings and dom nodes into a single string possibly with a delimiter ignores nil and empty string
Returns a new scoped dom builder, scoped to the passed in node. Nodes built with this builder will be added to the passed in node
if the attribute is not on the element then put it there with the specified value, returns the elem and whether or not the attribute was set
for each attribute in the plist push-new into the attributes list of the elem, returns the elem
removes an attribute and passes the elem through, returns the elem
given a list of urls, will build a list of script nodes pointing to the appropriate urls. Pass in #’xul:script or #’xhtml:script as the first argument
set-attribute for each attribute specified in the plist, returns the elem
given a list of urls, will build a list of ?xml-stylesheet nodes pointing to the appropriate urls
Binary write-out a document. will create/overwrite any existing file named the same.
Write the document to the designated out-stream, or *standard-ouput* by default.
Adds a new css class to the element and returns the element
element) new-class) ¶Returns a list of css classes (space separated names in the ’class’ attribute)
An in order traversal of a subset of the dom, that calls the appropriate sax events
entity-reference) &key &allow-other-keys) ¶processing-instruction) &key &allow-other-keys) ¶comment) &key &allow-other-keys) ¶text) &key &allow-other-keys) ¶cdata-section) &key &allow-other-keys) ¶element) &key include-xmlns-attributes include-doctype include-default-values &allow-other-keys) ¶document) &key include-xmlns-attributes include-doctype include-default-values recode) ¶Gets the value of an attribute on an element if the attribute does not exist return nil
element)) ¶removes an attribute and passes the elem through, returns the elem
If the attribute does not exist, simply skip it
Removes a css class from the elements and returns the element
element) new-class) ¶Sets an attribute and passes the elem through, returns the elem. If value is nil, removes the attribute
get all of the textnodes of a dom:element and return that string with splice between each character
html-whitespace-remover) data) ¶sax.
scoped-dom-builder)) ¶sax.
scoped-dom-builder)) ¶sax.
html5-capable-character-output-sink) name public-id system-id) ¶hax.
scoped-dom-builder) data) ¶sax.
A dom builder that builds inside of another dom-node
dom-builder.
helper to define with-html-snippet and with-xhtml-snippet
buffers out sax:events to a sting
xml parameters like <param:foo param:type="string"><div>bar</div></param:foo>
are requested to be strings (presumably for string processing)
A driver that will walk over every node in a set of dom trees
iterates over the children of a dom node as per flatten-children
A driver that will return each parent node up from a starting node until we get to a null parent
Takes many continuations and makes a single continuation that iterates through each of the arguments in turn
calls this on a dom tree (or tree list) and you get back
a node and a continuation function.
repeated calls to the continuation each return the next node
and the next walker continuation
get a list of the nodes in a depth first traversal of the dom trees
Returns the document of a given node (or the document if passed in)
Handles flattening nested lists and vectors of nodes
into a single flat list of children
Prepares an attribute name for output to html by coercing to strings
prepares a value for html out put by coercing to a string
trims the whitespace from a string returning nil
if trimming produces an empty string or the string ’nil’
writes a cxml:dom document to a character stream
writes a cxml:dom document to a character stream
writes a cxml:dom document to the given stream-sink,
passing the document through a namespace normalizer first, and
possibly a html-compatibility-sink if *html-compatibility-mode* is set
Given a snippet of xmls, return a new dom snippet of that content
| Jump to: | %
?
A B C D E F G H I J M P R S T U W X |
|---|
| Jump to: | %
?
A B C D E F G H I J M P R S T U W X |
|---|
| Jump to: | *
+
S |
|---|
| Jump to: | *
+
S |
|---|
| Jump to: | B C D F H M N P S T |
|---|
| Jump to: | B C D F H M N P S T |
|---|