D.1 Line Tags

[1] Line Tag Summary

Format a line of text ========== ==================================================== ================================ API Scope Line Tag Description ========== ==================================================== ================================ rv.I text _[#] text [6] Endnote number rv.I text _[D] label, filename | text [3] Download link rv.I text _[G] glossary term | text [7] Glossary link rv.I text _[S] label, section | text [8] Section link rv.I text _[U] label, url | text [9] URL link rv.I,V title _[T] [11] Table number rv.I,V caption _[F] [12] Figure number rv.I,V text _[C] [2] Bold center text rv.I,V text math _[M] description [4] Text math rv.I,V LaTeX math _[L] description [5] LaTeX math rv.I,V text _[V] var_name | text [10] Variable value all ## text nonprinting comment ========== ==================================================== ================================

[2] Bold center text

Center line of text within the page margins.

_[C]

Syntax:
    text _[C]

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

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

---

[3] Download link

Insert a download link.

_[D]

Syntax:
    text _[D] label, filename | text

Example:
    This is a link to _[D] my file, my_file.pdf | for download.

API Scope	Insert
Doc Types	text, PDF, HTML

---

[4] Text math

Format math expression into text.

_[M]

Syntax:
    text math expression  _[M]

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

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

---

[5] LaTeX math

Format LaTeX math expression.

_[L]

Syntax:
    LaTeX math expression  _[L]

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

API Scope	Insert, Values
Doc Types	PDF, HTML

---

[6] Endnote number

Assign 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, Values
Doc Types	text, PDF, HTML

---

[7] Glossary link

Link 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, Values
Doc Types	PDF, HTML

---

[8] Section link

Create 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, Values
Doc Types	PDF, HTML

---

[9] URL link

Link 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, Values
Doc Types	PDF, HTML

---

[10] Variable value

Insert 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

---

[11] Table number

Label and number tables.

_[T]

Syntax:
    Table Title  _[T]

Example:
    A New Table _[T]

API Scope	Insert
Doc Types	text, PDF, HTML

---

[12] Figure number

Labels and numbers figures.

_[F]

Syntax:
    Figure caption _[F]

Example:
    Stress Distribution _[F]

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