C.2 Metadata - rv.M

<i>

[1] Definitions

---

The Metadata API function is always the first API function if used. The function provides metadata for doc processing and overriding defaults. Metadata is specified as Python dictionaries, lists and variables and uses the convention of a capital variable suffix indicating the data type.

<m>

[2] Dictionaries

rv_authD specifies the author, version, email, repository and license information and lists the forks. rv_forknD specifies data for the forked file. The rv_authD is always included.

---

# default - author dictionary
rv_authD = {
        "authors": "",
        "version": "0.0.0",
        "email": "",
        "repo": "",
        "license": "https://opensource.org/license/mit/",
        "forks": ["", "", "", ""],
        }

# example - author dicitionary
rv_authD = {
        "authors": "rholland",
        "version": "0.6.1",
        "email": "rod.h.holland@gmail.com",
        "repo": "https://github.com/rivt-info/rivt-simple-doc",
        "license": "https://opensource.org/license/mit/",
        "forks": ["rv_fork1D", "", "", ""],
        }

#example - fork dictionary
rv_fork1D = {
        "authors": "",
        "version": "0.1.0",
        "email": "",
        "repo": "",
        }

<i>

[3] Lists

---

rv_headerL specfies the contents and order of the doc per page heading.

# default - header list
rv_headerL = ["date", "time", "file", "version"]

# example - header list
rv_headerL = ["date", "file", "authors", "version"]

<i>

[4] Variables

---

rv_localB overrides the default report structure and specifies that the values and logs files are written to the local rivt folder.

# default - folder setting
rv_localB = false

# example - folder setting override
rv_localB = true

rv_docnameS overrides the default doc title derived from the rivt file name.

# default - doc name override
 rv_docnameS = "" # does not override default name

 # example - folder setting override
 rv_docnameS = "My Document Title"