A.2 Terms#
[1t] rivt Terms#
- API header#
- API headers#
The first line of a rivt string. It includes a section title, followed by comma separated parameters.
- API log#
API excecution history written to log folder as the file rvDss-api.rst. For the complete execution history see the rivt log file rvDss-log.txt.
- block tag#
A block tag formats a block of text that begins with _[[TAG]] and terminates with _[[Q]].
- command#
- commands#
rivt commands read and write external files and assign values to variables. They start in the initial columns with a vertical bar ( | ) followed by the file path, name and parameters. The path is relative to the rivt report root folder. If the metadata variable rv_localB is set to true resources will be read from and written to the local rivt file folder.
| COMMAND | relative path | parameters
- content#
- content text#
- content substring#
The text in a rivt string that follows the header substring. The text is utf-8 (Unicode Transformation Format - 8-bit), a character encoding standard that is a superset of ASCII, handles text from any language, and is constant across all platforms.
- division#
A group of related rivt files organized in a report and labeled in the rivt file name. Optionally organized in a division folder.
- doc#
- docs#
A formatted document file output using the rivtlib package. A doc is a text, PDF or HTML file with the default name of the rivt file and file type suffix.
- doc number#
Prefix of a rivt and doc file name and used to organize a report. It has the form rvDss-filename.py where D is a capital alphanumeric division number and ss is the subdivision number.
- header#
- headers#
- header text#
- header substring#
The first line of a rivt string. It includes a section title, followed by comma separated parameters.
- line tag#
A line tag has the form _[TAG] and formats a line of text.
- report#
- reports#
- rivt report#
A group of compiled docs organized by rivt file number.
- report folder#
- report folders#
The folder structure for producing a report is described here.
- report script#
A Python script that assembles docs into a report.
- rivt#
An open source Python project that includes rivtlib and approximately two dozen Python packages. When rivt is installed docs and reports may be edited and published using a text editor.
- rivt doc#
- rivt docs#
A formatted document file output from a rivt file using the rivtlib package. A doc is a text, PDF or HTML file with the default name of the rivt file and file type suffix.
- rivt file#
- rivt files#
A Python file that imports rivtlib and includes rivt markup.
- rivt file number#
Prefix of rivt file name used to organize a report (rvDss-). It has the form rvDss-filename.py where D is a capital alphanumeric division number and ss is the subdivision number.
- rivt folder#
A folder containing a rivt file and all of its resources in the same folder. Generally used
- rivt framework#
- framework#
The recommended rivt-framework includes the following separately installed programs:
VSCode <https://code.visualstudio.com/> and VSCode extensions <https://marketplace.visualstudio.com/vscode>. rivt extensions and snippets are here.
Git <https://git-scm.com> and set up a GitHub <hhttps://github.com>
LaTeX <https://www.tug.org/texlive/>
QCAD <https://qcad.io/en/>
- rivt log file#
rivt file execution log written to the log folder as rvDss-log.txt.
- rivt markup#
A light weight markup that wraps restructuredText and outputs reports in text, PDF and HTML. Markup is included in string arguments to rivt API functions.
- rivt report folder#
A folder containing multiple rivt files to be organized in a report and resources organized in subfolders
- rivt string#
Triple quoted string argument to an API function.
- rivtlib#
Open source Python package that generates docs and reports from a rivt file
- rvspace#
rivt alias name for the global rivt file namespace. Other user namespaces may be specified
- section parameter#
- section parameters#
Comma separated parameters in a header that specify the section processing.
- single doc#
- single docs#
A single doc is a rivt file that publishes a doc that is not part of a report and is used for quick docs that only require limited formatting.
It is specified in a comment variable directly after the rivtlib import statement.
# rv singledoc = True
The default setting is False. The rivt file folder is used for source and output files. A folder structure is not used.
[2t] Python Terms#
- docutils#
A Python package that processes restructured text files into HTML, LaTeX, and other formats.
- namespace#
Provides scope for functions and variables.
- Python#
A programming language that lets you work quickly and integrate systems more effectively
- restructuredtext#
- restructuredtext markup#
A lightweight markup language designed to be processed by document software including docutils, Sphinx and rivt.
[3t] GitHub and VSCode Terms#
- Codespace#
- Codespaces#
An online VSCode environment by Microsoftthat is integrated with GitHub.
- fork#
- forked#
A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project. Most commonly, forks are used to either propose changes to someone else’s project or to use someone else’s project as a starting point for your own idea.
- Git#
A version control system that lets you manage and keep track of your source code history.
- IDE#
Integrated Development Environment. A software application that provides comprehensive facilities to computer programmers for software development. An IDE typically includes a code editor, build automation tools, and a debugger. rivt extensions are mostly developed for VSCode. Other examples include PyCharm, Spyder, and JupyterLab.
- profile#
Allows VSCode users to customize their environment for different workflows, projects, or tasks. This feature provides a way to manage distinct configurations of settings, extensions, keyboard shortcuts, snippets, and tasks.
- repo#
- repository#
a storage location for software packages
- rivt Codespace#
A Codespace set up with extensions, snippets and keyboard shortcuts for editing and publishing rivt docs.