C.4 Insert - rv.I

<i>

[1] TAG KEY

---

line tags format a line of text and are denoted with _[TAG] at the end of the line. Block tags format a block of text that begin with _[[TAG]] on the first line and end with _[[Q]] after the last line.

_[TAG] : line tag description

---

syntax : description

example

outputs: types of output

_[[TAG]] : block tag description

syntax : description

example

outputs: types of output

---

<i>

[2] _[#] : endnote number

---

text _[#]

Text is wrapped when formatted. _[#]

This tag assigns an endnote number to the text. Endnotes are defined with the block tag _[[NOTE]] and are listed at the end of the doc. Numbers are assigned in the order they are processed.

outputs: text, pdf, html

<i>

[3] _[H] or ______ : horizontal line

---

_[H] or 4 or more underscores

or some text _[H]

Draws a horizontal line the width of the page.

outputs: text, pdf, html

<i>

[4] _[A] : ASCII math

---

equation _[A]

f(x,y) = sin(x)**2 + y/5 _[A]

The math expression will be formated in ASCII text.

outputs: text, pdf, html

<i>

[5] _[L] : LaTeX math

---

equation _[L]

frac{1}{sqrt{x}} _[L]

The LaTeX math expression will be formatted in PDF and HTML.

outputs: pdf, html

<i>

[6] _[C] : center

---

text _[C]

This text will be centered _[C]

Center text within the page margins.

outputs: text, pdf, html

<i>

[7] _[E] : equation label

---

equation label _[E]

Equation label _[E]

Labels and numbers equation.

outputs: text, pdf, html

<i>

[8] _[I] : image label

---

caption _[I]

Image label _[I]

Labels and numbers images.

outputs: text, pdf, html

<i>

[9] _[T] : table label

---

title _[T]

Table Title _[T]

Labels and numbers tables.

outputs: text, pdf, html

<i>

[10] _[S] : link sections

---

text _[S]

text at end of line _[s] section number, link label

Links sections within a doc. Text will be continued and wrapped when formatted.

outputs: text, pdf, html

<i>

[11] _[D] : link docs

---

text _[D] doc link

text at end of line _[S] doc number, link label

Links docs within a report. Text will be continued and wrapped when formatted.

outputs: text, pdf, html

<i>

[12] _[U] : external url

---

text _[U] url link

text at end of line _[U] urlname, link label

External url link. Text will be continued and wrapped when formatted.

outputs: text, pdf, html

<i>

[13] _[P] : new page

---

text _[P]

end of line. _[P]

Starts a new page. Pages indicated with double dashed line in text output.

outputs: text, pdf, html

<i>

[14] _[[TEXT]] : literal text or code

---

_[[TEXT]] language or literal

_[[TEXT]] python
print("some text")
b = 3 + 5
...
_[[QUIT]]

This block formats text as literal or code. The parameters specify formatting and syntax coloring. Languages include: - python - bash - sh - cmd

outputs: text, pdf, html

<i>

[15] _[[LATEX]] : LaTeX

---

_[[L]]

_[[L]]
\frac{\alpha}{\beta}
\sum_{n=1}^{10} n
...
_[[QUIT]]

Formats LaTeX, which needs to be installed.

outputs: pdf, html

<i>

[16] _[[NOTE]] : endnote text

---

_[[NOTE]]

_[[NOTE]]
this is an endnote - assigned to an endnote tag [#] in order of
of processing.
_[[QUIT]]

Formats and numbers an endnote in order of processing.

outputs: text, pdf, html

<i>

[17] _[[ITALIC]] : indent italic

---

_[[I]] spaces

_[[ITALIC]] 4
text
text
...
_[[QUIT]]

Indents the specified number spaces and italicizes block.

outputs: pdf, html

<i>

<i>

[18] _[[INDENT]] : indent text

---

_[[INDENT]] spaces

_[[INDENT]] 4
text
text
...
_[[QUIT]]

Indents text four spaces.

<i>

[19] _[[TOPIC]] : topic

---

_[[TOPIC]] topic title

_[[TOPIC]] topic title
text
text
...
_[[QUIT]]

Formats a highlighted block.

outputs: pdf, html

<i>

[20] COMMAND KEY

---

| COMMAND | relative path | parameters

example

Commands read and write files. The relative path is relative to the rivt file.

outputs: types of outputs

[21] | IMAGE | : insert image

---

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

IMG | src/file1.png | .50, Map _[I]

Reads PNG and JPEG files (.png, jpg) and inserts them in the doc. The Image tag may be added to the captions.

outputs: PDF, HTML

<i>

[22] | IMAGE2 | : insert adjacent images

---

| IMAGE2 | rel path1, rel path2| sc1, sc2, cap1 (_[I]), cap2 (_[I])

IMAGE2 | src/file1.png, src/file2.png | .50, .40, Map _[I], Plan _[I]

Reads PNG and JPEG files (.png, jpg) and inserts them side by side in the document. The Image tag may be added to the captions.

outputs: PDF, HTML

<i>

[23] | TABLE | : format table

---

| TABLE | relative path | width, l;c;r, title (_[T])

TABLE | src/file1.csv | 30, c, Forces _[T]

Reads text, csv and EXCEL files (.txt, .csv, .xls) and outputs formatted tables. The width parameter specifies the maximum column width. The l,c,r parameter specifies cell justification (left, center, right). The Table tag may be added to the caption.

outputs: text, PDF, HTML

<i>

[26] | TEXT | : format text

---

| TEXT | relative path | literal; code

TEXT | src/file1.py | python

Reads and formats text and code files. The parameters specify formatting and syntax coloring. Languages include:

• python

• bash

• sh

• cmd

outputs: text, PDF, HTML