Lara-MD – Inhalte pflegen

In Lara-MD pflegen Sie Ihre Inhalte als Dokumente, die in einer Ordnerstruktur liegen – ähnlich wie Dateien auf Ihrem Rechner. Sie arbeiten dabei in der Verwaltung; was Sie dort schreiben, wird beim Veröffentlichen zu fertigen Seiten, die der Reader anzeigt. Diese Seite zeigt, wie Sie Ordner und Dokumente anlegen, im Editor schreiben und Ihre Struktur pflegen.

Verwaltung und Reader

Lara-MD trennt zwei Rollen, die Sie kennen sollten:

Die Verwaltung ist der geschützte Arbeitsbereich, in dem Sie Inhalte anlegen und bearbeiten. Hier melden Sie sich an, hier liegt der Ordnerbaum mit dem Editor.
Der Reader ist die Leseansicht der fertigen Seiten. Er löst die Bausteine auf, stellt die Gestaltung bereit und bietet die Volltextsuche.

Beim Veröffentlichen erzeugt die Verwaltung aus Ihren Dokumenten die fertigen Seiten und legt sie am Zielort ab, wo der Reader sie ausliefert. Details dazu stehen unter Veröffentlichen und Verteilen.

Die Ordnerstruktur

Alle Inhalte liegen in einem Baum aus Ordnern und Dokumenten. Ein Ordner kann weitere Ordner und Dokumente enthalten; ein Dokument ist die eigentliche Seite mit Text, Bildern und Bausteinen.

Der Baum bestimmt zugleich den Pfad einer Seite. Liegt ein Dokument Erste Schritte im Ordner Handbuch, ist es später unter handbuch/erste-schritte erreichbar. Aus dem Namen leitet Lara-MD dabei einen technischen Pfad-Bestandteil ab (den Slug): aus Erste Schritte wird erste-schritte – klein geschrieben, ohne Leer- und Sonderzeichen. Umbenennen oder Verschieben passt den Pfad automatisch an.

Ordner und Dokumente anlegen

In der Kopfzeile der Verwaltung legen Sie über Ordner oder Dokument einen neuen Eintrag an. Im Dialog wählen Sie im Ordnerbaum das übergeordnete Ziel – oder die oberste Ebene, wenn der Eintrag ganz oben stehen soll – und geben einen Namen an.

Ein neues Dokument ist zunächst leer. Sie öffnen es anschließend im Editor und schreiben den Inhalt.

Der Editor

Ein Klick auf ein Dokument im Baum öffnet rechts den Editor – ein Textfeld mit Syntax-Hervorhebung, über dem eine Werkzeugleiste die wichtigsten Aktionen bereithält:

Speichern sichert Ihre Änderungen.
Vorschau zeigt das fertige Ergebnis, ohne etwas zu veröffentlichen.
Reader öffnet die veröffentlichte Ansicht in einem neuen Tab.
Link fügt einen Querverweis auf ein anderes Dokument ein (siehe Querverweise).
Kürzel fügt einen wiederverwendbaren Baustein ein (siehe Bausteine).
Unter Mehr finden Sie Umbenennen, Verschieben, Kopieren und Exportieren.

Oberhalb des Textfelds sehen Sie Name, Pfad und den Status des Dokuments. Über den Status steuern Sie, ob eine Seite veröffentlicht wird – das ist unter Veröffentlichen und Verteilen beschrieben.

Speichern Sie Ihre Änderungen, bevor Sie das Dokument verlassen.

Vorschau und Reader-Ansicht

Bevor eine Seite nach außen geht, prüfen Sie sie mit Vorschau. Dabei werden alle Bausteine und Querverweise aufgelöst (dieser Schritt heißt Zusammenstellen), sodass Sie das echte Ergebnis sehen – ohne etwas zu veröffentlichen.

Empfehlung: den Reader am Zielort einsetzen. Die fertige Gestaltung – Abbildungs-Karten, Download-Schaltflächen, Diagramme – und die Volltextsuche über alle Seiten stellt der Lara-MD-Reader bereit; er bringt die Gestaltungsvorlagen (auf Basis von Bootstrap) und die Suchfunktion mit. Liefern Sie die veröffentlichten Seiten am Zielort deshalb möglichst über den Reader aus. Werden sie stattdessen über einen fremden Viewer angezeigt, sind zwar alle Bausteine und Verweise korrekt aufgelöst, aber gestaltete Elemente können ohne ihr Layout erscheinen, und die Suche steht nicht zur Verfügung.

Anmerkung – ein zweiter, unabhängiger Weg: Neben dem redaktionellen Schreiben, das diese Seite beschreibt, kann Lara-MD Dokumente auch aus Datenquellen erzeugen – über den Generator. Dessen Ausgabe ist allgemeines, portables Markdown, das ohne Reader in jeder Markdown-Umgebung uneingeschränkt verwendbar ist. Redaktion und Generator sind bewusst getrennte Wege mit eigener Quelle und eigenem Ziel – siehe Generator.

Markdown – die Schreibweise

Inhalte schreiben Sie in Markdown, einer schlichten Textschreibweise, aus der die Formatierung automatisch entsteht. Ein kurzes Beispiel:

## Erste Schritte

Willkommen zu **Lara-MD**. Diese Anleitung führt Sie durch die *ersten Schritte*:

- Ordner anlegen
- Dokument schreiben
- veröffentlichen

Die gebräuchlichsten Schreibweisen im Überblick:

Schreibweise	Ergebnis
`# Titel`	Überschrift (die Anzahl der `#` bestimmt die Ebene, 1 bis 6)
`wichtig`	wichtig (fett)
`betont`	betont (kursiv)
`- Punkt`	Aufzählung
`1. Punkt`	nummerierte Liste
`[Text](adresse)`	Link
`Code`	Code im Fließtext
`> Zitat`	eingerückter Zitatblock

Tabellen schreiben Sie mit senkrechten Strichen, wie die Tabelle oben. Eine Leerzeile trennt zwei Absätze; einen Zeilenumbruch innerhalb eines Absatzes erzeugen Sie mit einem \ am Zeilenende.

Gut zu wissen:

Beginnen Sie jedes Dokument mit [TOC] – daraus entsteht automatisch das Inhaltsverzeichnis der Seite mit Sprungmarken zu den Überschriften.
Beginnen Sie Überschriften mit einem Wort statt mit einer Zahl (## Überblick statt ## 1. Überblick) – nur dann funktionieren die Sprungmarken des Inhaltsverzeichnisses zuverlässig.
Wiederkehrende Inhalte binden Sie als Baustein in der Form {{name}} ein – etwa einen festen Hinweis, eine Adresse oder eine Abbildung. Mehr dazu unter Bausteine.
Abbildungen, Download-Dateien und Ablauf-Diagramme fügen Sie über eigene Bausteine ein – siehe Bilder, Downloads und Diagramme.

Umbenennen, verschieben, kopieren

Ihre Struktur bleibt jederzeit änderbar. Die Aktionen finden Sie im Editor unter Mehr:

Umbenennen ändert Name und Pfad; der Inhalt bleibt unberührt.
Verschieben hängt einen Ordner oder ein Dokument an eine andere Stelle im Baum.
Kopieren legt ein eigenständiges Duplikat eines Dokuments an – praktisch als Vorlage oder um eine Variante zu erstellen.

Solche Änderungen wirken zunächst nur in der Verwaltung. Damit die veröffentlichten Seiten nachziehen und am alten Pfad nichts zurückbleibt, veröffentlichen Sie anschließend einmal. Weil Querverweise in Lara-MD an das Ziel-Dokument gebunden sind und nicht an dessen Pfad, bleiben Verweise nach dem Umbenennen oder Verschieben gültig – siehe Querverweise.