D.4 | API Scopes

[1] rv.R Markup

The Run API processes text and scripts. It does not use markup. The header substring takes an additional parameter that specifies the type of text or script. The header substring has the form:

rv.R("""Section title | script_type, other parameters""")

script type	Description
endnotes	Footnotes separated by blank line, in order
python	Python script
literal	literal text
rst	reStructuredText
html	HTML markup
mermaid	Mermaid diagram (requires mermaid installation)
latex	LaTeX (requires LaTeX installation)

---

[2] rv.I Markup

The Insert API inserts and formats static sources into the doc, including images, tables, links and formatted text.

Tags / Commands / Assignment	Description
text _[C]	[2] Bold center text
text math _[M] description	[4] Text math
LaTeX math _[L] description	[5] LaTeX math
text _[#] text	[6] Endnote number
text _[G] text, term	[7] Glossary link
text _[S] text, section link	[8] Section link
text _[U] text, label	[9] URL link
text _[V] var_name text	[10] Substitute value
title _[T]	[11] Table number
_[[TEXT]] optional label	[2] Text block
_[[TOPIC]] topic	[1] Topic
_[[END]]	[8] End block
| IMAGE | relative path | scale, caption, figure	[5] Image file
| IMAGE2 | rel path1, rel path2 | s1, s2, c1, c2, fig1, fig2	[6] Adjacent images
| TEXT | relative path | language	[3] Text file
| TABLE | rel path | title, width, rows, align, head	[4] Table file

---

[3] rv.V Markup

The Values API defines values and evaluates equations and functions.

Tags / Commands / Assignment	Description
_[[TEXT]] optional label	[2] Text block
_[[PYTHON]] namespace	[4] Python block
_[[END]]	[8] End block
TABLE | rel path | title,width,rows,align,head,num	[4] Table file
IMAGE | relative path | scale, caption, figure	[5] Image file
IMAGE2 | rel path1, rel path2 | c1, c2, s1, s2, f1, f2	[6] Adjacent images
VALTABLE | rel path | title, width, rows	[7] Valtable file
PYTHON | relative path | namespace	[8] Python file
a ==: 1*IN | unit1, unit2, decimal, num | label	[2] Define values | ==:
c <=: expression | unit1, unit2, decimal, num | label	[3] Assign expression values | <=:
c :=: expression | unit1, unit2, decimal | label, number	[9] Function
a < c | decimal | text1,text2,align, num	[5] Compare values | <=

---

[4] rv.T Markup

The Tool API executes shell commands.

Command	Description
_[[SHELL]] process parameters	[6] Shell script
_[[END]]	[8] End block
| SHELL | relative path | os, wait	[2] Shell file

---

[5] rv.D Markup

The Doc API publishes formatted docs from the rivt API strings.

Tags / Commands / Assignment	Description
_[[METADATA]] label	[7] Metadata
_[[END]]	[8] End block
| PDFATTACH | relative path | place, cover	[11] Attach PDF
| PUBLISH | doc title | type	[12] Publish doc