| Author | DaveJarvis <email> |
|---|---|
| Date | 2025-08-29 12:50:36 GMT-0700 |
| Commit | 89177b9f564085fa923ab31d1b14f784f3c2b39c |
| Parent | 9e46554 |
| Delta | 24 lines added, 8 lines removed, 16-line increase |
| # Variable definitions | ||
| -Variable definitions provide a way to insert key names having associated values into a document. The variable names and values are declared inside an external file using the [YAML](http://www.yaml.org/) file format. Simply put, variables are written in the file as follows: | ||
| +Variable definitions provide a way to insert key names having associated values into a document. The variable names and values are declared inside an external file using the YAML file format. Simply put, variables are written in the file as follows: | ||
| ``` | ||
| ## Document editing | ||
| -The application's purpose is to completely separate the document's content from its presentation. To achieve this, documents are composed using a [plain text](http://spec.commonmark.org/0.28/) format. | ||
| +The application helps separate the document's content from its presentation. To achieve this, documents are first written in a [plain text](http://spec.commonmark.org/0.28/) format, converted to XHTML, then typeset as required. The act of typesetting adds presentation styling (colours, fonts, layout, etc.) to the final output document. | ||
| ### Create document | ||
| Let's assume that the variable definitions loaded into the application include: | ||
| -``` | ||
| +``` yaml | ||
| novel: | ||
| title: Diary of {{novel.author}} | ||
| -# Variables | ||
| +# Screenshots | ||
| + | ||
| +This chapter provides application screenshots from an older version. | ||
| + | ||
| +## Variables | ||
| Diagrams that include variables: | ||
|  | ||
| + | ||
| +:: GraphViz diagram | ||
|  | ||
| -# PDF themes | ||
| +:: Family tree diagram | ||
| + | ||
| +## PDF themes | ||
| In the background of the following screenshot, the editor shows a novel | ||
| being edited: | ||
|  | ||
| + | ||
| +:: PDF Themes | ||
| Highlighted items of note: | ||
| * Preferences dialog in the middle | ||
| -# Internationalization | ||
| +## Internationalization | ||
| Poem with locale settings: | ||
|  | ||
| -# Equations | ||
| +:: Locale settings | ||
| + | ||
| +## Equations | ||
| TeX equations with detached preview: | ||
|  | ||
| -# Dockable tabs | ||
| +:: TeX equations | ||
| + | ||
| +## Dockable tabs | ||
| Document outline opened and docked in bottom-left corner: | ||
|  | ||
| + | ||
| +:: Document outline | ||