1.2 Terms

KEY

---

term : context (rivt, python, docutils, github, os)

Definition

A

---

B

---

C

---

D

---

doc : rivt

A formatted document file output by rivt. The file is a text, PDF or HTML file.

docutils : python

A Python package that processes restructured text files into HTML, LaTeX, and other formats.

division : rivt

An ordered group of rivt docs that make up part of a report.

E

---

F

---

framework : rivt

The rivt framework includes:

• Python and libraries

• VSCode and extensions

• Git

The extended framework includes:

• LaTeX

• QCAD

figure : rivt

An imported image file (.png, .jpg) with optional caption.

footnote : rivt

A pair of tags defining the location and definition af an endnote.

G

---

github : github

A platform that allows developers to create, store, manage, and share their code.

H

---

I

---

J

---

K

---

L

---

LaTeX : os

A software system for typesetting documents, based on TeX.

M

---

markup : rivt

a text system that specifies document structure and formatting

namespace : Python

provides scope for functions and variables

N

---

O

---

P

---

public rivt : rivt

project folder containing private files not uploaded when sharing templates

Q

---

qcad : rivt

a computer-aided design (CAD) software application for 2D design and drafting.

R

---

repo

short for a GitHub or other repository

report : rivt

collated collection of docs

repository

a storage location for software packages

restructured text : Python

a lightweight markup language designed to be processed by document software such as Docutils and rivt, and readable by humans.

rivt : rivt

an open source markup language and framework for writing and publishing engineering documents.

rivt file : rivt

text file (.py) that imports the rivtlib package

rivt markup : rivt

a text system that specifies document structure and formatting using tags, commands and restructured text markup.

rivt.zip : rivt

single folder portable installation of rivt

rivtlib : rivt

Python package that generates docs and reports from a rivt file

S

---

section : rivt

part of a rivt doc

standalone doc : rivt

a doc produced by a rivt file that does not have a report prefix and with resource files located in the same folder as the rivt file

T

---

template

a rivt file that is used as a starting point for a new doc or report

text file : Python

a file that contains human-readable characters, such as letters, numbers, and symbols, typically encoded in UTF-8 format

U

---

V

---

VSCode : rivt

A source code editor developed by Microsoft for Windows, Linux and macOS with support for debugging, syntax highlighting, intelligent code completion, snippets, code refactoring, and embedded Git.

W

---

X

---

Y

---

Z

---