C.3 Block Tags

[1t] Block Tag Summary

---

Format blocks of text

API Scope	Block Tag	Description
rv.R	_[[SHELL]] process parameters	[2t] Shell script
rv.I	_[[INDENT]] spaces (4 default)	[3t] Indent text
rv.I	_[[ITALIC]] spaces (4 default)	[4t] Indent italic
rv.I	_[[ENDNOTES]] optional label	[5t] Endnotes
rv.I	_[[TEXT]] optional language	[6t] Text
rv.I	_[[TOPIC]] topic	[7t] Topic
rv.I	_[[BOX]] label	[8t] Box
rv.V,T	_[[PYTHON]] namespace	[9t] Python
rv.T	_[[MARKUP]] type	[10t] Markup block
rv.D	_[[METADATA]] label	[11t] Metadata
rv.D	_[[LAYOUT]] label	[12t] Layout block
all	_[[END]]	[13t] End block
all	_[[NEW PAGE]]	[14t] Start new page

[2t] Shell script

---

Runs shell scripts that run external programs. The shell parameters include specifying the operating system, process control and terminal window control. The os parameter specifies the terminal type. The wait parameter specifies whether rivt file processing waits for the script to complete before continuing. The open parameter specifies whether to keep the shell window open after execution.

_[[SHELL]]

Syntax:
    _[[SHELL]] win;mac;linux,wait; nowait,open; close
    shell command
    ...
    _[[END]]


Example:
    _[[SHELL]] win,nowait,open
    dir
    path
    _[[END]]

API Scope	Insert
Doc Types	text, PDF, HTML

[3t] Indent text

---

Indents text block the specified number of spaces.

_[[INDENT]]

Syntax:
    _[[INDENT]] number of spaces
    text
    text
    ...
    _[[END]]

Example:
    _[[INDENT]] 8
    This is a sentence that will be
    indented 8 spaces.
    _[[END]]

API Scope	Insert
Doc Types	text, PDF, HTML

[4t] Indent italic

---

_[[ITALIC]]

Italicizes and indents the text block the specified number of spaces.

Syntax:
    _[[ITALIC]] number of spaces
    text
    ...
    _[[END]]

Example:
    _[[ITALIC]] 4
    This is a sentence that will be
    italicized and indented 4 spaces.
    _[[END]]

API Scope	Insert
Doc Types	text, PDF, HTML

[5t] Endnotes

---

_[[ENDNOTES]]

Assigns numbers and formats endnotes in order of processing. Each endnote is separated by a blank line and is numbered in order of occurrence.

Syntax:
    _[[ENDNOTES]] label
    Endnote 1.

    Endnote 2.
    ...
    _[[END]]

Example:
    _[[ENDNOTES]] ACI citations
    This endnote is assigned to the first endnote tag (_[#]) in order of
    of processing.

    This second endnote is separated by a blank line and assigned
    to the second

    This is a third endnote.
    _[[END]]

API Scope	Insert
Doc Types	text, PDF, HTML

[6t] Text

---

_[[TEXT]]

Reads and formats text and code. The language parameter specifies formatting and syntax coloring. Languages include:

• literal

• python

• text

• sh

• cmd

Syntax:
    _[[TEXT]] language
    text and code
    ...
    _[[END]]

Example:
    _[[TEXT]] python
    # some code
    print(1)
    a = 1 + 3
    _[[END]]

API Scope	Insert
Doc Types	text, PDF, HTML

[7t] Topic

---

_[[TOPIC]]

Formats a topic block.

Syntax:
    _[[TOPIC]] topic title
    text
    ...
    _[[END]]

Example:
    _[[TOPIC]] topic title
    Text related to the topic.
    _[[END]]

API Scope	Insert
Doc Types	text, PDF, HTML

[8t] Box

---

_[[BOX]]

Draws a box around the block of text.

Syntax:
    _[[BOX]] optional label
    text
    ...
    _[[END]]

Example:
    _[[BOX]]
    This is a sentence.
    A second sentence.
    A box is drawn around the sentences.
    _[[END]]

API Scope	Insert
Doc Types	text, PDF, HTML

[9t] Python

---

_[[PYTHON]]

Executes Python script in the rivt namespace or a user specified namespace. File paths in the script are relative to the rivt file folder.

Syntax:
    _[[Python]] topic title
    code
    ...
    _[[END]]

Example:
    _[[PYTHON]] *rvspace*; user namespace
    b = 1*inch + 2.2*ft
    print(b)
    _[[END]]

API Scope	Value, Tool
Doc Types	text, PDF, HTML

[10t] Markup block

---

Inserts HTML into an HTML doc, LaTeX into a PDF doc, and reStructuredText into either PDF or HTML.

_[[MARKUP]]

Syntax:
    _[[MARKUP]] *html;latex;rst*
    markup
    ...
    _[[END]]

Example:
    _[[MARKUP]] rst
    This is **bold** and
    this is *italic* in
    reStructuredtext
    ...
    _[[END]]

API Scope	Tool
Doc Types	text, PDF, HTML

[11t] Metadata

---

_[[METADATA]]

Metadata is written to the rvAnn-apilog.py file and is converted internally to a Python dictionary rvmetaD with key name taken from the label e.g. docnameS or authorsD.

Synatax - defaults:
    _[[METADATA]] optional label
    docname = ""
    authors = ""
    version = 0.0.0
    email = ""
    repo = ""
    license = https://opensource.org/license/mit
    fork1 = author, version, email, repo
    fork2 = author, version, email, repo
    _[[END]]

Example:
    _[[METADATA]]
    docname = Bearing Pressures
    authors = rholland, rward
    version = 0.1.1
    email = rholland@email.com
    repo = https://github.com/rivt-info/rivt-simple-doc
    license = https://opensource.org/license/mit
    _[[END]]

API Scope	Docs
Doc Types	text, PDF, HTML

[12t] Layout block

---

Overrides default layout settings.

_[[LAYOUT]]

Syntax - defaults:
    _[[LAYOUT]] optional label
    variables
    ...
    _[[END]]

Example:
    _[[LAYOUT]]
    docname = ""
    footer = date, docname, page
    _[[END]]

API Scope	Doc
Doc Types	text, PDF, HTML

[13t] End block

---

_[[END]]

Terminates a block tag.

Syntax:
    _[[NEWPAGE]] optional label

Example:
    _[[END]]

API Scope	All
Doc Types	text, PDF, HTML

[14t] Start new page

---

_[[NEWPAGE]]

Starts new page.

Syntax:
    _[[NEWPAGE]] optional label

Example:
    _[[NEWPAGE]]

API Scope	All
Doc Types	PDF