D.5 Markup by API

[1] rv.R Markup

The Run API function executes markup and scripts.

[1-1] rv.R Block Tags

Block Tag	Description
_[[PYTHON]] namespace	[7] Python
_[[MARKUP]] type	[8] Markup block
_[[END]]	[10] End block

---

[1-2] rv.R Commands

Command	Description
| PYTHON | relative path | namespace	[11] Python file
| MARKUP | relative path | type	[12] Markup file

---

[2] rv.I Markup

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

---

[2-1] rv.I Line Tags

Line Tag	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] Variable value
title _[T]	[11] Table number
caption _[F]	[12] Figure number

---

[2-2] rv.I Block Tags

Block Tag	Description
_[[BOX]] optional label	[6] Box
_[[TOPIC]] topic	[5] Topic
_[[END]]	[10] End block

---

[2-3] rv.I Commands

Command	Description
| 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 function defines values and evaluates equations and functions.

---

[3-1] Line Tags

Format a line of text

Line Tag	Description
text _[V] var_name | text	[10] Variable value
title _[]	[11] Table number
caption _[F]	[12] Figure number

---

[3-2] Block Tags

Format or execute a block of text

Block Tag	Description
_[[PYTHON]] namespace	[7] Python
_[[END]]	[10] End block

---

[3-3] Commands

Format files and calculations

Command	Description
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	[11] Python file
a ==: 1*IN | unit1, unit2, decimal, num | label	[8] Define value
c <=: expression | unit1, unit2, decimal, num | label	[9] Assign value
c :=: expression | unit1, unit2, decimal | label, number	[9] Function value
a < c | decimal | text1,text2,align, num	[10] Compare values

---

[4] rv.T Markup

The Tool API function executes shell commands.

---

[4-1] Block Tags

Block Tag	Description
_[[SHELL]] process parameters	[2] Shell script
_[[END]]	[10] End block

---

[4-2] Commands

Command	Description
| SHELL | relative path | os, wait	[2] Shell file

---

[5] rv.D Markup

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

---

[5-1] Block Tags

Block Tag	Description
_[[METADATA]] label	[9] Metadata
_[[END]]	[10] End block

[5-2] Commands

Command	Description
| PDFATTACH | relative path | place, cover	[13] Attach PDF
| PUBLISH | ini rel. path | type	[14] Publish doc