The vertex Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The vertex Reference Manual

This is the vertex Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:29:59 2018 GMT+0.


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

1 Introduction

VerTeX

Build Status

A markup language with TeX syntax.

Syntax

Basic

VerTeX syntax, as the name implies, is basically TeX syntax. Blocks look like this:

The syntax, as a sort of regular expression, is like this:

\<tag name>([(<attribute>=<value>)*])?({<body>})?

Markup

Paragraphs

Paragraphs are delimited by double newlines.

A paragraph.

Another paragraph with \b{bold text}.

A third paragraph.

b

Bold text.

This is \b{bold text}.

i

Italicized text.

This text is in \i{italics}.

u

Underlined text.

This text is \u{underlined}.

strike

Struck-through text.

This text is \strike{struck through}.

sup and sub

Superscript and subscript.

The value of the vacuum permittivity, ε\sub{0}, is 8.8x10\sup{-12}.

Code

c

Inline code.

The function \c{find} takes as arguments...

code

A block of code.

\code[lang='lisp']{
  (let ((x 1))
    (incf x))
}

Quotes

q

An inline quote.


quote

A block quote.


Links and References

ref

A reference to a section of the document, or to another document.

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.

Visit \link[uri='https://www.google.com/']{Google}.

Lists

list

An unordered list.

Ingredients:

\list{
  \item{One egg}
  \item{One tablespoon of olive oil}
  \item{Grated cheese}
}

Produces:

enum

An ordered list.

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.

\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.

\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.

\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.


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

2 Systems

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


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

2.1 vertex

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/CommonDoc/vertex

Source Control

(:git "git@github.com:commondoc/vertex.git")

Bug Tracker

https://github.com/CommonDoc/vertex/issues

License

MIT

Description

A markup language with TeX syntax.

Long Description

# VerTeX

[![Build Status](https://travis-ci.org/CommonDoc/vertex.svg?branch=master)](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.

Version

0.1

Dependencies
Source

vertex.asd (file)

Component

src (module)


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 vertex/src

Parent

vertex (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 vertex.asd

Location

vertex.asd

Systems

vertex (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 vertex/src/parser.lisp

Parent

src (module)

Location

src/parser.lisp

Packages

vertex.parser

Exported Definitions
Internal Definitions

input->common-doc (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 vertex/src/emitter.lisp

Dependency

parser.lisp (file)

Parent

src (module)

Location

src/emitter.lisp

Packages

vertex.emitter

Exported Definitions

emit-to-stream (function)


Previous: , Up: Lisp files   [Contents][Index]

4.1.4 vertex/src/vertex.lisp

Dependency

emitter.lisp (file)

Parent

src (module)

Location

src/vertex.lisp

Packages

vertex

Exported Definitions

vertex (class)


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

5 Packages

Packages are listed by definition order.


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

5.1 vertex.parser

Parse a TeX file into a CommonDoc document.

Source

parser.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

input->common-doc (function)


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

5.2 vertex.emitter

Create a VerTeX representation of a CommonDoc document.

Source

emitter.lisp (file)

Use List

common-lisp

Exported Definitions

emit-to-stream (function)


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

5.3 vertex

The main interface.

Source

vertex.lisp (file)

Use List
Exported Definitions

vertex (class)


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

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Functions

Function: emit-to-stream DOCUMENT STREAM
Package

vertex.emitter

Source

emitter.lisp (file)

Function: parse-file PATHNAME

Parse a VerTeX file.

Package

vertex.parser

Source

parser.lisp (file)

Function: parse-string STRING

Parse a VerTeX string.

Package

vertex.parser

Source

parser.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Classes

Class: vertex ()

The VerTeX format.

Package

vertex

Source

vertex.lisp (file)

Direct superclasses

document-format (class)

Direct methods
  • emit-document (method)
  • emit-document (method)
  • parse-document (method)
  • parse-document (method)

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

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: input->common-doc INPUT
Package

vertex.parser

Source

parser.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   V  
Index Entry  Section

F
File, Lisp, vertex.asd: The vertex<dot>asd file
File, Lisp, vertex/src/emitter.lisp: The vertex/src/emitter<dot>lisp file
File, Lisp, vertex/src/parser.lisp: The vertex/src/parser<dot>lisp file
File, Lisp, vertex/src/vertex.lisp: The vertex/src/vertex<dot>lisp file

L
Lisp File, vertex.asd: The vertex<dot>asd file
Lisp File, vertex/src/emitter.lisp: The vertex/src/emitter<dot>lisp file
Lisp File, vertex/src/parser.lisp: The vertex/src/parser<dot>lisp file
Lisp File, vertex/src/vertex.lisp: The vertex/src/vertex<dot>lisp file

M
Module, vertex/src: The vertex/src module

V
vertex.asd: The vertex<dot>asd file
vertex/src: The vertex/src module
vertex/src/emitter.lisp: The vertex/src/emitter<dot>lisp file
vertex/src/parser.lisp: The vertex/src/parser<dot>lisp file
vertex/src/vertex.lisp: The vertex/src/vertex<dot>lisp file

Jump to:   F   L   M   V  

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

A.2 Functions

Jump to:   E   F   I   P  
Index Entry  Section

E
emit-to-stream: Exported functions

F
Function, emit-to-stream: Exported functions
Function, input->common-doc: Internal functions
Function, parse-file: Exported functions
Function, parse-string: Exported functions

I
input->common-doc: Internal functions

P
parse-file: Exported functions
parse-string: Exported functions

Jump to:   E   F   I   P  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   P   S   V  
Index Entry  Section

C
Class, vertex: Exported classes

P
Package, vertex: The vertex package
Package, vertex.emitter: The vertex<dot>emitter package
Package, vertex.parser: The vertex<dot>parser package

S
System, vertex: The vertex system

V
vertex: The vertex system
vertex: The vertex package
vertex: Exported classes
vertex.emitter: The vertex<dot>emitter package
vertex.parser: The vertex<dot>parser package

Jump to:   C   P   S   V