F.1 Quick Ref#
[1t] API functions#
API Function |
Name |
Purpose |
|---|---|---|
rv.R (rS) |
Run |
Run shell commands |
rv.I (rS) |
Insert |
Insert static sources |
rv.V (rS) |
Values |
Calculate values |
rv.T (rS) |
Tools |
Python and markup scripts |
rv.S (rS) |
Skip |
Skip section (comments and debugging) |
rv.D (rS) |
Doc |
Publish docs |
rv.X (rS) |
Exit |
Exit rivt (debugging) |
The first line of a rivt string (rS) is a header substring.
rv.I("""A New Section | private, doc, section
Content text
...
""")
Default settings in the header substring do not need to be specified. The default setting for each API is listed first (in bold) in the table below.
API |
private;public |
doc;stored |
section;merge |
|---|---|---|---|
rv.R |
private;public |
stored;doc |
merge;section |
rv.I |
private;public |
doc;stored |
section;merge |
rv.V |
private;public |
doc;stored |
section;merge |
rv.T |
private;public |
stored;doc |
merge;section |
rv.S |
private;public |
stored |
merge |
rv.D |
public |
stored |
merge |
rv.X |
[2t] Line Tag Summary#
API Scope |
Line Tag |
Description |
|---|---|---|
rv.I |
text _[C] |
|
rv.I |
text _[R] |
|
rv.I |
text math _[M] |
|
rv.I |
LaTeX math _[L] |
|
rv.I |
text _[#] text |
|
rv.I |
text _[G] glossary term |
|
rv.I |
text _[S] text, section label |
|
rv.I |
text _[D] text,rivt_file |
|
rv.I |
text _[U] text, url |
|
rv.V, I |
text _[V] var_name text |
|
rv.V, I |
assign var or label _[E] |
|
rv.V, I |
title _[T] |
|
rv.V, I |
caption _[F] |
[3t] Block Tag Summary#
API Scope |
Block Tag |
Description |
|---|---|---|
rv.R |
_[[SHELL]] process parameters |
|
rv.I |
_[[INDENT]] spaces (4 default) |
|
rv.I |
_[[ITALIC]] spaces (4 default) |
|
rv.I |
_[[ENDNOTES]] optional label |
|
rv.I |
_[[TEXT]] optional language |
|
rv.I |
_[[TOPIC]] topic |
|
rv.I |
_[[BOX]] label |
|
rv.V, T |
_[[PYTHON]] namespace |
|
rv.D |
_[[METADATA]] label |
|
rv.D |
_[[LAYOUT]] label |
|
all |
_[[END]] |
|
all |
_[[NEW PAGE]] |
[4t] Command Summary#
See here for the folder structure. If files are in the default path only the file name needs to be provided.
Read, write and format files
API Scope |
Command | path | parameters
|
Description |
|---|---|---|
rv.R |
| SHELL | rel path | os, wait |
|
rv.I |
| TEXT | rel path | language |
|
rv.V, I |
| TABLE | rel path | title, width, rows, align, head |
|
rv.V, I |
| IMAGE | rel path | caption, scale, number |
|
rv.V, I |
| IMAGE2 | rel path1, rel path2 | caption, scale number |
|
rv.V |
| VALTABLE | rel path | title, rows, number |
|
rv.V |
a =: 1*IN | unit1, unit2, decimal | label |
|
rv.V |
c <=: expression | unit1, unit2, decimal | label |
|
rv.V |
a < c | decimal | text1, text2, color1, color2 |
|
rv.T, V |
| PYTHON | rel path | namespace |
|
rv.T |
| MARKUP | rel path | type |
|
rv.D |
| ATTACHPDF | rel path | place, title |
|
rv.D |
| PUBLISH | rel path (ini) | type |
Default command paths
Command |
Default Path |
|---|---|
| SHELL | |
/Src/Shell/ |
| TEXT | |
/Src/Data/ |
| TABLE | |
/Src/Data/ |
| IMAGE | |
/Src/Image/ |
| IMAGE2 | |
/Src/Image/ |
| VALTABLE | |
/Src/Data/ [1] |
| PYTHON | |
/Src/Scripts/ |
| MARKUP | |
/Src/Scripts/ |
| ATTACHPDF | |
/Src/Gendocs/ |
| PUBLISH | |
/Src/Gendocs/ |
[1] use /stored/data/filename to read values previously defined and stored
[5t] Folders#
[rivt]-Report-Label/ Report Folder Name
├── [rv101-]filename1.py | rivt input files
├── [rv102-]filename2.py
├── [rv201-]filename3.py
├── [rv202-]filename4.py
├── [Public]/ || public rivt files
├── rv-101-filename1.py
├── rv-102-filename1.py
├── rv-201-filename3.py
└── rv-202-filename4.py
├── [Publish]/ || reports and docs
├── [Html]/ HTML site
├── [docs]/
├── _images/
├── _sources/
├── _static/
├── rv101-filename1.html
├── rv102-filename2.html
├── rv201-filename3.html
├── rv201-filename4.html
└── index.html HTML site entry point
├── rv101-filename1.rst intermediate rst files
├── rv102-filename2.rst
├── rv201-filename3.rst
└── rv202-filename4.rst
├── [Rstpdf]/ PDF from rst2pdf
├── [src]/ intermediate rst files
├── rv101-filename1.rst
├── rv102-filename2.rst
├── rv201-filename3.rst
└── rv202-filename4.rst
├── rv101-filename1.pdf PDF docs from rst2pdf
├── rv102-filename2.pdf
├── rv201-filename3.pdf
├── rv202-filename4.pdf
└── Report-Label.pdf PDF report from rst2pdf
├── [Texpdf]/ PDF from LaTeX
├── [src]/ intermediate rst files
├── rv101-filename1.rst
├── rv102-filename2.rst
├── rv201-filename3.rst
└── rv202-filename4.rst
├── rv101-filename1.pdf PDF docs from LaTeX
├── rv102-filename2.pdf
├── rv201-filename3.pdf
├── rv202-filename4.pdf
└── Report-Label.pdf PDF report from LaTeX
├── [Text]/ text report
├── rv101-filename1.txt text docs
├── rv102-filename2.txt
├── rv201-filename3.txt
├── rv202-filename4.txt
└── README.txt searchable text report
├── [Src] | source files from authors
├── [Data]/
├── data1.csv
├── steel-vals.csv
└── conc-vals.csv
├── [Shell]/
├── shell1.cmd
└── shell1.csv
├── [Image]/
├── fig1.png
└── fig2.jpg
├── [Scripts]/
├── plot.py
├── new-units.py define new units
└── opensees1.txt
├── [Gendoc]/
├── genhtml.cmd html generating script
├── genpdf.cmd pdf generating script
├── gentexpdf.cmd LaTeX generating script
├── rivt-report.py report generating script
├── Report-Cover.pdf
├── attach1.pdf
└── [Style]/ style files for docs
├── [Html]/ html style files
├── _locale/
├── _static/
├── _templates/
├── conf.py
├── genhtml.cmd
└── index.rst
├── [Rstpdf]/ rst2pdf style files
├── fonts/
└── style/
├── [Texpdf]/ pdftex style files
└── rivt.sty
├── [Text]/ text ini file
└── rv-text.ini
├── [Stored]/ || stored files from rivt
├── [Logs]/ log files
├── rv101-api.txt
├── rv101-log.txt
└── rv102-log.txt
├── [Sect]/ stored sections
├── rv202-5d.txt
├── rv103-4t.txt
└── rv301-2r.txt
├── [Temp]/ temp files
└── rv101-label3.tex
└── [Data]/
├── table1.csv stored script output
├── image1.png stored value files
├── v101-2.csv
└── v102-3.csv
└── README.txt || searchable text report