Hyperbook Dokumenation

Seitenverzeichnis

Das ::pagelist-Element ermöglicht es, ein dynamisches Seitenverzeichnis zu erstellen, das eine Liste von Seiten auf einer Webseite anzeigt. Dabei können verschiedene Optionen verwendet werden, um die angezeigten Seiten zu filtern, das Format der Liste zu wählen und die Reihenfolge zu bestimmen.

::pagelist{format="<Format>" source="<Source>" orderBy="<Sortierkriterium>"}

Parameter

  • format
    • ol: Erzeugt eine geordnete Liste
    • ul: Erzeugt eine ungeordnete Liste
    • glossary: Erzeugt einen gruppierte Liste
    • #: Nutzt das Snippet zum Erstellen der Liste. Dabei bekommt das Snippet pages übergeben, welches alle Seiten enthält. Diese können dann verarbeitet werden.
  • source
    • href: Der Link der Seite
    • name: Der Name der Seite
    • keyword: Die Keywords der Seite
  • orderBy
    • name: Sortiert nach dem Namen der Seite
    • index: Sortiert nach dem Index der Seite
    • href: Sortiert nach der URL
    • asc: Aufsteigend
    • desc: Absteigend

Beispiel

Glossar

::pagelist{format="glossary" source="href(/glossary/.*)"}

Ein Glossar aller Elemente

::pagelist{format="glossary" source="href(/elements/.*)"}

Ungeordnete Liste nach dem href

::pagelist{format="ul" source="href(/elements/.*)" orderBy="name:desc"}

Geordnete Liste mit IDE im Namen und einmal zusätzlich mit SQL in der URL

::pagelist{format="ol" source="name(.*IDE.*)"}
::pagelist{format="ol" source="href(.*SQL.*) AND name(.*IDE.*)"}

Eigenes Snippet

Das Snippet liegt im Ordner snippets mit dem Namen list.md.hbs

{{#each pages}}
- {{{ name }}}: [{{ href }}]({{ href }})
{{/each}}
::pagelist{format="#list" source="name(^V.*)"}
Seitenverzeichnis
✎ GitHub© Copyright 2024 by OpenPatch