tu Script

Unser kleiner Redaktionshelfer

13. Februar 2021 / Stephan Post

Ausführen des Scripts:

Der einfachste Weg das Script am richtigen Ort auszuführen ohne lange Ordnernamen eintippen zu müssen ist wie folgt:

  • das Verzeichnis, in dem die Aktionen ausgeführt werden sollen in IDEA auf der rechten Seite auswählen:
  • rechtsklick auf das Verzeichnis

Ansicht Redaktion / Live

Wenn eine der o.g. Ansichten ausgewählt ist besteht das Kontextmenu nur noch aus dem Punkt "Run Trip Unlimited Script". Ein Klick startet das Script dann automatisch.

Idea - Run Trip Unlimited Script

Ansicht Projekt

  • Im Kontextmenü den Punkt "Open in Terminal" auswählen

Idea - open in Terminal

Es öffnet sich am unteren Bildschirmrand der Terminal-Bereich. Hier ist wichtig, daß der Name des Ordners angezeigt wird auf dem wir den rechtsklick ausgeführt haben.

Idea - Terminal Bereich

Im Terminal-Bereich dann folgenden Befehl eingeben und mit Enter bestätigen

tu

Benutzung des Scripts

Es wird zuerst nach der auszuführenden Aktion gefragt.

Trip Unlimited Script - Hauptmenü Aktion auswählen

AktionBeschreibung
New PageOptionen zum anlegen einer neuen Seite
Update Last Modified Dateaktualisiert das "Aktualisiert am"-Datum
Publish PageKennzeichnet eine Seite für die LIVE-Ausspielung
De-Publish PageKennzeichnet eine Seite für die PREVIEW-Ausspielung
CANCELBeendet das Script

Durch Drücken der Taste wird die hervorgehobene Standardaktion ausgewählt.

neue Seitenstruktur anlegen

Es wird nach der auszuführenden Aktion gefragt.

Trip Unlimited Script - Untermenü Neue Seite Aktion auswählen

AktionBeschreibung
New Page (incl. md-file)Legt die komplette Struktur einer neuen Seite inklusive einer *.md Datei an
New Page (only Structure)Legt komplette Struktur einer neuen Seite ohne eine *.md Datei an
New Page (import from path)Legt komplette Struktur einer neuen Seite inklusive einer *.md Datei an aus einem Dateipfad an.
CANCELBeendet das Script

Durch Drücken der Taste wird die hervorgehobene Standardaktion ausgewählt. Nach Auswahl der Aktion wird nach dem Namen des Verzeichnisses gefragt welches angelegt werden soll. Daraus wird auch der permLink (die URL der Seite) generiert. Alle Leerzeichen im Namen werden durch '-' ersetzt. Alles andere landet aktuell direkt in dem Link zur Seite !Daher sollten alle Sonderzeichen wie Emojis, "*", "#", "?", "!" vermieden werden !

Doppelte (") sowie einfache Anführungszeichen (') sind hier verboten !

Sollten Sonderzeichen im Titel benötigt werden so müssen sie als enkodierte Zeichen eingegeben werden. z.B.: € für das €-Zeichen. Eine Übersicht aller Zeichen findet sich hier: HTML Codes

Die "Unterüberschrift" (subHeadline) wird durch " - " von dem Seitentitel getrennt ! Es sollten somit keine weiteren " - " in der subHeadline verwendet werden.

Trip Unlimited Script - Seitentitel eingeben

Anschließend wird nach dem zu verwendenden Layout gefragt.

Trip Unlimited Script - Layout auswählen

Hier sollte aktuell immer das Layout trips gewählt werden. Die Funktion der unterschiedlichen Layouts sind hier beschrieben.

Durch Drücken der Taste wird die hervorgehobene Standardaktion ausgewählt.

komplett inkl. *.md - Datei (default)
AktionBeschreibung
New Page (incl. md-file)Legt die komplette Struktur einer neuen Seite inklusive einer *.md Datei an

Es wird folgende Struktur angelegt:
Im nachfolgenden Beispiel wurde der Titel: My Title - my Subtitle verwendet. Ausgeführt wurde das Skript im Ordner posts.

Trip Unlimited Script - komplette Struktur Neue Seite

nur Struktur ohne *.md - Datei
AktionBeschreibung
New Page (only Structure)Legt komplette Struktur einer neuen Seite ohne eine *.md Datei an

In dieser Aktion wird keine *.md Datei angelegt. Dies kann sinnvoll sein, wenn eine extern erzeugte *.md Datei einfach nur in die angelegte Struktur kopiert werden soll.

Es wird folgende Struktur angelegt:
Im Beispiel wurde der Titel: My Title - my Subtitle verwendet. Ausgeführt wurde das Skript im Ordner posts.

Trip Unlimited Script - Struktur Neue Seite ohne *.md-Datei

aus Pfad importieren

Hier gibt es aktuell die folgenden Auswahlmöglichkeiten:

Trip Unlimited Script

Aus default Verzeichnis importieren
AktionBeschreibung
Import from Default Directory (default)Legt komplette Struktur einer neuen Seite inklusive einer *.md Datei an aus dem DEFAULT_IMPORT_DIR der Umgebungsvariablen an.

Es muss die Umgebungsvariable DEFAULT_IMPORT_DIR gesetzt sein !

Nach der Auswahl der Aktion werden alle Verzeichnis die unter dem DEFAULT_IMPORT_DIR gefunden werden angezeigt. Hier kann nun das für den Import verwendete Verzeichnis ausgewählt werden.

Anschließend folgt der Ablauf dem generellen Anlegen einer neuen Seite (Title, layout)

Verzeichnispfad eingeben
AktionBeschreibung
New Page (import from path)Legt komplette Struktur einer neuen Seite inklusive einer *.md Datei an aus einem Dateipfad an.

Diese Aktion importiert einen kompletten Ordner nebst allen Dateien.

Wenn unter dem Pfad auch Bilder gefunden werden so werden diese automatisch in den "_img"-Ordner der neu anzulegenden Seite kopiert. Im Anschluss werden alle Pfade der Bilder in der Markdown-Datei auf die angelegte Dateistruktur ("_img/") umgeschrieben. Auch werden die H-Tags (#) an die Seitenstruktur angepasst (# -> ###) Im Idealfall sollte nach dem Import nichts weiter zu tun sein um die Seite im Browser vollständig und korrekt anzeigen zu können. Auch in IDEA sollten in der Vorschau und bei mouse-over alle Bilder zu sehen sein.

Es wird nach dem Pfad gefragt, aus dem der Content importiert werden soll.

Trip Unlimited Script - Pfadnamen eingeben

Den Pfad zu einem Ordner erhält man unter MacOS wie folgt:

Im Finder:
rechtsklick auf den Ordner, anschließend die Taste drücken.
Das Kontext-Menü ändert sich und es erscheint "Ordner" als Pfadname kopieren. Anschließend kann der Pfad im IDEA-Terminal durch das Drücken der Tasten ⌘V eingefügt werden.
Eine Bestätigung mit Return startet nun den Importvorgang. Je nachdem wie viele Bilder in der Seite enthalten sind, dauert es beim ersten Aufruf etwas, bis die Bilder prozessiert worden sind und die Seite im Browser verfügbar ist.

Trip Unlimited Script - Ordner als Pfadnamen kopieren

ALT ! - Markdown Image Tags umschreiben

AktionBeschreibung
Rewrite Image LinksSchreibt alle Markdown-Image Tags zu Nunchucks-Image Tags um

Extern erstellte Markdown Dateien haben einen falschen Bildverweis. Diese Aktion schreibt automatisch alle in den *.md-Dateien vorhandenen Bildverweise auf die für unsere Seite richtigen um.

Bearbeitungsdatum aktualisieren

AktionBeschreibung
Update Last Modified DateAktualisert das "Aktualisiert am"-Datum

Diese Aktion schreibt automatisch das aktuelle Tagesdatum sowie die aktuelle Uhrzeit im korrekten Format in die zu einer Seite gehörende *.json Datei.

Seite publizieren

AktionBeschreibung
Publish PageKennzeichnet eine Seite für die LIVE-Ausspielung

Neu erstellte Seiten werden immer im Status "preview" erstellt und sind damit von der Ausspielung auf der Live-Seite ausgenommen. Nur Seiten mit dem Status "live" werden ausgespielt.

Diese Aktion setzt den Status einer Seite auf "live".

Seite De-publizieren

AktionBeschreibung
De-Publish PageKennzeichnet eine Seite für die PREVIEW-Ausspielung

Neu erstellte Seiten werden immer im Status "preview" erstellt und sind damit von der Ausspielung auf der Live-Seite ausgenommen. Nur Seiten mit dem Status "live" werden ausgespielt.

Diese Aktion setzt den Status einer Seite auf "preview".

Script abbrechen

Das Programm kann jederzeit durch das gleichzeitige Drücken der Tasten ⌃C (ctrl-c) beendet werden

DRAFT