The plump-tex Reference Manual

Table of Contents

The plump-tex Reference Manual

This is the plump-tex Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Thu Mar 11 14:30:30 2021 GMT+0.

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"))

2 Systems

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

2.1 plump-tex

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

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

Source Control

(:git "https://github.com/shinmera/plump-tex.git")

Bug Tracker

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

License

zlib

Description

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

Version

0.1.0

Dependencies

• plump
• cl-ppcre

Source

plump-tex.asd (file)

Component

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

Location

plump-tex.asd

Systems

plump-tex (system)

3.1.2 plump-tex/plump-tex.lisp

Parent

plump-tex (system)

Location

plump-tex.lisp

Packages

plump-tex

Exported Definitions

• parse (generic function)
• parse (method)
• parse (method)
• parse (method)
• serialize (generic function)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)

Internal Definitions

• *tex-tag-dispatchers* (special variable)
• *whitespace* (special variable)
• read-tex-attribute (function)
• read-tex-attribute-name (function)
• read-tex-attribute-value (function)
• read-tex-attributes (function)
• read-tex-block (function)
• read-tex-children (function)
• read-tex-name (function)
• read-tex-root (function)
• read-tex-standard-tag (function)
• read-tex-tag (function)
• read-tex-text (function)
• replace-escaped (function)

4 Packages

Packages are listed by definition order.

4.1 plump-tex

Source

plump-tex.lisp (file)

Nickname

org.tymoonnext.plump.tex

Use List

• plump
• common-lisp

Exported Definitions

• parse (generic function)
• parse (method)
• parse (method)
• parse (method)
• serialize (generic function)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)
• serialize (method)

Internal Definitions

• *tex-tag-dispatchers* (special variable)
• *whitespace* (special variable)
• read-tex-attribute (function)
• read-tex-attribute-name (function)
• read-tex-attribute-value (function)
• read-tex-attributes (function)
• read-tex-block (function)
• read-tex-children (function)
• read-tex-name (function)
• read-tex-root (function)
• read-tex-standard-tag (function)
• read-tex-tag (function)
• read-tex-text (function)
• replace-escaped (function)

5 Definitions

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

5.1 Exported definitions

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

5.2 Internal definitions

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)

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)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types