Documentation System Integration for Advtrains

• Index

Contents

• Functions

Modules

• advtrains_doc_integration.bc
• advtrains_doc_integration.describe
• advtrains_doc_integration.hypertext
• advtrains_doc_integration
• advtrains_doc_integration.latex
• advtrains_doc_integration.mathutils
• advtrains_doc_integration.utils

Topics

• README

Module advtrains_doc_integration.latex

Code related to LaTeX generation.

Functions

escape (str)	Escape string in LaTeX.
escape_translated (lang, str)	Escape a translated string in LaTeX.
describe_color (cstr)	Describe a color in LaTeX.
describe_coupler (coupler)	Describe a coupler in LaTeX.
describe_wagon_prototype (itemname)	Describe a wagon prototype in LaTeX.

Functions

escape (str)

Escape string in LaTeX.

Parameters:

• str string The string to escape.

Returns:

string The escaped string.

escape_translated (lang, str)

Escape a translated string in LaTeX.

Parameters:

• lang string The language to use for server-side translation
• str string The string to escape.

Returns:

The escaped string.

describe_color (cstr)

Describe a color in LaTeX.

Parameters:

• cstr string The color string.

Returns:

string The string describing the color.

describe_coupler (coupler)

Describe a coupler in LaTeX.

Parameters:

• coupler string The name of the coupler.

Returns:

string The string describing the coupler.

describe_wagon_prototype (itemname)

Describe a wagon prototype in LaTeX.

Parameters:

• itemname string The item name of the wagon prototype.

Returns:

string The description of the prototype.