Next: Introduction, Previous: (dir), 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 Mon Feb 26 17:35:11 2024 GMT+0.

Next: Systems, Previous: The plump-tex Reference Manual, Up: The plump-tex Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The plump-tex Reference Manual [Contents][Index]

2 Systems

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

plump-tex

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

2.1 `plump-tex`

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

Maintainer

Yukari Hafner <shinmera@tymoon.eu>

Author

Yukari 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).

Next: Packages, Previous: Systems, Up: The plump-tex Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: plump-tex/plump-tex.lisp, Previous: Lisp, 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.

Previous: plump-tex/plump-tex.asd, Up: Lisp [Contents][Index]

3.1.2 `plump-tex/plump-tex.lisp`

Source

plump-tex.asd.

Parent Component

plump-tex (system).

Packages

plump-tex.

Public Interface

parse (generic function).
serialize (generic function).

Internals

*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).

Next: Definitions, Previous: Files, Up: The plump-tex Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

plump-tex

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

4.1 `plump-tex`

Source

plump-tex.lisp.

Nickname

org.tymoonnext.plump.tex

Use List

common-lisp.
plump.

Public Interface

parse (generic function).
serialize (generic function).

Internals

*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).

Next: Indexes, Previous: Packages, Up: The plump-tex Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Generic functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

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

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

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, 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: Special variables, 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.

Previous: Definitions, Up: The plump-tex Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

Next: Variables, Previous: Concepts, 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

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`tex-tag-dispatchers`:	Private special variables
	`whitespace`:	Private special variables

S
	`Special Variable, tex-tag-dispatchers`:	Private special variables
	`Special Variable, whitespace`:	Private special variables

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

A.4 Data types

Jump to:	F P S

	Index Entry	Section

F
	`File, plump-tex.asd`:	The plump-tex/plump-tex․asd file
	`File, plump-tex.lisp`:	The plump-tex/plump-tex․lisp file

P
	`Package, plump-tex`:	The plump-tex package
	`plump-tex`:	The plump-tex system
	`plump-tex`:	The plump-tex package
	`plump-tex.asd`:	The plump-tex/plump-tex․asd file
	`plump-tex.lisp`:	The plump-tex/plump-tex․lisp file

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

The plump-tex Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 plump-tex

3 Files

3.1 Lisp

3.1.1 plump-tex/plump-tex.asd

3.1.2 plump-tex/plump-tex.lisp

4 Packages

4.1 plump-tex

5 Definitions

5.1 Public Interface

5.1.1 Generic functions

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `plump-tex`

3.1.1 `plump-tex/plump-tex.asd`

3.1.2 `plump-tex/plump-tex.lisp`

4.1 `plump-tex`