3.2 – Ebenen und Kopfzeilen

depth — wie tief

options:
  depth: 1   # 0 = unbegrenzt (Vorgabe)

Gezählt wird ab dem gewählten Ordner (3.1): depth: 1 zeigt nur seine Kinder, depth: 2 auch deren Kinder. Ordner an der Grenze erscheinen als Link, ohne aufzuklappen.

Die üblichen Werte:

Wo	depth
Menüleiste bar	1
dropdown	2 — erste Ebene in der Leiste, zweite im Menü
mega	3 — Leiste, Spaltenköpfe, Einträge
Sitemap columns	2
Seitenspalte tree, accordion	0

depth gilt auch für select und pager: Ein Pager mit depth: 1 blättert nur durch die erste Ebene.

hideOutsideRoot — wo sie sich ausblendet

Nur wirksam mit rootPath. Mit der Vorgabe true erscheint die Navigation ausschließlich auf der Ordnerseite von rootPath und auf Seiten darunter.

options:
  rootPath: docs
  hideOutsideRoot: false   # auch auf dem Blog die Doku-Navigation

false ist richtig für eine Sitemap in der Fußzeile, die überall denselben Teilbaum zeigen soll. true ist richtig für alles, was nur in einem Bereich Sinn ergibt. Eine Navigation je Sprache braucht dafür keinen rootPath (8.3).

showScopeRoot — eine Kopfzeile

options:
  scope: section
  showScopeRoot: true

Über der Liste steht der gezeigte Ordner selbst, als Link. Mit scope: section ist das der Name des Bereichs — „1 – Einstieg“ über den Seiten des ersten Kapitels, wie rechts auf dieser Seite. Wohin der Link zeigt, entscheidet folderLink (3.3).

showHome — ein Eintrag „Start“

options:
  variant: bar
  depth: 1
  showHome: true

Der erste Eintrag der Liste führt auf die Ordnerseite von rootPath, ohne rootPath also auf die Startseite. Beschriftet ist er mit „Start“ (oder „Home“, je nach Sprache — 7.3), in den senkrechten Varianten mit einem Haus davor. Er erscheint nur, wenn es diese Seite gibt, und nie bei tabs.

indexEntry — eine Zeile „Übersicht“

options:
  variant: accordion
  indexEntry: first

Jeder Ordner, dessen Kinder gezeigt werden und der eine Ordnerseite hat, bekommt als erstes Kind den Eintrag „Übersicht“, der auf diese Seite führt.

Gebraucht wird das, wenn die Ordnerzeile selbst kein Link ist: Mit der Vorgabe folderClick: toggle klappt ein Klick auf die Zeile den Ordner nur auf (5.1). Ohne indexEntry wäre die Ordnerseite aus dieser Navigation dann nicht erreichbar.