Deutsch
Über dieses Handbuch

Dieses Handbuch gehört zum Quartz-Plugin quartz-navigations. Und es ist mit ihm gebaut: das Menü darüber und „Zurück / Weiter“ unter jedem Text kommen von dort.

  • Einstieg — die erste Navigation in fünf Minuten
  • Varianten — alle zehn im Vergleich
  • Rezepte — fertige Kombinationen zum Abschauen
  • Nachschlagen — alle Optionen auf einer Seite

Wie die Einträge dafür aussehen, steht in 8.1.

1.1 – Wozu dieses Plugin

Was Quartz mitbringt

Der Explorer zeigt den Inhaltsordner als Baum in der Seitenspalte, mit aufklappbaren Ordnern, die er sich merkt. Für einen Notizgarten ist das genau richtig: Man sieht alles, und man findet alles.

Für eine Website mit Bereichen reicht er nicht. Er kennt nur eine Form, er zeigt immer den ganzen Baum, und er steht einmal auf der Seite. Vier Dinge, die viele Websites brauchen, lassen sich mit ihm nicht bauen:

Was fehltWie es hier heißt
Eine Menüleiste im Kopf, deren Einträge Untermenüs öffnenvariant: dropdown oder mega
In der Seitenspalte nur der Bereich, in dem man gerade liestscope: section
„Zurück“ und „Weiter“ in Lesereihenfolge unter dem Textvariant: pager
Eine Sitemap in der Fußzeilevariant: columns

Und auf dem Smartphone soll aus der Menüleiste etwas werden, das in eine Hand passt — ein Menü hinter einem Burger-Button etwa (mobile: offcanvas).

Was dieses Plugin anders macht

Ein Plugin, beliebig viele Einträge. Jeder Eintrag in der quartz.config.yaml ist eine eigene Navigation mit eigenen Optionen. Eine Website kann oben eine Leiste mit der ersten Ebene, links ein Akkordeon mit dem aktuellen Bereich und unten einen Pager tragen — dreimal dasselbe Plugin.

Alle lesen denselben Baum. Er entsteht beim Bauen aus den Inhaltsordnern und wird nur einmal je Bau berechnet, egal wie viele Navigationen ihn zeigen (1.3).

Die Seite steuert mit. Titel, Reihenfolge und Sichtbarkeit lassen sich in der Konfiguration festlegen oder im Frontmatter der Seite selbst — navOrder, navTitle, navHide, navIcon (Kapitel 2).

Was es nicht tut

  • Es ersetzt den Explorer nicht zwangsweise. Beide können nebeneinander stehen; sie teilen keine Klassennamen und stören sich nicht. Diese Website hat ihn trotzdem ersetzt, durch ein Akkordeon (8.1).
  • Es kennt keine Links, die nicht im Inhaltsordner liegen. Ein Menüpunkt „GitHub“ oder „Impressum auf einer anderen Domain“ ist keine Seite und kommt in keinem Baum vor. Dafür gibt es die Fußzeile von Quartz oder eine Layout-Box.
  • Es sucht nicht. Die Suche bleibt Quartz’ eigene.