Dieses Paket dient zur Erstellung einer Navigationsleiste mit mehreren Bereichen, welche zum Beispiel jeweils eine Reihe von Links enthalten. Typischerweise existieren zwei solche Bereiche, welche am linken und rechten Ende der Navigationsleiste dargestellt werden. Es ist aber auch möglich, nur einen solchen Bereich einzublenden, oder beliebig viele Bereiche anzulegen.
Jeder Bereich enthält einen oder mehrere Abschnitte, welche grafisch als abgeschlossene Einheiten dargestellt werden. An den seitlichen Enden eines jeden Abschnitts bleibt bis zum Rand der Navigationsleiste oder bis zum Nachbarabschnitt im jeweiligen Bereich ein einzelner fester Abstand. Wenn Bereiche einander durch Platzmangel nahekommen, wird zwischen ihnen auch dieser Abstand als Platz eingehalten.
Die Navigationsleiste wird im ReST-Code als ein container beschrieben. Abschnitte werden als Textabsätze definiert. Derartige Abschnitte können entweder direkt im Navigationsleisten-Container positioniert werden, oder sie können durch einen übergeordneten Gruppen-Container innerhalb der Navigationsleiste gruppiert werden. Im ersten Fall erzeugt der Abschnitt einen Bereich, welcher aus genau dem einen Abschnitt besteht; im zweiten Fall werden im durch die Gruppe beschriebenen Bereich die Abschnitte direkt nebeneinander angezeigt. Der Gruppen-Container selbst tritt grafisch nicht in Erscheinung, er gruppiert lediglich die in ihm enthaltenen Abschnitte. Es ist möglich, in der Navigationsleiste genau eine Gruppe zu definieren; diese wird dann stets auf der linken Seite angezeigt.
Beispielsweise kann man schreiben:
.. container:: flexnavbar .. container:: flexgroup ((Abschnitt 1)) ((Abschnitt 2)) ((Abschnitt 3))
Diese Struktur wird folgendermaßen gerendert:
Abschnitt 1
Abschnitt 2
Abschnitt 3
Die Navigationsleisten dieser Art werden auch kurz als Navbars bezeichnet.
Zusätzlich werden auf eine ähnliche Weise Fußleisten möglich gemacht:
.. container:: flexfooter ((linker Abschnitt)) ((rechter Abschnitt))
Eine Gruppierung von Abschnitten ist in Fußleisten nicht möglich.
Die container-Direktive in docutils umschließt ihren Inhalt im HTML-Rendering durch ein div-Element. Man schreibt:
.. container:: ((Argumente)) ((Körper des Containers))
Die (optionalen) Argumente der container-Direktive werden in Klassennamen des resultierenden div-Elements übertragen.
Enthält der Körper eines docutils-Containers nur einen einzelnen Absatz, welcher aus Fließtext besteht, so dieser bildet dieser Absatz den Inhalt des Container-div-Elements. Wenn ein solcher Textabsatz stattdessen einer von mehreren Absätzen im Körper des Containers ist, so wird der Absatz von einem p-Element umschlossen. Absätze, welche nicht Fließtext darstellen, werden nie in einem p-Element gerendert. Dies trifft z.B. auf Bereiche zu, welche eine Gruppierung von Abschnitten sind.
Dies hat Auswirkungen auf das Design der Navbar-Styles, da man im Falle eines einzelnen Text-Absatzes nicht mit einem p-Element rechnen kann. Andernfalls, bei Vorhandensein mehrerer Absätze, können die p-Elemente von Textabsätzen für das Styling verwendet werden.
Für die Gruppierung von Inhalten in Absätzen stellt docutils die compound-Direktive bereit. Man könnte daher schreiben:
.. container:: .. compound:: ((Absatzinhalt))
Leider erzeugt die compound-Direktive zwar wie gewünscht ein p-Element, welches den ((Absatzinhalt)) umschließt, aber dieser Absatz wird nicht direkt im Container-div-Element platziert. Stattdessen wird der p-Absatz umschlossen durch ein zusätzliches div-Element im übergeordneten div-Container dargestellt.
Es ist mir keine Methode bekannt, um in einem Container mit nur einem Absatz als Körper dessen Inhalt in ein p-Element einzuschließen, so dass dieser Absatz direkt im Container-div-Element positioniert wird. Deshalb werden getrennte Styles für Navigationsleisten mit mehreren Abschnitten und solche mit nur einem Abschnitt bereitgestellt. Eine derartige Unterscheidung ist auch deshalb sinnvoll, um für Navigationsleisten mit nur einem Abschnitt zwischen der Darstellung dieses Abschnitts auf der linken oder rechten Seite wählen zu können. Es ist auch richtig, dass docutils bei Abwesenheit mehrerer Absätze das p-Element fortlässt, um das HTML-Rendering so einfach wie möglich zu halten.
Der hier vorgestellte CSS-Code ist anwendbar, wenn die Abschnitte der Navigationsleiste durch p-Elemente umschlossen sind. Dies ist erfüllt, sobald auf jeder Ebene mit Textabsätzen mindestens zwei Absätze vorhanden sind:
(2.) gründet sich auf folgende Beobachtungen:
Ein Beispiel für eine Navigationsleiste ohne Gruppen mit zwei Abschnitten ist:
.. container:: flexnavbar ((Abschnitt 1)) ((Abschnitt 2))
Eine so definierte Navbar wird dagestellt als:
Abschnitt 1
Abschnitt 2
Anstelle eines jeden hier verwendeten Text-Absatzes kann eine Gruppe
geschrieben werden (.. container:: flexgroup), siehe oben.
Weiter ist es möglich, in der Navigationsleiste genau eine Gruppe zu kodieren, welche dann mehrere Abschnitte hat:
.. container:: flexnavbar .. container:: flexgroup ((Abschnitt 1)) ((Abschnitt 2)) ((Abschnitt 3))
Dabei wird diese Gruppe stets auf der linken Seite der Navigationsleiste dargestellt:
Abschnitt 1
Abschnitt 2
Abschnitt 3
Dem div.flexnavbar-Container geben wir den folgenden Stil:
div.flexnavbar { display: flex; justify-content: space-between; background-color: #f8f8f8; column-gap: 1.5ex; padding: 0 1.5ex; border: thin solid #ddd; border-radius: 1.5ex; }
Durch die Deklaration display: flex wird das
div.flexnavbar-Element zu einem Flex-Container mit von links nach rechts
verlaufender Hauptachse (dem Standardverhalten).
Um bei zwei Abschnitten diese am linken und rechten Ende des Containers
darzustellen, kommt die Deklaration justify-content: space-between
zur Anwendung.
Außerdem geben wir der gesamten Navigationsleiste noch einen grauen Farbton, mit einer grauen dünnen Umrandungslinie sowie abgerundeten Ecken.
An den seitlichen Enden der Navbar wird zwischen Inhalt und Umrandung ein
Abstand von 1.5ex gelassen (padding: 0 1.5ex). Die Distanz
zwischen benachbarten Elementen im Inneren der Navigationsleiste wird zu
kleinen Werten hin per column-gap: 1.5ex durch ebenfalls 1.5ex
begrenzt, typischerweise ist aber aufgrund von justify-content:
space-between der Abstand größer als dieses Maß. Das vertikale Padding
zwischen den Kindelementen des div.flexnavbar-Elements und der
Umrandungslinie beträgt 0, sodass Gruppen genau dieselbe Höhe haben.
Absätze im flexnavbar-Container können entweder aus Text bestehen oder
aus .. container:: flexgroup-Containern. Diese
flexgroup-Elemente erhalten an ihren Enden links und rechts durch den
flexnavbar-Container den richtigen Abstand zum Ende der
Navigationsleiste oder zu benachbarten Bereichen der Navbar. Ihre einzige
Aufgabe ist es daher, als Flexcontainer aufzutreten und in ihrem Innern
ihre Kindelemente mit korrektem horizontalem Abstand zu rendern. Dies
erreicht man durch:
div.flexnavbar div.flexgroup { display: flex; column-gap: 1.5ex; }
In der vertikalen Richtung sind die Gruppen genausohoch wie die gesamte Navbar, und in ihrem Innern verhält sich alles genauso wie im flexnavbar-Container.
Es wurde hier bereits vorausgesetzt, dass die Abschnitte der Navbar als p-Elemente gerendert werden. Um diese als Abschnitte der Navbar zu formatieren, kann man schreiben:
div.flexnavbar p { text-align: left; padding: 0.5ex 0.8ex; margin: 1.25ex 0; background-color: white; border: thin solid #ccc; border-radius: 1ex; }
Hier werden die Absatzelemente selektiert, welche Nachfahren des
Container-div.flexnavbar-Elements sind. Dies betrifft sowohl direkt in
der flexnavbar enthaltene Kind-p-Elemente als auch solche, welche
in einer Gruppe im Innern der Navigationsleiste liegen. Wir umranden die
Abschnitte durch das Setzen der border-Eigenschaft mit einem dünnen
grauen Rahmen. Die Ecken der Abschnittsumrandungen werden ähnlich denen
der Navbar abgerundet. Innerhalb des Rahmens werden die Abschnitte durch
weißen Hintergrund (background-color: white) aus der Navbar
herausgehoben.
Der Rahmen um einen Abschnitt wird außerdem ein klein wenig von seinem
Textinhalt abgesetzt (padding). Dabei wird der horizontale Abstand
etwas größer als der vertikale Abstand gewählt, um visuell diese Abstände
gleich groß zu rendern. Das Padding ist insbesondere aufgrund der
abgerundeten Ecken als Korrektur notwendig.
Durch Definition von 1.25ex vertikalen margin bleibt zwischen
den horizontalen Randlinien der Abschnitte und dem Rand der Navbar ein
Abstand, welcher absichtlich ein wenig kleiner als das in horizontaler
Richtung durch flexnavbar und flexgroup vorgegebene Maß von
1.5ex ist. Da die Ober- und Unterkante von
flexgroup-Gruppen-Containern mit der Ober- und Unterkante der
Gesamt-flexnavbar übereinstimmen, verhalten sich die 1.25ex
margin innerhalb von Gruppen genauso wie direkt in der
flexnavbar. Da weiter der horizontale Raum um die Abschnitte durch die
Containerelemente (flexnavbar oder flexgroup) festgelegt wird, brauchen
die Abschnitts-p-Element keinerlei horizontalen margin.
Wenn in einem Abschnitt kein Zeilenumbruch notwendig ist, bestimmt sich seine horizontale Größe genau aus dem in ihm enthaltenen Text:
Wenn der horizontale Platz in der Navigationsleiste nicht ausreicht, um den
Text des Navbar-Abschnitts einzeilig darzustellen, kommt die Deklaration
text-align: left zum Tragen:
Inhaltsverzeichnis des Projektes | Übersicht aller Projekte | Zusätzlicher Link 1 | Zusätzlicher Link 2 |
Project Table of Contents | Overview of all Projects | Additional Link 1 | Additional Link 2
Downloads im Projekt | Downloads der gesamten Site | Impressum
Der überschüssige Platz wird hier durch text-align: left am rechten
Ende der Abschnitte freigelassen.
Im Falle nur eines einzelnen Abschnitts im Container für die Navigationsleiste existiert im Container-div kein hierarchisch untergeordnetes XML-Element, welches den Inhalt des Abschnitts umschließt. Es ist deswegen nicht möglich, den einzelnen Abschnitt von der umschließenden Navigationsleiste grafisch abzusetzen. Für die Gestaltung bietet sich daher an:
div.flexnavbar-left { text-align: left; padding: 0.5ex 0.8ex; background-color: #f8f8f8; border: thin solid #ddd; border-radius: 1ex; } div.flexnavbar-right { text-align: right; padding: 0.5ex 0.8ex; background-color: #f8f8f8; border: thin solid #ddd; border-radius: 1ex; }
Diese CSS-Codes erheben den Abschnitt zur Navbar. Die Auszeichnung ist
weitgehend äquivalent zur Gestaltung der Abschnitte im Falle von
Navigationsleisten mit mehreren Abschnitten, sie betrifft hier allerdings
den div-Bereich anstelle der p-Elemente, während der graue
Hintergrund des div-Elements beibehalten wird. Dies führt dazu, dass
der einzelne Bereich der flexnavbar-left- oder
flexnavbar-right-Navbar sich über die gesamte zur Verfügung stehende
Breite erstreckt. Der enthaltene Text wird durch die
text-align-Eigenschaft linksbündig bzw. rechtsbündig in der
Navigationsleiste formatiert.
Eine linksbündige Navigationsleiste mit einem einzelnen Abschnitt unter Verwendung von flexnavbar-left wird beispielsweise folgendermaßen dargestellt:
Für Fußleisten gibt es keine Gruppierung. Ansonsten werden Fußleisten genauso wie Navigationsleisten mit Inhalt versehen, es wird lediglich eine andere CSS-Klasse für den umschließenden Container verwendet:
.. container:: flexfooter ((linker Abschnitt)) ((rechter Abschnitt))
Styles für Fußzeilen mit nur einem Abschnitt werden nicht definiert, da sie nicht gebraucht werden. Es sind stets eim Abschnitt auf der linken Seite mit Datumsangaben bzgl. der Freigabe sowie ein Abschnitt auf der rechten Seite zur Navigation in der Veröffentlichungsgeschichte vorhanden.
Die Gestaltung von Fußleisten ist einfacher als die von Navigationsleisten, da Fußleisten vom gewöhnlichen Seiteninhalt bereits durch einen Querstrich getrennt sind und grafisch im Hintergrund stehen. Es reicht deshalb aus zu schreiben:
div.flexfooter { display: flex; justify-content: space-between; column-gap: 1.5ex; } div.flexfooter > p { text-align: left; margin-top: 0; margin-bottom: 0; }
Hier werden weder Hintergrundfarben noch Umrandungen angepasst. Das
prinzipielle Herangehen ist dem für Navigationsleisten mit mehreren
Abschnitten sehr ähnlich: Es wird ein flex-Container mit
justify-content: space-between und column-gap: 1.5ex
verwendet. Für die p-Abschnitte genügt es hier, die margin-top-
und margin-bottom-Maße auf 0 zu setzen, um den
docutils-Style von 1em zu übersteuern.
Ein Beispiel wird hier nicht gegeben, da der Trennstrich, welcher die Fußleiste vom Textkörper trennt, hier nicht wiedergegeben werden kann und es außerdem für die Darstellung essentiell ist, dass unterhalb der Fußleiste kein weiterer Inhalt mehr folgt.
Navigationsleisten können im Ausdruck nicht benutzt werden und sollen daher im Druck komplett weggelassen werden. Außerdem umfassen die Fußleisten in der Praxis genau zwei Abschnitte: Links die Angaben zur Freigabe und rechts die Werkzeuge zur Navigation in der Veröffentlichungsgeschichte des Artikels. Der rechte Abschnitt von Fußzeilen ist daher im Ausdruck ebenso irrelevant und soll gleichermaßen fortgelassen werden.
Man schreibt im Stylesheet daher:
@media print { div.flexnavbar { display: none; } div.flexfooter > p ~ p { display: none; } }
Zur Ausblendung wird dabei display: none für die entsprechenden
Elemente angewiesen.
Der CSS-Code für Navigationsleisten mit mehreren Abschnitten, Navigationsleisten mit nur einem Abschnitt sowie Fußzeilen lautet insgesamt:
navbars.css
div.flexnavbar { display: flex; justify-content: space-between; background-color: #f8f8f8; column-gap: 1.5ex; padding: 0 1.5ex; border: thin solid #ddd; border-radius: 1.5ex; } div.flexnavbar div.flexgroup { display: flex; column-gap: 1.5ex; } div.flexnavbar p { text-align: left; padding: 0.5ex 0.8ex; margin: 1.25ex 0; background-color: white; border: thin solid #ccc; border-radius: 1ex; } div.flexnavbar-left { text-align: left; padding: 0.5ex 0.8ex; background-color: #f8f8f8; border: thin solid #ddd; border-radius: 1ex; } div.flexnavbar-right { text-align: right; padding: 0.5ex 0.8ex; background-color: #f8f8f8; border: thin solid #ddd; border-radius: 1ex; } div.flexfooter { display: flex; justify-content: space-between; column-gap: 1.5ex; } div.flexfooter > p { text-align: left; margin-top: 0; margin-bottom: 0; } @media print { div.flexnavbar { display: none; } div.flexfooter > p ~ p { display: none; } }
Es gibt mehrere Gestaltungselemente, welche im Zusammenhang mit der Navbar gesehen werden können: Große Buttons und Codesegmente. Die hier vorgestellten Stile wurden so definiert, dass die resultierenden Navbars gestalterisch mit diesen anderen Elementen harmonieren. So wurde der Radius der äußeren Eckenabrundung genauso gewählt wie für die großen Buttons. Das Grau der Hintergrundfarbe der Navigationsleisten wurde so gewählt, dass das Gewicht der Navigationsleisten nicht zu groß und nicht zu klein ist; es ergibt sich ein anderes Grau als es für die Codesegmente verwendet wird. Der horizontale Abstand zwischen den Berandungen der Navbar-Abschnitten und der Kante der Navbar selbst wurde so angepasst, dass das Ergebnis den horizontalen Abständen in großen Buttons ähnelt; der vertikale Abstand ist davon unabhängig und wurde etwas kleiner eingestellt. Auf eine Angleichung der Eckabrundung zwischen Codesegmenten und Navbars wurde verzichtet, sodass die scharfen Ecken der Codesegmente ungeändert bleiben.
Die grafische Heraushebung der Navigationsleistenabschnitte aus dem Hintergrund der Navigationsleiste betont die Zusammengehörigkeit der Abschnittsinhalte. Für Fußzeilen kann auf eine derartige Betonung erfahrungsgemäß verzichtet werden.
Im Falle mehrzeiliger Abschnitte sind die Abschnitte der Navbar breiter als
der umgebrochene Inhalt. Die Lesbarkeit ist hier mit text-align:
left das Optimum, dies ist hier insbesondere der Alternative
text-align: justify überlegen.
Freigegeben am 29. Januar 2025.
← Vorherige Version | Nächste Version → | Letzte Version