Photo Flow

Impressum

Inhalt dieser Seite

1   Zielstellung

Zielstellung ist die Erstellung von Webseiten mit einem großen Foto in der Mitte der Darstellung, versehen mit Buttons links und rechts davon um zum nächsten bzw. vorherigen Foto zu wechseln. Die Buttons sollen genausohoch wie das Bild 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 Fotoseite in den ReST-Quellen soll sein:

.. container:: photoflex

    ((Button nach links))

    ((Das eigentliche Foto))

    ((Button nach rechts))

Der Text für ((Das eigentliche Foto)) soll dabei sein:

.. figure:: ((Rasterbild))

    ((Bildunterschrift))

Für die Buttons soll stehen:

.. container:: ((Button-Klasse))

    ((Button-Text))

Typischerweise besteht der ((Button-Text)) aus entweder einem einzelnen Unicode-Pfeil oder aus einem Link mit Text eines solchen Unicode-Pfeiles, welcher auf die Fotoflow-Seite des jeweils nächstens Fotos weist. Die Links sollen dabei genauso hoch sein wie das Bild, damit sie in der ganzen Bildhöhe anklickbar sind.

Idealerweise ist die ((Buttonklasse)) für aktive und inaktive Buttons dieselbe. Es ist jedoch akzeptabel, wenn es zwei Klassen gibt: Eine für aktive Buttons, eine für inaktive.

2   Umsetzung

2.1   Der photoflex-Container

Die Buttons und das Bild einer Seite des Photo Flows sollen horizontal direkt nebeneinander angeordnet werden. Alle zusammen sollen horizontal zentriert im Viewport plaziert werden. Dies erreicht man durch:

div.photoflex {
    display: flex;
    justify-content: center;
}

justify-content: center plaziert dabei die Kindelemente direkt nebeneinander insgesamt horiontal zentriert.

2.2   Die figure

Die Abbildung (figure), welche aus Bild und Bildunterschrift besteht, soll kleiner als die Bildschirmbreite sein:

  • Es muss Platz für die Schaltflächen zum Bildwechsel bleiben;
  • Die Überschrift der Abbildung wie auch die Bildunterschrift brauchen ein wenig Raum.

Ein passender Style für die Abbildung ist:

div.photoflex > div.figure {
    width: 80%;
}
div.photoflex > div.figure > img {
    width: 100%;
}

Docutils-Abbildungen bestehen aus mehreren Elementen:

<div class="figure">
    <img />
    <p class="caption">
        ((Bildunterschrift))
    </p>
</div>

width: 80% für die div.figure setzt die Gesamtheit von Bild (img) und Unterschrift (p.caption) mit einer Breite von 80% des Viewports. Innerhalb dieses Abschnitts (div) wird dann das Bild (img) mit genau derselben Breite gerendert. Lässt man width: 100% für das img-Element weg, wird das Bild anhand seiner nativen Pixelzahl skaliert, wodurch es zu groß angezeigt wird.

Der Wert von 80% für die Breite des div.figure-Elements ist angemessen, wenn 16:9-Bilder auf einem 16:9-Bildschirm im Vollbildmodus angeschaut werden. Ohne Vollbildmodus ist davon auszugehen, dass die Seite vertikal nicht ganz auf einmal sichtbar ist.

Der obige CSS-Code genügt für Bilder, welche stets 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: 80% für div.photoflex > div.figure kann dabei bestehenbleiben, er wird durch die :figwidth:-Option übersteuert. Auf diese Weise kann die Angabe width: 80% 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.

2.3   Inaktive Buttons

Inaktive Buttons bestehen aus einem reinen Text, typischerweise einem einzelnen Unicode-Pfeil. Solch ein Button kann mit folgendem CSS-Code realisiert werden:

div.photoflex > div.inactivebutton {
    display: grid;
    grid-template-columns: auto;
    grid-template-rows: auto;
    align-items: center;

    text-align: center;
    width: 2.5em;
}

grid-template-columns: auto und grid-template-rows: auto legen dabei jeweils genau eine Spalte/Reihe an.

align-items: center und text-align: center plazieren 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.

2.4   Aktive Buttons

Aktive Buttons sind ein Link. Sie werden als a-Element mit einem gewissen Text kodiert. Der Text kann ein Pfeil sein. Im Unterschied zum inaktiven Button befindet sich beim aktiven Button der Text innerhalb eines a-Elements. Das a-Element soll sich über die gesamte Höhe der Abbildung erstrecken. Dies erreicht man durch:

div.photoflex > div.activebutton {
    display: flex;
    flex-direction: column;

    text-align: center;
    width: 2.5em;
}
div.photoflex > 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.

Um den Hintergrund des Link-Elements beim Darüberhovern mit der Maus anzupassen, kann man noch schreiben:

div.photoflex > div.activebutton > a:hover {
    background: #333;
}

2.5   Gestaltung der Gesamtseite

Wenn man das Bild bspw. auf schwarzem Hintergrund mit weißer Textfarbe darstellen möchte, bietet sich folgendes CSS an:

body {
    background: black;
    color: white;
}

Die Photo-Flow-Seite braucht einen Link, welcher zurück zu der Seite führt, von welcher die Photoflow-Seite aufgerufen wurde. Man kann dafür bspw. den Untertitel der Seite verwenden (nicht zu verwechseln mit dem Untertitel der Abbildung). 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. Insgesamt kann man schreiben:

h2 > a {
    color: inherit;
    text-decoration: inherit;
}
h2 > a:hover {
    text-decoration: revert;
}

text-decoration: revert macht dabei den CSS-Code der Autorstufe (hier text-decoration: inherit) rückgängig, sodass typischerweise der entsprechende Link wieder mit Unterstreichung dargestellt wird, entsprechend den Ergebnissen der Browser- und Nutzerstufe.

2.6   Zusammenfassung

Die HTML-Struktur einer Photoflow-Seite ist in den wesentlichen Teilen (in diesem Beispiel ist der Link nach links inaktiv, während der nach rechts aktiv ist):

<div class="photoflex">
    <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>

docutils fügt dabei noch ein paar Klassen und Attribute mehr ein, diese sind hier aber nicht von Belang.

Das CSS-Markup lautet insgesamt:

photoflex.css
div.photoflex {
    display: flex;
    justify-content: center;
}

div.photoflex > div.figure {
    width: 80%;
}
div.photoflex > div.figure > img {
    width: 100%;
}

div.photoflex > div.inactivebutton {
    display: grid;
    grid-template-columns: auto;
    grid-template-rows: auto;
    align-items: center;

    text-align: center;
    width: 2.5em;
}

div.photoflex > div.activebutton {
    display: flex;
    flex-direction: column;

    text-align: center;
    width: 2.5em;
}
div.photoflex > div.activebutton > a {
    display: grid;
    grid-template-columns: auto;
    grid-template-rows: auto;
    align-items: center;
    flex: auto;

    color: inherit;
    text-decoration: inherit;
}
div.photoflex > div.activebutton > a:hover {
    background: #333;
}

body {
    background: black;
    color: white;
}

h2 > a {
    color: inherit;
    text-decoration: inherit;
}
h2 > a:hover {
    text-decoration: revert;
}

Der das o.g. HTML generierende ReST-Code ist:

.. container:: photoflex

    .. container:: inactivebutton

        ((nach links))

    .. figure:: ((Bild))

        ((Bildunterschrift))

    .. container:: activebutton

        ((Link auf das Target))

3   Bereitstellung und Nutzung der CSS-Datei

Die CSS-Datei photoflex.css kann im Sources/Supp/Common-Verzeichnis des Projektes abgelegt werden. Es kann dann durch Schreiben eines Einschluss-Statements in der angemessenen .blox-Datei in jenem Verzeichnis eingebunden werden. Man kann bspw. in Universal.blox schreiben:

Photo Flow Styles /css/ : photoflex.css ::

Der Purpose Tag /css/ deklariert die Datei als CSS-Inklusionsdatei, welche in HTML-Resultaten aller von blox-rst2html prozessierten Dateien eingeschlossen werden soll, welche von photoflex.css abhängen (oder sie nutzen). Die Abhängigkeit kann z.B. in den ReST-Quelldateien von Seiten, welche den Photo-Flex-Style nutzen, durch Plazierung eines Blox-Abhängigkeits-Tags deklariert werden:

.. :Blox:`<-- photoflex.css`

Für docutils ist dies ein gewöhnlicher ReST-Kommentar, während der Blox-Compiler die Zeile als ein Abhängigkeits-Tag aufgreift, welches besagt, dass die prozessierte ReST-Datei von der Datei photoflex.css abhängt (oder sie benutzt). Weil der Zweck von photoflex.css "css" ist, wird es als Style Sheet eingebunden.

4   Anwendungsbeispiel

Folgende Symbole kommen für die Buttons in Frage:

Link Ersetzungsname Pfeilsymbol Darstellung
Link zum nächsten Bild |nextp| |srarr| →
Link zum verherigen Bild |prevp| |slarr| ←
Deaktivierter Link zum nächsten Bild |no-nextp| |nrarr| ↛
Deaktivierter Link zum verherigen Bild |no-prevp| |nlarr| ↚
Link zurück zur übergeordneten Seite |return| |slarr| ←

Um Zugriff auf diese Symbole zu haben, kann man eine Ressourcendatei anlegen, hier Photoflex.rst genannt:

Photoflex.rst
.. |nextp| replace:: |srarr|
.. |prevp| replace:: |slarr|

.. |no-nextp| replace:: |nrarr|
.. |no-prevp| 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 Photoflex.rst einbinden und die Ersetzungen für die Gestaltung der Photoflex-Seite verwenden. Die Symbole stammen aus der isoamsa.txt-Standard-Docutils-Definitionsdatei, eingebunden durch:

.. include:: <isoamsa.txt>

Das p in z.B. |nextp| dient der Unterscheidung von der Ersetzung |next|, welche bei der Versionierung von Seiten auftritt. Die Unterscheidung ist nicht streng notwendig, wenn Photoflow-Seiten niemals versioniert werden.

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 sollte, 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 benutzten. Bei Photo-Flow-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 Photo-Flow-Seiten 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 Photo-Flow-Seite verwendete Stempel dienen. In Seiten, welche auf die Photo-Flow-Seite verweisen, kann ein "lokales Alias" erzeugt werden.

In diesem Beispiel gibt es zwei Photoflow-Seiten mit Stempeln 2023-04-08_1825 und 2023-10-31_1743, welche die Titel Raumschiff vor dem Mun bzw. Stark geneigte Umlaufbahn tragen. Die Ersetzungen in Articles.rst lauten daher:

.. |2023-04-08_1825| replace:: Raumschiff vor dem Mun
.. _2023-04-08_1825: 2023-04-08_1825.html

.. |2023-10-31_1743| replace:: Stark geneigte Umlaufbahn
.. _2023-10-31_1743: 2023-10-31_1743.html

Die Seite, von welcher aus der Photoflow zugänglich sein soll, trägt in unserem Beispiel hier den Artikelstempel 2023-02-09_2009. Verweise aus den einzelnen Fotoseiten zurück auf diese Hauptseite sollen stets auf die letzte Version dieses einbindenden Artikels unter Verwendung von 2023-02-09_2009_ geschehen. Dieser Link verweist stets auf die letzte Version des Artikels. Sollte die referenzierte Seite sich ändern, wird die Articles.rst-Datei entsprechend modifiziert werden, und dies zieht die Neuübersetzung des gesamten Projekts nach sich; auf diese Weise werden auch die Artikelverweise aus den Fotoseiten automatisch aktualisiert.

Wir nehmen hier an, dass zwei Bilder 01-009.png und 01-012.png vorliegen, welche Bildschirmfotos im Format 16:9 sind. Diese können im Artikel-Supp-Verzeichnis abgelegt werden und per bxsupp ins Supp-Verzeichnis des Projektes transferiert werden. Sie sind dann für Seiten des Projektes als 2023-02-09_2009/01-009.png und 2023-02-09_2009/01-012.png verfügbar.

Die in unserem Beispiel angelegten Photo-Flow-Seiten, deren Seitenstempeldateien im Compound-Verzeichnis 2023-04-08_1825.rst und 2023-10-31_1743.rst sind, tragen folgende Inhalte:

2023-04-08_1825.rst
.. include:: Articles.rst
.. include:: Photoflex.rst
.. include:: <isoamsa.txt>

.. :Blox:`photoflex.css`

-de-
.. |subheading| replace:: |return| Zum Artikel
-en-
.. |subheading| replace:: |return| To the Article
-all-
.. _subheading: 2023-02-09_2012.html

.. _nextp: 2023-10-31_1743.html


|2023-04-08_1825|
#################

|subheading|_
*************

.. container:: photoflex

    .. container:: inactivebutton

        |no-prevp|

    .. figure:: 2023-02-09_2009/2023-12-06_1930/01-009.png

        -de-
        Das Raumschiff, wie es gerade auf den Mun zufliegt.
        -en-
        The starship, as it approaches Mun.
        -all-

    .. container:: activebutton

        |nextp|_
2023-10-31_1743.rst
.. include:: Articles.rst
.. include:: Photoflex.rst
.. include:: <isoamsa.txt>

.. :Blox:`photoflex.css`

-de-
.. |subheading| replace:: |return| Zum Artikel
-en-
.. |subheading| replace:: |return| To the Article
-all-
.. _subheading: 2023-02-09_2012.html

.. _prevp: 2023-04-08_1825.html


|2023-10-31_1743|
#################

|subheading|_
*************

.. container:: photoflex

    .. container:: activebutton

        |prevp|_

    .. figure:: 2023-02-09_2009/2023-12-06_1930/01-012.png

        -de-
        Ansicht der gegenüber der Ekliptik stark geneigten Bahn des
        Raumschiffs.
        -en-
        Depiction of the starship's orbit, which is strongly inclinated
        with respect to the ecliptic.
        -all-

    .. container:: inactivebutton

        |no-nextp|

Die zugehörigen Photo-Flow-Seiten sind:

Für die hier gezeigten Links werden die Titel und die Verweisziele automatisch per |2023-04-08_1825|_ und |2023-10-31_1743|_ eingefügt.

5   Diskussion

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 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 Bildes 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 gesamte a-Element nimmt dann den gewünschten 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.

Dem a-Element wird als a:hover 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.

Es ist mithin nicht möglich, für den aktiven und für den inaktiven Button dieselbe CSS-Klasse zu verwenden.