Glossary
The words these docs use for the parts of CodeBaker, each with one meaning. If a page uses another word for one of these, it is a mistake: please tell us.
| Word | What it is |
|---|---|
| Template | A folder .CodeBaker/<id>/ in your project: the files to generate, a codebaker.config.json5, and optionally a mapping file. See Template Basics. |
| Variable | A named value the template can use. It comes from vars, from the JSON area of the dialog, or from the system properties, and its value is what you type in the dialog. |
| Field | A text box of the dialog. Each entry of vars is one field, with its value as the default. See Values and Variables. |
| JSON area | The editable box under the fields, filled from the json section of the config. It holds lists and objects, and each of its top-level keys is a variable. See Values and Variables. |
| Resolve | To compute a value written with {{ ... }} from the values already known: the vars from the top down, then the JSON area. See Values and Variables. |
| Placeholder | A variable written inside a template file as ___name___ (a style you declare under placeholders). The same value can also be written as the Pebble expression {{ name }}. |
| Directive | A comment that starts with CodeBaker:. CodeBaker reads it and turns it into a Pebble tag, a rule, a slot marker or a separator, so the template stays a valid file of its own language. See Template Basics. |
| Rule | A replace or regex directive. It changes text from its own line downwards. See Inline & Block Replace. |
| Raw block | Text between {% raw %} and {% endraw %} (the same as verbatim), or a printed string such as {{ 'text' }}. It comes out exactly as written. |
| Mapping file | codebaker.advanced.json5: says where each template file goes and how it is written (renamed, repeated, written once, merged into another file). See Advanced Templates. |
| Entry | One item of the mapping file: a source path with its target and, if needed, its type. |
| Slot | A named place inside a file that an insert or replace entry fills. |
| Fragment | A block with an id that an insert puts into a slot; the same id later replaces it. |
| Seed | A file that is written once and then left alone. The word also names the starter content (seed:) of an insert or json-upsert target that does not exist yet. |
| Generation | One run through the four steps of the dialog, from the form to the written files. See the Generation Workflow. |