Ausgabegenerierungseinstellungen konfigurieren id181AI0B0E30

AEM Guides verfügt über eine Vielzahl von Konfigurationsoptionen, mit denen Sie den Output-Generierungsprozess anpassen können. In diesem Thema werden alle Konfigurationen und Anpassungen behandelt, die Ihnen bei der Einrichtung Ihres Ausgabegenerierungsprozesses helfen.

Konfigurieren der Registerkarte "Grundlinie"im DITA-Map-Dashboard id223MD0D0YRM

So blenden Sie die Registerkarte "Grundlinie"im DITA-Map-Dashboard aus:

Gemischte Veröffentlichung auf einer vorhandenen AEM-Site konfigurieren id1691I0V0MGR

Wenn Sie über eine AEM-Site verfügen, die DITA-Inhalte enthält, können Sie Ihre AEM Site-Ausgabe so konfigurieren, dass DITA-Inhalte an einer vordefinierten Stelle auf Ihrer Site veröffentlicht werden. Im folgenden Screenshot einer AEM Site-Seite ist der Knoten ditacontent beispielsweise zum Speichern von DITA-Inhalten reserviert:

Die verbleibenden Knoten auf der Seite werden direkt im AEM Site-Editor erstellt. Durch die Konfiguration der Veröffentlichungseinstellung zum Veröffentlichen von DITA-Inhalten an einem vordefinierten Speicherort wird sichergestellt, dass keiner Ihrer vorhandenen Nicht-DITA-Inhalte durch den AEM Guides-Veröffentlichungsprozess geändert wird.

Sie müssen die folgenden Konfigurationen auf Ihrer vorhandenen Site durchführen, um die Veröffentlichung von DITA-Inhalten in einem vordefinierten Knoten zu ermöglichen:

Führen Sie die folgenden Schritte aus, um die Vorlageneigenschaften Ihrer vorhandenen Site zu konfigurieren:

Wenn Sie das nächste Mal DITA-Inhalte mithilfe der Vorlagenkonfigurationen Ihrer Site veröffentlichen, wird der Inhalt in den Knoten veröffentlicht, die in den Eigenschaften topicContentNode und topicHeadNode angegeben sind.

AEM Site-Ausgabe anpassen id166TG0B30WR

AEM Guides unterstützt das Erstellen von Ausgaben in folgenden Formaten:

Für die AEM Site-Ausgabe können Sie verschiedene Designvorlagen mit verschiedenen Ausgabeaufgaben zuweisen. Diese Designvorlagen können den DITA-Inhalt in verschiedenen Layouts rendern. Sie können beispielsweise verschiedene Designvorlagen für interne und externe Zielgruppen angeben.

Sie können auch benutzerdefinierte DITA Open Toolkit (DITA-OT)-Plug-ins mit AEM Guides verwenden. Sie können diese benutzerdefinierten DITA-OT-Plug-ins hochladen, um eine PDF-Ausgabe auf eine bestimmte Art zu generieren.

Anpassen der Designvorlage zum Generieren der Ausgabe customize_xml-add-on

AEM Guides verwendet eine Reihe vordefinierter Designvorlagen, um AEM Site-Ausgabe zu generieren. Sie können die AEM Guides-Designvorlagen anpassen, um die Ausgabe zu generieren, die Ihrem Corporate Branding entspricht. Eine Designvorlage ist eine Sammlung verschiedener Stile (CSS), Skripte (Server- und Client-seitig), Ressourcen (Bilder, Logos und andere Assets) und JCR-Knoten, die alle diese Ressourcen miteinander verknüpfen. Eine Designvorlage kann so einfach sein wie ein einzelnes serverseitiges Skript mit nur einigen JCR-Knoten oder eine komplexe Kombination von Stilen, Ressourcen und JCR-Knoten. Designvorlagen werden vom AEM Guides Publishing-Subsystem verwendet, während AEM Site-Ausgabe generiert wird. Sie steuern die Struktur, das Erscheinungsbild der generierten Ausgabe.

Es gibt keine Einschränkung, wo sich die Ressourcen für die Designvorlage auf dem Server befinden sollten, aber sie sind in der Regel entsprechend ihrer Funktion logisch organisiert. Beispielsweise werden in der Standardvorlage alle JavaScript- und CSS-Dateien im Ordner "/etc/designs/fmdita/clientlibs/siteoutput/default"gespeichert. Wo immer sich diese Dateien befinden, werden sie durch eine Sammlung von JCR-Knoten verknüpft. Gemeinsam bilden diese JCR-Knoten und die Dateien die gesamte Designvorlage.

Mit der im Lieferumfang von AEM Guides enthaltenen Standard-Designvorlage können Sie die Komponenten für Landingpages, Themen und Suchseiten anpassen. Sie können eine Kopie des Standarddesigns und der entsprechenden Referenzvorlagen erstellen und verschiedene Komponenten angeben, um die gewünschte Ausgabe zu generieren.

Führen Sie die folgenden Schritte aus, um Ihre eigene Designvorlage für AEM Site-Ausgabegenerierung festzulegen:

Weitere Informationen finden Sie unter Erstellen Ihrer ersten Adobe Experience Manager-Website und Die Grundlagen zum Entwickeln Ihrer eigenen Website auf AEM.

Dokumenttitel zum Generieren AEM Site-Ausgabe verwenden

Beim Generieren AEM Site-Ausgabe spielt die Art und Weise, wie URLs generiert werden, eine wichtige Rolle bei der Entdeckung Ihres Inhalts. Wenn Sie UUID-basierte Dateinamen verwenden, wäre das Generieren von URLs basierend auf der UUID Ihrer Dateien nicht suchfreundlich. Als Administrator oder Herausgeber haben Sie die Kontrolle darüber, wie Sie die URLs für Ihre AEM Site-Ausgabe generieren möchten. AEM Guides bietet eine Konfiguration, mit der Sie die URLs AEM Site-Ausgabe mithilfe des Dateinamens und nicht der UUID-basierten Dateinamen generieren können. Standardmäßig ist diese Option bei UUID-basierten Dateisystemen aktiviert. Dies bedeutet, dass beim Generieren AEM Site-Ausgabe für UUID-basierte Dateisysteme die Dateinamen zum Generieren der URLs und nicht der UUIDs der Dateien verwendet werden.

Verwenden Sie die Anweisungen unter Konfigurationsüberschreibungen , um die Konfigurationsdatei zu erstellen. Geben Sie in der Konfigurationsdatei die folgenden (property) Details an, um die URLs zu konfigurieren, die in AEM Site-Ausgabe generiert werden:

URL der Ausgabe der AEM Site zur Verwendung des Dokumenttitels konfigurieren

Sie können die Dokumenttitel in der URL der AEM Site-Ausgabe verwenden. Wenn der Dateiname nicht vorhanden ist oder alle Sonderzeichen enthält, können Sie das System so konfigurieren, dass die Sonderzeichen in der URL der AEM Site-Ausgabe durch ein Trennzeichen ersetzt werden. Sie können sie auch so konfigurieren, dass sie durch den Namen des ersten untergeordneten Themas ersetzt werden.

Um die Seitennamen zu konfigurieren, führen Sie die folgenden Schritte aus:

Wenn beispielsweise @navtitle in <topichead> alle Sonderzeichen enthält und Sie die Eigenschaft aemsite.pagetitle auf "true"setzen, wird standardmäßig ein Trennzeichen verwendet. Wenn Sie die Eigenschaft nodename.systemDefinedPageName auf "true"setzen, wird der Name des ersten untergeordneten Themas angezeigt.

Konfigurieren von Bereinigungsregeln für Dateinamen zum Erstellen von Themen und Veröffentlichen AEM Site-Ausgabe id2164D0KD0XA

Als Administrator können Sie eine Liste gültiger Sonderzeichen definieren, die in Dateinamen zulässig sind und letztendlich die URL einer AEM Site-Ausgabe bilden. In früheren Versionen konnten Benutzer Dateinamen mit Sonderzeichen wie @, $, > und mehr definieren. Diese Sonderzeichen führten bei der Generierung AEM Site-Seiten zu einer kodierten URL.

Ab Version 3.8 wurden Konfigurationen hinzugefügt, um eine Liste von Sonderzeichen zu definieren, die in Dateinamen zulässig sind. Standardmäßig enthält die gültige Dateinamenkonfiguration "a-z A-Z 0-9 - _". Dies bedeutet, dass Sie beim Erstellen einer Datei beliebige Sonderzeichen im Dateinamen haben können, diese jedoch intern durch einen Bindestrich (-) im Dateinamen ersetzt werden. Sie können beispielsweise den Titel der Datei als Einführung 1 oder Introduction@1 festlegen. Der entsprechende Dateiname, der für beide Fälle generiert wurde, wäre Einführung-1.

Beachten Sie bei der Definition einer Liste gültiger Zeichen, dass diese Zeichen "*/:[\]|#%{}?&<>"/+" und "a space" immer durch einen Bindestrich (-) ersetzt werden.

Verwenden Sie die Anweisungen unter Konfigurationsüberschreibungen , um die Konfigurationsdatei zu erstellen. Geben Sie in der Konfigurationsdatei die folgenden (Eigenschaft)-Details an, um die gültigen Sonderzeichen in Dateinamen und AEM Site-Ausgabe zu konfigurieren:

Sie können auch die anderen Eigenschaften konfigurieren, z. B. Kleinschreibung in Dateinamen, Trennzeichen zur Verarbeitung ungültiger Zeichen und maximal zulässige Anzahl von Zeichen in Dateinamen. Um diese Eigenschaften zu konfigurieren, fügen Sie die folgenden Schlüssel-Wert-Paare in die Konfigurationsdatei ein:

Reduzieren AEM Site-Knotenstruktur konfigurieren

Wenn Sie AEM Site-Ausgabe generieren, wird intern ein Knoten für jedes Element in den Themen erstellt. Für eine DITA-Map mit Tausenden von Themen kann diese Knotenstruktur zu tief werden. Diese Art von tief verschachtelter Knotenstruktur kann Leistungsprobleme bei größeren Sites haben. Die folgende Momentaufnahme zeigt eine tief verschachtelte Knotenstruktur für eine AEM Site-Ausgabe:

Im obigen Schnappschuss sehen Sie, dass für jedes p -Element ein Knoten erstellt wird und dessen nachfolgende Unterelemente sowie eine ähnliche Struktur für jedes andere Element erstellt wird, das im Thema verwendet wird.

Mit AEM Guides können Sie konfigurieren, wie AEM Knotenstruktur der Site-Ausgabe intern erstellt wird. Sie können die Knotenstruktur bei bestimmten Elementen reduzieren. Das bedeutet, dass Sie ein Element definieren können, das als Hauptelement betrachtet wird. Alle darin enthaltenen Unterelemente werden mit dem Hauptelement zusammengeführt. Wenn Sie beispielsweise das Element p reduzieren möchten, wird jedes Element, das im Element p erscheint, mit dem Hauptelement p zusammengeführt. Für kein Unterelement innerhalb des Elements p wird ein separater Hinweis erstellt. Die folgende Momentaufnahme zeigt die Knotenstruktur, die auf das Element p reduziert wird:

So reduzieren Sie AEM Site-Knotenstruktur:

Wenn Sie jetzt die Ausgabe der AEM Site generieren, werden die Knoten im Element p reduziert und im Element p selbst gespeichert. Sie finden die neuen Reduzierungseigenschaften für das Element p in CRXDE.

Suchen Sie eine Zeichenfolge innerhalb des Inhalts in AEM Site-Ausgabe

Standardmäßig können Sie in den Titeln nur in der AEM Site-Ausgabe nach einer Zeichenfolge suchen. Sie können das System so konfigurieren, dass sowohl in den Titeln als auch im Inhalt oder im Hauptteil der AEM Site-Ausgabe nach einer Zeichenfolge gesucht wird.

Um die Suche zu aktivieren, sollten Sie die Reduzierung AEM Site-Knotenstruktur konfigurieren.

VORSICHT:

Sie können bis zu 1 MB reduzierten Inhalt durchsuchen. Im vorherigen Screenshot können Sie beispielsweise suchen, ob der Inhalt unter dem Tag <p> <= 1Mb ist.

Reduzieren AEM Site-Knotenstruktur verhindern

Ähnlich wie beim Festlegen des Knotens, der in AEM Site-Ausgabe reduziert werden soll, können Sie auch ein Element angeben, das Sie aus dieser Konfiguration ausschließen möchten. Wenn Sie beispielsweise Knoten beim Element body reduzieren möchten, aber kein Element table innerhalb von body reduziert werden soll, können Sie die Eigenschaft exclude innerhalb der Definition des Elements table hinzufügen.

Um das Element table vom Reduzieren auszuschließen, fügen Sie die folgende Eigenschaft zur Definition des Elements table hinzu:

<preventancestorflattening>true|false</preventancestorflattening>

Versionierung für gelöschte Seiten in AEM Site-Ausgabe konfigurieren

Wenn Sie AEM Site-Ausgabe mit der für die Einstellung Vorhandene Ausgabeseiten ausgewählten Option Löschen und Erstellen ​ ​generieren, wird eine Version für die zu löschende(n) Seite(n) erstellt. Sie können das System so konfigurieren, dass vor dem Löschen die Erstellung einer Version angehalten wird.

Führen Sie die folgenden Schritte aus, um die Erstellung einer Version für die zu löschende(n) Seite zu stoppen:

Einrichten eines benutzerdefinierten Rewriters mit Experience Manager Guides custom-rewriter

Experience Manager Guides verfügt über ein benutzerdefiniertes Sling-Modul rewriter für die Behandlung von Links, die bei Querkarten generiert werden (Links zwischen den Themen zweier verschiedener Maps). Diese Rewriter-Konfiguration wird unter folgendem Pfad installiert:
/apps/fmdita/config/rewriter/fmdita-crossmap-link-patcher.

Wenn Sie in Ihrer Codebasis über einen anderen benutzerdefinierten Sling-Rewriter verfügen, verwenden Sie einen 'order' -Wert größer als 50, da der Experience Manager Guides Sling-Rewriter 'order' 50 verwendet. Um dies zu überschreiben, benötigen Sie einen Wert > 50 . Weitere Informationen finden Sie unter Pipelines zum Neuschreiben der Ausgabe.

Verwenden von Metadaten bei der Veröffentlichung der Ausgabe über DITA-OT id191LF0U0TY4

AEM Guides bietet eine Möglichkeit, benutzerdefinierte Metadaten beim Veröffentlichen der Ausgabe mithilfe von DITA-OT zu übergeben. Als Administrator und Herausgeber müssen Sie die folgenden Aufgaben ausführen, um benutzerdefinierte Metadaten in der veröffentlichten Ausgabe zu konfigurieren und zu verwenden:

Um die erforderlichen Metadaten im System hinzuzufügen, führen Sie die folgenden Schritte aus:

Der neue Parameter wird jetzt auf der Seite Eigenschaften für alle DITA-Maps angezeigt.

Als Nächstes müssen Sie die benutzerdefinierten Metadaten in der DITA-Map-Konsole verfügbar machen. Führen Sie die folgenden Schritte aus, um die benutzerdefinierten Metadaten auf der DITA Map-Dashboards verfügbar zu machen:

Jetzt werden die benutzerdefinierten Metadaten in der Dropdownliste Eigenschaften der DITA-Map-Konsole angezeigt.

Als Herausgeber müssen Sie schließlich die benutzerdefinierten Metadaten in die veröffentlichte Ausgabe aufnehmen. Um die benutzerdefinierten Metadaten beim Generieren der Ausgabe zu verarbeiten, führen Sie die folgenden Schritte aus:

Die ausgewählten Eigenschaften/Metadaten werden an den Veröffentlichungsprozess übergeben und in der endgültigen Ausgabe verfügbar gemacht.

Validieren von Metadaten, die zur Verarbeitung an DITA-OT übergeben werden

Um die an DITA-OT übergebenen Metadatenwerte zu überprüfen, kann eine lokale Umgebung mit einer Cloud-fähigen JAR-Datei verwendet werden. Da wir nicht auf das lokale Dateisystem in der Cloud zugreifen können, ist die einzige Möglichkeit, die Metadatendatei zu überprüfen, über die Cloud-fähige JAR-Datei.

DITA-Elementzuordnung mit AEM Komponenten anpassen id1679J600HEL

DITA-Elemente in der AEM Guides werden ihren entsprechenden AEM-Komponenten zugeordnet. AEM Guides verwendet diese Zuordnung in Workflows wie Veröffentlichung und Überprüfung, um DITA-Elemente in eine entsprechende AEM zu konvertieren. Die Zuordnung wird in der Datei "elementmapping.xml" definiert, auf die über den Package Manager zugegriffen werden kann.

Sie können die vordefinierten DITA-Elementzuordnungen verwenden oder DITA-Elemente Ihren benutzerdefinierten AEM zuordnen. Um Ihre benutzerdefinierten AEM-Komponenten zu verwenden, müssen Sie die Struktur der elementmapping.xml-Datei verstehen.

elementmapping.xml structure

Eine allgemeine Übersicht über die Struktur von elementmapping.xml wird nachfolgend beschrieben:

DITA-Elementschema

Im Folgenden finden Sie ein Beispiel für das DITA-Elementschema in der Datei elementmapping.xml :

<ditaelement>
    <name>element_name</name>
    <class>element_class</class>
    <componentpath>fmdita/components/dita/component_name</componentpath>
    <type>COMPOSITE|STANDALONE</type>
    <attributeprop>propname_a</attributeprop>
    <textprop>propname_t</textprop>
    <xmlprop>propname_x</xmlprop>
    <xpath>xpath expression string</xpath>
    <target>head|para</target>
    <wrapelement>div</wrapelement>
    <wrapclass>class_name</wrapclass>
    <attributemap>
        <attribute from="attrname"         to="propname"         ispath="true|false"         rel="source|target" />
    </attributemap>
    <skip>true|false</skip>
</ditaelement>

In der folgenden Tabelle werden die Elemente im DITA-Elementschema beschrieben:

Zusätzliche Hinweise

DITA-Map-Konsole anpassen id188HC08M0CZ

AEM Guides bietet Ihnen die Flexibilität, die Funktionen der DITA-Map-Konsole zu erweitern. Wenn Sie beispielsweise eine Reihe von Berichten haben, die sich von den in der AEM Guides verfügbaren Berichten unterscheiden, können Sie diese Berichte zur Zuordnungskonsole hinzufügen. Um die Zuordnungskonsole anzupassen, müssen Sie eine AEM Client-Bibliothek (oder ClientLib) erstellen, die den Code enthält, um die benötigten Funktionen auszuführen.

AEM Guides stellt die Kategorie "apps.fmdita.dashboard-extn"zum Anpassen der Zuordnungskonsole bereit. Bei jedem Laden der Zuordnungskonsole wird die unter der Kategorie apps.fmdita.dashboard-extn erstellte Funktion ausgeführt und geladen.

Verarbeiten der Bilddarstellung während der Ausgabegenerierung id177BF0G0VY4

AEM enthält eine Reihe von Standard-Workflows und Medien-Handles zur Verarbeitung von Assets. In AEM gibt es vordefinierte Workflows für die Verarbeitung von Assets für die häufigsten MIME-Typen. Normalerweise erstellt AEM für jedes Bild, das Sie hochladen, mehrere Ausgabeformate desselben Binärformats. Diese Ausgabedarstellungen können unterschiedlich groß sein, mit einer anderen Auflösung, einem hinzugefügten Wasserzeichen oder anderen geänderten Eigenschaften. Weitere Informationen dazu, wie AEM mit Assets umgehen, finden Sie unter Verarbeiten von Assets mithilfe von Medien-Handlern und Workflows in AEM Dokumentation.

Mit AEM Guides können Sie konfigurieren, welche Bilddarstellung zum Zeitpunkt der Generierung der Ausgabe für Ihre Dokumente verwendet werden soll. Sie können beispielsweise aus einer der standardmäßigen Bildausgabeformate wählen oder eine erstellen und zum Veröffentlichen Ihrer Dokumente dasselbe verwenden. Die Bildwiedergabe-Zuordnung zum Veröffentlichen Ihrer Dokumente wird in der Datei /libs/fmdita/config/ **renditionmap.xml** gespeichert. Ein Codefragment der Datei renditionmap.xml stellt sich wie folgt dar:

<renditionmap>
   <mapelement>
      <mimetype>image/png</mimetype>
      <rendition output="AEMSITE">cq5dam.web.1280.1280.jpeg</rendition>
      <rendition output="PDF">original</rendition>
      <rendition output="HTML5">cq5dam.web.1280.1280.jpeg</rendition>
      <rendition output="EPUB">cq5dam.web.1280.1280.jpeg</rendition>
      <rendition output="CUSTOM">cq5dam.web.1280.1280.jpeg</rendition>
   </mapelement>
...
</renditionmap>

Das Element mimetype gibt den MIME-Typ des Dateiformats an. Das Element rendition output gibt den Typ des Ausgabeformats und den Namen der Ausgabedarstellung (z. B. cq5dam.web.1280.1280.jpeg) an, die zum Veröffentlichen der angegebenen Ausgabe verwendet werden soll. Sie können die Bildausgabeformate angeben, die für alle unterstützten Ausgabeformate verwendet werden sollen - AEMSITE, PDF, HTML5, EPUB und CUSTOM.

Wenn die angegebene Ausgabedarstellung nicht vorhanden ist, sucht der AEM Guides-Veröffentlichungsprozess zunächst nach der Webdarstellung des angegebenen Bildes. Wenn selbst die Webausgabe nicht gefunden wird, wird die ursprüngliche Ausgabe des Bildes verwendet.

Konfigurieren des Zeitrahmens für die automatische Bereinigung für den Ausgabestverlauf id19AAI070V8Q

Wenn Sie eine Ausgabe generieren, wird die Ausgabe zusammen mit den Ausgabsprotokollen erstellt. Bei großen DITA-Maps können diese Protokolle viel Platz in Ihrem Repository beanspruchen. Standardmäßig werden die Protokolle am folgenden Speicherort im Repository gespeichert:

/var/dxml/metadata/outputHistory

Über einen bestimmten Zeitraum konnte die kollektive Größe aller Protokolldateien in GBs dargestellt werden. Mit AEM Guides können Sie einen Zeitraum konfigurieren, um diese Protokolldateien im Repository zu speichern. Nach dem angegebenen Zeitraum werden die Protokolle zusammen mit dem Ausgabegenerierungsverlauf aus dem Repository gelöscht.

Die Konfiguration der Verlaufsbereinigungsfunktion wirkt sich auf die Generierung der Ausgabe für alle DITA-Maps im Repository aus. Auf der Registerkarte "Outputs"einer DITA-Zuordnung wird der Verlauf nach der angegebenen Anzahl von Tagen und zu der in der Einstellung festgelegten Zeit bereinigt.

Verwenden Sie die Anweisungen unter Konfigurationsüberschreibungen , um die Konfigurationsdatei zu erstellen. Geben Sie in der Konfigurationsdatei die folgenden (Eigenschaft)-Details an, um einen Tag und eine Uhrzeit für die Bereinigung des Ausgabedarstellungsverlaufs und der -protokolle festzulegen:

Ändern der zuletzt generierten Ausgabelistenbegrenzung id1679JH0H0O2

Sie können die maximale Anzahl der generierten Ausgaben ändern, die auf der Registerkarte "Ausgaben"für eine DITA-Zuordnung angezeigt werden.

Verwenden Sie die Anweisungen unter Konfigurationsüberschreibungen , um die Konfigurationsdatei zu erstellen. Geben Sie in der Konfigurationsdatei die folgenden (Eigenschaft)-Details an, um die Anzahl der Ausgaben zu ändern, die in der Liste angezeigt werden sollen: