Reference Table
The reftable environment is used to create a special purpose table for describing functions, methods, and operators in a programming language. It is derived from the tabular environment and accepts all of the same arguments, but defines two additional arguments specific for this table. In the description below, only the most commonly used arguments are included.
tables module
\begin{reftable}[
term='Function'
descp='Description'
width=#
colwidth='30%|'
colalign='l|l'
colclass='refterm|'
headalign='c|c'
class=reftable
style=names]
\row{function}{
This is the description which can flow across multiple lines.}
\row{leftcol-value}{rightcol-value}
\end{reftable}
Used to build a table that provides a reference summary of various functions, methods, and operators in a programming language The table is comprised of two columns: the left column contains the function or method and the right column contains the description. The left column is narrower and does not wrap, while the right column typically includes multiple lines of text. Note that only the normal \row command can be used in this table.
Keys:
- term
-
The header for the left column. The default is Function.
- descp
-
The header for the right column. The default is Description.
Plugin: ReferenceTable
An example of a reference table is provided below:
Example
source
- \begin{reftable}[
- term='Symbolic Name' descp='Purpose'
- colalign='c|l']
- \row{$zero}{stores the immediate value of 0.}
- \row{$t0 - $t9}{general purpose, for temporary values.}
- \row{$s0 - $s7}{general purpose, saved between function calls.}
- \row{$a0 - $a}{passing function arguments.}
- \row{$v0 - $v1}{stores function return values.}
- \end{reftable}
| Symbolic Name | Purpose |
|---|---|
| $zero | stores the immediate value of 0. |
| $t0 - $t9 | general purpose, for temporary values. |
| $s0 - $s7 | general purpose, saved between function calls. |
| $a0 - $a | passing function arguments. |
| $v0 - $v1 | stores function return values. |
results