Verlinktes Inhaltsverzeichnis

Aktualisiert am 17.11.2024 Lesedauer 1 - 2 Min.

Fügt eine verlinkte Liste aller Dateien aus dem gewählten Verzeichnis in die Aktuelle Datei ein.

Für eine komfortable Verwendung der Funktion werden optional aus dem Yaml-Header der Dateien Variablen verwendet. Diese können über die Zuordnung individuell gewählt werden.

Enthält der Yaml-Header einer Markdown-Datei einen dieser aktiven Yaml-Parameter:

delete
ignore
notoc

wird diese Datei ignoriert.

Diese Funktion unterstellt, dass die Dateien aus der Markdown-Quelle auf dem Server verfügbar sind. Es findet keine Prüfung statt, ob das tatsächlich der Fall ist.

Definition

$$$ mdtoc zuordnung[-] [title] [sort] [more] : relativer Pfad $$$

Zuordnung

Eindeutiger Bezeichner der Funktion (obligatorisch).

Endet die Zuordnung mit einem Minuszeichen -, werden verknüpfte URLs in der Liste ohne Dateiendung erzeugt. Andernfalls werden URLs mit dem Projektparameter stdout gebildet.

„title“

Ein beliebiger Yaml-Eintrag aus der eingelesenen Datei, der für den Titel des Eintrags verwendet wird.

Fehlt diese Angabe, wird nach title im Yaml-Header gesucht und verwendet.

Fehlt title, wird Ohne Titel ausgegeben, damit ein anklickbarer Text für den zur Datei führenden Link vorhanden ist.

„sort“: Ein beliebiger Yaml-Eintrag aus der eingelesenen Datei, der zum Sortieren der Listeneinträge verwendet wird.

„more“: Ein beliebiger Yaml-Eintrag aus der eingelesenen Datei, der als Beschreibung unter den Titel eingefügt wird, .z.B. „description“.

relativer Pfad

Der Pfad zum Verzeichnis der Markdown-Dateien, ausgehend vom Quellverzeichnis des Projekts, typischerweise ist das Projekte\Projektname\md.

In diesem Verzeichnis werden ausschließlich Dateien mit der in der Projektkonfiguration festgelegten Dateierweiterung für Quelldateien eingelesen (typischerweise md).

Die Formatierung

Dieser Artikel enthält den Yaml-Parameter notoc, weshalb er in den Beispiellisten fehlt.

Ohne Beschreibungstext wird jeder Link als Absatz in die Markdown-Datei eingefügt:

<p><a href="URL-Referenz auf dem Server">Yaml-Titel ▶</a></p>

$$$ mdtoc einfuegen- : /editor/einfuegen/functions/  $$$

Mit Beschreibungstext werden Definitionslistenn-Einträge erzeugt. Die Ausgabe kann nur sortiert erfolgen:

<dl><dt><a href="URL-Referenz auf dem Server">Titel</a></dt>
<dd>
<p>Zugewiesene Beschreibung aus dem Yaml-Header.</p>
</dd></dl>

$$$ mdtoc einfuegen- : /editor/einfuegen/functions/  $$$

choice: Einfügen eines Textes abhängig von variablen Inhalten.

define: Definition des Inhalts eines Platzhalters.

dir: Einfügen aller Dateien eines Verzeichnisses ohne Bearbeitung.

file: Unbearbeitetes Einfügen einer Datei.

ID-Text: mkid: Erzeugen eines ID-kompatiblen Eintrags aus einem übergebenen Text.

insert: Festlegen einer Platzhalterposition.

mddir: Einfügen eines Verzeichnisses mit Markdown-Dateien in die Arbeitsdatei.

mdfile: Einfügen einer Markdown-Datei in die Arbeitsdatei..

Textanker: id: Erzeigen eines Texts mit Anker.

toc: Dynamische Erzeugung eines Seiten-Inhaltsverzeichnisses

Die Formatierung kann mit umschließenden Klassen und nachgeordneten Definitionen für die Definitionsliste darin frei gestaltet werden.

Die Sortierung

Die Sortierung erfolgt mit der Methode „A11…A101“.

Das ermöglicht eine leicht erstell- und pflegbare Rangfolge über eine „Rang“-Yaml-Variable oder das (rückwärts ausgegebene) Bearbeitungsdatum.

Verlinktes Inhaltsverzeichnis

« Funktionen

Definition

Die Formatierung

Die Sortierung