The plump-tex Reference Manual

Table of Contents

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

The plump-tex Reference Manual

This is the plump-tex Reference Manual, version 0.1.0, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:11:12 2018 GMT+0.


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

1 Introduction

plump-tex

Rudimentary parser turning TeX-like syntax into a Plump DOM. This really does nothing more at the moment than dumbly translating TeX tags to DOM nodes, which can then be serialised into XHTML.

(plump:serialize (plump-tex:parse "Oh hey, \\how{are you} \\holding[up=there]{with all that} {exciting stuff} going on"))

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 plump-tex

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://github.com/Shinmera/plump-tex

License

Artistic

Description

Rudimentary parser turning TeX-like syntax into a Plump DOM.

Version

0.1.0

Dependencies
Source

plump-tex.asd (file)

Component

plump-tex.lisp (file)


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

3 Files

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


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

3.1 Lisp


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

3.1.1 plump-tex.asd

Location

plump-tex.asd

Systems

plump-tex (system)


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

3.1.2 plump-tex/plump-tex.lisp

Parent

plump-tex (system)

Location

plump-tex.lisp

Packages

plump-tex

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 plump-tex

Source

plump-tex.lisp (file)

Nickname

org.tymoonnext.plump.tex

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


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

5.1.1 Generic functions

Generic Function: parse INPUT &key ROOT
Package

plump-tex

Source

plump-tex.lisp (file)

Methods
Method: parse (INPUT string) &key ROOT
Method: parse (INPUT pathname) &key ROOT
Method: parse (INPUT stream) &key ROOT
Generic Function: serialize NODE &optional STREAM

Serialize the given node in TeX syntax and print it to the stream.

Package

plump-tex

Source

plump-tex.lisp (file)

Methods
Method: serialize (NODE text-node) &optional STREAM
Method: serialize (NODE element) &optional STREAM
Method: serialize (TABLE hash-table) &optional STREAM
Method: serialize (NODE nesting-node) &optional STREAM
Method: serialize (NODES vector) &optional STREAM

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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *tex-tag-dispatchers*
Package

plump-tex

Source

plump-tex.lisp (file)

Special Variable: *whitespace*
Package

plump-tex

Source

plump-tex.lisp (file)


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

5.2.2 Functions

Function: read-tex-attribute ()
Package

plump-tex

Source

plump-tex.lisp (file)

Function: read-tex-attribute-name ()
Package

plump-tex

Source

plump-tex.lisp (file)

Function: read-tex-attribute-value ()
Package

plump-tex

Source

plump-tex.lisp (file)

Function: read-tex-attributes ()
Package

plump-tex

Source

plump-tex.lisp (file)

Function: read-tex-block ()
Package

plump-tex

Source

plump-tex.lisp (file)

Function: read-tex-children ()
Package

plump-tex

Source

plump-tex.lisp (file)

Function: read-tex-name ()
Package

plump-tex

Source

plump-tex.lisp (file)

Function: read-tex-root &optional ROOT
Package

plump-tex

Source

plump-tex.lisp (file)

Function: read-tex-standard-tag NAME
Package

plump-tex

Source

plump-tex.lisp (file)

Function: read-tex-tag ()
Package

plump-tex

Source

plump-tex.lisp (file)

Function: read-tex-text ()
Package

plump-tex

Source

plump-tex.lisp (file)

Function: replace-escaped STRING
Package

plump-tex

Source

plump-tex.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   P  
Index Entry  Section

F
File, Lisp, plump-tex.asd: The plump-tex<dot>asd file
File, Lisp, plump-tex/plump-tex.lisp: The plump-tex/plump-tex<dot>lisp file

L
Lisp File, plump-tex.asd: The plump-tex<dot>asd file
Lisp File, plump-tex/plump-tex.lisp: The plump-tex/plump-tex<dot>lisp file

P
plump-tex.asd: The plump-tex<dot>asd file
plump-tex/plump-tex.lisp: The plump-tex/plump-tex<dot>lisp file

Jump to:   F   L   P  

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

A.2 Functions

Jump to:   F   G   M   P   R   S  
Index Entry  Section

F
Function, read-tex-attribute: Internal functions
Function, read-tex-attribute-name: Internal functions
Function, read-tex-attribute-value: Internal functions
Function, read-tex-attributes: Internal functions
Function, read-tex-block: Internal functions
Function, read-tex-children: Internal functions
Function, read-tex-name: Internal functions
Function, read-tex-root: Internal functions
Function, read-tex-standard-tag: Internal functions
Function, read-tex-tag: Internal functions
Function, read-tex-text: Internal functions
Function, replace-escaped: Internal functions

G
Generic Function, parse: Exported generic functions
Generic Function, serialize: Exported generic functions

M
Method, parse: Exported generic functions
Method, parse: Exported generic functions
Method, parse: Exported generic functions
Method, serialize: Exported generic functions
Method, serialize: Exported generic functions
Method, serialize: Exported generic functions
Method, serialize: Exported generic functions
Method, serialize: Exported generic functions

P
parse: Exported generic functions
parse: Exported generic functions
parse: Exported generic functions
parse: Exported generic functions

R
read-tex-attribute: Internal functions
read-tex-attribute-name: Internal functions
read-tex-attribute-value: Internal functions
read-tex-attributes: Internal functions
read-tex-block: Internal functions
read-tex-children: Internal functions
read-tex-name: Internal functions
read-tex-root: Internal functions
read-tex-standard-tag: Internal functions
read-tex-tag: Internal functions
read-tex-text: Internal functions
replace-escaped: Internal functions

S
serialize: Exported generic functions
serialize: Exported generic functions
serialize: Exported generic functions
serialize: Exported generic functions
serialize: Exported generic functions
serialize: Exported generic functions

Jump to:   F   G   M   P   R   S  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*tex-tag-dispatchers*: Internal special variables
*whitespace*: Internal special variables

S
Special Variable, *tex-tag-dispatchers*: Internal special variables
Special Variable, *whitespace*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, plump-tex: The plump-tex package
plump-tex: The plump-tex system
plump-tex: The plump-tex package

S
System, plump-tex: The plump-tex system

Jump to:   P   S