Link Search Menu Expand Document

 Fertig 

Seiten erstellen


Seite erstellen

Jede Seite liegt in einem eigenen Ordner. Zuerst wird ein eigener Order für die Seite angelegt.

> Aufbau des Handbuches

Danach wird die index.md aus dem Ordner Referenz-index-md kopiert und in den neu erstellten Ordner eingefügt. Alternativ kann eine neue Datei index.md im neuen Ordner erstellt und der folgende Quelltext der Referenz-index.md eingefügt werden.

> Link zur Referenz-index-md


Header

Jede Seite (index.md) enthält oben einen Bereich, der Seiteneigenschaften festlegt. Er beginnt und endet mit --- .

---
title: Seiten
last_modified_date: 2020-07-31
author: Florian Starke, Michael Gut
grand_parent:
parent: Erste Schritte
has_children:
nav_order: 400
nav_exclude:
search_exclude:
permalink: /404.html
layout: default
categories: F
---

Der Einfachheit halber enthält der Bereich auf allen Seiten die gleichen Zeilen, obwohl nicht alle gebraucht werden.

title Dies ist die wichtige Zeile. Hier steht der Titel der Seite. Er sollte eindeutig sein. Er wird gebraucht, um z.B. Abhängigkeiten zwischen Seiten herzustellen, wie bei Links, Deeplinks oder Navigation.
last_modified_date Hier soll das Datum der letzten relevanten Änderung stehen.
Format ist JJJJ-MM-TT, also z.B. 1970-01-01 . Es muss nichts eingetragen werden.
author Hier werden die Namen der Bearbeiter komma-separiert eingetragen. Es muss nichts eingetragen werden.
grand_parent Bei Unterseiten der 3. Ebene im Menü muss hier der Titel der übergeordneten Seite der übergeordneten Seite stehen. Sonst steht hier nichts.
parent Bei Unterseiten ab der 2. Ebene im Menü muss hier der Titel der übergeordneten Seite stehen. Sonst steht hier nichts.
has_children Bei Seiten, die untergeordnete Seiten im Menü haben, muss hier true stehen. Da false der Standardwert ist, steht hier entweder true oder nichts.
nav_order Standardmäßig werden die Seiten alphabetisch sortiert. Im ersten Schritt sollten die Seiten in 100er Schritten sortiert werden, damit noch Seiten eingefügt werden können, ohne dass alle Seiten geändert werden müssen.*
nav_exclude Damit eine Seite, wie z.B. die 404.html-Fehlerseite, nicht in der Navigation auftaucht, muss hier true stehen. In der Regel steht hier nichts.
search_exclude Damit eine Seite, wie z.B. die 404.html-Fehlerseite, nicht in der Suche auftaucht, muss hier true stehen. In der Regel steht hier nichts.
permalink Hier kann ein Link festgelegt werden, unter dem die Seite erreichbar ist. Der Permalink überschreibt die automatische Festlegung und ist vor allem sinnvoll für z.B. Fehlerseiten, die alle in einem Ordner Fehlerseiten gesammelt sind. Hier sollte in der Regel nichts eingetragen werden.
layout Da alle Seiten das Standardlayout verwenden, wird hier immer default stehen.
categories Im Handbuch-Handbuch gibt es 3 verschiedene Status, In Planung (P), In Bearbeitung (B) und Fertig (F).

* Die ersten 7 Seiten hätten also die nav_order 100, 200, 300… 700. Wird zwischen Seite 300 und 400 eine Seite eingefügt, bekäme sie die nav_order 350. Eine weitere eingefügte Seite zwischen 300 und 350, hätte die Nummer 325 usw.


Copyright © 2024 Buchner & Partner GmbH

Zuletzt bearbeitet am: 17.3.2022