The plump-tex Reference Manual

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 4.0 beta 2 "William Riker" on Thu Sep 15 05:52:57 2022 GMT+0.

Table of Contents


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.


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

2.1 plump-tex

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

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

Version

0.1.0

Dependencies
  • plump (system).
  • cl-ppcre (system).
Source

plump-tex.asd.

Child Component

plump-tex.lisp (file).


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   [Contents][Index]

3.1.1 plump-tex/plump-tex.asd

Source

plump-tex.asd.

Parent Component

plump-tex (system).

ASDF Systems

plump-tex.


3.1.2 plump-tex/plump-tex.lisp

Source

plump-tex.asd.

Parent Component

plump-tex (system).

Packages

plump-tex.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 plump-tex

Source

plump-tex.lisp.

Nickname

org.tymoonnext.plump.tex

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

5 Definitions

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


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

5.1 Public Interface


5.1.1 Generic functions

Generic Function: parse (input &key root)
Package

plump-tex.

Source

plump-tex.lisp.

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.

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 Internals


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

5.2.1 Special variables

Special Variable: *tex-tag-dispatchers*
Package

plump-tex.

Source

plump-tex.lisp.

Special Variable: *whitespace*
Package

plump-tex.

Source

plump-tex.lisp.


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

5.2.2 Ordinary functions

Function: read-tex-attribute ()
Package

plump-tex.

Source

plump-tex.lisp.

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

plump-tex.

Source

plump-tex.lisp.

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

plump-tex.

Source

plump-tex.lisp.

Function: read-tex-attributes ()
Package

plump-tex.

Source

plump-tex.lisp.

Function: read-tex-block ()
Package

plump-tex.

Source

plump-tex.lisp.

Function: read-tex-children ()
Package

plump-tex.

Source

plump-tex.lisp.

Function: read-tex-name ()
Package

plump-tex.

Source

plump-tex.lisp.

Function: read-tex-root (&optional root)
Package

plump-tex.

Source

plump-tex.lisp.

Function: read-tex-standard-tag (name)
Package

plump-tex.

Source

plump-tex.lisp.

Function: read-tex-tag ()
Package

plump-tex.

Source

plump-tex.lisp.

Function: read-tex-text ()
Package

plump-tex.

Source

plump-tex.lisp.

Function: replace-escaped (string)
Package

plump-tex.

Source

plump-tex.lisp.


Appendix A Indexes


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

A.1 Concepts


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: Private ordinary functions
Function, read-tex-attribute-name: Private ordinary functions
Function, read-tex-attribute-value: Private ordinary functions
Function, read-tex-attributes: Private ordinary functions
Function, read-tex-block: Private ordinary functions
Function, read-tex-children: Private ordinary functions
Function, read-tex-name: Private ordinary functions
Function, read-tex-root: Private ordinary functions
Function, read-tex-standard-tag: Private ordinary functions
Function, read-tex-tag: Private ordinary functions
Function, read-tex-text: Private ordinary functions
Function, replace-escaped: Private ordinary functions

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

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

P
parse: Public generic functions
parse: Public generic functions
parse: Public generic functions
parse: Public generic functions

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

S
serialize: Public generic functions
serialize: Public generic functions
serialize: Public generic functions
serialize: Public generic functions
serialize: Public generic functions
serialize: Public generic functions

Jump to:   F   G   M   P   R   S