Authoring API Reference

All of the following functions and classes are not part of the core Paxter language. They are provided only for convenience; it is entirely possible to utilize Paxter package without using any of the following functions. Users are encouraged to read source code of these functions to learn how to reassemble core APIs to suit their needs.

Preset Functions

The following function combines Paxter language parsing together with parsed tree evaluation.


Environment Creations

The following function creates a pre-defined unsafe Python environment dictionary to be used with the evaluation context class.


Evaluation Context Objects

The following instances are available in preset environments.

Object

Alias

Simple Environment

Document Environment

"@"

"@@"

Yes

Yes

for_statement

for

Yes

Yes

if_statement

if

Yes

Yes

python_unsafe_exec

python

Yes

Yes

verbatim

verbatim

Yes

Yes

RawElement

raw

-

Yes

Paragraph

paragraph

-

Yes

Heading1

h1

-

Yes

Heading2

h2

-

Yes

Heading3

h3

-

Yes

Heading4

h4

-

Yes

Heading5

h5

-

Yes

Heading6

h6

-

Yes

Blockquote

blockquote

-

Yes

Bold

bold

-

Yes

Italic

italic

-

Yes

Underline

uline

-

Yes

Code

code

-

Yes

Link

link

-

Yes

Image

image

-

Yes

NumberedList

numbered_list

-

Yes

BulletedList

bulleted_list

-

Yes

Table

table

-

Yes

TableHeader

table_header

-

Yes

TableRow

table_row

-

Yes

horizontal_rule

hrule

-

Yes

line_break

line_break or "@\"

-

Yes

non_breaking_space

nbsp or "@%"

-

Yes

hair_space

hairsp or "@."

-

Yes

thin_space

thinsp or "@,"

-

Yes

Control Functions

Standard Functions

Element Data Classes