tikz-gallery-generator
Custum build of stapix for tikz.pablopie.xyz
README.md (3512B)
1 # tikz-gallery-generator 2 3 Custum build of [`stapix`](https://git.pablopie.xyz/stapix) for 4 <https://tikz.pablopie.xyz>. 5 6 ## Usage 7 8 Run: 9 10 ```console 11 $ tikz_gallery_generator config.yml [--full-build] 12 ``` 13 14 The configuration file `config.yml` should consist of a list of struct entries 15 describing the contents of each picture, such as in the following example: 16 17 ```yaml 18 - path: examples/images/grothendieck-riemann-roch.tex 19 license: PD 20 author: Alexander Grothendieck 21 alt: A hand-drawn commutative diagram surrounded by fire and devils carrying forks 22 caption: The infamous commutative diagram from Gothendieck's 1971 manuscript 23 24 - path: examples/images/caleb-yau.png 25 license: CC-BY-SA-2.5 26 author: Lunch 27 alt: A convoluted self-intersecting surface in pastel shades of pink and blue 28 caption: A visual representation of the Calabi-Yau manifold 29 ``` 30 31 Each entry in the list should contain the following fields: 32 33 * **`path`:** The path to the file in question 34 * **`alt`:** Text altenative for the figure 35 * **`caption` (optional):** A description of the figure 36 * **`author`:** The name of the author of the picture 37 * **`author-url` (optional):** A URL to a webpage by/on the picture's author 38 * **`license`:** The license type of the picture. Should be one of 39 `proprietary` (some proprietary license), `PD` (public domain), `CC0`, 40 `CC-BY-1`, `CC-BY-2`, `CC-BY-2.1`, `CC-BY-2.5`, `CC-BY-3`, `CC-BY-4`, 41 `CC-BY-SA-1`, `CC-BY-SA-2`, `CC-BY-SA-2.1`, `CC-BY-SA-2.5`, `CC-BY-SA-3`, 42 `CC-BY-SA-4`, `CC-BY-NC-1`, `CC-BY-NC-2`, `CC-BY-NC-2.1`, `CC-BY-NC-2.5`, 43 `CC-BY-NC-3`, `CC-BY-NC-4`, `CC-BY-NC-SA-1`, `CC-BY-NC-SA-2`, 44 `CC-BY-NC-SA-2.1`, `CC-BY-NC-SA-2.5`, `CC-BY-NC-SA-3`, `CC-BY-NC-SA-4`, 45 `CC-BY-ND-1`, `CC-BY-ND-2`, `CC-BY-ND-2.1`, `CC-BY-ND-2.5`, `CC-BY-ND-3`, 46 `CC-BY-ND-4`, `CC-BY-NC-ND-1`, `CC-BY-NC-ND-2`, `CC-BY-NC-ND-2.1`, 47 `CC-BY-NC-ND-2.5`, `CC-BY-NC-ND-3` or `CC-BY-NC-ND-4` 48 * **`source` (optional):** A URL poiting to the original source of the figure, 49 if available 50 51 For best accessibility, the `alt` field should contain a concise visual 52 description of the picture in question (including subjects, colors and scenery) 53 to be displayed by screen readers, while the `caption` field should contain 54 _additional_ information on the picture (such as the location or date when it 55 was taken) to be displayed for all users. **The `alt` and `caption` attributes 56 should not be the same!** See 57 <https://www.htmhell.dev/adventcalendar/2022/22/> for further details. 58 59 ### Options 60 61 * **`--full-build`:** Disables incremental builds. Re-renders all pages and 62 thumbnails. 63 64 ## Installation 65 66 `tikz_gallery_generator` can be installed via Cargo by cloning this directory, 67 as in: 68 69 ```console 70 $ git clone git://git.pablopie.xyz/tikz-gallery-generator 71 $ cargo install --path ./tikz-gallery-generator 72 ``` 73 74 ## External Dependencies 75 76 * [tikztosvg](https://www.ctan.org/pkg/tikztosvg) 77 78 ## License 79 80 This program is free software: you can redistribute it and/or modify it under 81 the terms of the GNU General Public License as published by the Free Software 82 Foundation, either version 3 of the License, or (at your option) any later 83 version. 84 85 This program is distributed in the hope that it will be useful, but WITHOUT ANY 86 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 87 PARTICULAR PURPOSE. See the GNU General Public License for more details. 88 89 You should have received a copy of the GNU General Public License along with 90 this program. If not, see <https://www.gnu.org/licenses/>. 91