Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the texp Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 15:14:35 2020 GMT+0.
• Introduction | What texp is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
Description:
texp is a domain specific language for producing TeX documents with Common Lisp.
Documentation:
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The texp system |
Max Rottenkolber <max@mr.gy>
GNU Affero General Public License
DSL for outputting TeX expressions using S-expressions.
named-readtables
texp.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The texp.asd file | ||
• The texp/texp.lisp file | ||
• The texp/syntax.lisp file |
Next: The texp/texp․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
texp.asd
texp (system)
Next: The texp/syntax․lisp file, Previous: The texp․asd file, Up: Lisp files [Contents][Index]
texp (system)
texp.lisp
Previous: The texp/texp․lisp file, Up: Lisp files [Contents][Index]
texp.lisp (file)
texp (system)
syntax.lisp
parenthesized-list-reader (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The texp package |
DSL for outputting _TeX_ expressions using S-expressions.
texp.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported macros | ||
• Exported functions |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
*Description:*
_Alist_ mapping _TeX_ special characters to quoted equivalent.
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
_parameters_::= {(}{{}_var_{\}}\*{)}
*Arguments and Values:*
_name_—a _symbol_ or _string_.
_forms_—_forms_.
_var_—a _symbol_.
*Description:*
{deftex} prints the definition of a _TeX_ macro with _name_ that
expands to _forms_ to {*standard-output*}. If _name_ is a _symbol_ it
will be printed in lower case. _Forms_ are evaluated as if by {tex}
with each _var_ in _parameters_ bound to a numeric _TeX_ parameter
identifier.
*Examples:*
#code#
(deftex hello (name) "Hello " ($ name))
▷ \def \hello #1{Hello #1}
#
_expressions_::= ↓_expression_\*
_expression_::= ↓_break-clause_ | ↓_interpolation-clause_ |
↓_brackets-clause_ | ↓_braces-clause_ |
↓_tex-clause_ | _literal_
_break-clause_::= {(br)}
_interpolation-clause_::= {($} _form_{)}
_brackets-clause_::= {([]} {{}_expression_{\}}\*{)}
_braces-clause_::= {({\}} {{}_expression_{\}}\*{)}
_tex-clause_::= {(} _tex-macro_ {{}_expression_{\}}\*{)}
*Arguments and Values:*
_literal_—a _string_, _symbol_ or _number_.
_form_—a _form_.
_tex-macro_—a _symbol_ or a _string_.
*Description:*
{tex} compiles _TeX expressions_ to {*standard-output*}.
A _Literal_ is printed as follows:
+ a _string_ is printed as it is
+ a _symbol_ is printed in lower case
+ a _number_ is printed _readably_
A _tex-clause_ prints a _TeX_ macro call of _tex-macro_ followed by
_expressions_.
A _break-clause_ prints two newlines (e.g. a paragraph separator).
An _interpolation-clause_ evaluates _form_ and prints its result if
the result is a _string_.
_Bracket-clause_ and _braces-clause_ print _expressions_ surrounded by brackets ({[}, {]}) and braces ({{}, {\}}) respectively. If the _readtable_ {texp:syntax} is used then _bracket-clause_ and _braces-clause_ can be written as {[} _expression_\* {]} and {{} _expression_\* {}}.
Previous: Exported macros, Up: Exported definitions [Contents][Index]
*Arguments and Values:*
_string_—a _string_.
*Description:*
{escape} encodes _string_ as defined by {*escape-table*}. E.g. it quotes _TeX_ special characters.
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal functions |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Compile _TeX_ EXPRESSION.
Compile _TeX_ EXPRESSIONS.
Interpolate EXPRESSIONS into the TEX macro.
Compile call to macro with NAME and ARGUMENTS.
Returns a map of PARAMETERS to _TeX_ macro parameter pointers of the form ’#<N>’ and a parameter string for _TeX_’s \\def.
Compile EXPRESSIONS parenthesized by OPEN and CLOSE.
Compile EXPRESSIONS parenthesized by braces.
Compile EXPRESSIONS parenthesized by brackets.
Return escaped string for CHARACTER.
Predicate to test if CHARACTER needs to be escaped.
Make parameter string for N parameters.
Return read macro function for parenthesized list terminated by CLOSE. It will be consed with TYPE.
syntax.lisp (file)
Return identifier string for SYMBOL.
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L T |
---|
Jump to: | F L T |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | C D E F M P S T |
---|
Jump to: | C D E F M P S T |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
S |
---|
Index Entry | Section | ||
---|---|---|---|
| |||
* | |||
*escape-table* : | Exported special variables | ||
| |||
S | |||
Special Variable, *escape-table* : | Exported special variables | ||
|
Jump to: | *
S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | P S T |
---|
Index Entry | Section | ||
---|---|---|---|
| |||
P | |||
Package, texp : | The texp package | ||
| |||
S | |||
System, texp : | The texp system | ||
| |||
T | |||
texp : | The texp system | ||
texp : | The texp package | ||
|
Jump to: | P S T |
---|