The common-doc-plump Reference Manual

Table of Contents

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

The common-doc-plump Reference Manual

This is the common-doc-plump Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:45:45 2018 GMT+0.


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

1 Introduction

common-doc-plump

Build Status Coverage Status

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

License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.


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 common-doc-plump

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

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

Description

Translate a Plump DOM into a CommonDoc document and back.

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
Source

common-doc-plump.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 common-doc-plump/src

Parent

common-doc-plump (system)

Location

src/

Components

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 common-doc-plump.asd

Location

common-doc-plump.asd

Systems

common-doc-plump (system)


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

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

Parent

src (module)

Location

src/parser.lisp

Packages

common-doc-plump.parser

Exported Definitions
Internal Definitions

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

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

Dependency

parser.lisp (file)

Parent

src (module)

Location

src/emitter.lisp

Packages

common-doc-plump.emitter

Exported Definitions

emit (function)

Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 common-doc-plump.parser

Parse a Plump document into a CommonDoc document.

Source

parser.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5.2 common-doc-plump.emitter

Emit a Plump DOM from a CommonDoc document.

Source

emitter.lisp (file)

Use List
Exported Definitions

emit (function)

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: *serializer*
Package

common-doc-plump.parser

Source

parser.lisp (file)


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

6.1.2 Functions

Function: emit NODE

Produce a Plump node from a CommonDoc document.

Package

common-doc-plump.emitter

Source

emitter.lisp (file)

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 (file)

Function: parse-document NODE

Parse a Plump node into a document.

Package

common-doc-plump.parser

Source

parser.lisp (file)

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 (file)


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

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 (file)

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.


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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *parsers*
Package

common-doc-plump.parser

Source

parser.lisp (file)


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

6.2.2 Macros

Macro: define-attr-only-parser NAME (ATTRS) &rest BODY
Package

common-doc-plump.parser

Source

parser.lisp (file)

Macro: define-attr-parser NAME (ATTRS ARGS) &rest BODY
Package

common-doc-plump.parser

Source

parser.lisp (file)

Macro: define-parser NAME (ARGS) &rest BODY
Package

common-doc-plump.parser

Source

parser.lisp (file)

Macro: define-trivial-emitters &rest CLASSES
Package

common-doc-plump.emitter

Source

emitter.lisp (file)

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 (file)


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

6.2.3 Functions

Function: parse-verbatim NODE

Parse a node with verbatim text.

Package

common-doc-plump.parser

Source

parser.lisp (file)

Function: trim-whitespace STRING

Trim whitespace from a string.

Package

common-doc-plump.parser

Source

parser.lisp (file)


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

6.2.4 Generic functions

Generic Function: doc->xml NODE

Turn a CommonDoc node to XML.

Package

common-doc-plump.emitter

Source

emitter.lisp (file)

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)

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
common-doc-plump.asd: The common-doc-plump<dot>asd file
common-doc-plump/src: The common-doc-plump/src module
common-doc-plump/src/emitter.lisp: The common-doc-plump/src/emitter<dot>lisp file
common-doc-plump/src/parser.lisp: The common-doc-plump/src/parser<dot>lisp file

F
File, Lisp, common-doc-plump.asd: The common-doc-plump<dot>asd file
File, Lisp, common-doc-plump/src/emitter.lisp: The common-doc-plump/src/emitter<dot>lisp file
File, Lisp, common-doc-plump/src/parser.lisp: The common-doc-plump/src/parser<dot>lisp file

L
Lisp File, common-doc-plump.asd: The common-doc-plump<dot>asd file
Lisp File, common-doc-plump/src/emitter.lisp: The common-doc-plump/src/emitter<dot>lisp file
Lisp File, common-doc-plump/src/parser.lisp: The common-doc-plump/src/parser<dot>lisp file

M
Module, common-doc-plump/src: The common-doc-plump/src module

Jump to:   C   F   L   M  

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

A.2 Functions

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

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

E
emit: Exported functions

F
find-tags-by-name: Exported functions
Function, emit: Exported functions
Function, find-tags-by-name: Exported functions
Function, parse-document: Exported functions
Function, parse-verbatim: Internal functions
Function, tags-without-name: Exported functions
Function, trim-whitespace: Internal functions

G
Generic Function, doc->xml: Internal generic functions
Generic Function, parse: Exported generic functions

H
html: Internal macros

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

P
parse: Exported generic functions
parse: Exported generic functions
parse: Exported generic functions
parse: Exported generic functions
parse: Exported generic functions
parse: Exported generic functions
parse-document: Exported functions
parse-verbatim: Internal functions

T
tags-without-name: Exported functions
trim-whitespace: Internal functions

Jump to:   D   E   F   G   H   M   P   T  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*parsers*: Internal special variables
*serializer*: Exported special variables

S
Special Variable, *parsers*: Internal special variables
Special Variable, *serializer*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
common-doc-plump: The common-doc-plump system
common-doc-plump.emitter: The common-doc-plump<dot>emitter package
common-doc-plump.parser: The common-doc-plump<dot>parser package

P
Package, common-doc-plump.emitter: The common-doc-plump<dot>emitter package
Package, common-doc-plump.parser: The common-doc-plump<dot>parser package

S
System, common-doc-plump: The common-doc-plump system

Jump to:   C   P   S