Test-Szenarien

Mit  OSE  können verschiedene Versionen einer Webseite erstellt werden. Die „Versionierung“ kann in verschiedenen Ausprägungen erfolgen. Jede Variante hat Vor- und Nachteile, die Varianten lassen sich kombinieren.

Letztendlich ist es eine Frage der eigenen Arbeitsweise und Vorlieben, welche Methode oder Kombination aus Methoden dafür am besten geeignet ist.

Lokale Webseite

Aus den Text-Dateien des Editors werden lokale HTML-Dateien in einem Verzeichnis erzeugt. Dieses Verzeichnis ist als lokale Kopie des Webservers gedacht. Diese Kopie kann z.B. mit XAMPP getestet werden, bevor die HTML-Dateien (und alles weitere) mit der entsprechenden Funktion des Editors auf den Server geladen werden.

Arbeitsprojekt → Finales Projekt

Eine Arbeitsumgebung wird Schritt für Schritt in die Ausgabeumgebung gespiegelt. Die Erstellung wird über die Einstellungen der Projektpfade in der Projektkonfiguration gesteuert.

Die Übernahme der Text-Dateien erfolgt aus der Testumgebung durch Anpassung des Yaml-Heaedrs in der Datei und speichern in der finalen Umgebung.

Vorteil

Die Daten sind strikt getrennt. Es werden in der finalen Version nur Daten gehalten, die dafür gedacht sind.

Nachtei

Die Übernahme von Ressourcen muss manuell erfolgen, der Yaml-Header muss dateiweise angepasst werden.

Stage

Im Yaml-Header jeder Datei kann mit dem Parameter „stage ein alternatives Ausgabeverzeichnis festgelegt werden:

Ohne stage

&#shy;&#shy;&#shy;
…
out: /info/pfade/draft-ausgabe.html
?­?stage: testpfad-zum-testen
…
&#shy;&#shy;&#shy;

Export in das Verzeichnis:

[Projektverzeichnis]/info/pfade/draft-ausgabe.html

Mit stage

&#shy;&#shy;&#shy;
…
out: /info/pfade/draft-ausgabe.html
stage: testpfad-zum-testen
…
&#shy;&#shy;&#shy;

Export in das Verzeichnis:

[Projektverzeichnis]/testpfad-zum-testen/info/pfade/draft-ausgabe.html

Vorteil

Es wird in einem Datenbestand gearbeitet, in dem es einen „Testpfad“ gibt.

Nachteil

Der „Testpfad“ ist auf dem Server erreichbar.

Das lässt sich mit Servereinstellungen, z.B. einem erforderlichen Login für diesen Abschnitt, einschränken.

Platzhalter define

Innerhalb der Datei können Abschnitte mit der Kommentarfunktion ausgeblendet werden. Das ist für kleine Abschnitte mit Varianten hilfreich.

Für Umfangreichere Abschnitte, die „normal“ bearbeitet werden können, lassen sich Platzhalter verwendet:

Ein „define“ wird ohne ein „insert“-Pendant entfernt. „Varianten“ eines Textes werden mit „define“ umfasst, die jeweils gewünschte Variante kann mit „insert“ ausprobiert werden – kombiniert mit der „stage“-Variable ist das eine extrem flexible Lösung.

Die finale Version wird bereits durch entfernen der „stage“-Variable erreicht: „define/insert“ fügen nur den Wert in die Ausgabe ein, der gewünscht ist. Die „Varianten“ könn(t)en im Quelltext verbleiben.

Beispiel

In der Arbeitsdatei

$$$insert Variante 13.11.2023 $$$

$$$define Variante 13.11.2023:
Dieser Text wurde am 13.11.2023 verfasst und für gut befunden. 
Deshalb erscheint er in der Ausgabe.
$$$   

$$$define Variante 24.9.2022:
Dieser Text wurde am 24.09.2022 erstellt und als veraltet angesehen. 
Eventuell 
- können später noch Teile daraus übernommen werden, 
- soll der Eintrag als Versionsnachweis erhalten bleiben.
$$$

Ausgabe

Dieser Text wurde am 13.11.2023 verfasst und für gut befunden.

Deshalb erscheint er in der Ausgabe.