Das Seiten-Exporttool

AEM bietet Ihnen die Möglichkeit, eine Seite als vollständige Webseite einschließlich aller Grafiken, JS- und CSS-Dateien zu exportieren.

Wenn Sie den Export konfiguriert haben, können Sie einfach eine Seite im Browser anfordern. Ersetzen Sie dafür in der URL html durch export.zip. So erzeugen Sie den Download einer ZIP-Datei, in der die gerenderte Seite im HTML-Format und die referenzierten Assets enthalten sind. Alle in der Seite enthaltenen Pfade, z. B. Pfade zu Grafiken, werden umgeschrieben und verweisen entweder auf die in der ZIP-Datei enthaltenen Dateien oder auf die Ressourcen auf dem Server.

Exportieren einer Seite

Die folgenden Schritte beschreiben, wie Sie eine Seite exportieren können. Vorausgesetzt wird, dass für Ihre Website eine Vorlage für die Exportkonfiguration vorliegt: Eine Konfigurationsvorlage legt fest, wie eine Seite exportiert wird, und gilt speziell für Ihre Website. Informationen zum Erstellen einer Konfigurationsvorlage finden Sie im Abschnitt Erstellen einer Seitenexportkonfiguration für Ihre Site.

So exportieren Sie eine Seite:

1. Öffnen Sie die Seite im Browser. Beispiel:

2. http://localhost:4502/content/geometrixx/en/products/triangle.html

3. Öffnen Sie das Dialogfeld „Seiteneigenschaften“, wählen Sie die Registerkarte Erweitert und erweitern Sie das Feld Exportieren.

4. Klicken Sie auf das Lupensymbol und wählen Sie eine Konfigurationsvorlage aus. Wählen Sie die geometrixx-Vorlage aus; sie ist die standardmäßige Vorlage für die Geometrixx-Website. Klicken Sie auf OK.

5. Klicken Sie auf OK, um das Dialogfeld „Seiteneigenschaften“ zu schließen.

6. Fordern Sie die Seite an, indem Sie html durch export.zip in der URL ersetzen.

7. Laden Sie die Datei <page-name>.export.zip in Ihr Dateisystem herunter.

8. Entpacken Sie in Ihrem Dateisystem die Datei:

   • Die HTML-Datei der Seite ( <page-name>.html) ist unterhalb von <unzip-dir>/<page-path> verfügbar.
   • Die anderen Ressourcen (JS- und CSS-Dateien, Grafiken usw.) befinden sich in den in der Exportvorlage festgelegten Verzeichnissen. In diesem Beispiel befinden sich einige Ressourcen unter <unzip-dir>/etc, einige unter <unzip-dir>/<page-path>.

9. Öffnen Sie die HTML-Datei der Seite ( <unzip-dir>/<page-path>.html) in Ihrem Browser, um die Wiedergabe zu überprüfen.

Erstellen einer Seiten-Exporttoolkonfiguration für Ihre Website

Das Seiten-Exporttool basiert auf dem Inhaltssynchronisierungs-Framework. Die im Dialogfeld "Seiteneigenschaften"verfügbaren Konfigurationen sind Konfigurationsvorlagen. Sie definieren alle erforderlichen Abhängigkeiten einer Seite. Wenn ein Seitenexport ausgelöst wird, wird die Konfigurationsvorlage verwendet und sowohl der Seitenpfad als auch der Entwurfspfad werden dynamisch auf die Konfiguration angewendet. Anschließend wird die ZIP-Datei erstellt, indem die Standardfunktion zur Inhaltssynchronisierung genutzt wird.

AEM bettet einige Vorlagen ein, darunter eine:

• Eine Standardeinstellung bei /etc/contentsync/templates/default. Diese Vorlage:

  • Dient als Fallback-Vorlage, wenn keine Konfigurationsvorlage im Repository gefunden wird
  • Kann als Grundlage für eine neue Konfigurationsvorlage dienen.

• Eines, das der Geometrixx-Site unter /etc/contentsync/templates/geometrixx gewidmet ist. Diese Vorlage kann als Beispiel verwendet werden, um eine neue zu erstellen.

So erstellen Sie eine Konfigurationsvorlage für das Seiten-Exporttool:

1. Erstellen Sie in CRXDE Lite einen Knoten unter /etc/contentsync/templates:

   • Name: z. B. mysite. Der Name wird im Dialogfeld "Seiteneigenschaften"angezeigt, wenn Sie die Vorlage für den Seitenexporteur auswählen.
   • Typ: nt:unstructured

2. Erstellen Sie unter dem Vorlagenknoten (in diesem Beispiel: mysite) eine Knotenstruktur mit den unten beschriebenen Konfigurationsknoten.

Konfigurationsknoten für das Seiten-Exporttool

Die Konfigurationsvorlage besteht aus einer Knotenstruktur. Jeder Knoten verfügt über die Eigenschaft type, die eine spezifische Aktion beim Erstellungsprozess der ZIP-Datei definiert. Weitere Informationen zur type-Eigenschaft finden Sie im Abschnitt Übersicht über Konfigurationstypen auf der Seite Inhaltssynchronisierung-Framework.

Mit den folgenden Knoten können Sie eine Export-Konfigurationsvorlage erstellen:

page nodeDer Seitenknoten wird verwendet, um die Seiten-HTML in die ZIP-Datei zu kopieren. Er weist die folgenden Eigenschaften auf:

• Er ist ein obligatorischer Knoten.
• Befindet sich unterhalb von /etc/contentsync/templates/<sitename>.
• Der Name ist page.
• Der Node-Typ ist nt:unstructured

Der Knoten page hat folgende Eigenschaften:

• Eine type-Eigenschaft mit dem Wert pages.

• Er verfügt nicht über die Eigenschaft path, da der aktuelle Seitenpfad dynamisch in die Konfiguration kopiert wird.

• Die anderen Eigenschaften werden im Abschnitt Übersicht über die Konfigurationstypen des Content Sync-Frameworks beschrieben.

rewrite nodeDer rewrite-Knoten definiert, wie die Links auf der exportierten Seite umgeschrieben werden. Die neu geschriebenen Links können entweder auf die Dateien in der ZIP-Datei oder auf die Ressourcen auf dem Server verweisen.

Auf der Seite Inhaltssynchronisierung finden Sie eine vollständige Beschreibung des Knotens rewrite.

design nodeDie Design-Node wird verwendet, um den Entwurf zu kopieren, der für die exportierte Seite verwendet wird. Er weist die folgenden Eigenschaften auf:

• Er ist optional.
• Befindet sich unterhalb von /etc/contentsync/templates/<sitename>.
• Der Name ist design.
• Der Knotentyp ist nt:unstructured.

Der Knoten design hat folgende Eigenschaften:

• Eine type-Eigenschaft, die auf den Wert copy gesetzt ist.

• Er verfügt nicht über die Eigenschaft path, da der aktuelle Seitenpfad dynamisch in die Konfiguration kopiert wird.

generischer KnotenEin generischer Knoten wird verwendet, um Ressourcen wie clientlibs .js- oder .css-Dateien in die ZIP-Datei zu kopieren. Er weist die folgenden Eigenschaften auf:

• Er ist optional.
• Befindet sich unterhalb von /etc/contentsync/templates/<sitename>.
• Er weist keinen bestimmten Namen auf.
• Der Knotentyp ist nt:unstructured.
• Verfügt über eine type-Eigenschaft und alle type-verwandten Eigenschaften, wie im Abschnitt Übersicht über Konfigurationstypen des Content Sync-Frameworks definiert.

Beispielsweise kopiert der folgende Konfigurationsknoten die JS-Dateien der Geometrixx-Clientlibs in die ZIP-Datei:

"geometrixx.clientlibs.js": {
    "extension": "js",
    "type": "clientlib",
    "path": "/etc/designs/geometrixx/clientlibs",
    "jcr:primaryType": "nt:unstructured"
}

Die Geometrixx-Konfigurationsvorlage für das Seiten-Exporttool zeigt, wie Sie einen Seitenexport konfigurieren können. Um die Knotenstruktur der Vorlage in Ihrem Browser im JSON-Format anzuzeigen, fordern Sie die folgenden URL an:

http://localhost:4502/etc/contentsync/templates/geometrixx.-1.json

Implementieren einer benutzerdefinierten Konfiguration

Wie Sie vielleicht bei der Knotenstruktur bemerkt haben, verfügt die Geometrixx-Konfigurationsvorlage für das Seiten-Exporttool über den Knoten logo, bei dem die Eigenschaft typeauf image festgelegt ist. Das ist ein spezieller Konfigurationstyp, der erstellt wurde, um das Grafiklogo in die ZIP-Datei zu kopieren. Um bestimmte Anforderungen zu erfüllen, müssen Sie möglicherweise eine benutzerdefinierte Eigenschaft type implementieren. Informationen hierzu finden Sie im Abschnitt Implementieren eines benutzerdefinierten Aktualisierungshandlers auf der Seite „Inhaltssynchronisierung“.

Programmatisches Exportieren einer Seite

Um eine Seite programmatisch zu exportieren, können Sie den OSGi-Dienst PageExporter nutzen. Mit diesem Dienst können Sie:

• eine Seite exportieren und in die HTTP-Servlet-Antwort schreiben
• eine Seite exportieren und die ZIP-Datei an einem bestimmten Ort speichern

Das Servlet, das an den Selektor export und die Erweiterung zip gebunden ist, verwendet den PageExporter-Dienst.

Fehlerbehebung

Wenn beim Herunterladen der ZIP-Datei ein Problem auftritt, können Sie den Knoten /var/contentsync im Repository löschen und die Exportanforderung erneut senden.