C.8 Quick Lookup#

<i>

[1] Line tags#

<i>

API Scope

Line Tags

Description (doc scope)

rv.V

function _[D]

add doc string to function log (all)

rv.V

function _[F]

add code to function log (all)

rv.I, V

text _[#]

endnote number (all)

rv.I, V

text _[C]

center text (all)

rv.I, V

text _[R]

right justify text (all)

rv.I, V

math _[L]

format LaTeX math (all)

rv.I, V

math _[A]

format ASCII math (all)

rv.I, V

label _[E]

equation label (all)

rv.I, V

caption _[I]

image label (all) [1]

rv.I, V

title _[T]

table label (all) [1]

rv.I, V

text _[P]

new page (all)

rv.I, V

text _[H]

dividing line (all)

rv.I, V

dividing line - >4 underscores (all)

rv.I, V

text word _[S] section link

link section within doc (all)

rv.I, V

text word _[D] report link

link doc within report (all)

rv.I, V

text word _[U] external url

external url link (all)

[1] tag may be added to the label parameter in IMAGE and TABLE commands

<i>

[2] Block tags#

API Scope

Block Tags

Description (doc scope)

rv.M

_[[AUTH]] optional label

author data (all)

rv.R

_[[WIN]] wait;nowait

Windows command script (all)

rv.R

_[[MACOS]] wait;nowait

Mac shell script (all)

rv.R

_[[LINUX]] wait;nowait

Linux shell script (all)

rv.I, V

_[[INDENT]] spaces (4 default)

Indent (all)

rv.I, V

_[[ITALIC]] spaces (4 default)

Italic indent - (all)

rv.I, V

_[[NOTE]] optional label

Endnote description (all)

rv.I, V

_[[TEXT]] optional language

literal, code (all)

rv.I, V

_[[TOPIC]] topic

Topic (all)

rv.V

_[[VALUES]] optonal title (_[T])

Define values(all)

rv.T

_[[PYTHON]] rv-namespace;userspace

Python script (all)

rv.T

_[[LATEX]] optional label

LaTeX markup (pdf)[1]

rv.T

_[[HTML]] optional label

HTML markup (html)

rv.T

_[[RST]] optional label

reStructuredText (pdf,html)

all

_[[END]] optional label

End block (all)

[1] LaTeX processing requires the installation of Texlive

<i>

[3] Commands#

API Scope
Command | path | parameters

R/W

input types

rv.R

| LINUX | relative path | wait;nowait

R

sh

rv.R

| MACOS | relative path | wait;nowait

R

sh

rv.R

| WIN | relative path | wait;nowait

R

bat, cmd

rv.I, V

| IMAGE | relative path | scale, caption (_[I])

R

png, jpg

rv.I, V

| IMAGE2 | relative path | s1, s2, c1, c2 (_[I])

R

png, jpg

rv.I, V

| TABLE | relative path | width, l;c;r, title

R

csv, txt, xlsx

rv.I, V

| TEXT | relative path | normal;literal ;code

R

txt, code

rv.V

| VALUES | relative path | visible;hide (_[T])

R

csv

rv.V

a := 1*IN | unit1, unit2, decimal | description

W

define value

rv.V

b <= a + 3*FT | unit1, unit2, decimal | ref (_[E])

W

assign value

rv.V

c ^= func1(a,b) | unit1, unit2, decimal | ref (_[D]_[F])

W

assign value

rv.T

| PYTHON | relative path | rv-namespace; userspace

R

py

rv.T

| HTML | relative path | html

R

html

rv.T

| LATEX | relative path | pdf

R

tex

rv.T

| RST | relative path | pdf;html;both

R

rst

rv.D

| APPEND | relative path | cover_page_title

W

pdf

rv.D

| PUBLISH | relative path | pdf;pdftex;text;html

W

pdf, html, txt

<i>

[4] Default Header Settings#

The paramaters for headers include the following. The default setting is listed first.

API

print

public

merge

rv.M

hide; show

private; public

merge; section

rv.R

hide; show

private; public

merge; section

rv.I

show; hide

private; public

section; merge

rv.V

show; hide

private; public

section; merge

rv.T

hide; show

private; public

merge; section

rv.D

hide; show

private; public

merge; section

rv.S

hide; show

private; public

merge; section

rv.Q

hide; show

private; public

merge; section

<i>

[5] Folders#

Folder Key

  • Required folder and file prefix names are shown in brackets [ ].

  • Single vertical bar ( | ) identifies files provided by the report author.

  • Double vertical bar ( || ) identifies files written by rivtlib

  • Four vertical bars ( |||| ) are a mix of author and rivtlib written files

**Collapsed folders**

[rivt]-Report-Label/                Report Folder Name
    ├── [rv101-]filename1.py        | rivt file
    ├── [rv102-]filename2.py        | rivt file
    ├── [rv201-]filename3.py        | rivt file
    ├── [rv202-]filename4.py        | rivt file
    ├── [log]/                      || log folder
    ├── [public]/                   || public rivt folder
    ├── [publish]/                  || reports folder
    ├── [src]/                      |||| source folder
    └── README.txt                  || GitHub searchable text report

**Expanded folders**

[rivt]-Report-Label/                       Report Folder Name
    ├── [rv101-]filename1.py               | rivt file
    ├── [rv102-]filename2.py               | rivt file
    ├── [rv201-]filename3.py               | rivt file
    ├── [rv202-]filename4.py               | rivt file
    ├── [log]/                             || log files
        ├── rv101-api.rst
        ├── rv101-log.txt
        └── rv102-log.txt
    ├── [public]/                          || public rivt files
        ├── rv-101-filename1.py            ||
        ├── rv-201-filename3.py            ||
        └── rv-202-filename4.py            ||
    ├── [publish]/                         || Reports and Docs
        ├── [html]/
            ├── [docs]/                    || HTML
                ├── _images/               ||
                ├── _sources/              ||
                ├── _static/               ||
                ├── rv101-filename1.html   || HTML files
                ├── rv102-filename2.html   ||
                ├── rv201-filename3.html   ||
                ├── rv201-filename4.html   ||
                └── index.html             || HTML site
            ├── rv101-filename1.rst
            ├── rv102-filename2.rst
            ├── rv201-filename3.rst
            └── rv202-filename4.rst
        ├── [pdf]/                         || pdf report
            ├── [src]/
                ├── rv101-filename1.rst
                ├── rv102-filename2.rst
                ├── rv201-filename3.rst
                └── rv202-filename4.rst
            ├── rv101-filename1.pdf         || PDF from rst2pdf files
            ├── rv102-filename2.pdf         ||
            ├── rv201-filename3.pdf         ||
            ├── rv202-filename4.pdf         ||
            └── Report-Label.pdf            || PDF from rst2pdf report
        ├── [pdftex]/                       || pdftex report
            ├── [src]/
                ├── rv101-filename1.rst
                ├── rv102-filename2.rst
                ├── rv201-filename3.rst
                └── rv202-filename4.rst
            ├── rv101-filename1.pdf         || PDF from LaTeX files
            ├── rv102-filename2.pdf
            ├── rv201-filename3.pdf
            ├── rv202-filename4.pdf
            └── Report-Label.pdf            || PDF from LaTeX report
        ├── [text]/                         || text report
            ├── rv101-filename1.txt         ||
            ├── rv102-filename2.txt         ||
            ├── rv201-filename3.txt         ||
            ├── rv202-filename4.txt         ||
            └── README.txt                  || GitHub searchable text report
        ├── gen-html.cmd                    | html generating script
        ├── gen-pdf.cmd                     | pdf generating script
        ├── gen-pdftex.cmd                  | LaTeX generating script
        └── rivt-report.py                  | report generating script
    ├── [src]                               |||| doc source files
        ├── data/                           | author created folder
            ├── data1.csv
            ├── newvals.csv
            └── download1.csv
        ├── image/                          | author created folder
            ├── fig1.png
            └── fig2.jpg
        ├── [style]/                        | doc style files
            ├── [html]/                     | html style files
                ├── _locale/
                ├── _static/
                ├── _templates/
                ├── conf.py
                ├── genhtml.cmd
                └── index.rst
            ├── [pdf]/                       | rst2pdf style files
                ├── fonts/
                ├── style/
                ├── Report-Cover.pdf
                └── genrst2pdf.cmd
            ├── [pdftex]/                    | pdftex style files
                ├── gentexpdf.cmd
                ├── Report-cover.pdf
                └── rivt.sty
            ├── [text]/                      | text ini file
                └── rv-text.ini
        ├── [temp]/                          || temp files
            └── rv01-label3.tex
        ├── [tools]/                         |||| functions and output
            ├── plot.py
            └── loads.py
            ├── tablepy.csv
            └── imagepy.png
        ├── [values]/                        |||| stored values
            ├── new-units.py
            ├── add-values-v.csv
            ├── v101-2.csv
            └── v102-3.csv
    └── README.txt                           || GitHub searchable text report