Dave Jarvis' Repositories
git clone https://repo.autonoma.ca/repo/keenwrite.git
Fixes grammar issues, adds notes, defines sigil
| Author | DaveJarvis <email> |
|---|---|
| Date | 2025-09-05 01:29:42 GMT-0700 |
| Commit | 3d1701064f51c7b17770fdd0b4fe833d97930360 |
| Parent | 4d7ee4c |
| Delta | 49 lines added, 33 lines removed, 16-line increase |
docs/01-introduction.md
| * **Variable interpolation** enables a single source of truth for content | ||
| * **Internationalization** with font handling for multiple languages | ||
| +* **Mathematical** equations and formulas rendered beautifully | ||
| ### User interface |
docs/02-installation.md
| After completing the installation process, it's important to verify that the | ||
| typesetting software has been installed correctly and is accessible from the | ||
| -command line. | ||
| - | ||
| -Verify the installation is complete as follows: | ||
| +command line. Verify the installation is complete as follows: | ||
| 1. Open a new terminal or command prompt. | ||
 | ||
| See your operating system instructions for how to install a font. | ||
| + | ||
| +When running ConTeXt within the typesetter container image, all fonts are | ||
| +included. | ||
docs/03-quick-start.md
| 1. Click **File → Open** to load the variable definition file. | ||
| 1. Change **Source Files** to **Variable Files** to list variable definition files. | ||
| -1. Browse to and select the `.yaml`. | ||
| +1. Browse to and select the `.yaml` file. | ||
| 1. Click **Open**. | ||
| The variable definitions appear in the variable definition tab under the heading of **Variables**. | ||
| ## Basic syntax | ||
| The editor supports standard Markdown features listed in [@tbl:markdown-syntax-basic]. While editing, try the toolbar icons to see how formatting appears in the preview tab. | ||
| -| Style | Syntax | | ||
| -|--------------------|---------------------------| | ||
| -| **Bold** | `**bold**` | | ||
| -| *Italic* | `*italic*` | | ||
| -| ~~Struck text~~ | `~~struck~~` | | ||
| -| Horizontal rule | `---` on an empty line | | ||
| -| Unordered lists | `- item` or `* item` | | ||
| -| Ordered lists | `1. item` | | ||
| -| Inline code | `` `code` `` | | ||
| -| Links | `[label](url)` | | ||
| -| Images | `` | | ||
| -| Blockquotes | `> quoted text` | | ||
| -| Headings | `#`, `##`, `###` | | ||
| +| Style | Syntax | | ||
| +|--------------------|-------------------------------| | ||
| +| **Bold** | `**strong**` | | ||
| +| *Italic* | `*emphasis*` or `_emphasis_` | | ||
| +| ~~Struck text~~ | `~~struck~~` | | ||
| +| Horizontal rule | `---` on an empty line | | ||
| +| Unordered lists | `- item` or `* item` | | ||
| +| Ordered lists | `1. item` | | ||
| +| Inline code | `` `code` `` | | ||
| +| Links | `[label](url)` | | ||
| +| Images | `` | | ||
| +| Blockquotes | `> quoted text` | | ||
| +| Headings | `#`, `##`, `###` | | ||
| :: Basic Markdown syntax {#tbl:markdown-syntax-basic} | ||
| + | ||
| +Remember that most of these items are suggestions to the presentation layer. | ||
| +How they may appear in the final document may differ from what you anticipate. | ||
| ## Preview |
docs/05-metadata.md
| Some themes, such as *Handrit*, have additional metadata that may be included | ||
| in the final document automatically. *Handrit*, in particular, has a way to | ||
| -pass in a pseudonym (or by-line) for publishing manuscripts under a pen name. | ||
| +pass in a pseudonym (or by-line) for publishing manuscripts under a pseudonym. | ||
docs/06-basic-markdown.md
| ## Tables | ||
| -Tables use pipes (`|`) to indicate separate columns and hyphens (`-`) to define | ||
| +Tables use pipes (`|`) to indicate separate columns and hyphens (`-`) to mark | ||
| the header row. Markdown does not define a syntax for table footers. | ||
docs/07-advanced-markdown.md
| ## Fenced divs | ||
| -Fenced divs provide transform into XHTML `div` elements. They allow semantic | ||
| +Fenced divs are transformed into XHTML `div` elements. They allow semantic | ||
| organization and styling beyond standard Markdown. | ||
| ||
| Fenced divs have an extended syntax for more influence over the presentation. | ||
| -The syntax allows for a unique identifier (marked with a hash, `#`), multiple classes (starting with a period, `.`), and key-value pairs (of the form `name=value`): | ||
| +The syntax allows for a unique identifier (marked with a hash, `#`), multiple | ||
| +classes (each starting with a period, `.`), and key-value pairs (of the form | ||
| +`name=value`): | ||
| ``` markdown | ||
| ||
| ``` | ||
| -While this syntax is not strictly Markdown, it is well supported by a variety | ||
| -of other tools, including pandoc. | ||
| +While this syntax is not standard Markdown (i.e., CommonMark), it is supported | ||
| +by many tools, including pandoc. | ||
| ### Nested syntax | ||
| -Fenced blocks may be nested to create complex document structures: | ||
| +Fenced blocks may be nested to create hierarchical document structures: | ||
| ``` markdown | ||
| ||
| </div></div> | ||
| ``` | ||
| + | ||
| +Such nesting can help with complex presentation logic. | ||
| ## Code blocks | ||
| ||
| ### Cross-references | ||
| -Cross-references use anchor type names and unique identifiers to captions: | ||
| +Cross-references use anchor type names and unique identifiers such as: | ||
| - `{#type-name:id}` -- defines an anchor name | ||
| - `[@type-name:id]` -- references the anchor | ||
| Example image with cross-reference: | ||
| ``` markdown | ||
| There is no cuter animal than the one in [@fig:animal]. | ||
| - | ||
| + | ||
| :: World's cutest animal {#fig:animal} | ||
docs/08-images.md
| ### Resolution strategy | ||
| -The algorithm follows a multi-step process to determine the correct image file | ||
| -to display: | ||
| +The algorithm follows a multi-step process to determine the file to display: | ||
| 1. **Remote URLs** -- If the image reference begins with a remote protocol | ||
| ||
| 1. Look for a file named `company-logo` in a specified images directory. | ||
| 1. Look for `company-logo.png`, `company-logo.jpg`, etc. | ||
| -1. Use the first valid readable matching file found, or log an error. | ||
| +1. Use the first valid readable matching file found. | ||
| +1. Log an error if the file cannot be found. | ||
docs/09-exporting.md
| Without alphanumeric sorting, `chapter_10.md` would incorrectly appear before | ||
| -`chapter_2a.md` in a standard alphabetic sort. | ||
| +`chapter_2a.md` in a standard alphabetic sort because the computer would | ||
| +otherwise compare the _text_ `1` vs. `2` rather than the _numbers_ `10` vs. `2`. | ||
| ## Batch Processing |
docs/11-math.md
| ## Syntax | ||
| +A sigil is a special symbol used to mark or identify different types of | ||
| +elements, much like how medieval magicians and alchemists used them to | ||
| +represent spirits, forces, or intentions. Rooted in occult traditions, sigils | ||
| +served as visual signatures—condensed symbols encoding names, ideas, or goals | ||
| +in a hidden or abstract form. | ||
| + | ||
| Mathematical expressions must be enclosed within sigils. Spaces are not | ||
| -allowed after the opening or before the closing sigil. | ||
| +allowed after the opening sigil or before the closing one. | ||
| ## Inline expressions | ||
| -Enclose inline TeX code within single dollar sign sigils (`$`): | ||
| +Enclose inline TeX code inside single dollar sign sigils (`$`): | ||
| ``` tex | ||
| The quadratic formula is: $x=\fraction{-b \pm \sqrt{b^2 - 4ac}}{2a}$ | ||
| ``` | ||
| ## Standalone expressions | ||
| -Enclose standalone TeX code within double dollar sign sigils (`$$`): | ||
| +Enclose standalone TeX code inside double dollar sign sigils (`$$`): | ||
| ``` tex |
docs/user-manual.pdf
Binary files differ