This is the vertex Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 08:02:59 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
vertexA markup language with TeX syntax.
Fernando Borretti <eudoxiahp@gmail.com>
Fernando Borretti <eudoxiahp@gmail.com>
(GIT git@github.com:CommonDoc/vertex.git)
MIT
# VerTeX
[](https://travis-ci.org/CommonDoc/vertex)
A markup language with TeX syntax.
# Syntax
## Basic
VerTeX syntax, as the name implies, is basically TeX syntax. Blocks look like
this:
* ‘\some-tag‘
* ‘\b{bold text}‘
* ‘\link[uri=’https://www.google.com/’]{Google}‘
The syntax, as a sort of regular expression, is like this:
“‘
\<tag name>([(<attribute>=<value>)*])?({<body>})?
“‘
## Markup
### Paragraphs
Paragraphs are delimited by double newlines.
“‘tex
A paragraph.
Another paragraph with \b{bold text}.
A third paragraph.
“‘
### ‘b‘
Bold text.
“‘tex
This is \b{bold text}.
“‘
### ‘i‘
Italicized text.
“‘tex
This text is in \i{italics}.
“‘
### ‘u‘
Underlined text.
“‘tex
This text is \u{underlined}.
“‘
### ‘strike‘
Struck-through text.
“‘tex
This text is \strike{struck through}.
“‘
### ‘sup‘ and ‘sub‘
Superscript and subscript.
“‘tex
The value of the vacuum permittivity, ε\sub{0}, is 8.8x10\sup{-12}.
“‘
## Code
### ‘c‘
Inline code.
“‘tex
The function \c{find} takes as arguments...
“‘
### ‘code‘
A block of code.
“‘tex
\code[lang=’lisp’]{
(let ((x 1))
(incf x))
}
“‘
## Quotes
### ‘q‘
An inline quote.
“‘tex
“‘
### ‘quote‘
A block quote.
“‘tex
“‘
## Links and References
### ‘ref‘
A reference to a section of the document, or to another document.
“‘tex
See section \ref[sec=search]{Search}.
For a more thorough discussion, see \ref[doc=aima, sec=search]{the AIMA chapter}
on search algorithms.
“‘
### ‘link‘
A link to a URI.
“‘tex
Visit \link[uri=’https://www.google.com/’]{Google}.
“‘
## Lists
### ‘list‘
An unordered list.
“‘tex
Ingredients:
\list{
\item{One egg}
\item{One tablespoon of olive oil}
\item{Grated cheese}
}
“‘
Produces:
* One egg
* One tablespoon of olive oil
* Grated cheese
### ‘enum‘
An ordered list.
“‘tex
Recipe for eudoxia’s patent-pending microwave eggs:
\enum{
\item{Pour the olive oil into the bowl}
\item{Crack the egg into it}
\item{Put the cheese on top}
\item{Microwave for 45 seconds}
}
“‘
Produces:
1. Pour the olive oil into the bowl
2. Crack the egg into it
3. Put the cheese on top
4. Microwave for 45 seconds
### ‘deflist‘
A definition list.
“‘tex
\deflist{
\term{Sum Rule}
\def{If two tasks can be performed in m and n ways, respectively, then
there are m+n ways of doing \b{either}.}
\term{Product Rule}
\def{If two sequential tasks can be performed in m and n ways,
respectively, there are m*n ways of performing the sequence.}
}
“‘
## Images and Figures
## Tables
### ‘table‘, ‘row‘, ‘cell‘
Exactly what you would expect.
“‘tex
\table{
\row{
\cell{} \cell{\b{Peach}} \cell{\b{Egg}}
}
\row{
\cell{\i{Fat}} \cell{0.25g} \cell{10.6g}
}
\row{
\cell{\i{Protein}} \cell{0.91g} \cell{12.6g}
}
}
“‘
Produces:
| | **Peach** | **Egg** |
| ———– | ——— | ——- |
| *Fat* | 0.25g | 10.6g |
| *Protein* | 0.91g | 12.6g |
## Structure
### ‘section‘
Defines a section.
“‘tex
\section[title=The Reader]{
... For other stuff see the chapter on \ref[sec=compiler]{Compilation}.
}
\section[title=The Compiler, ref=compiler]{
... A compiler is basically ...
}
“‘
# License
Copyright (c) 2014-2015 Fernando Borretti
Licensed under the MIT License.
0.1
common-doc (system).
common-doc-plump (system).
plump-tex (system).
src (module).
Modules are listed depth-first from the system components tree.
vertex/srcvertex (system).
parser.lisp (file).
emitter.lisp (file).
vertex.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
vertex/src/parser.lispsrc (module).
parse-file (function).
parse-string (function).
input->common-doc (function).
vertex/src/emitter.lispparser.lisp (file).
src (module).
emit-to-stream (function).
vertex/src/vertex.lispemitter.lisp (file).
src (module).
emit-document (method).
emit-document (method).
parse-document (method).
parse-document (method).
vertex (class).
Packages are listed by definition order.
vertexThe main interface.
common-doc.format.
common-lisp.
vertex (class).
vertex.parserParse a TeX file into a CommonDoc document.
common-lisp.
parse-file (function).
parse-string (function).
input->common-doc (function).
vertex.emitterCreate a VerTeX representation of a CommonDoc document.
common-lisp.
emit-to-stream (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Parse a VerTeX file.
Parse a VerTeX string.
vertex) (node document-node) stream) ¶common-doc.format.
vertex) (pathname pathname)) ¶Return a VerTeX document parsed from a file.
common-doc.format.
vertex) (string string)) ¶Return a VerTeX document parsed from a string.
common-doc.format.
The VerTeX format.
document-format.
| Jump to: | E F I M P |
|---|
| Jump to: | E F I M P |
|---|
| Jump to: | C E F M P S V |
|---|
| Jump to: | C E F M P S V |
|---|