The xml-emitter Reference Manual

Table of Contents

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.

1 Introduction

xml-emitter

The official repository, taken over from Peter Scott.

Version

• xml-emitter-1.1.0 (January 2020)
  • Fix WITH-RSS2 Macro, add Travis CI and tests
• xml-emitter-1.0.5 (November 2019)
  • Provide new Macros WITH-RSS-CHANNEL-HEADER and WITH-RSS-ITEM
• xml-emitter-1.0.4 (September 2016)
  • Provide new function EMPTY-TAG
• xml-emitter-1.0.3 (September 2015)
  • Unicode Support

License

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

2 Systems

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

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

• license (file)
• package.lisp (file)
• xml.lisp (file)
• rss2.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 xml-emitter.asd

Location

xml-emitter.asd

Systems

xml-emitter (system)

Packages

xml-emitter-system

3.1.2 xml-emitter/package.lisp

Dependency

license (file)

Parent

xml-emitter (system)

Location

package.lisp

Packages

xml-emitter

3.1.3 xml-emitter/xml.lisp

Dependency

package.lisp (file)

Parent

xml-emitter (system)

Location

xml.lisp

Exported Definitions

• emit-simple-tags (function)
• empty-tag (function)
• simple-tag (function)
• with-simple-tag (macro)
• with-tag (macro)
• with-xml-output (macro)
• xml-as-is (function)
• xml-out (function)

Internal Definitions

• *char-escapes* (special variable)
• *entities* (special variable)
• *indent* (special variable)
• *whitespace* (special variable)
• *xml-output-stream* (special variable)
• end-tag (function)
• indent (function)
• start-tag (function)
• with-indent (macro)
• write-escaped (function)

3.1.4 xml-emitter/rss2.lisp

Dependency

xml.lisp (file)

Parent

xml-emitter (system)

Location

rss2.lisp

Exported Definitions

• rss-channel-header (function)
• rss-item (function)
• with-rss-channel-header (macro)
• with-rss-item (macro)
• with-rss2 (macro)

3.2 Static

3.2.1 xml-emitter/LICENSE

Parent

xml-emitter (system)

Location

LICENSE

4 Packages

Packages are listed by definition order.

4.1 xml-emitter-system

Source

xml-emitter.asd

Use List

• asdf/interface
• common-lisp

4.2 xml-emitter

Source

package.lisp (file)

Use List

• cl-utilities
• common-lisp

Exported Definitions

• emit-simple-tags (function)
• empty-tag (function)
• rss-channel-header (function)
• rss-item (function)
• simple-tag (function)
• with-rss-channel-header (macro)
• with-rss-item (macro)
• with-rss2 (macro)
• with-simple-tag (macro)
• with-tag (macro)
• with-xml-output (macro)
• xml-as-is (function)
• xml-out (function)

Internal Definitions

• *char-escapes* (special variable)
• *entities* (special variable)
• *indent* (special variable)
• *whitespace* (special variable)
• *xml-output-stream* (special variable)
• end-tag (function)
• indent (function)
• start-tag (function)
• with-indent (macro)
• write-escaped (function)

5 Definitions

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

5.1 Exported definitions

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)

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)

5.2 Internal definitions

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)

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)

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)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types