Kapitelanfang « ◉ » Installation

Vorweg…

Aktualisiert am 14.02.2024 Lesedauer 3 - 4 Min.

Im Steckbrief ist ein kurzer Überblick zur Arbeitsweise hinterlegt. In diesem Abschnitt werden die Grundlagen für die erfolgreiche Verwendung von  OSE  beschrieben.

Die Herangehensweise von  OSE  unterscheidet sich von den gängigen Konzepten. Sie folgt dem Praxiswunsch, mit geringstmöglichem Aufwand von einer zentralen Stelle aus den stabilen Betrieb mehrerer voneinander unabhängigen Internet-Präsenzen zu gewärleisten.

Dafür ist für jede Webpräsenz ein vorbereitender Aufwand erforderlich, mit dem die Rahmenbedingungen dafür geschaffen werden. Der Anfang für eine Webseite ist damit sehr schnell gemacht. Änderungen sind jederzeit während der Bearbeitung möglich.

Der subjektiv empfundene Aufwand hängt maßgeblich von den angestrebten Zielen, den vorhandenen Kenntnissen und der Bereitschaft ab, fehlendes Wissen via Suchmaschine zu kompensieren. Wenn es keine Berührungsängste mit „Code“ gibt, lassen sich auch komplexe Webseiten in sehr kurzer Zeit aufsetzen.

BITTE

… anhand des Abschnitts »Grundlagen« das erste Projekt starten.

Die erfolgreiche Verwendung von  OSE  hängt maßgeblich vom Verstehen der Zusammenhänge und der verwendeten Grundbegriffe (nachfolgend) ab.

Die verwendeten Randsymbole sind im Glossar erläutert .

  • HTML-, CSS-, …, Kenntnisse sind hilfreich, fehlendes Wissen legt die Lernhürde höher. Die Höhe definiert sich über das fehlende Wissen zum Erreichen des angestrebten Ergebnisses.
  • Dringend empfohlen ist ein Anlesen der konzeptionellen Grundlagen.
  • Das Zusammenwirken von verschiedenen Daten und Dateien bei der Nutzung von  OSE  ist im Tipp Wie eine Seite entsteht beschrieben.

Die Anleitung hat abhängig von Tagesform, Zeit und „Gedankenknoten“ beim Schreiben, eine variable Qualität.

Wesentlicher Bestandteil der Hilfe ist deshalb „Frag den Autor“ mit der Kommentar-/Kontaktfunktion am Ende jeder Seite.

Grundwissen

Die wesentlichen Begriffe für die Arbeit mit  OSE :

OffSiteEdit

OffSiteEdit ( OSE ) ist kein Ersatz für „klassische“ Editoren wie z. B. PSPAD oder Notepad++. Das Programm ist auf die spezielle Verwendung für die Webseitenpflege mit Markdown ausgerichtet.

Für ergänzende Daten (Stilevorlagen, Bilder, Layout-Dateien, …) sind darauf spezialisierte Editoren vorzuziehen. Die genannten eignen sich hinreichend für Layout- und Stilevorlagen. Für Bilder ist Photoline ein ausgesprochen leistungsfähiges und dennoch preiswertes Werkzeug.

Projekt

In einem Projekt werden die Daten zur Erstellung und die fertigen einzelnen oder beliebig vielen zusammengehörenden Seiten zusammengefasst, die zu einer Domäne im Internet gehören.

Ob diese Seiten tatsächlich im Internet bereit gestellt werden, ist dabei ohne Belang.

Arbeitsdatei

Der aktuell im Editor angezeigte Text ist kein Bestandteil eines Projekts. Unten links im Editor oder oben im Yaml-Header (später…) wird lediglich angegeben, wohin die Datei gehören könnte. Zum Projekt gehört die Datei, die mit „Speichern“ oder „Exportieren“ in einem Projekt abgelegt wird.

Alles zwischen dem Laden und dem Speichern einer Datei passiert ausschließlich im Editor ohne Synchronisation mit dem Projekt. Es ist lediglich eine „Arbeitsdatei“. Wird während der Bearbeitung ohne vorheriges Speichern die Arbeitsdatei gewechselt, gehen alle Änderungen seit dem Laden verloren.

Es erfolgt keine Warnung. Dieses Verhalten ist erwünscht: Es erlaubt schnelles Ausprobieren und Verwerfen von Änderungen. Für jedes Projekt kann individuell festgelegt werden, ob beim Laden einer Arbeitsdatei automatische Backups von Änderungen angelegt werden. Diese können bei Bedarf geöffnet und durch Speichern/Exportieren die Projektdateien aktualisieren.

 OSE  kümmert sich eigenständig um die Arbeitsdatei. Sie wird beim Öffnen genau so geladen, wie sie beim Schließen verlassen wurde. Deshalb kann die Arbeit an beliebiger Stelle jederzeit unterbrochen und genau dort wieder fortgesetzt werden — ggf. sogar auf einem anderen Rechner.

Layout

 OSE  erzeugt aus Markdown HTML-Code. Damit dieser Code die Anmutung einer Webseite bekommt, wird er in eine Vorlage eingefügt. Dieses Layout ist eine leere Webseite, die stat eines Textes lediglich den Platzhalter %%%content%%% enthält.

Beim Export wird das erzeugte HTML an der so markierten Position in das Layout eingefügt.

Vor und nach dem Einfügen der HTML-Übersetzung in das Layout passieren noch viele weitere Dinge. Dazu später mehr.

Quelldatei

Aus einer Arbeitsdatei wird beim Speichern eine Quelldatei, die einem Projekt zugeordnet ist. Das ist eine Textdatei mit Markdown-Auszeichnung, die ebensogut mit einem anderen Editor erstellt und bearbeitet werden kann.

Bei der Pflege mit externen Editoren muss gewährleistet sein, dass keine  OSE -relevanten Einträge (Yaml-Header, Modul-/Funktionseinträge, … ) verändert oder entfernt werden.

Die Quelldatei enthält alle Informationen für die Erstellung der …

Zieldatei

In der Zieldatei ist das fertige Ergebnis abgelegt, das durch den Export erzeugt wird. Je nach Konfiguration mit oder ohne erforderlicher aktiven Umgebung, kann eine Zieldatei direkt im Browser betrachtet werden.

Kapitelanfang « ◉ » Installation