C.2 Line Tags

[1t] Line Tag Summary

---

Format a line or partial line of text

API Scope	Line Tag	Description
rv.I	text _[C]	[2t] Center text
rv.I	text _[R]	[3t] Right justify text
rv.I	text math _[M]	[4t] Text math
rv.I	LaTeX math _[L]	[5t] LaTeX math
rv.I	text _[#] text	[6t] Endnote number
rv.I	text _[G] glossary term	[7t] Glossary link
rv.I	text _[S] text, section label	[8t] Section link
rv.I	text _[D] text, rivt_file	[9t] Doc link
rv.I	text _[U] text, url	[10t] URL link
rv.V, I	text _[V] var_name text	[11t] Variable value
rv.V, I	assign cmd or label _[E]	[12t] Equation number
rv.V, I	title _[T]	[13t] Table number
rv.V, I	caption _[F]	[14t] Figure number

[2t] Center text

---

Centers line of text within the page margins.

_[C]

Syntax:
    text _[C]

Example:
    This text wil be centered. _[C]

API Scope	Insert
Doc Types	text, PDF, HTML

[3t] Right justify text

---

Right justifies line of text within the page margins.

_[R]

Syntax:
    text _[R]

Example:
    This text wil be right justified _[R]

API Scope	Insert
Doc Types	text, PDF, HTML

[4t] Text math

---

Formats a text math expression.

_[M]

Syntax:
    text math expression  _[M]

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

API Scope	Insert
Doc Types	text, PDF, HTML

[5t] LaTeX math

---

Formats a LaTeX math expression in the font specified in the style files.

_[L]

Syntax:
    LaTeX math expression  _[L]

Example:
    \frac{1}{\sqrt{x}} _[L]

API Scope	Insert
Doc Types	PDF, HTML

[6t] Endnote number

---

Assigns endnote number to the text in order of processing. Endnotes are defined with the block tag _[[ENDNOTE]] and are listed at the end of the doc.

_[#]

Syntax:
    text _[#] more text

Example:
    This is a sentence with an endnote _[#] tag.

API Scope	Insert
Doc Types	text, PDF, HTML

[7t] Glossary link

---

Links a term to the glossary.

_[G]

Syntax:
    text _[G] glossary term

Example:
    A definition of _[G] namespace
    is provided in the glossary.

API Scope	Insert
Doc Types	PDF, HTML

[8t] Section link

---

Creates a link to the section label defined in the API header with optional link text. If the text is ommitted the section label is used for the link.

_[S]

Syntax:

text _[S] link text, section title

Example:

This creates a link to _[S] Section Title, actual section label which provides more detail.

API Scope	Insert
Doc Types	PDF, HTML

[9t] Doc link

---

Links to a doc in a report with an optional link text. If the link text is ommitted the doc title will be inserted as the link term.

_[D]

Syntax:
    text _[D] text, rivt_file

Example:
    This is a link to _[D] rv101-filename1
    for reference.

API Scope	Insert
Doc Types	PDF, HTML

[10t] URL link

---

Links to a an external site with optional link text. If the link text is ommitted the url will be inserted as the link term.

_[U]

Syntax:
    text _[U] link label ,external url

Example:
    text _[U]  github, https://www.github.com

API Scope	Insert
Doc Types	PDF, HTML

[11t] Variable value

---

Inserts the value of var_name _[V] in the sentence.

_[V]

Syntax:
    text var_name _[V] more text

Example:
    The value of my_var is my_var _[V].

API Scope	Insert, Values
Doc Types	text, PDF, HTML

[12t] Equation number

---

If the line of text is math text or a label, the text is assigned an equation number and right justified. If the line is an equation assignment the equation label is used for the label text.

_[E]

Syntax:
    math text or label _[E]

    assignment command _[E]

Example:
    3x * 4/(1+n) _[E]

    x <= 3*IN + 4.1*FT | inch, cm, 2 | example 1 _[E]

API Scope	Insert, Values
Doc Types	text, PDF, HTML

[13t] Table number

---

Labels and numbers tables.

_[T]

Syntax:
    Table Title  _[T]

Example:
    A New Table _[T]

API Scope	Insert, Values
Doc Types	text, PDF, HTML

[14t] Figure number

---

Labels and numbers figures.

_[F]

Syntax:
    Figure caption _[F]

Example:
    Stress Distribution _[F]

API Scope	Insert, Values
Doc Types	text, PDF, HTML