Generierung ausführen

Die Aktion „Generierung ausführen“ dient dazu, eine Voll- bzw. Teilgenerierung des gewählten Projekts durchzuführen (siehe auch Zeitplanung).

Eine Vollgenerierung generiert alle Inhalte des Projekts, eine Teilgenerierung nur die ausgewählten „Startpunkte“ und deren Kinder.

Zu weiteren Informationen über die Generierung in FirstSpirit siehe auch Generierung (→Online Dokumentation FirstSpirit).

Register "Eigenschaften"

Vollgenerierung

Vollgenerierung durchführen: Ist diese Option aktiviert, wird das Projekt bei der Auftragsausführung vollständig generiert.

Ergänzend zur zeitintensiven Vollgenerierung eines Projektes besteht die Möglichkeit, nur die geänderten Inhalte eines Projektes (bezogen auf die letzte erfolgreiche Generierung) über die FirstSpirit Access-API zu ermitteln und nur diese zu generieren („Delta-Generierung“). Eine Gegenüberstellung der einzelnen Generierungsarten sowie ein Konfigurationsbeispiel für eine Delta-Generierung findet sich in Generierung (→Online Dokumentation FirstSpirit).

Teilgenerierung

Teilgenerierung durchführen für folgende Startpunkte: Ist diese Option aktiviert, werden nur die in der nachfolgenden Tabelle „Startpunkte“ angezeigten Knoten generiert (einschließlich aller untergeordneten Startpunkte):

Teilgenerierung ausführen

Startpunkte: Diese Tabelle zeigt alle Startpunkte, die bei Ausführung der Aktion generiert werden sollen. Die ausgewählten Elemente werden rekursiv durchlaufen. Wird also beispielsweise ein Medien-Ordner hinzugefügt, sind auch alle untergeordneten Elemente (Medien und weitere Ordner) ein Bestandteil des Generierungsauftrags.

Durch einen Klick auf die Schaltfläche „Hinzufügen“ öffnet sich ein Dialog, der alle verfügbaren und noch nicht ausgewählten Startpunkte des Projekts anzeigt (aktueller Stand des Projekts). Knoten, die noch nie freigegeben waren, und eine Generierung somit zu Problemen führen kann, werden im Dialog speziell visualisiert („Es wurden Startpunkte definiert, die im Freigabestand nicht verfügbar sind!“).

Durch einen Klick auf den Button „Löschen“ wird der selektierte Startpunkt gelöscht.

Vom Benutzer definierbar? (nur für interaktive Aufträge): Für eine Teilgenerierung kann die Option „Vom Benutzer definierbar“ aktiviert werden. Durch das Aktivieren der Option kann der Projekt-Administrator dem Benutzer gestatten, eigene Startpunkte für die Generierung beim Ausführen des Auftrags festzulegen. Diese Änderungen wirken sich nur auf die aktuelle Generierung aus.

Innerhalb eines Generierungsauftrags können auch Startpunkte für die Generierung von Medien definiert werden.

Hintergrund: Beim Veröffentlichen von Projektinhalten werden referenzierte Medien, beispielsweise innerhalb einer Bildeingabekomponente auf einer Seite, ebenfalls generiert und veröffentlicht. Medien, die nicht explizit referenziert werden, werden bei der Generierung nicht automatisch berücksichtigt. In einigen Anwendungsfällen, beispielsweise wenn Medien innerhalb eines Skriptes verwendet werden, müssen auch diese Medien in der Generierung enthalten sein.

Die Generierung von Medien kann einzelnen Generierungsaufträgen zugeordnet werden. Zielsetzung dieser Option ist es, eine schnellere Veröffentlichung einzelner Teilbereiche zu ermöglichen. Das Auslagern der rechenzeitintensiven Generierung von Medien in separate Generierungsaufträge bietet, insbesondere beim Ausführen mehrerer kleiner Teilgenerierungen, einen hohen Performancegewinn, da für jede Generierung ausschließlich die gewünschten Medien berücksichtigt werden. Diese Option eignet sich aber auch ideal, um beispielsweise Medien in einem Remote-Projekt zu veröffentlichen („Remote-Medien“, siehe Remote-Projekte).

Medien, für die die Option „Datei parsen“ aktiviert ist (siehe Datei-Ebene (→Handbuch FirstSpirit SiteArchitect)), werden nicht generiert/veröffentlicht, wenn sie unterhalb eines gewählten Startpunkts liegen und auf keiner Seite der Generierung referenziert werden.

Weitere Eigenschaften

Generieren nur wenn erforderlich: Ist diese Option aktiviert, wird vor der Generierung geprüft, ob es seit der letzten Ausführung Änderungen an dem Projekt gab. Die Generierung wird nur durchgeführt, wenn im Projekt eine neue Revision erzeugt wurde (vgl. auch Delta-Generierung).

Bitte beachten Sie, dass die Verwendung dieser Option zusammen mit dem manuellen Erzeugen einer neuen Revision vor der Generierung - was in manchen Konstellationen notwendig ist - keinen Sinn macht!

Generierungsverzeichnis vorher leeren: Ist diese Option aktiviert, wird das Generierungsverzeichnis vor Beginn der Generierung geleert.

Freigabestand generieren: Bei einem Freigabeprojekt (vgl. Option Freigaben nutzen) unterscheidet FirstSpirit zwischen dem freigegebenen und dem aktuellen Projektstand. Nutzt ein Projekt diese Option, müssen Änderungen im Projekt durch einen Benutzer mit entsprechenden Rechten (z. B. durch den Chefredakteur) freigegeben werden, um im generierten Stand sichtbar zu sein. Ein nicht freigegebener Projektstand, beispielsweise einer Seite aus der Inhalte-Verwaltung, wird bei der nächsten Generierung nicht übernommen. (Stattdessen wird der letzte freigegebene Stand der Seite berücksichtigt.)

Ist diese Option aktiviert, wird der Freigabestand für das Projekt generiert (Standardeinstellung).

Ist die Option deaktiviert, wird der aktuelle Stand für das Projekt generiert (auch wenn dieser Änderungen enthält, die zum gegenwärtigen Zeitpunkt noch nicht freigegeben sind).

Medien im Generierungsverzeichnis erzeugen: Ist diese Option aktiviert, werden alle referenzierten Medien bei der Generierung automatisch im Generierungsverzeichnis erzeugt.
Ist die Option deaktiviert, werden bei der Generierung keine Medien im Generierungsverzeichnis erzeugt (Ausnahme: geparste Medien). Damit kann die I/O-Last und der beanspruchte Plattenplatz im Generierungsverzeichnis reduziert werden. Eine Übertragung der Medien wird durch diese Option nicht unterbunden, da bei einer Veröffentlichung über FirstSpirit-interne Veröffentlichungsmechanismen (in Dateisystem, per FTP oder per CRC) alle referenzierte Medien, die nicht im Generierungsverzeichnis vorliegen, über das BerkeleyDB-Backend gestreamt werden. Dies gilt nicht für andere, externe Übertragungsmechanismen (z. B. via rsync, siehe Sichere Veröffentlichung über rsync und ssh). (Hinweis: Ist die Option deaktiviert, ist das Generierungsverzeichnis (fs5staging) nicht „browse-bar“.)

ACL-Datenbank nutzen: Ist diese Option aktiviert, werden bei einer Generierung Informationen – für jede Seitenreferenz in der Struktur-Verwaltung und für jedes Medium in der Medien-Verwaltung – in einer lokalen Datenbank hinterlegt, der so genannten „FirstSpirit-Access-Control-Datenbank“, kurz „ACL-Datenbank“. Diese Datenbank dient zur Bereitstellungen von Informationen zu FirstSpirit-Objekten, beispielsweise zur Bereitstellung von Zugriffsrechten, die für ein Objekt gespeichert wurden. Die Daten werden mit einem Zeitstempel versehen, der bei der zukünftigen Erzeugung der Datei als Dateidatum verwendet wird. Sofern der Inhalt der Datei sich nicht ändert, ändert sich auch nicht deren Dateidatum. Dies hat den Vorteil, dass die Dateien auch vom Live-Server als nicht geändert angesehen werden und somit beispielsweise nicht neu kompiliert werden müssen.
Die Synchronisation der Access-Control-Datenbank mit dem aktuell freigegebenen Projektstand erfolgt automatisch bei der Generierung der Inhalte.
Weiterführende Informationen zur ACL-Datenbank siehe "Dokumentation zum Modul FirstSpirit Security".

Pfaderzeugung: Aus dieser Liste wird eine Methode zur Pfaderzeugung ausgewählt. Aktuell gibt es vier verschiedene Arten der Erzeugung:

• Advanced URLs: Bei dieser Methode werden die Anzeigenamen der FirstSpirit-Objekte für die URL-Erzeugung zugrunde gelegt (siehe dazu Advanced URLs (→Online Dokumentation FirstSpirit)).
• Default URLs: Bei dieser Methode existiert für jede Sprache des Projekts ein eigener Unterordner auf dem Webserver (de, en, etc., siehe dazu Generierung (→Online Dokumentation FirstSpirit).
• Multiview URLs: Bei dieser Methode existieren keine sprachspezifischen Unterordner, stattdessen werden die Dateien für jede Sprache mit dem jeweiligen Sprachkürzel gekennzeichnet. Dabei werden die Sprachkürzel nach der Dateierweiterung eingefügt (z. B. index.html.de, index.html.en, vgl. Optionen).
• Infix URLs: Bei dieser Methode existieren ebenfalls keine sprachspezifischen Unterordner, stattdessen werden die Dateien für jede Sprache mit dem jeweiligen Sprachkürzel gekennzeichnet. Dabei werden die Sprachkürzel vor der Dateierweiterung eingefügt (z. B. index.de.html, index.en.html).

Präfix für absolute Pfade: Der hier eingegebene Präfix wird allen Links vorangestellt, welchen in einem Template (im SiteArchitect) die Eigenschaft eines absoluten Links zugewiesen wird.

Erfolgreich nur wenn: Es gibt 2 Optionen zu entscheiden, wann eine Generierung erfolgreich ist und wann nicht:

• Keine schweren Fehler und Schwellwerte eingehalten
• Keine schweren Fehler

In beiden Fällen wird die Generierung abgebrochen, sobald ein schwerwiegender Fehler auftritt. Treten keine schweren Fehler auf, gilt die Generierung bei der Option „Keine schweren Fehler“ immer und bei der Option „Keine schweren Fehler und Schwellwerte eingehalten“ nur als erfolgreich, wenn die folgenden Schwellwerte nicht überschritten werden:

• Schwellwert für normale Fehler
• Schwellwert für Warnungen

Register "Erweitert"

Vorlagensätze

Vorlagensätze: Über diesen Bereich kann definiert werden, für welchen Vorlagensatz in welcher Sprache die Generierung durchgeführt werden soll.

Variablen

Variablen: Über dieses Feld können Variablen im Generierungsauftrag gesetzt werden, die bei der Generierung eines Projekts ausgelesen werden. Sie sind im gesamten Projekt verfügbar, so dass z. B. in Seiten- und Absatzvorlagen auf diese Variablen zugegriffen werden kann.
In den Projekteinstellungen (Projekteinstellungen (→Handbuch FirstSpirit SiteArchitect)) stehen die hier definierten Variablen standardmäßig nicht zur Verfügung. Zu Informationen, wie die hier definierten Variablen auch in den Projekteinstellungen verfügbar gemacht werden können, siehe Sonderfälle (→Online Dokumentation FirstSpirit).
In Generierungsaufträgen gesetzte Variablen können darüber hinaus z. B. Variablen überschreiben, die im Projekt auf Menüebenen definiert wurden. Siehe dazu auch projektbezogen (→Online Dokumentation FirstSpirit).

Variablen für den Generierungsauftrag können mit Bezeichner und Wert über die Schaltfläche „Hinzufügen“ definiert werden. Bereits vorhandene Variablen können über die Schaltfläche „Löschen“ wieder entfernt werden. Zur Verwendung von Variablen in FirstSpirit (Definition, Ausgabe, Vererbung, Überschreiben) siehe auch Variablen (→Online Dokumentation FirstSpirit).

Die reservierte Variable

media_resolution_tags

kann verwendet werden, um bei einer Medien-Generierung (Startpunkt der Generierung liegt in der Medien-Verwaltung) nur Auflösungen zu berücksichtigen, für die die angegebenen Tags aktiviert sind (siehe dazu Seite Auflösungen). Mehrere Tags werden per Komma separiert.

Clustering

Clustering: siehe dazu Seite Konfiguration.
Über den Aufruf #global.scheduleContext kann auf den Ausführungskontext eines Generierungsauftrags zugegriffen werden und damit auf Informationen wie z. B. den Projektnamen, den Start-Zeitpunkt des Auftrags, den Pfad zum Generierungsverzeichnis, die Fehleranzahl bei der Generierung usw. Das Interface de.espirit.firstspirit.access.schedule.ScheduleContext, das die notwendigen Methoden bereitstellt, ist in der FirstSpiritAccess-API verfügbar.