Editor-Variablen ▶

Erstellt am 18.09.2022 Aktualisiert am 10.03.2024 Lesedauer 2 - 3 Min.

Editor-Variablen sind vordefinierte Standard-Variablen, die ohne Definition in der Arbeitsdatei verwendet werden können. Sie sind in zwei Gruppen geteilt:

  • Die „Präprozessor-Variablen“ werden nach den Präprozessor-Funktionen ersetzt.
  • Die „Postprozessor-Variablen“, zu denen auch alle selbst definierten Variablen im Yaml-Header gehören, werden vor den Postprozessor-Funktionen ersetzt.

Diese Reihenfolge kann bei der Verwndung von Variablen in Modulen oder Funktionen relevant sein. Die Editor-Variablen werden beim Erzeugen der Zieldatei durch den zu diesem Zeitpunkt gültigen Wert ersetzt, f+r den sie Platzhalter sind.

Yaml- vs. Editor-Variable

  • Yaml-Variablen müssen im Yaml-Header definiert worden sein, damit sie verwendet werden können.
  • Editor-Variablen können ohne vorherige Definition verwendet werden — auch als Inhalt von Yaml-Variablen.
    Damit lassen sich nötigenfalls Lesezeiten in Module übernehmen oder Werte in eine eigene Notation überführen.

Verfügbare Variablen

Editor-VariableFunktion
Nach Präprozessor
READ%%% geschätzte Lesedauer auf Minuten gerundet: ≤ 1 oder m - n (s. Zählen)
%­%­%ERTIME%%% geschätzte Lesezeit auf 10s gerundet m:ss
Vor Postprozessor
%%%DATE%%% Aktuelles Datum (tt.mm.yyyy)
%%%YEAR%%% Aktuelles Jahr (yyyy)
%%%SORTDATE%%% Aktuelles Daum rückwärts (yyyy-mm-dd) → sortierbar
%%%TIME%%% Aktuelle Zeit (hh:mm), minutengenau
%%%CLEANTIME%%% Zeit ≈ 15 Min. (hh:mm), auf Viertelstunden abgerundet
%%%RAWTIME%%% Zeitstempel des Computers als Double/Float-Zeitstempel
%%%PROGVERS%%% Programmversion des erzeugenden  OSE 
%%%OSEBREADCRUMB%%% Breadcrumb erzeugt einen „Krümelpfad“ (s. dort)
%%%CURRPATH%%% Datei mit Pfad : /editor/einfuegen/
%%%FILEWITHOUTEXT%%% Datei mit Pfad ohne Ext. : /editor/einfuegen/editor-variable
%%%RELRPATH%%% Relativer Pfad zur Datei: : ../../
%%%CONTENT%%%

In diese Variable wird der von  OSE  erzeugte HTML-Code geschrieben.

Es muss gewährleistet sein, dass diese Variable im erzeugten Code maximal ein Mal vorkommt. Andernfalls ist das Ergebnis unabsehbar, inklusive Programmabsturz oder „hängendem“ Rechner.

Bitte beachten
  • Im Gegensatz zu den in der Projektkonfiguration verwenbaren Datums-Variablen, die beim Anlegen der Datei durch die aktuellen Werte ersetzt werden, wird für Editor-Variablen erst beim Export der dann gültige Wert verwendet.
  • Bei gleichnamigen Yaml-/Editor-Variablen ist das Ergebnis nur bedingt vorhersehbar..
  • Der Dateiname und -pfad kann beim manuellen Speichern geändert werden. Das führt zwangsläufig zu einem falschen Pfad/Namen in Variablen.

Krümelpfad

Es wird ausgehend von der Startseite ein „klickbarer Pfad“ mit Links zu jeder vorgelagerten Index-Datei der aktuellen Datei erzeugt.

Voraussetzung
  • Es wird explizit im Ausgabeordner nach Dateien mit dem Namen „index“ und der Default-Dateiendung für die erzeugten Dateien gesucht. Das verhindert die Integration von womöglich noch unveröffentlichen Dateien/Pfaden.
  • Für eine fehlende Index-Datei wird »No Index« ausgegeben (s. dazu auch Projekt neu generieren).

Dieser (beispielhaft struktuiert) dargestellte Code wird – kompakt in einer Zeile – erzeugt:

<span class="osecrumb">
  <span><a href="root">Titel Root</a></span>
  <span><a href="Dir-index">Titel Dir1-Index</a><span>
  <span><a href="Dir-index">…</a><span>
  <span><a href="Dir-index">Titel DirN-Index</a><span>
  Titel aktuelle Date
</span>

Der Krümelpfad ist lediglich mit einem <span class="osecrumb"> umschlossen, damit eine gezielte und dennoch individuelle CSS-Formatierung möglich ist.

<style>
.osecrumb span::after {
    content: '•';
    padding: 0 0.5em;
}
</style>

Mit dieser Formatierung wird für die aktuelle Seite dieser Krümelpfad erzeugt:

OffSiteEdit-Online HilfeDer EditorEinfügenEditor-Variablen ▶