Dave Jarvis' Repositories
git clone https://repo.autonoma.ca/repo/keenwrite.git
Adds captions to figures
| Author | DaveJarvis <email> |
|---|---|
| Date | 2025-08-29 13:45:21 GMT-0700 |
| Commit | 0d6122aa5ec41ec4fc624a8f5b0d90804b2b3e1c |
| Parent | 89177b9 |
| Delta | 36 lines added, 25 lines removed, 11-line increase |
docs/03-metadata.md
| -# Document Metadata Management | ||
| +# Document metadata management | ||
| -This chapter covers the fundamentals of document metadata, including basic metadata concepts, custom metadata configuration, and special metadata handling during document export. | ||
| +This chapter covers document metadata, including basic metadata concepts, custom metadata configuration, and special metadata handling during document export. | ||
| ## Document metadata | ||
 | ||
| Custom metadata allows you to define specific key-value pairs for your documents with variable substitution capabilities. | ||
| -The following screenshot shows example metadata preferences: | ||
| +The screenshot in [@fig:ui-metadata] shows example metadata preferences: | ||
| - | ||
| + {#fig:ui-metadata} | ||
| + | ||
| +:: Custom metadata | ||
| The **Key** column lists metadata names and the **Value** column lists | ||
docs/05-diagram.md
| # Architecture overview | ||
| -The high-level application architecture for converting Markdown documents demonstrates a sophisticated processing pipeline that transforms raw Markdown content through multiple stages to produce the final output. This architecture emphasizes modularity and extensibility through its processor chain design. | ||
| +[@fig:architecture] illustrates the high-level application architecture for converting Markdown documents. The architecture is a processing pipeline that transforms raw Markdown content through multiple stages to produce the final output. | ||
| ```diagram-graphviz | ||
| ||
| } | ||
| ``` | ||
| + | ||
| +:: Architecture overview {#fig:architecture} | ||
| ## Extension System Architecture | ||
docs/06-svg.md
| -# SVG Compatibility Fixes | ||
| +# SVG compatibility fixes | ||
| This chapter addresses common compatibility problems that arise when using SVG files created in Inkscape with the Batik SVG drawing software. These issues can prevent proper rendering of vector graphics and result in missing or incorrectly displayed content. | ||
| ||
| The remainder of this document explains these problems and how to fix them. | ||
| -## Nested Element Issues | ||
| +## Nested element issues | ||
| This section covers problems related to flowRoot elements that can cause rendering failures when SVG files are processed by Batik. | ||
| ||
| The SVG will now appear inside the application; however, the text may appear as black blocks. | ||
| -## Black Blocks | ||
| +## Black blocks | ||
| This section explains why text elements may render as solid black rectangles and provides steps to resolve this rendering issue. | ||
| -Depending on how text is added to a vector graphic in Inkscape, the text may be inserted within an element called a `flowRoot`. Although Batik recognizes `flowRoot` for SVG version 1.2, it cannot fully interpret the contents. Black blocks are drawn instead of the text, such as those depicted in the following figure: | ||
| +Depending on how text is added to a vector graphic in Inkscape, the text may be inserted within an element called a `flowRoot`. Although Batik recognizes `flowRoot` for SVG version 1.2, it cannot fully interpret the contents. Black blocks are drawn instead of the text, such as those depicted in [@fig:blocked-text]: | ||
|  | ||
| + | ||
| +:: Missing text {#fig:blocked-text} | ||
| ### Fix | ||
| ||
| When the illustration is reloaded, the black blocks will have disappeared, but the text elements ignore any assigned colour. | ||
| -## Black Text | ||
| +## Black text | ||
| This section addresses issues where text renders in black instead of the intended colors due to Inkscape-specific font specification references. | ||
| -When an SVG `style` attribute contains a reference to `-inkscape-font-specification`, Batik ignores all values that follow said reference. This results in black text, such as: | ||
| +When an SVG `style` attribute contains a reference to `-inkscape-font-specification`, Batik ignores all values that follow said reference. This results in black text, shown in [@fig:blacked-text]: | ||
|  | ||
| + | ||
| +:: Missing text {#fig:blacked-text} | ||
| ### Fix | ||
| Resolve the issue of colourless text as follows: | ||
| 1. Open the SVG file in a plain text editor. | ||
| 2. Remove all references `-inkscape-font-specification:'<FONT>';`, including the trailing (or leading) semicolon. | ||
| 3. Save the file. | ||
| -When the illustration is reloaded, the colours will have reappeared, such as: | ||
| +[@fig:resolved-text] shows colours having reappeared after reloading: | ||
|  | ||
| + | ||
| +:: Resolved text {#fig:resolved-text} | ||
docs/11-div.md
| -# Fenced Divs | ||
| +# Fenced divs | ||
| This chapter provides a comprehensive overview of the fenced div syntax used to generate HTML `div` elements within Markdown documents. It covers the basic, extended, and nested syntax forms, illustrating how to structure fenced divs and how they translate into HTML. |
docs/15-screenshots.md
| ## Variables | ||
| -Diagrams that include variables: | ||
| +Diagrams that include variables are shown in [@fig:screenshot-diagram-graphviz] | ||
| +and [@fig:screenshot-diagram-genealogy]: | ||
|  | ||
| -:: GraphViz diagram | ||
| +:: GraphViz diagram {#fig:screenshot-diagram-graphviz} | ||
|  | ||
| -:: Family tree diagram | ||
| +:: Family tree diagram {#fig:screenshot-diagram-genealogy} | ||
| ## PDF themes | ||
| -In the background of the following screenshot, the editor shows a novel | ||
| -being edited: | ||
| +The background of [@fig:screenshot-pdf-themes] depicts a novel being edited: | ||
|  | ||
| -:: PDF Themes | ||
| +:: PDF Themes {#fig:screenshot-pdf-themes} | ||
| Highlighted items of note: | ||
| ||
| ## Internationalization | ||
| -Poem with locale settings: | ||
| +[@fig:screenshot-locale] shows a poem with locale settings: | ||
|  | ||
| -:: Locale settings | ||
| +:: Locale settings {#fig:screenshot-locale} | ||
| ## Equations | ||
| -TeX equations with detached preview: | ||
| +[@fig:screenshot-tex] shows TeX equations in a detached preview pane: | ||
|  | ||
| -:: TeX equations | ||
| +:: TeX equations {#fig:screenshot-tex} | ||
| ## Dockable tabs | ||
| -Document outline opened and docked in bottom-left corner: | ||
| +[@fig:screenshot-outline] shows a document outline opened and docked in | ||
| +bottom-left corner: | ||
|  | ||
| -:: Document outline | ||
| +:: Document outline {#fig:screenshot-outline} | ||
docs/user-manual.pdf
Binary files differ