The xml-emitter Reference Manual

Table of Contents

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

The xml-emitter Reference Manual

This is the xml-emitter Reference Manual, version 1.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 12:38:27 2020 GMT+0.


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

1 Introduction

xml-emitter

The official repository, taken over from Peter Scott.

Version

License

This code is in the public domain. You can do whatever you like with it.


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 xml-emitter

Author

Peter Scott / Vito Van / Philipp Marek / Kieran Grant / Matteo Landi

License

Public Domain / 0-clause MIT

Description

xml-emitter simply emits XML, with some
complexity for handling indentation. It can be used to produce all sorts of useful XML output; it has an RSS 2.0 emitter built in.

Version

1.1.0

Dependency

cl-utilities

Source

xml-emitter.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 xml-emitter.asd

Location

xml-emitter.asd

Systems

xml-emitter (system)

Packages

xml-emitter-system


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

3.1.2 xml-emitter/package.lisp

Dependency

license (file)

Parent

xml-emitter (system)

Location

package.lisp

Packages

xml-emitter


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

3.1.3 xml-emitter/xml.lisp

Dependency

package.lisp (file)

Parent

xml-emitter (system)

Location

xml.lisp

Exported Definitions
Internal Definitions

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

3.1.4 xml-emitter/rss2.lisp

Dependency

xml.lisp (file)

Parent

xml-emitter (system)

Location

rss2.lisp

Exported Definitions

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

3.2 Static


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

3.2.1 xml-emitter/LICENSE

Parent

xml-emitter (system)

Location

LICENSE


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

4 Packages

Packages are listed by definition order.


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

4.1 xml-emitter-system

Source

xml-emitter.asd

Use List

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

4.2 xml-emitter

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Macros

Macro: with-rss-channel-header (TITLE LINK &key DESCRIPTION GENERATOR LANGUAGE IMAGE IMAGE-TITLE IMAGE-LINK) &body BODY
Package

xml-emitter

Source

rss2.lisp (file)

Macro: with-rss-item (TITLE &key LINK DESCRIPTION AUTHOR CATEGORY COMMENTS GUID PUBDATE SOURCE) &body BODY
Package

xml-emitter

Source

rss2.lisp (file)

Macro: with-rss2 (STREAM &key ENCODING ATTRS) &body BODY
Package

xml-emitter

Source

rss2.lisp (file)

Macro: with-simple-tag (NAME &optional ATTRS NAMESPACE) &body BODY

Like WITH-TAG, but without the linebreaks.

Package

xml-emitter

Source

xml.lisp (file)

Macro: with-tag (NAME &optional ATTRS NAMESPACE) &body BODY

Wrap BODY in a tag. BODY is indented, and linebreaks are added.

Package

xml-emitter

Source

xml.lisp (file)

Macro: with-xml-output (STREAM &key ENCODING STANDALONE) &body BODY

Wrap XML output on STREAM with the necessary XML heading information

Package

xml-emitter

Source

xml.lisp (file)


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

5.1.2 Functions

Function: emit-simple-tags &rest TAGS-PLIST

Given a plist mapping tag names to values (or nil), emit tags in the order given, skipping ones with nil values. Tag names are downcased unless they’re passed as strings.

Package

xml-emitter

Source

xml.lisp (file)

Function: empty-tag NAME &optional ATTRS NAMESPACE
Package

xml-emitter

Source

xml.lisp (file)

Function: rss-channel-header TITLE LINK &key DESCRIPTION GENERATOR LANGUAGE IMAGE IMAGE-TITLE IMAGE-LINK
Package

xml-emitter

Source

rss2.lisp (file)

Function: rss-item TITLE &key LINK DESCRIPTION AUTHOR CATEGORY COMMENTS GUID PUBDATE SOURCE
Package

xml-emitter

Source

rss2.lisp (file)

Function: simple-tag NAME CONTENT &optional ATTRS NAMESPACE

Emit a simple tag with given content

Package

xml-emitter

Source

xml.lisp (file)

Function: xml-as-is X &key INDENT

Write X to XML output, unescaped and optionally indented

Package

xml-emitter

Source

xml.lisp (file)

Function: xml-out X &key INDENT

Write X to XML output, escaped and optionally indented

Package

xml-emitter

Source

xml.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *char-escapes*
Package

xml-emitter

Source

xml.lisp (file)

Special Variable: *entities*
Package

xml-emitter

Source

xml.lisp (file)

Special Variable: *indent*

Number of spaces to indent each line of XML output

Package

xml-emitter

Source

xml.lisp (file)

Special Variable: *whitespace*
Package

xml-emitter

Source

xml.lisp (file)

Special Variable: *xml-output-stream*

The stream to write XML to

Package

xml-emitter

Source

xml.lisp (file)


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

5.2.2 Macros

Macro: with-indent (&optional SPACES) &body BODY

Increase the indentation level in BODY by SPACES

Package

xml-emitter

Source

xml.lisp (file)


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

5.2.3 Functions

Function: end-tag NAME

Write en ending tag to XML output

Package

xml-emitter

Source

xml.lisp (file)

Function: indent &optional SPACES

Indent a given number of spaces

Package

xml-emitter

Source

xml.lisp (file)

Function: start-tag NAME &optional ATTRS NAMESPACE END-IT

Write a start tag to XML output

Package

xml-emitter

Source

xml.lisp (file)

Function: write-escaped STRING STREAM

Writes string to stream with all character entities escaped.

Package

xml-emitter

Source

xml.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   S   X  
Index Entry  Section

F
File, Lisp, xml-emitter.asd: The xml-emitter․asd file
File, Lisp, xml-emitter/package.lisp: The xml-emitter/package․lisp file
File, Lisp, xml-emitter/rss2.lisp: The xml-emitter/rss2․lisp file
File, Lisp, xml-emitter/xml.lisp: The xml-emitter/xml․lisp file
File, static, xml-emitter/LICENSE: The xml-emitter/license file

L
Lisp File, xml-emitter.asd: The xml-emitter․asd file
Lisp File, xml-emitter/package.lisp: The xml-emitter/package․lisp file
Lisp File, xml-emitter/rss2.lisp: The xml-emitter/rss2․lisp file
Lisp File, xml-emitter/xml.lisp: The xml-emitter/xml․lisp file

S
Static File, xml-emitter/LICENSE: The xml-emitter/license file

X
xml-emitter.asd: The xml-emitter․asd file
xml-emitter/LICENSE: The xml-emitter/license file
xml-emitter/package.lisp: The xml-emitter/package․lisp file
xml-emitter/rss2.lisp: The xml-emitter/rss2․lisp file
xml-emitter/xml.lisp: The xml-emitter/xml․lisp file

Jump to:   F   L   S   X  

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

A.2 Functions

Jump to:   E   F   I   M   R   S   W   X  
Index Entry  Section

E
emit-simple-tags: Exported functions
empty-tag: Exported functions
end-tag: Internal functions

F
Function, emit-simple-tags: Exported functions
Function, empty-tag: Exported functions
Function, end-tag: Internal functions
Function, indent: Internal functions
Function, rss-channel-header: Exported functions
Function, rss-item: Exported functions
Function, simple-tag: Exported functions
Function, start-tag: Internal functions
Function, write-escaped: Internal functions
Function, xml-as-is: Exported functions
Function, xml-out: Exported functions

I
indent: Internal functions

M
Macro, with-indent: Internal macros
Macro, with-rss-channel-header: Exported macros
Macro, with-rss-item: Exported macros
Macro, with-rss2: Exported macros
Macro, with-simple-tag: Exported macros
Macro, with-tag: Exported macros
Macro, with-xml-output: Exported macros

R
rss-channel-header: Exported functions
rss-item: Exported functions

S
simple-tag: Exported functions
start-tag: Internal functions

W
with-indent: Internal macros
with-rss-channel-header: Exported macros
with-rss-item: Exported macros
with-rss2: Exported macros
with-simple-tag: Exported macros
with-tag: Exported macros
with-xml-output: Exported macros
write-escaped: Internal functions

X
xml-as-is: Exported functions
xml-out: Exported functions

Jump to:   E   F   I   M   R   S   W   X  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*char-escapes*: Internal special variables
*entities*: Internal special variables
*indent*: Internal special variables
*whitespace*: Internal special variables
*xml-output-stream*: Internal special variables

S
Special Variable, *char-escapes*: Internal special variables
Special Variable, *entities*: Internal special variables
Special Variable, *indent*: Internal special variables
Special Variable, *whitespace*: Internal special variables
Special Variable, *xml-output-stream*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   S   X  
Index Entry  Section

P
Package, xml-emitter: The xml-emitter package
Package, xml-emitter-system: The xml-emitter-system package

S
System, xml-emitter: The xml-emitter system

X
xml-emitter: The xml-emitter system
xml-emitter: The xml-emitter package
xml-emitter-system: The xml-emitter-system package

Jump to:   P   S   X