D.1 Docs

<i>

[1] rivt Files

---

Each rivt file outputs a corresponding formatted doc. A rivt report is organized using the rivt doc numbers. If the rivt file names are:

rvA01-filename.py
rv105-filename.py
rv212-filename.py

the report numbers would be:

• A.1 (division A, subdivision 1)

• 1.5 (division 1, subdivision 5)

• 2.12 (division 2, subdivision 12)

Note that leading zeroes are dropped. Docs are sorted alpha-numerically into divisions and subdivisions in the report.

<i>

[2] Docs

---

Each rivt file outputs a corresponding formatted doc written to the publish folder unless it is a stand-alone doc.

Docs may be text, HTML or PDF. PDF doc files are produced by two different libraries, referred to as pdf and pdftex. A pdf doc is formatted using the rst2pdf library, a subset of the larger ReportLab library. It is the default PDF doc. Its advantage is a small library that has been incorporated into rivt.

A pdftex doc requires separate installation of the much larger texlive LaTeX library (approx. 3GB). Its advantage is additional control over doc formatting and appearance.

<i>

[3] Single docs

---

A document that will not be part of a report may use the local rivt file folder for reading and writing files, without referencing the rivt report folders. A single doc is formatted by setting the rv_local variable in a comment, immediately following the rivtlib import statement.

# rv_local=True

The text, PDF and HTML docs will be written to the local file folder using simple style settings built into rivtlib. Stand-alone docs require less setup but also offer less formatting control.