C.4 Values - rv.V

<i>

[1] Summary

---

The Value API function inserts static sources including images, tables and formatted text.

Line Tags	Description (doc scope)
text _[#]	endnote number (all)
text _[C]	center text (all)
text _[R]	right justify text (all)
label _[E]	equation number and label (all)
caption _[I]	image number and caption (all)[1]
title _[T]	table number and title (all)[1]
text _[S] section link	link section within doc (all)
text _[D] report link	link doc within report (all)
text _[U] external url	external url link (all)
-----	>4 dashes inserts line (all)[2]
=====	>4 underscores inserts page (all)[2]

[1] tag may be added to the label parameter in the IMAGE and TABLE commands

[2] must start in first indented column (absolute column 4)

Block Tags	Description (doc scope)
_[[INDENT]] spaces (4 default)	Indent (all)
_[[ITALIC]] spaces (4 default)	Italic indent - (all)
_[[NOTES]] optional label	Endnote descriptions (all)
_[[TEXT]] optional language	literal, code (all)
_[[TOPIC]] topic	Topic (all)
_[[VALUES]] table title (_[T])	Define values(all)
_[[END]]	End block (all)

Command | path | parameters	R/W	input types
| IMAGE | relative path | scale, caption (_[I])	R	.png, .jpg
| IMAGE2 | relative path | s1, s2, c1, c2 (_[I])	R	.png, jpg
| TABLE | relative path | width, l;c;r, title	R	csv, txt, xlsx
| TEXT | relative path | normal;literal ;code	R	txt, code
| VALUES | relative path | title, show;hide (_[T])	R	csv
a := 1*IN | unit1, unit2, decimal | label (_[E])[1]	W	define value
b <= a + 3*FT | unit1, unit2, decimal | label (_[E])	W	assign value
c <= func1(x,y) | unit1, unit2, decimal | label (_[E])	W	assign value

[1] The equation tag (_[E]) is ignored when values are defined in a block

<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] _[C] : center text

---

text _[C]

This text will be centered _[C]

Center text within the page margins.

outputs: text, pdf, html

<i>

[4] _[R] : right justify text

---

equation _[L]

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

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

outputs: pdf, html

outputs: text, pdf, html

<i>

[5] _[E] : equation label

---

equation label _[E]

Equation label _[E]

Labels and numbers equation.

outputs: text, pdf, html

<i>

[6] _[I] : image label

---

caption _[I]

Image label _[I]

Labels and numbers images.

outputs: text, pdf, html

<i>

[7] _[T] : table label

---

title _[T]

Table Title _[T]

Labels and numbers tables.

outputs: text, pdf, html

<i>

[8] _[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>

[9] _[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>

[10] _[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>

[11] ______ : 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>

[12] ======== : 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>

[13] _[[INDENT]] : indent text

---

_[[INDENT]] spaces

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

Indents text four spaces.

<i>

[14] _[[ITALIC]] : indent italic

---

_[[I]] spaces

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

Indents the specified number spaces and italicizes block.

outputs: pdf, html

<i>

[15] _[[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>

[16] _[[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>

[17] _[[TOPIC]] : topic

---

_[[TOPIC]] topic title

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

Formats a highlighted block.

outputs: pdf, html

<i>

[18] _[[VALUES]] : topic

---

_[[VALUES]] topic title

_[[VALUES]] topic title
c_1 := 5*unit | unit1, unit2, decimal | label
c_2 := 2.2*unit | unit1, unit2, decimal | label
...
_[[QUIT]]

Defines values and writes them to out folder.

outputs: pdf, html

<i>

[19] | 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>

[20] | 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>

[21] | 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>

[22] | TEXT | : format text

---

| TEXT | relative path | literal; code type

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

<i>

<i>

[23] | VALUES | : table title

---

| VALUES | relative path | show;hide

VALUES | src/data/newvals.csv | show

Defines values and writes them to out folder.

outputs: pdf, html

[24] := : define value

---

c := 5*unit | unit1, unit2, decimals | label

D_1 := 10*IN | IN, M, 3 | beam depth

Defines a value and writes to a file vnum-s.csv where num is the doc number and s is the section number. The file is written to the folder out/values unless rv_localB is set to True in the Meta API function.

outputs: text, PDF, HTML

<i>

[25] <= : assign value

---

b <= a * 10*FT | unit1, unit2, decimals | label (_[E])

b_1 <= E_1 * 12.1*IN^2 | KIP, KN, 2 | Std. 123

c <= func1(a,b) | KIP, KN, 2 | ACI 318-19 Table 22.5.5.1

Assigns a value to an equation or function variable and writes the values to a file vnum-s.csv where num is the doc number and s is the section number. The file is written to the folder out/values unless rv_localB is set to True in the Meta API function.

outputs: text, PDF, HTML