C.6 Tool - rv.T#

Files processed by the Tools API function are read and written to the src/tools folder unless the rvsource variable is set to True in the Meta API function. In that case files are read and written to the rivt file folder.

The Tool API function does not use line tags.

<i>

[1] TAG KEY#

_[[TAG]] : block tag description

output types

<i>

[2] _[[RST]] : reStructuredText code#

_[[RST]] description
code
code
...
_[[QUIT]]

outputs: pdf, html

<i>

[3] _[[HTML]] : HTML code#

_[[HTML]] pdf;nopdf
code
code
...
_[[QUIT]]

If the parameter is pdf a PDF file is output. It may be added as a source of the HTML doc. The file name is derived from the rivt doc and section number.

outputs: pdf, html

<i>

[4] _[[LATEX]] : LaTeX code#

_[[LATEX]] description
code
code
...
_[[QUIT]]

outputs: pdf, html

<i>

<i>

[5] _[[PYTHON]] : Python code#

_[[PYTHON]] *rv-namespace*; user namespace
code
code
...
_[[QUIT]]

Executes Python script in the rivt namespace or a user specified namespace. File paths are constucted relative to the rivt file folder.

outputs: text, pdf, html

[6] COMMAND KEY#

output file types

<i>

[7] | RST | reStructuredText markup#

Reads .rst files and outputs PDF or HTML markup. The description is for author reference only.

outputs: pdf, html

<i>

[7] | HTML | HTML markup#

Reads .html and .htm files and outputs HTML markup. If the parameter is pdf a separate PDF file is output from the formatted HTML and may be appended to a PDF report. The file name is derived from the rivt doc and section number.

outputs: pdf, html

<i>

[8] | LATEX | LaTeX markup#

Reads .tex files. If the parameter is pdf a separate PDF file is output from the formatted LaTeX and may be appended to an HTML report. The file name is derived from the rivt doc and section number.

outputs: pdf, html

<i>

[28] | PYTHON | Python script#

Executes Python code in the rivt namespace or user specified namespace. File paths are constucted relative to the rivt file folder.

outputs: text, pdf, html