Kapitelanfang « ◉ » Anker: a

Allgemeine Module

Erstellt: 07.03.2022 Lesedauer 1 - 2 Min.

Auf dieser Seite

Für alle Projekte können globale und optional projektspezifische Module verwendet werden.

„Module“ sind ausgelagerter Programm-Code, dem Parameter übergeben werden können.

Beim Export erfolgt eine Ersetzung des Modul-Eintrags in der Arbeitsdatei durch den Code, der für den in einer Moduldatei definierten Modulnamen gefunden wird.

An Module können sowohl direkt mit Parametern, Yaml-Variablen, und Funktionen „übergeben, werden. Diese haben unterschiedliche Gültigkeitsbereiche:

Variablen mit %­%­% gelten im Editor und Layout. Hier werden Editor-Variablen und Yaml-Variablen unterschieden.

  • Editor-Variablen werden vor dem Export in der Arbeitsdatei mit Werten ersetzt.
  • Yaml-Variablen werden nach dem ersetzen der Module und dem Einfügen der übersetzten Arbeitsdatei ins Layout mit Werten ersetzt.
  • Funktionen werden abschließend in der HTML-Seite ersetzt.

Alle Ersetzungen (Module, Variablen, Funktionen) finden ausschließlich in der erzeugten HTML-Datei statt.

Durch Code dynamisch nachgeladene und eingefügte Elemente (Javascript, PHP, …) werden wie sie sind angezeigt.

An nachgeladenen Code können Werte über Code-Variablen in der erzeugten Datei übergeben werden.

Durch Module oder Code nachgeladene Text-Elemente können die für die Arbeitsdatei errechnete Lesedauer grob verfälschen.

Mit den daraus resultierenden Möglichkeiten kann HTML-Code generiert werden, für den es in Markdown keine Entsprechung gibt, beispielsweise ein Video einbetten oder Code, mit dem eine Slideshow oder ein dynamisches Seitenverzeichnis erzeugt wird.

Querverweis

Grundlagen für die Moduldefinition

Kapitelanfang « ◉ » Anker: a