The buildnode Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The buildnode Reference Manual

This is the buildnode Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:00:22 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Buildnode: A libary to ease interaction with cxml:dom documents and nodes

Examples

Please see the examples directory for runable examples in each XML dialect

Primary Goals

Authors

;; Copyright (c) 2011 Russ Tyndall , Acceleration.net http://www.acceleration.net
;; All rights reserved.
;;
;; Redistribution and use in source and binary forms, with or without
;; modification, are permitted provided that the following conditions are
;; met:
;;
;;  - Redistributions of source code must retain the above copyright
;;    notice, this list of conditions and the following disclaimer.
;;
;;  - Redistributions in binary form must reproduce the above copyright
;;    notice, this list of conditions and the following disclaimer in the
;;    documentation and/or other materials provided with the distribution.
;;
;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
;; A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 buildnode

Author

http://www.acceleration.net

License

BSD

Description

Tool for building up an xml dom nicely.

Dependencies
Source

buildnode.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 buildnode/src

Parent

buildnode (system)

Location

src/

Components

Previous: , Up: Modules   [Contents][Index]

3.2 buildnode/src/tags

Dependency

buildnode.lisp (file)

Parent

src (module)

Location

src/tags/

Component

tags.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 buildnode.asd

Location

buildnode.asd

Systems

buildnode (system)

Packages

net.acceleration.buildnode.system


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 buildnode/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

net.acceleration.buildnode


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 buildnode/src/dom-walker.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/dom-walker.lisp

Exported Definitions
Internal Definitions

compute-attributes (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 buildnode/src/buildnode.lisp

Dependency

dom-walker.lisp (file)

Parent

src (module)

Location

src/buildnode.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.5 buildnode/src/tags/tags.lisp

Parent

tags (module)

Location

src/tags/tags.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 net.acceleration.buildnode.system

Source

buildnode.asd

Use List

Previous: , Up: Packages   [Contents][Index]

5.2 net.acceleration.buildnode

Source

packages.lisp (file)

Nickname

buildnode

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *cdata-script-blocks*

Should script blocks have a cdata?

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Special Variable: *document*

A variable that holds the current document that is being built. see with-document.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Special Variable: *html-compatibility-mode*
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Special Variable: *namespace-prefix-map*
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

Macro: def-tag-node PACKAGE NAME NAMESPACE DOCSTRING &optional FN-NAME

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

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Macro: with-document &body CHILLINS

(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

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-document-to-file FILENAME &body CHILLINS

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.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html-document &body BODY

(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.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html-document-to-file (FILENAME) &body BODY

Creates an html-document, writes out the results to filename

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html-document-to-string () &body BODY

trys to output a string containing all

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html-snippet (&optional STREAM SINK) &body BODY

builds a little piece of html-dom and renders that to a string / stream

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html5-document &body BODY

(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>.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html5-document-to-file (FILENAME) &body BODY

Creates an html-document, writes out the results to filename

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html5-document-to-string () &body BODY

trys to output a string containing all

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-html5-snippet (&optional STREAM SINK) &body BODY

builds a little piece of html-dom and renders that to a string / stream

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-xhtml-document &body CHILLINS

(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.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-xhtml-document-to-file FILENAME &body CHILLINS

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.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-xhtml-frameset-document &body CHILLINS

(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.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: with-xhtml-snippet (&optional STREAM SINK) &body BODY

builds a little piece of xhtml-dom and renders that to a string / stream

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Functions

Function: ?processing-instruction TARGET DATA
Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: ?xml-stylesheet HREF &optional TYPE

adds an xml-stylesheet processing instruction to the cxml:dom document bound to the special variable *document*

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: add-children ELEM &rest KIDS &aux LIST? DOC ELEM-LIST

adds some kids to an element and return that element alias for append-nodes

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: add-css-class-helper &rest NEW-CLASSES
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: append-nodes TO-LOCATION &rest CHILLINS

appends a bunch of dom-nodes (chillins) to the location specified alias of add-children

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: cdata DATA
Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: create-complete-element DOCUMENT NAMESPACE TAGNAME ATTRIBUTES CHILDREN &optional NAMESPACE-PREFIX-MAP

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.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: document-to-string DOC

Return a string representation of a document.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: dom-comment TEXT

Insert a dom comment into the current *document*

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: inner-html STRING &optional TAG NAMESPACE-URI DTD REMOVE-WHITESPACE?
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: insert-children ELEM IDX &rest KIDS

insert a bunch of dom-nodes (kids) to the location specified alias for insert-nodes

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: insert-html-string STRING &key TAG NAMESPACE-URI DTD REMOVE-WHITESPACE?

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.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: insert-nodes TO-LOCATION INDEX &rest CHILLINS

insert a bunch of dom-nodes (chillins) to the location specified alias of insert-children

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: join-text TEXT &key DELIMITER

Like joins trees of lists strings and dom nodes into a single string possibly with a delimiter ignores nil and empty string

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: make-output-sink STREAM &key CANONICAL INDENTATION CHAR-P
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: make-scoped-dom-builder NODE

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

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: push-new-attribute ELEM ATTRIBUTE VALUE

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

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: push-new-attributes ELEM &rest ATTRIBUTE-P-LIST

for each attribute in the plist push-new into the attributes list of the elem, returns the elem

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: remove-attributes ELEM &rest ATTRIBUTES

removes an attribute and passes the elem through, returns the elem

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: script-block FN LIST-OF-URLS

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

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: set-attributes ELEM &rest ATTRIBUTE-P-LIST

set-attribute for each attribute specified in the plist, returns the elem

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: stylesheet-block LIST &optional TYPE

given a list of urls, will build a list of ?xml-stylesheet nodes pointing to the appropriate urls

Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: write-doc-to-file DOC FILENAME

Binary write-out a document. will create/overwrite any existing file named the same.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: write-document DOCUMENT &optional OUT-STREAM

Write the document to the designated out-stream, or *standard-ouput* by default.

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Generic functions

Generic Function: add-css-class ELEMENT NEW-CLASS

Adds a new css class to the element and returns the element

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: add-css-class (EL element) NEW-CLASS
Generic Function: add-css-classes COMP &rest CLASSES
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: add-css-classes COMP &rest CLASSES
Generic Function: css-classes O

Returns a list of css classes (space separated names in the ’class’ attribute)

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: css-classes O
Generic Function: dom-walk HANDLER VALUE &key INCLUDE-XMLNS-ATTRIBUTES INCLUDE-DOCTYPE INCLUDE-DEFAULT-VALUES RECODE &allow-other-keys

An in order traversal of a subset of the dom, that calls the appropriate sax events

Package

net.acceleration.buildnode

Source

dom-walker.lisp (file)

Methods
Method: dom-walk HANDLER (N entity-reference) &key &allow-other-keys
Method: dom-walk HANDLER (N processing-instruction) &key &allow-other-keys
Method: dom-walk HANDLER (N comment) &key &allow-other-keys
Method: dom-walk HANDLER (N text) &key &allow-other-keys &aux PN PARENT
Method: dom-walk HANDLER (N cdata-section) &key &allow-other-keys
Method: dom-walk HANDLER (N element) &key INCLUDE-XMLNS-ATTRIBUTES INCLUDE-DOCTYPE INCLUDE-DEFAULT-VALUES &allow-other-keys
Method: dom-walk HANDLER (DOCUMENT document) &key INCLUDE-XMLNS-ATTRIBUTES INCLUDE-DOCTYPE INCLUDE-DEFAULT-VALUES RECODE
Generic Function: get-attribute ELEM ATTRIBUTE

Gets the value of an attribute on an element if the attribute does not exist return nil

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: get-attribute ELEM ATTRIBUTE
Generic Function: remove-all-children EL
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: remove-all-children (IT element)
Generic Function: remove-attribute ELEM ATTRIBUTE

removes an attribute and passes the elem through, returns the elem If the attribute does not exist, simply skip it

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: remove-attribute ELEM ATTRIBUTE
Generic Function: remove-css-class EL NEW-CLASS

Removes a css class from the elements and returns the element

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: remove-css-class (EL element) NEW-CLASS
Generic Function: remove-css-classes COMP &rest CLASSES
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: remove-css-classes COMP &rest CLASSES
Generic Function: set-attribute ELEM ATTRIBUTE VALUE

Sets an attribute and passes the elem through, returns the elem. If value is nil, removes the attribute

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: set-attribute ELEM ATTRIBUTE VALUE
Generic Function: text-of-dom-snippet EL &optional SPLICE STREAM

get all of the textnodes of a dom:element and return that string with splice between each character

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: text-of-dom-snippet EL &optional SPLICE STREAM

Previous: , Up: Exported definitions   [Contents][Index]

6.1.5 Classes

Class: scoped-dom-builder ()

A dom builder that builds inside of another dom-node

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Direct superclasses

dom-builder (class)

Direct methods
  • unescaped (method)
  • end-document (method)
  • start-document (method)

Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *snippet-output-stream*
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Special Variable: *tags-indentation-hints*
Package

net.acceleration.buildnode

Source

tags.lisp (file)

Special Variable: *xhtml1-transitional-extid*
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Special Variable: +common-white-space-trimbag+
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Macros

Macro: %with-snippet (TYPE &optional STREAM SINK) &body BODY

helper to define with-html-snippet and with-xhtml-snippet

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: buffer-xml-output (&optional STREAM SINK) &body BODY

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)

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: clause-for-in-dom-1 &key (FOR NODE) (IN-DOM TREE) GENERATE

A driver that will walk over every node in a set of dom trees

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: clause-for-in-dom-children-3 &key (FOR KID) (IN-DOM-CHILDREN NODES) GENERATE

iterates over the children of a dom node as per flatten-children

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: clause-for-in-dom-parents-2 &key (FOR PARENT) (IN-DOM-PARENTS NODE) GENERATE

A driver that will return each parent node up from a starting node until we get to a null parent

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: eval-always &body BODY
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Macro: trim-and-nullify! &rest PLACES
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Functions

Function: %buffer-xml-output STREAM SINK BODY-FN
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: %enstream STREAM CONTENT-FN
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: %merge-conts &rest CONTS

Takes many continuations and makes a single continuation that iterates through each of the arguments in turn

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: %walk-dom-cont TREE

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

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: attribute-uri ATTRIBUTE
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: calc-complete-tagname NAMESPACE BASE-TAG NAMESPACE-PREFIX-MAP
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: compute-attributes ELEMENT XMLNSP DEFAULTP
Package

net.acceleration.buildnode

Source

dom-walker.lisp (file)

Function: depth-first-nodes TREE

get a list of the nodes in a depth first traversal of the dom trees

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: do-def-tag-node PACKAGE NAME NAMESPACE DOCSTRING &optional FN-NAME
Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: document-of EL

Returns the document of a given node (or the document if passed in)

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: flatten-children KIDS &optional DOC

Handles flattening nested lists and vectors of nodes into a single flat list of children

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: get-namespace-from-prefix PREFIX &optional NAMESPACE-PREFIX-MAP
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: get-prefix NAMESPACE &optional NAMESPACE-PREFIX-MAP
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: html5-capable-character-output-sink STREAM &key CANONICAL INDENTATION ENCODING
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: make-script-block-fn FN-SCRIPT JS
Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: make-script-fn FN-SCRIPT URL
Package

net.acceleration.buildnode

Source

tags.lisp (file)

Function: prepare-attribute-name ATTRIBUTE

Prepares an attribute name for output to html by coercing to strings

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: prepare-attribute-value VALUE

prepares a value for html out put by coercing to a string

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: trim-and-nullify S

trims the whitespace from a string returning nil
if trimming produces an empty string or the string ’nil’

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: trim-whitespace S
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: write-document-to-character-stream DOCUMENT CHAR-STREAM

writes a cxml:dom document to a character stream

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: write-document-to-octet-stream DOCUMENT OCTET-STREAM

writes a cxml:dom document to a character stream

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: write-normalized-document-to-sink DOCUMENT STREAM-SINK

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

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Function: xmls-to-dom-snippet SXML &key NAMESPACE

Given a snippet of xmls, return a new dom snippet of that content

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Generic functions

Generic Function: html-output? DOC
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Methods
Method: html-output? DOC

Previous: , Up: Internal definitions   [Contents][Index]

6.2.5 Classes

Class: html-whitespace-remover ()

a stream filter to remove nodes that are entirely whitespace

Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Direct superclasses

sax-proxy (class)

Direct methods

characters (method)

Class: html5-capable-character-output-sink ()
Package

net.acceleration.buildnode

Source

buildnode.lisp (file)

Direct superclasses

sink (class)

Direct methods

start-document (method)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   B   F   L   M  
Index Entry  Section

B
buildnode.asd: The buildnode<dot>asd file
buildnode/src: The buildnode/src module
buildnode/src/buildnode.lisp: The buildnode/src/buildnode<dot>lisp file
buildnode/src/dom-walker.lisp: The buildnode/src/dom-walker<dot>lisp file
buildnode/src/packages.lisp: The buildnode/src/packages<dot>lisp file
buildnode/src/tags: The buildnode/src/tags module
buildnode/src/tags/tags.lisp: The buildnode/src/tags/tags<dot>lisp file

F
File, Lisp, buildnode.asd: The buildnode<dot>asd file
File, Lisp, buildnode/src/buildnode.lisp: The buildnode/src/buildnode<dot>lisp file
File, Lisp, buildnode/src/dom-walker.lisp: The buildnode/src/dom-walker<dot>lisp file
File, Lisp, buildnode/src/packages.lisp: The buildnode/src/packages<dot>lisp file
File, Lisp, buildnode/src/tags/tags.lisp: The buildnode/src/tags/tags<dot>lisp file

L
Lisp File, buildnode.asd: The buildnode<dot>asd file
Lisp File, buildnode/src/buildnode.lisp: The buildnode/src/buildnode<dot>lisp file
Lisp File, buildnode/src/dom-walker.lisp: The buildnode/src/dom-walker<dot>lisp file
Lisp File, buildnode/src/packages.lisp: The buildnode/src/packages<dot>lisp file
Lisp File, buildnode/src/tags/tags.lisp: The buildnode/src/tags/tags<dot>lisp file

M
Module, buildnode/src: The buildnode/src module
Module, buildnode/src/tags: The buildnode/src/tags module

Jump to:   B   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   ?  
A   B   C   D   E   F   G   H   I   J   M   P   R   S   T   W   X  
Index Entry  Section

%
%buffer-xml-output: Internal functions
%enstream: Internal functions
%merge-conts: Internal functions
%walk-dom-cont: Internal functions
%with-snippet: Internal macros

?
?processing-instruction: Exported functions
?xml-stylesheet: Exported functions

A
add-children: Exported functions
add-css-class: Exported generic functions
add-css-class: Exported generic functions
add-css-class-helper: Exported functions
add-css-classes: Exported generic functions
add-css-classes: Exported generic functions
append-nodes: Exported functions
attribute-uri: Internal functions

B
buffer-xml-output: Internal macros

C
calc-complete-tagname: Internal functions
cdata: Exported functions
clause-for-in-dom-1: Internal macros
clause-for-in-dom-children-3: Internal macros
clause-for-in-dom-parents-2: Internal macros
compute-attributes: Internal functions
create-complete-element: Exported functions
css-classes: Exported generic functions
css-classes: Exported generic functions

D
def-tag-node: Exported macros
depth-first-nodes: Internal functions
do-def-tag-node: Internal functions
document-of: Internal functions
document-to-string: Exported functions
dom-comment: Exported functions
dom-walk: Exported generic functions
dom-walk: Exported generic functions
dom-walk: Exported generic functions
dom-walk: Exported generic functions
dom-walk: Exported generic functions
dom-walk: Exported generic functions
dom-walk: Exported generic functions
dom-walk: Exported generic functions

E
eval-always: Internal macros

F
flatten-children: Internal functions
Function, %buffer-xml-output: Internal functions
Function, %enstream: Internal functions
Function, %merge-conts: Internal functions
Function, %walk-dom-cont: Internal functions
Function, ?processing-instruction: Exported functions
Function, ?xml-stylesheet: Exported functions
Function, add-children: Exported functions
Function, add-css-class-helper: Exported functions
Function, append-nodes: Exported functions
Function, attribute-uri: Internal functions
Function, calc-complete-tagname: Internal functions
Function, cdata: Exported functions
Function, compute-attributes: Internal functions
Function, create-complete-element: Exported functions
Function, depth-first-nodes: Internal functions
Function, do-def-tag-node: Internal functions
Function, document-of: Internal functions
Function, document-to-string: Exported functions
Function, dom-comment: Exported functions
Function, flatten-children: Internal functions
Function, get-namespace-from-prefix: Internal functions
Function, get-prefix: Internal functions
Function, html5-capable-character-output-sink: Internal functions
Function, inner-html: Exported functions
Function, insert-children: Exported functions
Function, insert-html-string: Exported functions
Function, insert-nodes: Exported functions
Function, join-text: Exported functions
Function, make-output-sink: Exported functions
Function, make-scoped-dom-builder: Exported functions
Function, make-script-block-fn: Internal functions
Function, make-script-fn: Internal functions
Function, prepare-attribute-name: Internal functions
Function, prepare-attribute-value: Internal functions
Function, push-new-attribute: Exported functions
Function, push-new-attributes: Exported functions
Function, remove-attributes: Exported functions
Function, script-block: Exported functions
Function, set-attributes: Exported functions
Function, stylesheet-block: Exported functions
Function, trim-and-nullify: Internal functions
Function, trim-whitespace: Internal functions
Function, write-doc-to-file: Exported functions
Function, write-document: Exported functions
Function, write-document-to-character-stream: Internal functions
Function, write-document-to-octet-stream: Internal functions
Function, write-normalized-document-to-sink: Internal functions
Function, xmls-to-dom-snippet: Internal functions

G
Generic Function, add-css-class: Exported generic functions
Generic Function, add-css-classes: Exported generic functions
Generic Function, css-classes: Exported generic functions
Generic Function, dom-walk: Exported generic functions
Generic Function, get-attribute: Exported generic functions
Generic Function, html-output?: Internal generic functions
Generic Function, remove-all-children: Exported generic functions
Generic Function, remove-attribute: Exported generic functions
Generic Function, remove-css-class: Exported generic functions
Generic Function, remove-css-classes: Exported generic functions
Generic Function, set-attribute: Exported generic functions
Generic Function, text-of-dom-snippet: Exported generic functions
get-attribute: Exported generic functions
get-attribute: Exported generic functions
get-namespace-from-prefix: Internal functions
get-prefix: Internal functions

H
html-output?: Internal generic functions
html-output?: Internal generic functions
html5-capable-character-output-sink: Internal functions

I
inner-html: Exported functions
insert-children: Exported functions
insert-html-string: Exported functions
insert-nodes: Exported functions

J
join-text: Exported functions

M
Macro, %with-snippet: Internal macros
Macro, buffer-xml-output: Internal macros
Macro, clause-for-in-dom-1: Internal macros
Macro, clause-for-in-dom-children-3: Internal macros
Macro, clause-for-in-dom-parents-2: Internal macros
Macro, def-tag-node: Exported macros
Macro, eval-always: Internal macros
Macro, trim-and-nullify!: Internal macros
Macro, with-document: Exported macros
Macro, with-document-to-file: Exported macros
Macro, with-html-document: Exported macros
Macro, with-html-document-to-file: Exported macros
Macro, with-html-document-to-string: Exported macros
Macro, with-html-snippet: Exported macros
Macro, with-html5-document: Exported macros
Macro, with-html5-document-to-file: Exported macros
Macro, with-html5-document-to-string: Exported macros
Macro, with-html5-snippet: Exported macros
Macro, with-xhtml-document: Exported macros
Macro, with-xhtml-document-to-file: Exported macros
Macro, with-xhtml-frameset-document: Exported macros
Macro, with-xhtml-snippet: Exported macros
make-output-sink: Exported functions
make-scoped-dom-builder: Exported functions
make-script-block-fn: Internal functions
make-script-fn: Internal functions
Method, add-css-class: Exported generic functions
Method, add-css-classes: Exported generic functions
Method, css-classes: Exported generic functions
Method, dom-walk: Exported generic functions
Method, dom-walk: Exported generic functions
Method, dom-walk: Exported generic functions
Method, dom-walk: Exported generic functions
Method, dom-walk: Exported generic functions
Method, dom-walk: Exported generic functions
Method, dom-walk: Exported generic functions
Method, get-attribute: Exported generic functions
Method, html-output?: Internal generic functions
Method, remove-all-children: Exported generic functions
Method, remove-attribute: Exported generic functions
Method, remove-css-class: Exported generic functions
Method, remove-css-classes: Exported generic functions
Method, set-attribute: Exported generic functions
Method, text-of-dom-snippet: Exported generic functions

P
prepare-attribute-name: Internal functions
prepare-attribute-value: Internal functions
push-new-attribute: Exported functions
push-new-attributes: Exported functions

R
remove-all-children: Exported generic functions
remove-all-children: Exported generic functions
remove-attribute: Exported generic functions
remove-attribute: Exported generic functions
remove-attributes: Exported functions
remove-css-class: Exported generic functions
remove-css-class: Exported generic functions
remove-css-classes: Exported generic functions
remove-css-classes: Exported generic functions

S
script-block: Exported functions
set-attribute: Exported generic functions
set-attribute: Exported generic functions
set-attributes: Exported functions
stylesheet-block: Exported functions

T
text-of-dom-snippet: Exported generic functions
text-of-dom-snippet: Exported generic functions
trim-and-nullify: Internal functions
trim-and-nullify!: Internal macros
trim-whitespace: Internal functions

W
with-document: Exported macros
with-document-to-file: Exported macros
with-html-document: Exported macros
with-html-document-to-file: Exported macros
with-html-document-to-string: Exported macros
with-html-snippet: Exported macros
with-html5-document: Exported macros
with-html5-document-to-file: Exported macros
with-html5-document-to-string: Exported macros
with-html5-snippet: Exported macros
with-xhtml-document: Exported macros
with-xhtml-document-to-file: Exported macros
with-xhtml-frameset-document: Exported macros
with-xhtml-snippet: Exported macros
write-doc-to-file: Exported functions
write-document: Exported functions
write-document-to-character-stream: Internal functions
write-document-to-octet-stream: Internal functions
write-normalized-document-to-sink: Internal functions

X
xmls-to-dom-snippet: Internal functions

Jump to:   %   ?  
A   B   C   D   E   F   G   H   I   J   M   P   R   S   T   W   X  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
S  
Index Entry  Section

*
*cdata-script-blocks*: Exported special variables
*document*: Exported special variables
*html-compatibility-mode*: Exported special variables
*namespace-prefix-map*: Exported special variables
*snippet-output-stream*: Internal special variables
*tags-indentation-hints*: Internal special variables
*xhtml1-transitional-extid*: Internal special variables

+
+common-white-space-trimbag+: Internal special variables

S
Special Variable, *cdata-script-blocks*: Exported special variables
Special Variable, *document*: Exported special variables
Special Variable, *html-compatibility-mode*: Exported special variables
Special Variable, *namespace-prefix-map*: Exported special variables
Special Variable, *snippet-output-stream*: Internal special variables
Special Variable, *tags-indentation-hints*: Internal special variables
Special Variable, *xhtml1-transitional-extid*: Internal special variables
Special Variable, +common-white-space-trimbag+: Internal special variables

Jump to:   *   +  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   H   N   P   S  
Index Entry  Section

B
buildnode: The buildnode system

C
Class, html-whitespace-remover: Internal classes
Class, html5-capable-character-output-sink: Internal classes
Class, scoped-dom-builder: Exported classes

H
html-whitespace-remover: Internal classes
html5-capable-character-output-sink: Internal classes

N
net.acceleration.buildnode: The net<dot>acceleration<dot>buildnode package
net.acceleration.buildnode.system: The net<dot>acceleration<dot>buildnode<dot>system package

P
Package, net.acceleration.buildnode: The net<dot>acceleration<dot>buildnode package
Package, net.acceleration.buildnode.system: The net<dot>acceleration<dot>buildnode<dot>system package

S
scoped-dom-builder: Exported classes
System, buildnode: The buildnode system

Jump to:   B   C   H   N   P   S