Scaffold - Predefined Variables in Global Scope

This page describes the variables located in "global scope". Other components like projects and generators are also capable of storing variables and have their own list of predefined variables. On top of these, the script engine reads all environment variables at the start of the execution and creates a variable for each (platform specific separators like ";" on Windows and ":" in unixes are used to split the value into components). Note that changing these values has no effect on the actual environment - use dedicated methods to set them.

PRJPATH

Prefered path for projects; PROJECT command assigns output paths based on it and the name of the project. To set this value simply run:
scaffold --savevar="PRJPATH=/some/path"
Only first entry is used by scaffold.

TPATH

Prefered path for templates; TEMPL command is the intended usage for it, when the directories containing template files are all grouped in a single place. To set this value simply run:
scaffold --savevar="TPATH=/some/path"
Scaffold does not use this variable internally.

CRTPATH

Current path for the application; since the application computes relative paths with respect to current control file, this variable must be used explicitly to indicate current directory.
The program sets this variable before first stage (executing statements in first control file).
Scaffold does not use this variable internally.

AUTHOR

Name of the author. To set this value run:
scaffold --savevar="AUTHOR=John Doe"
Scaffold does not use this variable internally.

AUTHOR_MAIL

Mail of the author. To set this value simply run:
scaffold --savevar="AUTHOR_MAIL=john.doe@work.lol"
Scaffold does not use this variable internally.

DMP_DELTRESH

diff_match_patch module variable¹
When deleting a large block of text (over ~64 characters), how close does the contents have to match the expected contents. (0.0 = perfection, 1.0 = very loose). Note that Match_Threshold controls how closely the end points of a delete need to match.
Defaults to 0.5. Only first entry is used by scaffold.

DMP_DIST

diff_match_patch module variable¹
It decides how far to search for a match (0 = exact location, 1000+ = broad match). A match this many characters away from the expected location will add 1.0 to the score (0.0 is a perfect match).
Defaults to 1000. Only first entry is used by scaffold.

DMP_EDITCOST

diff_match_patch module variable¹
Cost of an empty edit operation in terms of edit characters.
Defaults to 4. Only first entry is used by scaffold.

DMP_MARGIN

diff_match_patch module variable¹
Chunk size for context length.
Defaults to 4. Only first entry is used by scaffold.

DMP_TIMEOUT

diff_match_patch module variable¹
Number of seconds to map a diff before giving up (0 for infinity).
Defaults to 1. Only first entry is used by scaffold.

DMP_TRESH

diff_match_patch module variable¹
At what point is no match declared (0.0 = perfection, 1.0 = very loose).
Defaults to 0.5. Only first entry is used by scaffold.

• 1 diff_match_patch module is used only in second stage, after the control file has been interpreted. Before entering second stage these variables are looked up and, if set, their values are used to initialise diff_match_patch, otherwise the defaults are used.

Related source code documentation: