Zielstellung ist die Erstellung von Webseiten mit einem großen Bild oder einem YouTube-Video in der Mitte der Darstellung, versehen mit Buttons links und rechts davon um zur nächsten bzw. vorherigen Slide zu wechseln. Das zentrale Element soll mit einem Beschreibungstext versehen sein, welcher sich über genau die Breite des zentralen Inhalts erstreckt. Die Buttons sollen genausohoch wie das Element in der Mitte sein. Beim Hovern mit der Maus über die Buttons sollen diese ihre Hintergrundfarbe wechseln. Die Buttons sollen auch als deaktivierte Version verfügbar sein; deaktivierte Buttons sollen beim Darüberhovern mit der Maus ihre Hintergrundfarbe nicht ändern. Die Breite der Buttons soll größer als die Breite der Buttonbeschriftungen sein.
Zur Umsetzung soll CSS verwendet werden, mit flex- und grid-Containern. Statische Tabellen sollen vermieden werden.
Die prinzipielle Darstellung einer solchen Folie in den ReST-Quellen soll sein:
.. container:: slide ((Button nach links)) ((Das Bild oder das Video)) ((Button nach rechts))
Der Text für ein Bild im Abschnitt ((Das Bild oder das Video)) soll dabei sein:
.. figure:: ((Rasterbild)) ((Bildunterschrift))
YouTube-Videos können mittels eines HTML-iframe-Elements eingebunden werden. Für ein Video soll damit im Abschnitt ((Das Bild oder das Video)) stehen:
.. container:: youtube ((YouTube-Einbettungs-iframe)) ((Beschreibung des Videos))
Für die Buttons soll stehen:
.. container:: ((Button-Klasse)) ((Button-Text))
Für den Wechsel zur nächsten Folie besteht der ((Button-Text)) eines entsprechenden aktiven Buttons typischerweise aus einem Link, welcher einen Unicode-Pfeil als Text enthält. Inaktive Buttons beinhalten dagegen direkt ihren Text ohne umschließendes Link-Element.
Idealerweise ist die ((Buttonklasse)) für aktive und inaktive Buttons dieselbe, wobei die unterschiedlichen Funktionen durch die verschiedenen Elemente im Button-Container entstehen (Link mit Text oder reiner Text). Es ist jedoch akzeptabel, wenn es zwei Klassen gibt: Eine für aktive Buttons und eine für inaktive.
Es ergibt sich so für eine Folie mit einer Abbildung:
.. container:: slide .. container:: ((Button-Klasse)) ((Button-Text)) .. figure:: ((Rasterbild)) ((Bildunterschrift)) .. container:: ((Button-Klasse)) ((Button-Text))
und unter Verwendung eines YouTube-Videos:
.. container:: slide .. container:: ((Button-Klasse)) ((Button-Text)) .. container:: youtube ((YouTube-Einbettungs-iframe)) ((Beschreibung des Videos)) .. container:: ((Button-Klasse)) ((Button-Text))
Um im HTML-Resultat die Inhalte der Slide mit einem div-Element zu umschließen, wird als ReST-Code geschrieben:
.. container:: slide
Die Buttons und das Bild oder Video einer Folie sollen horizontal direkt nebeneinander angeordnet werden. Alle zusammen sollen horizontal zentriert im Viewport platziert werden. Dies erreicht man durch:
div.slide { display: flex; justify-content: center; }
Dies wandelt den div.slide in einen flex-Container (display:
flex), und justify-content: center platziert die Kindelemente
direkt nebeneinander, insgesamt horiontal zentriert.
Abbildungen (figures), welche aus Bild und Bildunterschrift besteht, sollen kleiner als die Bildschirmbreite sein:
Die Abbildungen sollen im ReST-Code durch eine nicht weiter veränderte
.. figure::-Direktive beschrieben werden, genauso wie in der
Zielstellung beschrieben:
.. figure:: ((Rasterbild)) ((Bildunterschrift))
Die Anpassung für die Zwecke einer Slide soll vollständig durch das Umschließen der Abbildung mit dem div.slide-Container geschehen.
Aus einer ReST-Abbildung entsteht als HTML-Resultat (hier hinsichtlich der Attribute abgekürzt dargestellt):
<div class="figure"> <img /> <p class="caption"> ((Bildunterschrift)) </p> </div>
Ein passender Style für derartige Abbildungen ist:
div.slide > div.figure { width: 160ex; } div.slide > div.figure > img { width: 100%; }
Dieser CSS-Code ist hinreichend, wenn alle Bilder dasselbe Seitenverhältnis aufweisen. Braucht man hier mehr Auswahlmöglichkeiten, so bietet sich an, die figwidth-Option für die ReST-figure zu verwenden, z.B. als:
.. figure:: ((Bild)) :figwidth: 50% ((Unterschrift))
wodurch das Bild nebst Unterschrift 50% der Breite des Viewports einnehmen.
Der Style width: 160ex für div.slide > div.figure kann dabei
bestehenbleiben, er wird durch die :figwidth:-Option übersteuert.
Auf diese Weise kann die Angabe width: 160ex im Stylesheet als
Vorgabewert verwendet werden, von welchem je nach Bedarf abgewichen
werden kann.
Man beachte, dass div.figure-Elemente per docutils einen Style
margin-left: 2em; margin-right: 2em erhalten. Dies resultiert in
einem gewissen Abstand zwischen dem eigentlichen Bild und den Buttons links
und rechts daneben.
Jedes YouTube-Video hat eine vom Namen unabhängige ID, welche in den URLs des Videos auftaucht, z.B. in https://youtube.com/watch?v=((ID)). Für die Einbettung eines YouTube-Videos in eine Webseite kann folgender HTML-Code verwendet werden:
<iframe src="https://www.youtube.com/embed/((ID))" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen> </iframe>
Diese Passage reinen HTMLs wird unter Nutzung der raw-Direktive eingebunden:
.. raw:: html <iframe src="https://www.youtube.com/embed/((ID))" ((...))> </iframe>
Das Anologon zur Abbildung ist daher, unter Ausgestaltung des Entwurfs aus der Zielstellung:
.. container:: youtube .. raw:: html <iframe src="https://www.youtube.com/embed/((ID))" ((...))> </iframe> ((Beschreibung des Videos))
Derartige Folien werden dann durch folgende Stile formatiert:
div.slide > div.youtube { width: 160ex; margin-left: 2em; margin-right: 2em; } div.slide > div.youtube > iframe { width: 160ex; height: 90ex; } div.slide > div.youtube > p { font-style: italic; }
Hier werden das div.youtube-Element und auch der iframe in
dessem Inneren mit width: 160ex formatiert; das iframe-Element
zusätzlich mit height: 90ex. Die Angaben für width und
height müssen für das iframe-Element explizit angegeben werden.
Weil sowohl width als auch height spezifiziert werden müssen, kann
keine Angabe in der Art von 80% als width verwendet werden, da es
keine entsprechende Entwurfsmöglichkeit für die Höhe gibt. Das
Bildverhältnis ist mit den im Stylesheet verwendeten Zahlen für ein
16:9-Video passend.
Für die Breite der Beschreibung unterhalb des Videos ist der
width-Style des div.youtube-Elements hinreichend. Dem Stil
von docutils-figures folgend wird die Unterschrift mit
font-style: italic formatiert, und links sowie rechts neben dem
div.youtube-Element werden 2em Platz gelassen.
Aktive Buttons nutzen einen Link, kodiert als a-Element mit einem gewissen Text. Der Text kann ein Pfeil sein. Dabei befindet sich der Text eines aktiven Buttons innerhalb des a-Elements. Um diese Inhalte eines aktiven Buttons der Gestaltung durch CSS zugänglich zu machen, wird es in einen Container eingeschlossen:
.. container:: activebutton ((Link))
Das a-Element soll sich dabei über die gesamte Höhe des Inhalts in der Mitte der Folie erstrecken. Man erreicht dies durch:
div.slide > div.activebutton { display: flex; flex-direction: column; text-align: center; width: 2.5em; } div.slide > div.activebutton > a { display: grid; grid-template-columns: auto; grid-template-rows: auto; align-items: center; flex: auto; color: inherit; text-decoration: inherit; }
Der .activebutton-Abschnitt wird dabei zum vertikalen
(flex-direction: column) Flex-Container (display: flex).
Aller Text innerhalb des div.activebutton-Elements wird horizontal
zentriert dargestellt (text-align: center), damit auch der Text des
Links.
Damit der Link eine gewisse (feste) Breite hat, wird der
div.activebutton mit width: 2.5em gerendert.
Da das a-Element mit flex: auto versehen ist, erstreckt es sich
über die ganze Höhe des div.activebutton-Containers. Man beachte
dass dieser ein Flex-Container in Spaltenrichtung (flex-direction:
column) ist.
Um den Text im a-Element (den Linktext) auch vertikal im
a-Element zu zentrieren, wird das a-Element als display:
grid formatiert, und zwar mit align-items: center (diese
Eigenschaft bezieht sich genau auf die vertikale Ausrichtung der
Kindelemente des Grids). Das a-Element enthält genau eine Spalte
(grid-template-columns: auto) und genau eine Zeile
(grid-template-rows: auto). Der direkt im a-Element
geschriebene Text bildet automatisch das (einzige) untergeordnete
Element des a-Elements. Insgesamt wird so der Text des Links
horizontal und vertikal zentriert dargestellt, während das a-Element
selbst die gewünschten Ausmaße hat.
Abweichend von Link-Elementen im Fließtext soll der Text des Links
genauso wie gewöhnlicher Text dargestellt werden; daher werden Styles
color: inherit und text-decoration: inherit verwendet.
Inaktive Buttons bestehen aus einem reinen Text, typischerweise einem (durchgestrichenen) Unicode-Pfeil. Man kann schreiben:
.. container:: inactivebutton ((Text))
Solch ein Button kann mit folgendem CSS-Code realisiert werden:
div.slide > div.inactivebutton { display: grid; grid-template-columns: auto; grid-template-rows: auto; align-items: center; text-align: center; width: 2.5em; }
Der inactivebutton-Abschnitt wird dabei per display: grid als
Grid-Container ausgezeichnet, wofür per grid-template-columns:
auto und grid-template-rows: auto genau eine Spalte und eine Reihe
angelegt werden.
align-items: center und text-align: center platzieren den
Text des inaktiven Buttons sowohl vertikal (align-items: center)
als auch horizontal (text-align: center) jeweils zentriert.
width: 2.5em setzt die Breite des inaktiven Buttons.
Die Styles für den Körper einer Folie lauten insgesamt:
slides.css
div.slide { display: flex; justify-content: center; } div.slide > div.figure { width: 160ex; } div.slide > div.figure > img { width: 100%; } div.slide > div.youtube { width: 160ex; margin-left: 2em; margin-right: 2em; } div.slide > div.youtube > iframe { width: 160ex; height: 90ex; } div.slide > div.youtube > p { font-style: italic; } div.slide > div.activebutton { display: flex; flex-direction: column; text-align: center; width: 2.5em; } div.slide > div.activebutton > a { display: grid; grid-template-columns: auto; grid-template-rows: auto; align-items: center; flex: auto; color: inherit; text-decoration: inherit; } div.slide > div.inactivebutton { display: grid; grid-template-columns: auto; grid-template-rows: auto; align-items: center; text-align: center; width: 2.5em; }
Mit den entwickelten Stilen können die Strukturen aus der Zielstellung konkret umgesetzt werden.
Der ReST-Quelltext einer Folie mit einem Bild folgt dem Muster (in diesem Beispiel ist der Link nach links inaktiv, während der nach rechts aktiv ist):
.. container:: slide .. container:: inactivebutton ((nach links)) .. figure:: ((Bild)) ((Bildunterschrift)) .. container:: activebutton ((Link auf das Target))
Die HTML-Struktur dieser Folie ist in den wesentlichen Teilen (docutils fügt dabei noch ein paar Klassen und Attribute mehr ein, diese sind hier aber nicht von Belang):
<div class="slide"> <div class="inactivebutton"> ((nach links)) </div> <div class="figure"> <img src="((Bild))" /> <p class="caption"> ((Bildunterschrift)) </p> </div> <div class="activebutton"> <a href="((Target))"> ((nach rechts)) </a> </div> </div>
Eine Folie mit einem YouTube-Video kann aus folgender ReST-Quelle erzeugt werden (hier mit inaktivem Button nach links und aktivem Button nach rechts):
.. container:: slide .. container:: inactivebutton ((nach links)) .. container:: youtube .. raw:: html <iframe src="https://www.youtube.com/embed/((ID))" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen> </iframe> ((Videobeschreibung)) .. container:: activebutton ((Link auf das Target))
Die entstehende HTML-Struktur kann umrissen werden durch (insbesondere der iframe wird dabei verkürzt dargestellt):
<div class="slide"> <div class="inactivebutton"> ((nach links)) </div> <div class="youtube"> <iframe src="https://www.youtube.com/embed/((ID))"></iframe> <p>((Videobeschreibung))</p> </div> <div class="activebutton"> <a href="((Target))"> ((nach rechts)) </a> </div> </div>
Die in diesem Abschnitt entwickelten CSS-Regeln sind spezifisch für die Demonstration der in Das gesamte Stylesheet gegebenen Stile.
Wenn man das Bild oder Video auf schwarzem Hintergrund mit weißer Textfarbe darstellen möchte, bietet sich folgendes CSS an:
body { background: black; color: white; }
Um den Hintergrund des Link-Elements eines aktiven Buttons beim Darüberhovern mit der Maus anzupassen, kann man schreiben:
div.slide > div.activebutton > a:hover { background: #333; }
Die Slide braucht einen Link, welcher zurück zu dem Artikel führt, zu welchem die Slide gehört. Man kann dafür bspw. den Untertitel der Seite verwenden (nicht zu verwechseln mit dem Untertitel der Abbildung bzw. des Videos). In diesem Fall soll der Link mglw. unaufdringlich ohne die linktypische Unterstreichung und auch in der gewöhnlichen Textfarbe ausgezeichnet werden, während beim Hovern über den Linktext die Unterstreichung als Hinweis wieder dargestellt werden soll. Dafür kann man schreiben:
h2 > a { color: inherit; text-decoration: inherit; } h2 > a:hover { text-decoration: revert; }
text-decoration: inherit verhindert für Links in Untertiteln
(selektiert durch h2 > a) Unterstreichung. text-decoration:
revert macht diese Deklarationen (des Autor-Stylesheets) für derartige
Links beim Darüberhovern wieder rückgängig, sodass dann die entsprechenden
Links wieder mit Unterstreichung dargestellt werden können, entsprechend
den Browser- und Nutzer-Stylesheets. Die Farbe des Linktextes wird
stets vom übergeordneten Element übernommen (color: inherit).
Es ergibt sich so insgesamt für die hier verwendeten spezifischen Styles:
slides-custom.css
body { background: black; color: white; } div.slide > div.activebutton > a:hover { background: #333; } h2 > a { color: inherit; text-decoration: inherit; } h2 > a:hover { text-decoration: revert; }
Folgende Symbole kommen für die Buttons in Frage:
| Link | Ersetzung | Symbol | Darstellung |
|---|---|---|---|
| Link zur nächsten Folie | |nextslide| | |srarr| | → |
| Link zur verherigen Folie | |prevslide| | |slarr| | ← |
| Deaktivierter Link zur nächsten Folie | |no-nextslide| | |nrarr| | ↛ |
| Deaktivierter Link zur verherigen Folie | |no-prevslide| | |nlarr| | ↚ |
| Link zurück zur übergeordneten Seite | |return| | |slarr| | ← |
Um Zugriff auf diese Symbole zu haben, kann man eine Ressourcendatei anlegen, hier Slides.rst genannt:
Slides.rst
.. |nextslide| replace:: |srarr| .. |prevslide| replace:: |slarr| .. |no-nextslide| replace:: |nrarr| .. |no-prevslide| replace:: |nlarr| .. |return| replace:: |slarr|
Diese Datei legt man zweckmäßigerweise im Supp/Common-Verzeichnis ab, von wo aus sie für jede Sprache verfügbar wird. Man kann dann Slides.rst einbinden und die Ersetzungen für die Gestaltung der Slides verwenden. Die Symbole stammen aus der isoamsa.txt-Standard-Docutils-Definitionsdatei, eingebunden durch:
.. include:: <isoamsa.txt>
Für versionierte Artikel wird für gewöhnlich unterschieden zwischen dem Titel der jeweiligen Seiten und dem Verweisnamen, unter welchem die aktuelle Version des betreffenden Artikels verlinkt wird. Letzterer sollte mit dem Titel der letzten Artikelversion übereinstimmen. Da jedoch in der Evolution der Seiten eines Artikels sich der Titel von Version zu Version unterscheiden kann, und die jeweilige Wahl je Seite möglicherweise beibehalten werden soll, ist es für solche versionierten Artikel nicht sinnvoll, die ReST-Ersetzung, welche den letzten Titel einfügt, in der Überschrift einer seiner Seiten zu benutzen. Bei Folien-Seiten verhält sich die Sache anders: Diese sind Teil eines Artikels und enthalten nur sehr wenig versionierbaren Inhalt; es gibt für sie kein Veröffentlichungsdatum und ihr Inhalt kann sich im Laufe der Zeit wieder ändern. Daher ist es für Folien sinnvoll, in ihrer Titelzeile die Ersetzung anzuwenden, welche auch bei Verweis auf die Seite eingefügt wird.
Die Ersetzung wird in Articles.rst definiert. Als ersetzter Name kann z.B. der für die Folie verwendete Stempel dienen. In Seiten, welche auf die Folie verweisen, kann ein "lokales Alias" erzeugt werden.
In diesem Beispiel gibt es zwei Folien mit Stempeln 2024-03-29_1105 und 2024-03-29_1133, welche die Titel Raumschiff vor dem Mun bzw. YouTube-Beispiel tragen. Die Ersetzungen in Articles.rst lauten daher:
.. |2024-03-29_1105| replace:: Raumschiff vor dem Mun .. _2024-03-29_1105: 2024-03-29_1105.html .. |2024-03-29_1133| replace:: YouTube-Beispiel .. _2024-03-29_1133: 2024-03-29_1133.html
Die Seite, auf welche man aus der Slide zurückverweist, kann eine individuelle Seite oder die letzte Seite des zugehörigen Artikels sein. Im ersteren Fall verwendet man den Namen der konkreten HTML-Datei, in letzterem Fall stattdessen den Artikel-Stempel-Link.
In unserem Fall trägt der Artikel den Stempel 2023-02-09_2009. Ein Rückverweis auf die letzte Seite dieses Artikels würde also 2023-02-09_2009_ lauten. Die hier gebrachten Beispiele gehören jedoch spezifisch zur hier vorliegenden Version des Artikels, auf welche sich aus diesem Grund auch die Rückreferenzen in den Folien beziehen.
Wir nehmen hier an, dass ein Bild 01-009.png und ein YouTube-Video mit der ID onsVKidGqTQ existieren. Beide sind im Format 16:9. Das Bild wird in unserem Fall als 2023-02-09_2009/2024-03-29_1103/01-009.png verfügbar gemacht.
Die in unserem Beispiel angelegten Folien, deren Seitenstempeldateien im Compound-Verzeichnis 2024-03-29_1105.rst und 2024-03-29_1133.rst sind, tragen folgende Inhalte:
2024-03-29_1105.rst
.. include:: Slides.rst .. include:: <isoamsa.txt> .. :Blox:`slides.css` .. |subheading| replace:: |return| Zum Artikel .. _subheading: 2024-03-29_1100.html .. _nextslide: 2024-03-29_1133.html |2024-03-29_1105| ################# |subheading|_ ************* .. container:: slide .. container:: inactivebutton |no-prevslide| .. figure:: 2023-02-09_2009/2024-03-29_1103/01-009.png Das Raumschiff, wie es gerade auf den Mun zufliegt. .. container:: activebutton |nextslide|_
2024-03-29_1133.rst
.. include:: Slides.rst .. include:: <isoamsa.txt> .. :Blox:`slides.css` .. |subheading| replace:: |return| Zum Artikel .. _subheading: 2024-03-29_1100.html .. _prevslide: 2024-03-29_1105.html |2024-03-29_1133| ################# |subheading|_ ************* .. container:: slide .. container:: activebutton |prevslide|_ .. container:: youtube .. raw:: html <iframe src="https://www.youtube.com/embed/onsVKidGqTQ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen> </iframe> Abflugwinkel 60 Grad, Fallschirmentsicherung im höchsten Bahnpunkt. Voller Steuerknüppeldruck nach vorn im aufsteigenden Ast. Die maximale erreichte Höhe liegt über der Fallschirm-Auslösegrenze. Die Geschwindigkeit in Höhe dieser Grenze ist klein genug um die Auslösung zu ermöglichen. Plangemäße Entfaltung und Landung. Ungefähr über der Küste Umschaltung auf Höhe über Grund. .. container:: inactivebutton |no-nextslide|
Die zugehörigen Folien sind:
Für die hier gezeigten Links werden die Titel und die Verweisziele
automatisch per |2024-03-29_1105|_ und |2024-03-29_1133|_
eingefügt.
Im div.inactivebutton-Abschnitt gibt es kein untergeordnetes Element
außer dem "anonymen" Element, welches vom Text des inaktiven Buttons
gebildet wird. Es besteht deshalb keine Möglichkeit, diesem Text einen
flex: auto-Style beizuordnen, wie es im div.activebutton >
a-Element geschieht. Aus diesem Grund muss für div.inactivebutton
display: grid verwendet werden mit align-items: center. Dies
positioniert dann den Text des inaktiven Buttons vertikal in der Mitte des
Button-Elements.
Wendet man denselben Style allerdings nun auf einen Button an, dessen Text von einem a-Element gebildet wird, so wird dieser Anker nicht vertikal die gesamte Höhe des Raums neben dem Bild oder dem Video einnehmen. Stattdessen wird der Link nur in seiner natürlichen Höhe (vertikal zentriert) dargestellt werden. Das Ziel, dass der Link die gesamte Höhe des zentralen Inhalts abdeckt, wird dann nicht erreicht.
Um das a-Element wie gewünscht zu formatieren, wird deshalb für den
div.activebutton-Abschnitt display: flex; flex-direction: column
angewendet, zusammen mit flex: auto für den im Button enthaltenen
a-Anker. Das a-Element nimmt dann den gesamten für ihn
vorgesehenen vertikalen Raum ein.
Innerhalb des a-Links wird dann der enthaltene reine Link-Text
genauso formatiert wie der Text im inaktiven Button. Die Grid-Styles
für div.inactivebutton und für div.activebutton > a sind
daher identisch.
Es ist mithin nicht möglich, für den aktiven und für den inaktiven Button dieselbe CSS-Klasse zu verwenden.
Dem a-Element wird als a:hover (im spezifischen Stylesheet) der
Style background: #333 zugeordnet, damit sich beim Darüberhovern wie
gewünscht die Hintergrundfarbe ändert. Es ist notwendig, dass das
a-Element die gewünschte Höhe hat, damit der Nutzer den Link in der
gesamten Höhe anklicken kann. Somit reicht es nicht, lediglich dem
div.activebutton:hover den background: #333-Stil zuzuordnen.
Die Nutzung von width: 160ex für die div.figure setzt die
Gesamtheit von Bild (img) und Unterschrift (p.caption) mit einer
Breite, welche kleiner als die des gesamten Viewports ist. Innerhalb
dieses Abschnitts (div) wird dann das Bild (img) mit genau
derselben Breite gerendert (width: 100%). Ließe man width:
100% für das img-Element weg, würde das Bild anhand seiner nativen
Pixelzahl skaliert werden, wodurch es zu groß angezeigt werden würde.
Der Wert von 160ex für die Breite der Abbildung oder des Videos ist
angemessen, wenn 16:9-Material auf einem 16:9-Bildschirm im Vollbildmodus
angeschaut werden soll. Ohne Vollbildmodus ist davon auszugehen, dass die
Seite vertikal nicht ganz auf einmal sichtbar ist. Das Maß 160ex
wurde so gewählt, dass dennoch wenigstens das zentrale Element in der Höhe
ganz auf den Bildschirm passt, wenn die Seite nicht im Vollbildmodus
betrachtet wird. Wollte man außerdem noch die Betitelung nebst der
Unterschrift außerhalb des Vollbildmodus' gleichzeitig darstellen, wäre
eine zu starke Verkleinerung des Bildes oder Videos vonnöten.