The common-doc-plump Reference Manual

This is the common-doc-plump Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:07:08 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 common-doc-plump

Translate a Plump DOM into a CommonDoc document and back.

Maintainer

Fernando Borretti <>

Author

Fernando Borretti <>

Home Page

https://github.com/CommonDoc/common-doc-plump

Source Control

(GIT git@github.com:CommonDoc/common-doc-plump.git)

Bug Tracker

https://github.com/CommonDoc/common-doc-plump/issues

License

MIT

Long Description

# common-doc-plump

[![Build Status](https://travis-ci.org/CommonDoc/common-doc-plump.svg?branch=master)](https://travis-ci.org/CommonDoc/common-doc-plump)
[![Coverage Status](https://coveralls.io/repos/CommonDoc/common-doc-plump/badge.svg?branch=master)](https://coveralls.io/r/CommonDoc/common-doc-plump?branch=master)

Translate a Plump DOM into a CommonDoc document and back. This is used by
[VerTeX][vertex].

[vertex]: https://github.com/CommonDoc/vertex

# License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies
  • common-doc (system).
  • common-doc-split-paragraphs (system).
  • plump (system).
  • anaphora (system).
  • cl-markup (system).
Source

common-doc-plump.asd.

Child Component

src (module).


3 Modules

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


3.1 common-doc-plump/src

Source

common-doc-plump.asd.

Parent Component

common-doc-plump (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 common-doc-plump/common-doc-plump.asd

Source

common-doc-plump.asd.

Parent Component

common-doc-plump (system).

ASDF Systems

common-doc-plump.


4.1.2 common-doc-plump/src/parser.lisp

Source

common-doc-plump.asd.

Parent Component

src (module).

Packages

common-doc-plump.parser.

Public Interface
Internals

4.1.3 common-doc-plump/src/emitter.lisp

Dependency

parser.lisp (file).

Source

common-doc-plump.asd.

Parent Component

src (module).

Packages

common-doc-plump.emitter.

Public Interface

emit (function).

Internals

5 Packages

Packages are listed by definition order.


5.1 common-doc-plump.parser

Parse a Plump document into a CommonDoc document.

Source

parser.lisp.

Use List
  • anaphora.
  • common-lisp.
Public Interface
Internals

5.2 common-doc-plump.emitter

Emit a Plump DOM from a CommonDoc document.

Source

emitter.lisp.

Use List
  • anaphora.
  • common-doc.
  • common-lisp.
Public Interface

emit (function).

Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *serializer*
Package

common-doc-plump.parser.

Source

parser.lisp.


6.1.2 Ordinary functions

Function: emit (node)

Produce a Plump node from a CommonDoc document.

Package

common-doc-plump.emitter.

Source

emitter.lisp.

Function: find-tags-by-name (tag-name vector)

Find a Plump tag in a vector by tag name.

Package

common-doc-plump.parser.

Source

parser.lisp.

Function: parse-document (node)

Parse a Plump node into a document.

Package

common-doc-plump.parser.

Source

parser.lisp.

Function: tags-without-name (tag-name-or-list vector)

Return a list of Plump tags in a vector whose tag name is not equal to ‘tag-name-or-list‘, which can be a string or a list of strings.

Package

common-doc-plump.parser.

Source

parser.lisp.


6.1.3 Generic functions

Generic Function: parse (obj)

Parse a plump-tex node into a CommonDoc node.

Package

common-doc-plump.parser.

Source

parser.lisp.

Methods
Method: parse ((node element))

Parse a Plump element.

Method: parse ((root root))

Parse a Plump root element.

Method: parse ((list list))

Parse a list.

Method: parse ((vec vector))

Parse a vector of Plump nodes.

Method: parse ((node text-node))

Parse a Plump text node.


6.2 Internals


6.2.1 Special variables

Special Variable: *parsers*
Package

common-doc-plump.parser.

Source

parser.lisp.


6.2.2 Macros

Macro: define-attr-only-parser (name (attrs) &rest body)
Package

common-doc-plump.parser.

Source

parser.lisp.

Macro: define-attr-parser (name (attrs args) &rest body)
Package

common-doc-plump.parser.

Source

parser.lisp.

Macro: define-parser (name (args) &rest body)
Package

common-doc-plump.parser.

Source

parser.lisp.

Macro: define-trivial-emitters (&rest classes)
Package

common-doc-plump.emitter.

Source

emitter.lisp.

Macro: html (&rest body)

A wrapper around cl-markup’s ‘markup‘ macro which works better in recursive contexts.

Package

common-doc-plump.emitter.

Source

emitter.lisp.


6.2.3 Ordinary functions

Function: parse-verbatim (node)

Parse a node with verbatim text.

Package

common-doc-plump.parser.

Source

parser.lisp.

Function: trim-whitespace (string)

Trim whitespace from a string.

Package

common-doc-plump.parser.

Source

parser.lisp.


6.2.4 Generic functions

Generic Function: doc->xml (node)

Turn a CommonDoc node to XML.

Package

common-doc-plump.emitter.

Source

emitter.lisp.

Methods
Method: doc->xml ((cell cell))
Method: doc->xml ((row row))
Method: doc->xml ((table table))
Method: doc->xml ((figure figure))
Method: doc->xml ((image image))
Method: doc->xml ((list definition-list))
Method: doc->xml ((list ordered-list))
Method: doc->xml ((list unordered-list))
Method: doc->xml ((def definition))
Method: doc->xml ((item list-item))
Method: doc->xml ((link web-link))
Method: doc->xml ((ref document-link))
Method: doc->xml ((code code-block))
Method: doc->xml ((content content-node))
Method: doc->xml ((node block-quote))
Method: doc->xml ((node inline-quote))
Method: doc->xml ((node subscript))
Method: doc->xml ((node superscript))
Method: doc->xml ((node code))
Method: doc->xml ((node strikethrough))
Method: doc->xml ((node underline))
Method: doc->xml ((node italic))
Method: doc->xml ((node bold))
Method: doc->xml ((node paragraph))
Method: doc->xml ((list list))
Method: doc->xml ((node text-node))

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   D   E   F   G   H   M   P   T  
Index Entry  Section

D
define-attr-only-parser: Private macros
define-attr-parser: Private macros
define-parser: Private macros
define-trivial-emitters: Private macros
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions
doc->xml: Private generic functions

E
emit: Public ordinary functions

F
find-tags-by-name: Public ordinary functions
Function, emit: Public ordinary functions
Function, find-tags-by-name: Public ordinary functions
Function, parse-document: Public ordinary functions
Function, parse-verbatim: Private ordinary functions
Function, tags-without-name: Public ordinary functions
Function, trim-whitespace: Private ordinary functions

G
Generic Function, doc->xml: Private generic functions
Generic Function, parse: Public generic functions

H
html: Private macros

M
Macro, define-attr-only-parser: Private macros
Macro, define-attr-parser: Private macros
Macro, define-parser: Private macros
Macro, define-trivial-emitters: Private macros
Macro, html: Private macros
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, doc->xml: Private generic functions
Method, parse: Public generic functions
Method, parse: Public generic functions
Method, parse: Public generic functions
Method, parse: Public generic functions
Method, parse: Public generic functions

P
parse: Public generic functions
parse: Public generic functions
parse: Public generic functions
parse: Public generic functions
parse: Public generic functions
parse: Public generic functions
parse-document: Public ordinary functions
parse-verbatim: Private ordinary functions

T
tags-without-name: Public ordinary functions
trim-whitespace: Private ordinary functions