Guidedog Handbuch 0.2.0
Sprache
Auf dieser Seite
Guidedog / Dokumentation 0.2.0

Bilder, Video, Audio und Downloads

Legen Sie Ressourcen nahe beim erklärenden Dokument ab. Verwenden Sie relative Pfade oder / für die Quellwurzel. Guidedog kopiert verwendete Ressourcen. Videos bleiben im Web abspielbar; das PDF benennt die Aufnahme.

Bilder

.. image:: diagrams/pipeline.png
   :alt: The build pipeline
   :width: 480px

.. figure:: /screenshots/search.png

   Searching the site.

Seiten kopieren Bilder nach _images, Bücher betten sie ein. PNG, JPEG, GIF, SVG und WebP funktionieren in beiden. Ein fehlendes Bild erzeugt eine Warnung: die Seite behält den Alternativtext, das Buch lässt das Bild aus.

Video und Audio

Ein image oder figure mit Video (.mp4, .webm, .ogv, .mov, .m4v) oder Audio (.mp3, .ogg, .oga, .m4a, .opus, .wav, .flac, .aac) spielt die Datei ab, wie Docutils bei Videos:

.. figure:: media/tour.mp4
   :alt: A tour of the site
   :width: 640

   The two-minute tour.

.. image:: media/pronunciation.mp3

Seiten zeigen den Browserplayer und einen Dateilink für Browser ohne Wiedergabe. Ein Buch kann Medien nicht abspielen und benennt die Aufnahme in einem Kasten anstelle des Players. Textausgabe schreibt [video: ...] oder [audio: ...].

Downloads

Die Rolle download verlinkt beliebige Dateien und kopiert sie nach _downloads:

Get :download:`the example project <examples/project.zip>`.

Dateien des Themes

_static enthält Stylesheets, Skripte, Schriften und Logos des Themes und wird unverändert nach _static der Site kopiert. html_static_path nennt den Ordner; html_css_files, html_js_files, html_logo und html_favicon seine Dateien. Inhaltsmedien gehören zu den Dokumenten, damit gemeinsames Verschieben die Links erhält.