Neue Projekt-Konfiguration…

Erstellt: 18.09.2022 Lesedauer 4 - 5 Min.

Die Projekt-Konfiguration ist unverschlüsselt. Zum Schutz sensibler Daten (FTP-Zugang) müssen geeignete Datenschutz-Maßnahmen getroffen werden.

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.

Bei Unklarheit eines Parameters vorzugsweise (vorerst) den Vorschlag dafür stehen lassen (wenn es einen gibt). Einige Einstellungen sind technisch sinnvoll (im Sinne von „richtig“), im weiteren Verlauf dennoch womöglich unerwünscht. Das lässt sich jederzeit ändern.

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

Parameter müssen in eine Zeile passen.

Verfügbare Parameter

EintragFunktion
[Set]Gruppe Projekt-Einstellungen (s. Set-Einstellungen)
backup1 : beim Laden von Dateien werden Backups des Editor-Inhalts angelegt (default), 0: keine Backups
autoopenNach dem manuellen Export wird dieser direkt angezeigt, (s. Set-Einstellungen)
stdinErmöglicht die Definition einer beliebigen Default-Editor-Extension, (s. Set-Einstellungen)
stdoutErmöglicht die Definition einer beliebigen Default-Export-Endung, (s. Set-Einstellungen)
environmentEs wird eine aktive Umgebung, z.B. für PHP, vorausgesetzt, (s. Set-Einstellungen)
[header]**Gruppe Header**
Project=…↓ Der Yaml-Header-Standard für neu erzeugte Dateien
in=…↓ und dem Yaml-Header-Check beim beim Öffnen von Projektdateien
out=…↓ Die Einträge erfolgen wie im Yaml-Header,
media=…↓ statt : als Trennstelle muss ein = verwendet werden.
↓ Es wird ein frei bearbeitbares Grundgerüst generiert.
↓ Datumsvariablen (s. Textbausteine werden ersetzt
↓ Mit dem Eintrag #in# kann für neue Dateien die Cursorposition bei öffnen festgelegt werden.
[Path]Gruppe Projektpfade (s. Pfade)
inBasis-Pfad zu den Quelldateien (Markdown)
outBasis-Pfad für den generierten lokalen Export
mediaBasis-Pfad für im Editor eingefügte Medien-Dateien
layoutBasis-Pfad zu den Layout-Dateien des Projekts
  backups  Basis-Pfad für die beim Öffnen von Dateien automatisch angelegten Backups und erzeugte Projektarchive.
[ftp]Serverkonfiguration für Upload
userFTP-Benutzername
passPasswort des FTP-Benutzers
hostder FTP-Host (typischerweise ohne ftp://)
rootDer Basispfad des Projekts, ohne Angabe ist das / = „root“
timeoutoptional: Legt die Dauer fest, in der eine Verbindung zustande kommen muss. Vorgabe sind 5 Sekunden. Je nach Verbindungen kann der Wert in Millisekunden größer oder kleiner gewählt werden (10s = 10000)
xchangeLege den relativen Pfad zur root für die Datensynchronisation fest.
uploadLegt fest, welche referenzierten, relativ verknüpften Medien (src="…", href="…" ohne ://) automatisch mit hochgeladen werden. Die Dateiendungen in der Liste müssen mit einem . beginnen.
[pack]Konfiguration der Archivierung (Datei-Menü, Hilfe-Menü)
type1 = Standardzip; 0 = Stark schützbares ZIP, inkompatibel zu den meisten Standard-Programmen (damit kein Entpacken möglich)
passPasswort für Archive
[styles}]Optionale Gruppe für Wrapper-Definitionen. (s. Stilvorlagen)
Stilvorlagen für Pandoc-Blöcke, die mit einer Beschreibung versehen werden können.

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.

Für Änderungen der Archiv-Struktur (Kompressionstyp, Passwort) muss grundsätzlich ein neues Archiv angelegt, ein bestehendes vorher gelöscht werden.

Der Menübefehl ProjekteNeue 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.

Die „Set“-Parameter

In diesem Parameterblock können optionale Angaben gemacht werden. Fehlende Parameter haben den Wert, der nachfolgend angegeben ist.

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.

Die „Standard-Dateitypen“ werden nur verwendet, wenn für die jeweilige Datei kein Dateityp vorgeben ist.

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.

Stilvorlagen für Pandoc-Blöcke

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.

Der Parametername muss einer Stil-Klasse aus dem verwendeten Stylesheet (ohne Punkt) entsprechen.

Mustereintrag „styles“

[styles]
info=Umrahmter Block
gap
=Abstandmax 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
:::
 

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

Projektvorlage.zip

Wenn im Programmverzeichnis ein Archiv mit dem Namen projektvorlage.zip gefunden wird, entpackt  OSE  dieses Archiv als „Standardvorgabe“ für das neue Projekt. Das Archiv wird wie es ist entpackt; ob und wie das in die spätere Projektstruktur passt, muss bei der Erstellung des Archivs bedacht werden.