Allgemeine Module
Modulübersicht
Für Module gelten diese Regeln
- „Module“ sind ausgelagerter Programm-Code, dem Parameter übergeben werden können.
- globale Module (im Module-Ordner des Programm-Verzeichnisse) können in allen Projekten genutzt werden
- Projektmodule (im Module-Ordner des Projekts) können ausschließlich vom jeweiligen Projekt genutzt werden
- gleichnamige Projektmodule überschreiben globale Module
- OffSiteEdit erwartet für Module die Datei-Endung „html“ oder „php“ – unabhängig vom tatsächlichen Inhalt
- Es findet keine Kontrolle statt, ob ein Modul als solches oder nach dem Einfügen validen, darstellbaren „Seiten-Code“ ergibt
- Beim Export werden Modul-Einträge nach der Markdown-Übersetzung in der Arbeitsdatei durch den Modulcode ersetzt, der für den in einer Moduldatei definierten Modulnamen gefunden wird.
- Yaml-Variablen werden anschließend ersetzt, deshalb können sie sowohl als Parameter im Modul-Aufruf, als auch direkt im Modulcode verwendet werden.
- Funktionen können ebenfalls in Modulen verwendet werden.
Module, Variablen und Funktionen werden im erzeugten HTML-Code ersetzt. Es hängt allein vom ersetzten Element ab, ob das validen, „anzeigbaren“ Code ergibt, insbesondere, wenn z.B. Module dynamischen Inhalt mit Skripten (PHP, Javascript, …) erzeugen.
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, der die für Markdown geltenden Beschränkungen aufhebt. Allerdings wird eine damit angereicherte Markdown-Datei in einem anderen Markdown-Editor die von OffSiteEdit interpretierten Auszeichnungserweiterungen ignorieren und „wie Text“ behandeln.
Die in diesem Abschnitt beschriebenen Module werden überlassen „wie sie sind“. Es wird der Zustand eines Moduls zum Zeitpunkt der Dokumentation beschrieben. Abhängig von der jeweiligen Umgebung und Weiterentwicklungen können für den erfolgreichen Gebrauch Anpassungen erforderlich sein.
Hinweise auf Fehler sind sehr willkommen.- Querverweis