B.5 | Commands

[1] Command Summary

Command Syntax

API Scope	Command	Description
rv.R	| SCRIPT | file name | args, output file	[2] Script
rv.R	| ARGS | file name | namespace	[3] Args
rv.R	| TEXT | file name | type	[4] Text
rv.R	| ABSTEXT | file name | type	[4] Text
rv.R	| ABSIMAGE | file name | caption, scale, num;non, time;not	[5] Image
rv.I, V	| IMAGE | file name | caption, scale, num;non, time;not	[5] Image
rv.I, V	| IMAGE2 | file1, file2 | c1,c2,s1,s2,n1,n2	[6] Adjacent images
rv.I, V	| TABLE | file name | title,width,head;nohead,num;non	[7] Table
rv.V	| VALTABLE | file name | title, width, num;non	[8] Valtable
rv.V	| VALSTOR | file name | title, width, num;non	[9] Valstor
rv.V	| PYTHON | file name | args, var, type, label	[11] Function
rv.V	| FUNCTION | function name | args, var, type, label	[11] Function
rv.T	| COPY | abs src path | abs dest path | file pattern	[12] Copy Files
rv.T	| SHELL | abs file path | os, wait	[13] Shell file
rv.D	| PUBLISH | doc title | type	[14] Publish doc
rv.D	| ATTACHPDF | file name | front;back, title	[15] Attach PDF

Command File Paths - Defaults

Command	Default Path [1]	R/W
| SCRIPT |	rvreport-…/scripts [2]	R/W
| ARGS |	rvreport-…/data	R
| TEXT |	rvreport-…/data	R
| IMAGE |	rvreport-…/image	R
| IMAGE2 |	rvreport-…/image	R
| TABLE |	rvreport-…/data	R
| VALTABLE |	rvreport-…/data	R
| VALSTOR |	rv_stor/vals	R
| ATTACHPDF |	rvreport-…/data	R
| PUBLISH |	rvreport-…/_published/ [3]	W
| COPY |	os root	R
| SHELL |	os root	R

[1]

Path overrides are relative to the rvreport-… folder and include an initial slash

[2]

Output is written to rvreport-…/data

[3]

docs are written to subdirectories of rvreport-../_published for each type

See here for the folder layout.

[2] Script

The SCRIPT block executes code and returns a file object (text, list, image etc.) that is written to rvreport-…/scripts. The language parameter specifies the processing and requires a compatible compiler installation.

Language types include:

1. python

2. ruby

3. mermaid

4. latex

| SCRIPT |

Syntax:
    | TEXT | relative path | type
Example:
    | TEXT | rvsrc/quote.txt | literal

API Scope	rv.R
File Types	see above
Doc Types	text, PDF, HTML

[3] Args

The ARGS command reads a Python file with arguments defined as dictionaries. The dictionary names are used as inputs to functions and scripts.

The namespace name rivt imports the values into the main rivt file namespace.

| ARGS |

Syntax:
    | ARGS | relative path | namespace
Example:
    | ARGS | bm1args.py | rivt

API Scope	rv.R
File Types	see above
Doc Types	text, PDF, HTML

[4] Text

The TEXT and ABSTEXT commands read and format text and code files. They insert text after framing and formatting, without actually running.

Language types include:

1. text - literal text

2. bold

3. italic

4. indent4

5. python - Python code

6. ruby - Ruby code

7. sphinx - Sphinx reStructuredText

8. rst - reStructuredText

9. html - HTML markup

| TEXT |

Syntax:
    | TEXT | relative path | type
Example:
    | TEXT | quote.txt | literal

| ABSTEXT |

Syntax:
    | TEXT | absolute path | type
Example:
    | TEXT | c:/mydir/quote.txt | literal

API Scope	rv.R
File Types	see above
Doc Types	text, PDF, HTML

[5] Image

The IMAGE and ABSIMAGE commands read a PNG or JPEG file and centers it in the doc. The scale parameter is a decimal fraction of the page width. The caption may be ommited by using a single hyphen. The num;nonum parameter specifies whether to assign a figure number. The image path is inserted in the text doc instead of the image.

Syntax:
    | IMAGE | relative path | caption, scale, num;nonum

Example:
    | IMAGE | file1.png | Map, 0.5, num

Syntax:
    | ABSIMAGE | absolute path | caption, scale, num;nonum

Example:
    | ABSIMAGE | c:/mydir/file1.png | Map, 0.5, num

API Scope	rv.V, rv.I or rv.R
File Types	PNG, JPG
Doc Types	PDF, HTML

[6] Adjacent images

The IMAGE2 command reads two PNG or JPEG file and places them side by side in the doc. The scale parameters are a decimal fraction of the page width. The captions may be ommited by using a single hyphen for either or both images. The fig;nofig parameters specify whether to assign a figure number to either or both images. The image path is inserted in the text doc instead of the image.

Syntax:
    | IMAGE2 | relative path | cap1, cap2, scale1, scale2, num;nonum, num;nonum

Example:
    | IMAGE2 | file1.png, file2.png | Map, Photo, .5,.5, num, num

API Scope	rv.I, rv.V
File Types	PNG, JPG jenn
Doc Types	PDF, HTML

[7] Table

The TABLE command reads csv, xls, and rst files and outputs formatted tables. The title may be ommited by inserting a hyphen “-”. The width parameter specifies the maximum character width of a column. The align parameter specifies the cell justification - left, center, right. The number parameter specifies whether the table is numbered. For csv files, the head parameter specifies whether the first row is a column header.

| TABLE |

Syntax:
    | TABLE | rel path | title, max width, rows, l;c;r, head;nohead, num;nonum

Example:
    | TABLE | file1.csv | Forces, 30, 0:0, c, nohead, num

API Scope	rv.I, rv.V
File Types	csv, xls, rst
Doc Types	text, PDF, HTML

[8] Valtable

The VALTABLE command imports and defines values from a csv or xls file. The file format is:

var = value, unit1, unit2, decimal, label

The path variable is either from src or stored depending on if the values were generated by rivtlib or provided by the author. The title parameter is the table title. A hyphen omits the title. The rows parameter specifies the rows to import. The num; nonum parameter specifies whether to assign a table number to the values table.

Syntax:
    | VALTABLE | relative path | title, rows, *num;nonum*

Example:
    If read from the default folder:
    | VALTABLE | newvals.csv | Beam Properties, 1:10, num
    If read from the stored folder:
    | VALTABLE | /stored/vals/vA01-2.csv | Beam Properties, 1-10, num

API Scope	rv.V
File Types	.csv, .xls,
Doc Types	text, PDF, HTML

[9] Valstor

The VALSTOR command imports and defines values from a csv or xls file. The file format is:

var = value, unit1, unit2, decimal, label

The path variable is either from src or stored depending on if the values were generated by rivtlib or provided by the author. The title parameter is the table title. A hyphen omits the title. The rows parameter specifies the rows to import. The num; nonum parameter specifies whether to assign a table number to the values table.

Syntax:
    | VALTABLE | relative path | title, rows, *num;nonum*

Example:
    If read from the default folder:
    | VALTABLE | newvals.csv | Beam Properties, 1:10, num
    If read from the stored folder:
    | VALTABLE | /stored/vals/vA01-2.csv | Beam Properties, 1-10, num

API Scope	rv.V
File Types	.csv, .xls,
Doc Types	text, PDF, HTML

[10] Python file

Executes Python code in the rivt namespace or user specified namespace. File paths used in the script are relative to the root rivt folder.

Syntax:
    | PYTHON | relative path | *rvspace*; user space

Example:
    | PYTHON | script1.py | rv-space

API Scope	rv.V, rv.T
File Types	.csv
Doc Types	text, PDF, HTML

[11] Function

Executes Python functions imported by the PYTHON command. Function args are defined and named by the [[ARG]] block.

Syntax:
    | FUNCTION | func name, args, return var, type | label

Example:
    | FUNCTION | bending1, beamprops, result1, str | beam design

API Scope	rv.V
File Types	.py
Doc Types	text, PDF, HTML

[12] Copy Files

Copy files using absolute paths. -rvsrc- is an alias for the rvsrc folder. OS alias may also be used e.g. %USERPROFILE% on Windows.

Syntax:
    | COPY | abs src path | abs dest path | file name and wildcards
Example:
    | COPY | -rvsrc-/scripts | %USERPROFILE%/venv1

API Scope	rv.T
File Types	.
Doc Types	text, PDF, HTML

[13] Shell file

The SHELL command runs shell scripts including .cmd, .bat and .sh files. The os parameter specifies the operating system: win, mac or linux. The wait; nowait specifies whether rivt file processing waits for the script to complete before continuing.

If the doc is part of a report and no path is specified, the file is assumed to be in the default folder /src/run/ . Otherwise the path is specified relative to the report root (rivt file folder). If the doc is a single doc the file is read from the rivt file folder.

Syntax:
    | SHELL | relative file path | file name

Example:
    | SHELL | rvsrc | sap.cmd

API Scope	rv.T
File Types	.cmd, .bat, .sh, .bsh
Doc Types	text, PDF, HTML

[14] Publish doc

Publishes a doc.

Syntax:
    | PUBLISH | ini relative path | rst2pdf, texpdf, tex, hmtl

Example:
    | PUBLISH | ini relative path | rst2pdf

API Scope	rv.D
File Types	tex, html, text, pdf
Doc Types	text, PDF, HTML

[15] Attach PDF

Appends or prepends a PDF file to the doc. The title parameter generates an Appendix cover page with the specified title. A “-” omits the over page. For HTML docs the file is inserted as a donwload link.

| ATTACHPDF |

Syntax:``
    | ATTACHPDF | relative path | front;back, title

Example:
    | ATTACHPDF | relative path | front;back, title

API Scope	rv.D
File Types	tex, html, text, pdf
Doc Types	text, PDF, HTML