Neue Projekt-Konfiguration…

Für die Projektorganisation sind Konfigurationsdateien erforderlich. Diese müssen im Projektverzeichnis von  OSE  liegen (s. Projektordner).

Fehlende Einträge werden - soweit möglich – mit Vorgaben besetzt. An einigen Stellen sind Prüfungen vorhanden, die unerwünschtes Verhalten verhindern sollen. Diese Datei sollte sorgfältig erstellt werden.

Die Reihenfolge der Sektionen (eingeleitet mit [Sektionsname]) ist beliebig. Eine Sektion wird mit der nächsten oder dem Dateiende begrenzt, Leerzeilen werden ebenso ignoriert, wie Zeilen mit ; am Anfang.

Die Angabe von Einstellungen erfolgt durch Zuweisung auf Parameternamen:

Parametername=Parameterwert

Verfügbare Parameter

Projekt-Pfade und Dateien

• Beim Upload der Daten gibt [FTP] root den Basispfad für [path] out vor.
• Der FTP-Upload spiegelt die lokale Struktur des out-Pfads auf dem Server in des Verzeichnis „ftp-root+path-root“.
  Deshalb muss media innerhalb des out-Pfades liegen.
• Relative Pfade (ohne :) haben als Basis das Projektverzeichnis von OffSiteEdit (/Projekte/).
• Pfade bilden sich aus »Pfad Projektdatei« + »out-Pfad« der Markdown-Datei. Pfadseparatoren (/, \) werden fallgerecht umgewandelt, „doppelte“ entfernt.
• Ohne Projektkonfiguration wird ein angegebener Projektname als Projektverzeichnis unterhalb des Programmverzeichnisses angenommen und gegebenenfalls angelegt (nach Rückfrage). Darin wird die Pfadstruktur der Yaml-Header angelegt.
• Die FTP-Funktion setzt die Konfigurationsdatei eines Projektes voraus.
• Bei passwortgeschützten Projektarchiven wird zum Entpacken das Passwort abgefragt.
• Bei passwortgeschützten Arbeitsdaten wird das gespeicherte Passwort der Projektkonfiguration zum Entpacken verwendet.

Der Menübefehl Projekte → Neue Projektkonfiguration… generiert standardmäßig ein Projektverzeichnis innerhalb des Programm-Verzeichnisses. Das ist ein funktionierender Vorschlag, der an die eigenen Anforderungen angepasst werden kann.

Eine neu erzeugte Projektkonfiguration wird automatisch der Liste im Menü Projekte hinzugefügt.

Projektvorlage.zip

Wenn im Programmverzeichnis ein Archiv mit dem Namen projektvorlage.zip gefunden wird, entpackt  OSE  dieses Archiv als „Standardvorgabe“ für ein neue Projekt. Das Archiv wird wie es ist in den neu erstellten Projekt-Ordner entpackt. Ob und wie das in die spätere Projektstruktur passt, muss bei der Erstellung des Archivs bedacht oder im Anschluss angepasst bzw. mit der Projektkonfiguration abgeglichen werden.

Die „Set“-Parameter

stdin=md

Setzt den Dateityp für die Quell-Dateien. Der Dateityp kann (ohne Punkt!) an die Projekt-Anforderungen angepasst werden.

Der hier festgelegte Dateityp bestimmt die Suche der Dateien für die Funktion Projekt neu generieren und wird als Standard beim Laden und Speichern von Projektdateien im Dialog eingestellt.

stdout=php

Setzt den Dateityp für die Ziel-Dateien. Der Dateityp kann (ohne Punkt!) an die Projekt-Anforderungen angepasst werden.

environment=1

zeigt an, dass eine „aktive Umgebung“ vorhanden ist, in der z.B. PHP-Dateien im Browser angezeigt werden können. Einem Relative Exportziel (ohne „:“) wird http://localhost vorangestellt und das ans Betriebssystem übergeben. Mit dem registrierten Standardbrowser wird mit Drücken von F5 (bzw. bei outoopen, s.u.) ein neues Fenster/neuer Tab geöffnet.

environment=0 übergibt den absoluten Pfad an das Betriebssystem, das die Datei mit dem für den verwendeten Dateityp registrierten Programm öffnet. So können z.B. generierte PHP-Dateien nach dem Erzeugen mit F5 (bzw. autoopen) direkt im Editor oder HTML-Dateien im Browser angezeigt werden.

autoopen=0

Ausgaben werden mit F5 gemäß der environment-Einstellungen geöffnet

autoopen=1 öffnet nach dem manuellen Export diese Datei automatisch, gemäß environment.

HTML-Dateien erzeugen im Browser ein neues Fenster/Tab, Editoren erkennen (Programm-abhängig) eine Dateiänderung und laden neu.

StdYaml

In diesem Abschnitt können wie im Header, Yaml-Variablen definiert werden, allerdings muss hier der Wert mit „=“ statt „:“ zugewiesen werden.

Yaml-Werte aus der Projektkonfiguration …

• … „sind immer da“, sie werden nirgends angezeigt oder geprüft
• … können mit einem gültigen Yaml-Eintrag (≠ auskommentiert) in einer Datei überschrieben werden
• … unterliegen den gleichen Regeln und Möglichkeiten wie Yaml-Variablen, die im Header stehen.
  Es gibt jedoch keine Unterstützung für Editor-Variablen; diese müssen „Header-Yaml-Variablen“ zugewiesen werden.
  Es findet jedoch keine automatische Ersetzung von Steuerzeichen statt.

Zur Entlastung des Yaml-Headers in Projektdateien kann hier beispielsweise der übliche Seitenautor, das Layout, eine Variable mit der Lesezeit (→ Lesezeit=%%%READ%%%), eine „Minimal-Description“, etc. hinterlegt werden. Variablen mit dem identischen Namen (Groß/Klein egal) können bedarfsweise, im Datei-Yaml-Header eingefügt, die Standardwerte überschreiben.

Header

Der hier definierte „Yaml-Header“ wird für neue Dateien verwendet und ist die Grundlage für den Yaml-Header-Check.

Bitte beachten

In der Projektkonfiguration muss der Standardwert mit „=“ zugewiesen werden, wogegen er im richtigen Yaml-Header mit „:“ vom Namen der Yaml-Variable getrennt wird.

Stilvorlagen für Wrapper

Dieser Abschnitt kann optional manuell eingefügt werden. Er füllt die Liste für die Funktion Wrapper, mit der formatierte Bereiche eingefügt werden können.

Die Reihenfolge in der Liste ist unerheblich, die Liste wird beim Einlesen alphabetisch sortiert.. Die „Zuweisung“ hat kommentierende Funktion, maßgeblich ist der Parametername, der als Stilname in die Bearbeitung übernommen wird.

Mustereintrag „styles“

[styles]
info=Umrahmter Block
gap=Abstand, max im verfügbaren Platz
gapx=Abstand ohne Umfluss max Breite
einzug1=1 Level
einzug2=2 Level
einzug3=3 Level
left=Float links
center=Zentriert
right=Float rechts
 

Die Auswahl von „info=Umrahmter Block“ erzeugt diesen Eintrag (kein Text ausgewählt):

(( gbox
 ← hier steht der Cursor
)) gbox

Ist ein markierter Text umschlossen, steht der Cursor hinter dem eingefügten Block.

Ein „ausgiebiger“ Standard-Yaml-Header

Nachfolgend ein „aufgebohrter“ Yaml-Header, der diverse Funktionen erüllt:

[Header]
 // zwingend erforderlich:
 project=%projekt%
 in=
 media=
 // „optional“ → an die eigenen Anforderungen anpassen ⟨ →  ; … entfernen!⟩:
 //out=                       ; entspricht ⟨Pfad, Name⟩ von „in“, wenn es fehlt, mit »stdout«
 //layout=                    ; ermöglicht das überschreiben des Eintrags in [StdYaml]
 //author=                    ; dito.
 //lang:de                    ; für mehrsprachige Webseiten, automatischer „Sprachordner“
 //stage=                     ; optionaler Ausgabepfad
 //upload=                    ; opitonales Hochladen von Daten, mehrfach zulässig
 //delete=                    ; Schalter: Entfernt ggf. Zieldaten und löscht auf dem Server
 //ignore=                    ; Verhindert das Erzeugen und Hochladen aus einer Quelle
 title=                       ; Meta-Eintrag
 //Ersatztitel=               ; Ersatztitel im Textkörper, keiner, wenn hier „-“
 //!Menu=                     ; ggf. kürzerer Menü-Eintrag
 //canonical=                 ; für canonical-link-Eintrag
 //!robots=noindex            ; Crawler-Anweisung
 !Lesezeit=%%%READ%%%         ; Lesezeit via Editorvariable
 !published=&#y-&#m-&#d       ; Erstellungsdatum
 //!modified=%%%SORTDATE%%%   ; Automatisiertes Änderungsdatum via Editorvariable
 //!Image=                    ; Bildpfad für X, Bluesky,Mastodon,…
 //!ImageAlt=                 ; Bildtitel dazu
 //twitter-card=summary       ; für großes Bidl: summary_large_image
 //!submenu=%%%CURRPATH%%%    ; Startpfad für OSE-Funktionen
 //Gruppe=1                   ; Zuordnung für Menüsteuerung
 //!Rang=1                    ; Reihenfolge in der Menüsteuerung
 //!keywords=                 ; Meta-Eintrag
 //description=               ; Meta-Eintrag
 //!summary=                  ; „lange“ Beschreibung für eigene Listen