tikz-gallery-generator

Custum build of stapix for tikz.pablopie.xyz

tikz-gallery-generator

Custum build of stapix for https://tikz.pablopie.xyz.

Usage

Run:

$ tikz_gallery_generator config.yml [--full-build]

The configuration file config.yml should consist of a list of struct entries describing the contents of each picture, such as in the following example:

- path: examples/images/grothendieck-riemann-roch.tex
  license: PD
  author: Alexander Grothendieck
  alt: A hand-drawn commutative diagram surrounded by fire and devils carrying forks
  caption: The infamous commutative diagram from Gothendieck's 1971 manuscript

- path: examples/images/caleb-yau.png
  license: CC-BY-SA-2.5
  author: Lunch
  alt: A convoluted self-intersecting surface in pastel shades of pink and blue
  caption: A visual representation of the Calabi-Yau manifold

Each entry in the list should contain the following fields:

path: The path to the file in question
alt: Text altenative for the figure
caption (optional): A description of the figure
author: The name of the author of the picture
author-url (optional): A URL to a webpage by/on the picture's author
license: The license type of the picture. Should be one of proprietary (some proprietary license), PD (public domain), CC0, CC-BY-1, CC-BY-2, CC-BY-2.1, CC-BY-2.5, CC-BY-3, CC-BY-4, CC-BY-SA-1, CC-BY-SA-2, CC-BY-SA-2.1, CC-BY-SA-2.5, CC-BY-SA-3, CC-BY-SA-4, CC-BY-NC-1, CC-BY-NC-2, CC-BY-NC-2.1, CC-BY-NC-2.5, CC-BY-NC-3, CC-BY-NC-4, CC-BY-NC-SA-1, CC-BY-NC-SA-2, CC-BY-NC-SA-2.1, CC-BY-NC-SA-2.5, CC-BY-NC-SA-3, CC-BY-NC-SA-4, CC-BY-ND-1, CC-BY-ND-2, CC-BY-ND-2.1, CC-BY-ND-2.5, CC-BY-ND-3, CC-BY-ND-4, CC-BY-NC-ND-1, CC-BY-NC-ND-2, CC-BY-NC-ND-2.1, CC-BY-NC-ND-2.5, CC-BY-NC-ND-3 or CC-BY-NC-ND-4
source (optional): A URL poiting to the original source of the figure, if available

For best accessibility, the alt field should contain a concise visual description of the picture in question (including subjects, colors and scenery) to be displayed by screen readers, while the caption field should contain additional information on the picture (such as the location or date when it was taken) to be displayed for all users. The alt and caption attributes should not be the same! See https://www.htmhell.dev/adventcalendar/2022/22/ for further details.

Options

--full-build: Disables incremental builds. Re-renders all pages and thumbnails.

Installation

tikz_gallery_generator can be installed via Cargo by cloning this directory, as in:

$ git clone git://git.pablopie.xyz/tikz-gallery-generator
$ cargo install --path ./tikz-gallery-generator

External Dependencies

tikztosvg

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.