Index of values


B
brtx_to_html [Bracetax_transform]
Transformation from Bracetax to HTML (actually almost XHTML).
brtx_to_latex [Bracetax_transform]
Transform from Bracetax to LaTeX.
build [Bracetax_generic_printer]
Build a printer from a GenericPrinter.output_t to feed Parser.do_transformation, the optional argument has the same meaning than for Transform.brtx_to_latex.
build [Bracetax_latex_printer]
Build a printer to feed Parser.do_transformation, the optional arguments have the same meaning than for Transform.brtx_to_latex.
build [Bracetax_HTML_printer]
Build a printer to feed Parser.do_transformation, the optional arguments have the same meaning than for Transform.brtx_to_html.

C
cell_arguments [Bracetax_commands.Table]
cell_start [Bracetax_commands.Table]
cell_stop [Bracetax_commands.Table]
cells_to_matrix [Bracetax_commands.Table.Util]
clean_string [Bracetax_escape]
Cleans a string to use only A-Z, a-z, 0-9, _ characters.
create [Bracetax_TOC_output]
Creation of the Generic_printer.output_t.
create [Bracetax_commands.Link]

D
default_default_align [Bracetax_commands.Table]
default_raw_end [Bracetax_commands.Raw]
do_transformation [Bracetax_parser]
(do_transformation printer read_fun filename) parses the input (the read_fun, until it returns None) by calling printer's functions.

E
empty [Bracetax_commands.Stack]
env_to_string [Bracetax_commands]
Converts to a (human readable) string.

F
fill_riddle [Bracetax_commands.Table.Util]
footer [Bracetax_latex_printer]
Close a LaTeX document.
footer [Bracetax_HTML_printer]
Close an HTML document.

G
get_TOC [Bracetax_transform]
Retrieve a table of contents from a Bracetax input.
get_kind [Bracetax_commands.Link]
In the returned string, if it is a "local:" link, removes the "local:" part.

H
head [Bracetax_commands.Stack]
header [Bracetax_latex_printer]
Build a LaTeX header.
header [Bracetax_HTML_printer]
Build an HTML header.

I
image_params [Bracetax_commands.Names]
Get the parameters of an "image", the path (optinally treated by img_hook), the size specification, and the label (the path and the label may be "").
is_authors [Bracetax_commands.Names]
is_begin [Bracetax_commands.Names]
is_bold [Bracetax_commands.Names]
is_cell [Bracetax_commands.Names]
is_close_brace [Bracetax_commands.Names]
is_ellipsis [Bracetax_commands.Names]
is_em_dash [Bracetax_commands.Names]
is_en_dash [Bracetax_commands.Names]
is_end [Bracetax_commands.Names]
is_header [Bracetax_commands.Names]
is_image [Bracetax_commands.Names]
is_italic [Bracetax_commands.Names]
is_item [Bracetax_commands.Names]
is_link [Bracetax_commands.Names]
is_list [Bracetax_commands.Names]
is_mono_space [Bracetax_commands.Names]
is_new_line [Bracetax_commands.Names]
is_non_break_space [Bracetax_commands.Names]
is_note [Bracetax_commands.Names]
is_open_brace [Bracetax_commands.Names]
is_paragraph [Bracetax_commands.Names]
is_quotation [Bracetax_commands.Names]
is_quote [Bracetax_commands.Names]
is_raw_cmd [Bracetax_commands.Raw]
is_section [Bracetax_commands.Names]
is_sharp [Bracetax_commands.Names]
is_subscript [Bracetax_commands.Names]
is_subtitle [Bracetax_commands.Names]
is_superscript [Bracetax_commands.Names]
is_table [Bracetax_commands.Names]
is_title [Bracetax_commands.Names]
is_utf8_char [Bracetax_commands.Names]
is_white_space [Bracetax_escape]

L
license [Bracetax_info]
list_style [Bracetax_commands.Names]

M
make_riddle [Bracetax_commands.Table.Util]
make_writer [Bracetax_signatures]
matrix_next_coordinates [Bracetax_commands.Table.Util]
mk [Bracetax_error]
Build an error message.

N
nb_rows [Bracetax_commands.Table.Util]
next_coordinates [Bracetax_commands.Table.Util]
Find next false in riddle
non_env_cmd_of_name [Bracetax_commands]
Transforms some commands to their Bracetax_commands.Stack.environment counter part.

P
pop [Bracetax_commands.Stack]
push [Bracetax_commands.Stack]

R
raw_cmd_of_str [Bracetax_commands.Raw]
replace_chars [Bracetax_escape]
Replace characters by strings.
replace_string [Bracetax_escape]

S
section_params [Bracetax_commands.Names]
Returns section's depth and label (maybe "").
start [Bracetax_commands.Table]
start [Bracetax_commands.Link]
Start recording a link, it returns the Bracetax_commands.Stack.environment element to put in the stack, and new "output" function to write/record the text of the link.
stop [Bracetax_commands.Link]
Stop recoring a link, returns the kind of link, the optional target, and the optional link text (already transformed).
str_of_raw_cmd [Bracetax_commands.Raw]
str_to_TOC [Bracetax_transform]
This function is a convenience replacement for Bracetax_transform.get_TOC, to get the table of contents from a string into another string together with a list of Error.errors.
str_to_html [Bracetax_transform]
This function is a convenience replacement for Bracetax_transform.brtx_to_html, to transform a string into another string together with a list of Error.errors.
str_to_latex [Bracetax_transform]
This function is a convenience replacement for Bracetax_transform.brtx_to_latex, to transform a string into another string together with a list of Error.errors.
string_io [Bracetax_transform]
Create a writer and a input_char from a string and two Buffer.t.

T
table_args [Bracetax_commands.Table]
to_list [Bracetax_commands.Stack]
to_string [Bracetax_error]
A built-in function for rendering errors as strings.

U
unparse [Bracetax_commands.Link]
Transform back to a Bracetax string (treats the text as pure text).

V
version [Bracetax_info]

W
write [Bracetax_commands.Table]