Einstellungen für die Ausgabegenerierung konfigurieren id181AI0B0E30
AEM Guides bietet viele Konfigurationsoptionen, mit denen Sie den Prozess der Ausgabenerstellung anpassen können. In diesem Abschnitt werden alle Konfigurationen und Anpassungen behandelt, die Ihnen beim Einrichten des Prozesses der Ausgabenerstellung helfen.
Konfigurieren der Registerkarte „Baseline“ im Dashboard „DITA-Zuordnung“ id223MD0D0YRM
Führen Sie die folgenden Schritte aus, um die Registerkarte „Baseline“ im DITA-Zuordnungs-Dashboard auszublenden:
- Verwenden Sie die Anweisungen unter Konfigurationsüberschreibungen, um die Konfigurationsdatei zu erstellen.
- Geben Sie in der Konfigurationsdatei die folgenden (Eigenschaft)-Details ein, um die Registerkarte „Baseline“ im Zuordnungs-Dashboard zu konfigurieren.
com.adobe.fmdita.config.ConfigManager
hide.tabs.baseline
true/false
).Standardwert: true
Konfigurieren von gemischten Veröffentlichungen innerhalb einer bestehenden AEM-Site id1691I0V0MGR
Wenn Sie über eine AEM-Site verfügen, die DITA-Inhalte enthält, können Sie die Ausgabe Ihrer AEM-Site so konfigurieren, dass DITA-Inhalte an einem vordefinierten Speicherort innerhalb Ihrer Site veröffentlicht werden. Im folgenden Screenshot einer AEM Site-Seite ist beispielsweise der Knoten ditacontent
für das Speichern von DITA-Inhalten reserviert:
Die verbleibenden Knoten auf der Seite werden direkt aus dem AEM-Website-Editor erstellt. Das Konfigurieren der Veröffentlichungseinstellung zum Veröffentlichen von DITA-Inhalten an einem vordefinierten Speicherort stellt sicher, 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:
-
Konfigurieren der Vorlageneigenschaften Ihrer Site
-
Hinzufügen von Knoten zur Site, um DITA-Inhalte zu veröffentlichen
Führen Sie die folgenden Schritte aus, um die Vorlageneigenschaften Ihrer vorhandenen Site zu konfigurieren:
-
Verwenden Sie den Package Manager, um die Datei /libs/fmdita/config/templates/default herunterzuladen.
note note NOTE Nehmen Sie keine Anpassungen in den Standardkonfigurationsdateien im Knoten libs
vor. Sie müssen eine Überlagerung des Knotenslibs
im Knotenapps
erstellen und die erforderlichen Dateien nur im Knotenapps
aktualisieren. -
Fügen Sie die folgenden Eigenschaften hinzu:
table 0-row-3 1-row-3 2-row-3 Eigenschaftsname Typ Wert topicContentNode
Zeichenfolge Geben Sie den Knotennamen an, in dem der DITA-Inhalt veröffentlicht werden soll. Der Standardknoten, auf dem AEM Guides DITA-Inhalte veröffentlicht, lautet beispielsweise: jcr:content/contentnode
topicHeadNode
Zeichenfolge Geben Sie den Knotennamen an, in dem die Metadateninformationen Ihres DITA-Inhalts gespeichert werden sollen. Der Standardknoten, in dem AEM Guides Metadateninformationen speichert, lautet beispielsweise: jcr:content/headnode
Wenn Sie das nächste Mal DITA-Inhalte mithilfe der Vorlagenkonfigurationen Ihrer Site veröffentlichen, werden die Inhalte in den Knoten veröffentlicht, die in den topicContentNode
- und topicHeadNode
angegeben sind.
Anpassen der AEM-Site-Ausgabe id166TG0B30WR
AEM Guides unterstützt das Erstellen von Ausgaben in folgenden Formaten:
- AEM Site
- HTML5
- EPUB
- Benutzerdefinierte Ausgabe über DITA-OT
Für die Ausgabe der AEM-Site können Sie verschiedene Design-Vorlagen mit verschiedenen Ausgabeaufgaben zuweisen. Diese Design-Vorlagen können den DITA-Inhalt in verschiedenen Layouts rendern. Sie können beispielsweise verschiedene Design-Vorlagen für interne und externe Zielgruppen angeben.
Mit dem AEM Guides können Sie auch benutzerdefinierte DITA Open Toolkit (DITA-OT)-Plug-ins verwenden. Sie können diese benutzerdefinierten DITA-OT-Plug-ins hochladen, um die PDF-Ausgabe auf eine bestimmte Weise zu generieren.
Anpassen der Design-Vorlage für die Generierung von Ausgaben customize_xml-add-on
Der AEM Guides verwendet einen Satz vordefinierter Design-Vorlagen , um die Ausgabe der AEM-Site zu generieren. Sie können die AEM Guides-Design-Vorlagen anpassen, um die Ausgabe zu generieren, die Ihrem Unternehmensbranding entspricht. Eine Design-Vorlage 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 verbinden. Eine Design-Vorlage kann so einfach sein wie ein einzelnes Server-seitiges Skript mit nur einigen JCR-Knoten oder eine komplexe Kombination aus Stilen, Ressourcen und JCR-Knoten. Design-Vorlagen werden vom AEM Guides-Veröffentlichungs-Subsystem beim Generieren der AEM-Site-Ausgabe verwendet und steuern die Struktur, das Erscheinungsbild der generierten Ausgabe.
Es gibt keine Einschränkung bezüglich des Speicherorts der Ressourcen der Design-Vorlage auf dem Server, sie sind jedoch in der Regel gemäß ihrer Funktion logisch organisiert. Beispielsweise werden bei der Standardvorlage alle JavaScript- und CSS-Dateien im Ordner /etc/designs/fmdita/clientlibs/siteoutput/default
gespeichert. Wo auch immer sich diese Dateien befinden, sie sind durch eine Sammlung von JCR-Knoten miteinander verknüpft. Zusammen bilden diese JCR-Knoten und die Dateien die gesamte Design-Vorlage.
Die mit der AEM Guides ausgelieferte Standard-Design-Vorlage ermöglicht die Anpassung der Komponenten der Landingpage, des Themas und der Suchseite. 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 Design-Vorlage anzugeben, die für die Generierung der AEM-Site-Ausgabe verwendet werden soll:
-
Verwenden Sie den Package Manager , um die standardmäßige Design-Vorlage vom folgenden Speicherort herunterzuladen:
/libs/fmdita/config/templates
-
Erstellen Sie eine Kopie der heruntergeladenen Dateien am folgenden Speicherort im Git-Repository von Cloud Manager:
/apps/fmdita/config/templates
-
Sie müssen auch die referenzierten Vorlagen vom Standardvorlagenknoten herunterladen und kopieren. Die referenzierten Vorlagen befinden sich unter:
/libs/fmdita/templates/default/cqtemplates
Die Eigenschaften der AEM Guides-Design-Vorlage werden in der folgenden Tabelle beschrieben.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 Eigenschaft Beschreibung landingPageTemplate
,searchPageTemplate
,topicPageTemplate
,shadowPageTemplate
Geben Sie den cq:Template
Knoten für die entsprechenden Seiten an (Landing, Search und Topic). Standardmäßig befindet sich dercq:Template
Knoten für diese Seiten/libs/fmdita/templates/default/cqtemplates
Knoten . Dieser Knoten definiert die Struktur und Eigenschaften der Landingpage, Suche und Themenseite.
DieshadowPageTemplate
wird zur Optimierung des segmentierten Inhalts verwendet. Sie müssen den Wert dieser Eigenschaft auf Folgendes setzen:fmdita/templates/default/cqtemplates/shadowpage
Hinweis Sie müssen einen Wert für dietopicPageTemplate
angeben.landingPageTemplate
undsearchPageTemplate
sind optionale Eigenschaften. Wenn Sie nicht möchten, dass die Such- und Landingpages generiert werden, geben Sie diese Eigenschaften nicht an.title
Ein beschreibender Name Ihrer Design-Vorlage. topicContentNode
Der Speicherort des Knotens, der den DITA-Inhalt auf einer Themenseite enthalten wird. Der Pfad ist relativ zur Themenseite. topicHeadNode
Der Speicherort des Knotens, der die vom DITA-Inhalt abgeleiteten Kopfwerte (oder Metadaten) enthalten wird. Der Pfad ist relativ zur Themenseite. tocNode
Der Speicherort des Knotens, der das Inhaltsverzeichnis enthalten wird. Der Pfad ist relativ zur Landingpage oder zum Zielpfad. basePathProp
Der Eigenschaftsname zum Speichern des Pfads des Stamms der veröffentlichten Site. indexPathProp
Der Eigenschaftsname zum Speichern des Pfads der Landingpage/Indexseite der veröffentlichten Site. pdfPathProp
Der Eigenschaftsname zum Speichern des Themapfades für PDF, wenn die Themengenerierung für PDF aktiviert ist. pdfTypeProp
Der Eigenschaftsname zum Speichern des Typs der PDF-Generierung. Derzeit enthält diese Eigenschaft immer „Thema“. searchPathProp
Der Eigenschaftsname zum Speichern des Pfads der Suchseite, wenn die Vorlage eine Suchseite enthält. siteTitleProp
Der Eigenschaftsname zum Speichern des Titels der veröffentlichten Site. Dieser Titel ist in der Regel identisch mit dem Titel der Karte, die veröffentlicht wird. sourcePathProp
Der Eigenschaftsname zum Speichern des Pfads des DITA-Quellthemas für die aktuelle Seite. tocPathProp
Der Eigenschaftsname zum Speichern des Pfads des Inhaltsverzeichnisstamms für die veröffentlichte Site.
Weitere Informationen finden Sie unter Erstellen der ersten Adobe Experience Manager-Website und Grundlagen Entwicklung einer eigenen Website in AEM.
Verwenden des Dokumenttitels zum Generieren der AEM-Site-Ausgabe
Beim Generieren der AEM-Site-Ausgabe spielt die Art und Weise, wie URLs generiert werden, eine wichtige Rolle für die Auffindbarkeit Ihrer Inhalte. Wenn Sie UUID-basierte Dateinamen verwenden, ist das Generieren von URLs, die auf der UUID Ihrer Dateien basieren, nicht suchfreundlich. Als Administrator oder Publisher haben Sie die Kontrolle darüber, wie Sie die URLs für die Ausgabe Ihrer AEM-Site generieren möchten. AEM Guides bietet eine Konfiguration, mit der Sie die URLs der AEM-Site-Ausgabe anhand des Dateinamens und nicht anhand der UUID-basierten Dateinamen generieren können. Standardmäßig ist diese Option für UUID-basierte Dateisysteme aktiviert. Dies bedeutet, dass beim Generieren der AEM-Site-Ausgabe für UUID-basierte Dateisysteme die Dateititel zum Generieren der URLs und nicht die 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 URL-Generierung in der AEM-Site-Ausgabe zu konfigurieren:
com.adobe.fmdita.config.ConfigManager
aemsite.pagetitle
Standardwert: false
Konfigurieren Sie die URL der Ausgabe der AEM-Site, um den Dokumenttitel zu verwenden
Sie können die Dokumenttitel in der URL der Ausgabe der AEM-Site verwenden. Wenn der Dateiname nicht vorhanden ist oder alle Sonderzeichen enthält, können Sie das System so konfigurieren, dass die Sonderzeichen durch ein Trennzeichen in der URL der AEM-Site-Ausgabe ersetzt werden. Sie können 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:
- Verwenden Sie die Anweisungen unter Konfigurationsüberschreibungen, um die Konfigurationsdatei zu erstellen.
- Geben Sie in der Konfigurationsdatei die folgenden (Eigenschafts-)Details an, um die Seitennamen für die Themen zu konfigurieren.
com.adobe.fmdita.common.SanitizeNodeName
nodename.systemDefinedPageName
true/false
). Standardwert: false
Wenn beispielsweise @navtitle in <topichead>
alle Sonderzeichen enthält und Sie die aemsite.pagetitle
-Eigenschaft auf „true“ setzen, wird standardmäßig ein Trennzeichen verwendet. Wenn Sie die nodename.systemDefinedPageName
-Eigenschaft auf „true“ setzen, wird der Name des ersten untergeordneten Themas angezeigt.
Konfigurieren von Regeln zur Bereinigung von Dateinamen zum Erstellen von Themen und Veröffentlichen von Ausgaben in AEM Sites und anderen Formaten id2164D0KD0XA
Als Admin können Sie eine Liste gültiger Sonderzeichen definieren, die in Dateinamen zulässig sind, welche schließlich die URL einer AEM Site-Ausgabe bilden. In früheren Versionen durften Benutzende Dateinamen definieren, die Sonderzeichen wie @
, $
, >
und mehr enthalten. Diese Sonderzeichen führten zu einer kodierten URL bei der Erstellung von AEM Site-Seiten.
Ab Version 3.8 wurden Konfigurationen hinzugefügt, um eine Liste von Sonderzeichen zu definieren, die in den 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 jedes Sonderzeichen im Titel der Datei haben können, aber intern wird es durch einen Bindestrich (-
) im Dateinamen ersetzt. Beispielsweise können Sie den Titel der Datei als Einführung 1 oder Introduction@1 haben. Der entsprechende Dateiname, der für diese beiden Fälle generiert wird, wäre Einführung-1.
Beachten Sie beim Definieren 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 (property)-Details an, um die gültigen Sonderzeichen in Dateinamen und AEM Site-Ausgaben zu konfigurieren:
com.adobe.fmdita.common.SanitizeNodeNameImpl
aemsite.DisallowedFileNameChars
'<>`@$
gesetzt ist. Sie können dieser Liste weitere Sonderzeichen hinzufügen.Sie können auch die anderen Eigenschaften konfigurieren, z. B. Kleinbuchstaben in Dateinamen, Trennzeichen zur Verarbeitung ungültiger Zeichen und die maximale Anzahl von in den Dateinamen zulässigen Zeichen. Um diese Eigenschaften zu konfigurieren, fügen Sie die folgenden Schlüsselwertpaare in der Konfigurationsdatei hinzu:
nodename.uselower
Standardwert: true
nodename.separator
Standardwert: _ (Unterstrich)
nodename.maxlength
Standardwert: 50
Konfigurieren des Reduzierens der Knotenstruktur der AEM-Site
Wenn Sie die Ausgabe der AEM-Site generieren, wird intern ein Knoten für jedes Element in den Themen erstellt. Bei einer DITA-Zuordnung mit Tausenden von Themen kann diese Knotenstruktur zu tief werden. Dieser Typ einer tief verschachtelten Knotenstruktur kann bei größeren Sites zu Leistungsproblemen führen. Der folgende Schnappschuss zeigt eine tief verschachtelte Knotenstruktur für eine AEM Site-Ausgabe:
Beachten Sie, dass im obigen Schnappschuss für jedes p
Element und seine nachfolgenden Unterelemente ein Knoten erstellt wird und für jedes andere Element, das im Thema verwendet wird, eine ähnliche Struktur erstellt wird.
Mit AEM Guides können Sie konfigurieren, wie die Knotenstruktur der AEM-Site-Ausgabe intern erstellt wird. Sie können die Knotenstruktur an bestimmten Elementen reduzieren, was bedeutet, dass Sie ein Element definieren können, das als Hauptelement betrachtet wird, und alle darin enthaltenen Unterelemente mit dem Hauptelement zusammengeführt werden. Wenn Sie sich beispielsweise entscheiden, das p
zu reduzieren, werden alle Elemente, die im p
Element erscheinen, mit dem p
zusammengeführt. Für kein Unterelement im p
wird eine separate Anmerkung erstellt. Die folgende Momentaufnahme zeigt die an p
Element reduzierte Knotenstruktur:
Führen Sie die folgenden Schritte aus, um die Knotenstruktur der AEM-Site zu reduzieren:
-
Identifizieren Sie die Elemente, an denen Sie die Knotenstruktur reduzieren möchten:
-
Überlagern Sie den Knoten
libs
im Knotenapps
und öffnen Sie die Datei elementmapping.xml. -
Fügen Sie die
<flatten>true</flatten>
-Eigenschaft in der Definition des Elements hinzu, bei dem Sie die Knotenstruktur reduzieren möchten. Wenn Sie beispielsweise die Knotenstruktur amp
reduzieren möchten, fügen Sie in der Definitionp
Elements das Attribut „flat“ hinzu, wie unten dargestellt:code language-xml <ditaelement> <name>p</name> <class>- topic/p</class> <componentpath>fmdita/components/dita/wrapper</componentpath> <type>COMPOSITE</type> <target>para</target> <flatten>true</flatten> <wrapelement>div</wrapelement> </ditaelement>
note note NOTE Standardmäßig wurde die Knoteneigenschaft „Reduzieren“ im p
konfiguriert. -
Verwenden Sie die Anweisungen unter Konfigurationsüberschreibungen, um die Konfigurationsdatei zu erstellen.
-
Geben Sie in der Konfigurationsdatei die folgenden (property)-Details an:
table 0-row-3 1-row-3 PID Eigenschaftsschlüssel Eigenschaftswert com.adobe.dxml.flattening.FlatteningConfigurationService
flattening.enabled
Boolescher Wert (true/false).
Standardwert:false
Wenn Sie jetzt die Ausgabe der AEM-Site generieren, werden die Knoten im p
reduziert und im p
selbst gespeichert. Sie finden die neuen Reduzierungseigenschaften für das p
in CRXDE.
Suchen einer Zeichenfolge innerhalb des Inhalts in der Ausgabe der AEM-Site
Standardmäßig können Sie in den Titeln nur innerhalb 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 Hauptteil der AEM-Site-Ausgabe nach einer Zeichenfolge gesucht wird.
Um die Suche zu aktivieren, sollten Sie die Reduzierung der Knotenstruktur der AEM-Site konfigurieren.
VORSICHT:
Sie können bis zu 1 MB reduzierten Inhalt durchsuchen. Beispielsweise können Sie im vorherigen Screenshot suchen, ob der Inhalt unter dem Tag <p> <= 1 MB beträgt.
<flatten>
Attribut auf „true“ gesetzt ist. Standardmäßig ist das <flatten>
-Attribut von AEM Guides für häufig verwendete Textelemente wie <p> <ul> <lI> auf „true“ gesetzt. Wenn Sie jedoch einige benutzerdefinierte Elemente erstellt haben, sollten Sie das <flatten>
-Attribut in der Datei elementmapping.xml auf „true“ setzen.Reduzieren der Knotenstruktur der AEM-Site verhindern
Ähnlich wie bei Angabe des Knotens, der in der 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 an body
Element reduzieren möchten, aber kein table
Element in body
reduzieren möchten, können Sie die Eigenschaft „exclude“ zur Definition des table
hinzufügen.
Um das table
-Element von der Reduzierung auszuschließen, fügen Sie die folgende Eigenschaft zur Definition des table
-Elements hinzu:
<preventancestorflattening>true|false</preventancestorflattening>
Konfigurieren der Versionierung für gelöschte Seiten in der AEM Site-Ausgabe
Beim Generieren der AEM-Site Ausgabe mit der Option Löschen und Erstellen) für die Einstellung Vorhandene Ausgabeseiten wird eine Version für die zu löschenden Seiten erstellt. Sie können das System so konfigurieren, dass die Erstellung einer Version vor dem Löschen gestoppt wird.
Führen Sie die folgenden Schritte aus, um die Erstellung einer Version für die zu löschenden Seiten zu stoppen:
-
Verwenden Sie die Anweisungen unter Konfigurationsüberschreibungen, um die Konfigurationsdatei zu erstellen.
-
Geben Sie in der Konfigurationsdatei die folgenden (property)-Details an, um die Option Keine Version für gelöschte Seiten erstellen zu konfigurieren:
table 0-row-3 1-row-3 PID Eigenschaftsschlüssel Eigenschaftswert com.adobe.fmdita.confi g.ConfigManager
no.version.creation.on.deletion
Boolescher Wert (true/false).
Standardwert:true
note note NOTE Wenn diese Option aktiviert ist, können Benutzer alle Seiten direkt löschen, ohne eine Version für sie zu erstellen. Wenn die Option nicht ausgewählt ist, wird eine Version erstellt, bevor die Seite(n) gelöscht werden.
Einrichten eines benutzerdefinierten Rewriters mit Experience Manager Guides custom-rewriter
Experience Manager Guides verfügt über ein benutzerdefiniertes Sling Rewriter-Modul für die Verarbeitung der Links, die bei Kreuzzuordnungen (Verknüpfungen zwischen den Themen zweier verschiedener Zuordnungen) generiert werden. Diese Rewriter-Konfiguration wird unter dem folgenden Pfad installiert:/apps/fmdita/config/rewriter/fmdita-crossmap-link-patcher
.
Wenn Sie einen anderen benutzerdefinierten Sling Rewriter in Ihrer Codebasis haben, 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 Output-Umschreibungs-Pipelines.
Verwenden von Metadaten in der Veröffentlichungsausgabe über DITA-OT id191LF0U0TY4
AEM Guides bietet die Möglichkeit, benutzerdefinierte Metadaten beim Veröffentlichen von Ausgaben mit DITA-OT zu übergeben. Als Administrator und Publisher müssen Sie die folgenden Aufgaben ausführen, um benutzerdefinierte Metadaten in der veröffentlichten Ausgabe zu konfigurieren und zu verwenden:
-
Fügen Sie als Administrator die erforderlichen Metadaten im System hinzu, damit sie auf der Seite Eigenschaften der DITA-Zuordnung verfügbar gemacht werden.
-
Fügen Sie als Administrator die benutzerdefinierten Metadaten zur Metadatenliste hinzu, sodass sie in der DITA-Zuordnungskonsole angezeigt werden.
-
Konfigurieren und fügen Sie als Publisher die benutzerdefinierten Metadaten mit der DITA-Zuordnung hinzu und generieren Sie die erforderliche Ausgabe.
Um die erforderlichen Metadaten im System hinzuzufügen, führen Sie die folgenden Schritte aus:
-
Melden Sie sich bei Adobe Experience Manager als Administrator an.
-
Klicken Sie oben auf den Adobe Experience Manager-Link und wählen Sie Tools aus.
-
Wählen Sie Assets aus der Liste der Tools aus.
-
Klicken Sie auf die Metadatenschemata.
Die Seite Metadatenschema-Forms wird angezeigt.
-
Wählen Sie das Standard-Formular aus der Liste aus.
note note NOTE Die Eigenschaften, die auf der Seite Eigenschaften für eine DITA-Zuordnung angezeigt werden, stammen aus diesem Formular. -
Klicken Sie auf Bearbeiten.
-
Fügen Sie die benutzerdefinierten Metadaten hinzu, die Sie in Ihren veröffentlichten Ausgaben verwenden möchten. Wir fügen beispielsweise Zielgruppen-Metadaten mithilfe der folgenden Schritte hinzu:
-
Ziehen Sie aus Komponentenliste Formular erstellen“ die Komponente Einzeiliger Text per Drag-and-Drop auf das Formular.
-
Wählen Sie das neue Feld aus, um die Einstellungen des Felds zu öffnen.
-
Geben unter „Feldbezeichnung den Metadatennamen - Zielgruppe ein.
-
Geben Sie in Einstellung „Zu Eigenschaft" an./jcr:content/metadata/<Name der Metadaten>. Für unser Beispiel setzen wir es auf ./jcr:content/metadata/audience.
Fügen Sie mithilfe dieser Schritte alle erforderlichen Metadatenparameter hinzu.
-
-
Klicken Sie auf Speichern.
Der neue Parameter wird jetzt auf der Seite Eigenschaften für alle DITA-Zuordnungen angezeigt.
Als Nächstes müssen Sie die benutzerdefinierten Metadaten in der DITA-Zuordnungskonsole verfügbar machen. Führen Sie die folgenden Schritte aus, um die benutzerdefinierten Metadaten auf dem DITA Map-Dashboard verfügbar zu machen:
-
Verwenden Sie den Package Manager, um auf die Datei „metadataList“ zuzugreifen, die unter dem folgenden Speicherort im Git-Repository Ihrer Cloud Manager verfügbar ist:
/libs/fmdita/config/metadataList
note note NOTE Die Datei „metadataList“ enthält eine Liste mit Eigenschaften, die in der Dropdown-Liste Eigenschaften einer DITA-Zuordnung im Zuordnungs-Dashboard angezeigt werden. Standardmäßig werden in dieser Datei vier Eigenschaften aufgelistet: docState, dc:language, dc:description und dc:title. -
Fügen Sie die benutzerdefinierten Metadaten hinzu, die Sie auf der Seite Metadatenschema-Forms hinzugefügt haben. Für unser Beispiel fügen Sie den Zielgruppenparameter am Ende der Standardliste hinzu.
Jetzt werden die benutzerdefinierten Metadaten in der Dropdown-Liste Eigenschaften“ der DITA- angezeigt.
Als Publisher müssen Sie schließlich die benutzerdefinierten Metadaten in die veröffentlichte Ausgabe einbeziehen. Um die benutzerdefinierten Metadaten beim Generieren der Ausgabe zu verarbeiten, führen Sie die folgenden Schritte aus:
-
Navigieren Sie in der Assets-Benutzeroberfläche zu der DITA-Karte, die Sie veröffentlichen möchten.
-
Wählen Sie die DITA-Zuordnungsdatei aus und öffnen Sie die zugehörige Eigenschaftsseite.
-
Geben Sie auf der Seite Eigenschaften den Wert für die benutzerdefinierten Metadaten an. In unserem Beispiel haben wir für den Zielgruppen-Parameter den Wert Extern angegeben.
-
Klicken Sie auf Speichern und schließen.
-
Klicken Sie auf die DITA-Zuordnungsdatei, um die DITA-Zuordnungskonsole zu öffnen.
-
Wählen auf der Registerkarte Ausgabevorgaben“ die Ausgabevorgabe aus, die Sie zum Generieren der Ausgabe verwenden möchten.
-
Klicken Sie auf Bearbeiten.
-
Wählen Sie aus Dropdown Liste „Eigenschaften“ die Eigenschaften aus, die Sie an den Veröffentlichungsprozess übergeben möchten.
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 das DITA-OT übergeben werden
Um die an das DITA-OT übergebenen Metadatenwerte zu überprüfen, kann die lokale Umgebung mit einem Cloud-fähigen JAR verwendet werden. Da wir auf das lokale Dateisystem in der Cloud nicht zugreifen können, ist die einzige Möglichkeit, die Metadatendatei zu validieren, über ein Cloud-fähiges JAR.
-
Dateiname: metadata.xml
-
Dateispeicherort: crx-quickstart/profiles/ditamaps/<ditamap-1234>
So greifen Sie auf metadata.xml zu:
- Melden Sie sich bei dem Server-Speicherort an, auf dem die AEM-Instanz ausgeführt wird.
- Migrieren Sie zu „crx-quickstart/profiles/ditamaps/<newly-created-directory-name>/metadata.xml".
-
Beispieldateiformat:
metadata.xml
code language-xml <?xml version="1.0" encoding="UTF-8" standalone="no"?> <root> <Path id="/absolutePath/sampleMap.ditamap"> <metadata> <meta isArray="false" key="dc:description">This is a file</meta> <meta isArray="false" key="dc:title">Myfile</meta> <meta isArray="true" key="multivalueText">One;Two;Three</meta> </metadata> </Path> <Path id="/absolutePath/sampleTopic.dita"> <metadata> <meta isArray="false" key="dc:description">description for the accountability</meta> <meta isArray="false" key="dc:title">accountability title</meta> <meta isArray="true" key="multivalueText">value1</meta> </metadata> </Path> </root>
-
isArray: Ein boolesches Attribut, das definiert, ob die Metadaten ein (Array) mit mehreren Werten sind oder nicht. Die Werte werden durch ein Semikolon voneinander getrennt.
-
Pfad-ID: Absoluter Pfad zur Datei, die im temporären Verzeichnis gespeichert ist.
Konfigurieren Sie das Befehlszeilenargumentfeld DITA-OT so, dass es Stammzuordnungsmetadaten akzeptiert
Um das DITA-OT-Befehlszeilenargumentfeld zum Übergeben von Stammzuordnungs-Metadaten zu verwenden, führen Sie die folgenden Schritte aus:
- Verwenden Sie die Anweisungen unter Konfigurationsüberschreibungen, um die Konfigurationsdatei zu erstellen.
- Geben Sie in der Konfigurationsdatei die folgenden (property)-Details an, um das Befehlszeilenargumentfeld „DITA-OT“ in der Voreinstellung zu konfigurieren:
com.adobe.fmdita.config.ConfigManager
pass.metadata.args.cmd.line
true/false
).Standardwert: true
- Wenn Sie den Eigenschaftswert auf true setzen, wird die DITA-OT-Befehlszeilenfunktion aktiviert, sodass Sie die Metadaten über die DITA-OT-Befehlszeile übergeben können.
- Wenn Sie den Wert der Eigenschaft auf false setzen, wird die DITA-OT-Befehlszeilenfunktion deaktiviert. Anschließend können Sie das Feld Eigenschaft in der Voreinstellung verwenden, um die Metadaten zu übergeben.
Anpassen der DITA-Elementzuordnung mit AEM-Komponenten id1679J600HEL
DITA-Elemente in AEM Guides werden den entsprechenden AEM-Komponenten zugeordnet. AEM Guides verwendet diese Zuordnung in Workflows wie Veröffentlichung und Überprüfung, um ein DITA-Element in eine entsprechende AEM-Komponente zu konvertieren. Die Zuordnung wird in der elementmapping.xml
definiert, auf die über den Package Manager zugegriffen werden kann.
libs
vor. Sie müssen eine Überlagerung des Knotens libs
im Knoten apps
erstellen und die erforderlichen Dateien nur im Knoten apps
aktualisieren.Sie können die vordefinierten DITA-Elementzuordnungen verwenden oder DITA-Elemente Ihren benutzerdefinierten AEM-Komponenten zuordnen. Um Ihre benutzerdefinierten AEM-Komponenten verwenden zu können, müssen Sie mit der Struktur der elementmapping.xml
-Datei vertraut sein.
Struktur ElementMapping.xml
Im Folgenden wird ein allgemeiner Überblick über die elementmapping.xml
-Struktur gegeben:
-
Jedes DITA-Element wird zunächst anhand des Elementnamens nach einer entsprechenden Komponentenzuordnung durchsucht. Zum Beispiel:
code language-xml <ditaelement> <name>**substeps**</name> <class>- topic/ol task/substeps</class> <componentpath>dita/components/ditaolist</componentpath> <type>COMPOSITE</type> <target>para</target> </ditaelement>
Im obigen Beispiel werden alle
substeps
DITA-Elemente mithilfe derdita/components/ditaolist
-Komponente gerendert. -
Wenn ein DITA-Element keine Übereinstimmung basierend auf dem Namen findet, wird eine Übereinstimmung auf Grundlage der
class
durchgeführt. Zum Beispiel:code language-xml <ditaelement> <name>topic</name> <class>**- topic/topic**</class> <componentpath>fmdita/components/dita/topic</componentpath> <type>COMPOSITE</type> <target>para</target> <attributemap> <attribute from="id" to="id" /> </attributemap> </ditaelement>
Wenn im obigen Beispiel keine Zuordnung für das
task
Element definiert ist, wird dastask
Element der obigen Komponente zugeordnet, datask
von dertopic
übernommen wird. -
Wenn ein Element über eine entsprechende Komponentenzuordnung verfügt, wird die weitere Verarbeitung seiner untergeordneten Elemente durch
type
bestimmt. Zum Beispiel:code language-xml <ditaelement> <name>title</name> <class>- topic/title</class> <componentpath>foundation/components/title</componentpath> <type>**STANDALONE**</type> <target>para</target> <textprop>jcr:title</textprop> </ditaelement>
type
nimmt die folgenden Werte an:-
COMPOSITE: Element zu Komponente die Zuordnung wird auch für Elemente fortgesetzt.
-
EIGENSTÄNDIG: Untergeordnete Elemente des aktuellen Elements werden nicht weiter zugeordnet.
Wenn im obigen Beispiel das
<title>
untergeordnete Elemente enthält, werden diese keiner anderen Komponente zugeordnet. Die -Komponente für<title>
-Element ist für das Rendern aller untergeordneten -Elemente innerhalb des<title>
-Elements verantwortlich. -
-
Wenn einem einzelnen DITA-Element mehrere Komponenten zugeordnet sind, wird die beste Übereinstimmung für das Element ausgewählt. Um die Komponente mit der besten Übereinstimmung auszuwählen, wird eine Domain- und strukturelle Spezialisierung von DITA-Elementen berücksichtigt.
Wenn es DITA-Elemente mit Domain-Spezialisierung gibt und eine Komponente für Domain-Spezialisierung zugeordnet ist, erhält diese Komponente hohe Priorität.
Wenn es DITA-Elemente mit struktureller Spezialisierung gibt und eine Komponente für strukturelle Spezialisierung zugeordnet ist, wird dieser Komponente ebenfalls hohe Priorität eingeräumt.
-
Sie können
<attributemap>
in der Elementzuordnung verwenden, um Attributwerte den entsprechenden Knoteneigenschaften zuzuordnen. -
textprop
kann zum Serialisieren des Textinhalts eines DITA-Elements in eine Knoteneigenschaft verwendet werden. Darüber hinaus kann es mehrmals in einem -Element-Tag verwendet werden, um den Textinhalt an mehreren Stellen in der veröffentlichten Hierarchie zu serialisieren. Sie können auch den Speicherort und den Namen der Zieleigenschaft anpassen. Zum Beispiel:code language-xml <ditaelement> <name>title</name> <componentpath>foundation/components/title</componentpath> <type>STANDALONE</type> <target>para</target> <textprop>**jcr:title**</textprop> </ditaelement>
Die obige Elementzuordnung gibt an, dass der Textinhalt
<title>
Elements als Wert einer Eigenschaft mit dem Namen "jcr:title
" auf dem Ausgabeknoten gespeichert wird. -
xmlprop
kann zum Serialisieren der gesamten XML für ein bestimmtes Element in eine Knoteneigenschaft verwendet werden. Die Komponente kann dann diese Knoteneigenschaft lesen und benutzerdefinierte Darstellungen durchführen. Zum Beispiel:code language-xml <ditaelement> <name>svg-container</name> <class>+ topic/foreign svg-d/svg-container</class> <componentpath>fmdita/components/dita/svg</componentpath> <type>STANDALONE</type> <target>para</target> <xmlprop>**data**</xmlprop> </ditaelement>
Die obige Elementzuordnung gibt an, dass das gesamte XML-Markup für Element
<svg-container>
als Wert einer Eigenschaft mit dem Namendata
im Ausgabeknoten gespeichert wird. -
Es gibt eine spezielle Attributzuordnung , um die Pfadauflösung beim Prozess der Ausgabegenerierung zu handhaben. Zum Beispiel:
code language-xml <attributemap> <attribute from="href" to="fileReference" ispath="true" rel="source" /> <attribute from="height" to="height" /> <attribute from="width" to="width" /> </attributemap>
Für die obige
attributemap
wird dashref
-Attribut in Ihrem DITA-Element einer Knoteneigenschaft mit dem NamenfileReference
zugeordnet. Daispath
nun auftrue
gesetzt ist, löst der Prozess der Ausgabegenerierung diesen Pfad auf und legt ihn dann infileReference
Knoteneigenschaft fest.Wie diese Auflösung geschieht, wird anhand des Werts des
rel
Attributs in der Attributzuordnung bestimmt.-
Wenn
rel=source
, wird der Wert vonhref
in Bezug auf die DITA-Quelldatei aufgelöst, die derzeit verarbeitet wird. Der Wert vonhref
wird aufgelöst und im WertfileReference
Eigenschaft platziert. -
Wenn
rel=target
, wird der Wert vonhref
in Bezug auf den Stamm-Veröffentlichungsspeicherort aufgelöst. Der Wert vonhref
wird aufgelöst und im WertfileReference
Eigenschaft platziert.
Wenn keine Vorverarbeitung oder Auflösung für Pfadattribute erfolgen soll, müssen Sie das Attribut
ispath
nicht angeben. Der Wert wird unverändert kopiert und die Komponente kann die erforderliche Auflösung vornehmen. -
DITA-Element-Schema
Im Folgenden finden Sie ein Beispiel für das DITA-Elementschema in elementmapping.xml
Datei :
<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:
<ditaelement>
<class>
Das Klassenattribut für das DITA-Thema lautet beispielsweise:
- topic/topic
<componentpath>
<type>
- COMPOSITE: Verarbeiten Sie auch untergeordnete Elemente
- STANDALONE: Überspringt die Verarbeitung von untergeordneten Elementen
<attributeprop>
<note type="Caution">
Element verfügen und die Komponente, die für dieses Element zugeordnet ist, über <attributeprop>attr_t</ attributeprop>
verfügt, werden das Attribut und der Wert des Knotens in attr_t
Eigenschaft des entsprechenden AEM-Knotens ( attr_t->type="caution"
) serialisiert.<textprop>propname_t</textprop>
getTextContent()
Ausgabe in der Eigenschaft, die durch propname_t.
definiert ist Hinweis: Dies ist eine optimierte Eigenschaft.
<xmlprop>propname_x </xmlprop>
propname_x.<br>
Hinweis: Dies ist eine optimierte Eigenschaft.<xpath>
<target>
Mögliche Werte:
- head: Unter dem Kopfknoten
- text: Unter dem Absatzknoten
<wrapelement>
<wrapclass>
wrapclass.
<attributemap>
<attribute>
-Knoten enthält.Zusätzliche Hinweise
-
Wenn Sie die standardmäßige Elementzuordnung überschreiben möchten, wird empfohlen, die Änderungen nicht in der
elementmapping.xml
vorzunehmen. Sie sollten eine neue XML-Zuordnungsdatei erstellen und die Datei an einem anderen Speicherort ablegen, vorzugsweise im Ordner für benutzerdefinierte Programme, den Sie erstellen. -
In der
elementmapping.xml
-Datei gibt es viele Zuordnungseinträge, die auf die fmdita/components/dita/wrapper-Komponente verweisen. Wrapper ist eine generische Komponente, die relativ einfache DITA-Konstrukte mithilfe von Eigenschaften auf ihrem Site-Knoten rendert, um relevante HTML zu generieren. Sie verwendet diewrapelement
-Eigenschaft zum Generieren umschließender Tags und delegiert das untergeordnete Rendering an die entsprechenden Komponenten. Dies ist nützlich, wenn Sie nur eine Container-Komponente benötigen. Anstatt eine neue Komponente zu erstellen, die ein bestimmtes Container-Tag wiediv
oderp
rendert, können Sie die Wrapper-Komponente mit den Eigenschaftenwrapelement
undwrapclass
verwenden, um denselben Effekt zu erzielen. -
Es wird nicht empfohlen, große Textmengen in den JCR-Eigenschaften von String zu speichern. Durch die Berechnung des optimierten Eigenschaftstyps bei der Ausgabegenerierung wird sichergestellt, dass kein großer Textinhalt als String-Typ gespeichert wird. Wenn stattdessen Inhalte gespeichert werden müssen, die größer als ein bestimmter Schwellenwert sind, wird der Typ der Eigenschaft in „binär“ geändert. Dieser Schwellenwert ist standardmäßig auf 512 Byte konfiguriert, kann jedoch im Konfigurations-Manager (com.adobe.fmdita.config.ConfigManager) geändert werden, indem die Einstellung Als binärer Schwellenwert speichern geändert wird.
-
Wenn Sie planen, einige (und nicht alle) der Elementzuordnungen zu überschreiben, müssen Sie nicht die gesamte
elementmapping.xml
replizieren. Sie müssen eine neue XML-Zuordnungsdatei erstellen und nur die Elemente definieren, die Sie überschreiben. -
Nachdem Sie die XML-Datei am benutzerdefinierten Speicherort erstellt haben, aktualisieren Sie die
Override Element Mapping
imcom.adobe.fmdita.config.ConfigManager
.
Anpassen der DITA-Zuordnungskonsole id188HC08M0CZ
AEM Guides bietet Ihnen die Flexibilität, die Funktionen der DITA-Zuordnungskonsole zu erweitern. Wenn Sie beispielsweise über einen Berichtssatz verfügen, der sich von dem unterscheidet, der in der AEM Guides verfügbar ist, können Sie solche Berichte zur Zuordnungskonsole hinzufügen. Um die Zuordnungskonsole anzupassen, müssen Sie eine AEM-Client-Bibliothek (oder clientLib) erstellen, die den Code zur Durchführung der benötigten Funktionen enthält.
AEM Guides stellt die apps.fmdita.dashboard-extn
zum Anpassen der Zuordnungskonsole bereit. Wenn die Zuordnungskonsole geladen wird, wird die unter der Kategorie apps.fmdita.dashboard-extn
erstellte Funktion ausgeführt und geladen.
Verarbeiten der Bildausgabedarstellung während der Ausgabegenerierung id177BF0G0VY4
AEM enthält einen Satz von standardmäßigen Workflows und Medien-Handles zur Verarbeitung von Assets. In AEM gibt es vordefinierte Workflows für die Asset-Verarbeitung für die gängigsten MIME-Typen. Normalerweise erstellt AEM für jedes Bild, das Sie hochladen, mehrere Ausgabedarstellungen desselben Bilds im Binärformat. Diese Ausgabedarstellungen können unterschiedlich groß sein, eine andere Auflösung, ein hinzugefügtes Wasserzeichen oder eine andere geänderte Eigenschaft aufweisen. Weitere Informationen zum Verarbeiten von Assets durch AEM finden Sie unter Verarbeiten von Assets mit Medien-Handlern und Workflows in der Dokumentation zu AEM.
Mit AEM Guides können Sie konfigurieren, welche Bildausgabe zum Zeitpunkt der Generierung der Ausgabe für Ihre Dokumente verwendet werden soll. Sie können beispielsweise aus einer der standardmäßigen Bildausgabedarstellungen auswählen oder eine erstellen und dieselbe zum Veröffentlichen Ihrer Dokumente verwenden. Die Bildausgabedarstellungszuordnung zum Veröffentlichen Ihrer Dokumente wird in der /libs/fmdita/config/ **renditionmap.xml**
-Datei gespeichert. Ein Ausschnitt renditionmap.xml
Datei lautet wie folgt:
renditionmap.xml
-Datei im apps
-Ordner zu erstellen.<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 mimetype
gibt den MIME-Typ des Dateiformats an. Das rendition output
-Element 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 Bildausgabedarstellungen 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 Web-Ausgabedarstellung des angegebenen Bildes. Wenn selbst die Web-Ausgabedarstellung nicht gefunden wird, wird die ursprüngliche Ausgabedarstellung des Bildes verwendet.
Automatische Bereinigungsperiode für den Ausgabegeschverlauf konfigurieren id19AAI070V8Q
Wenn Sie eine Ausgabe generieren, wird die Ausgabe zusammen mit den Ausgabeprotokollen erstellt. Bei großen DITA-Zuordnungen können diese Protokolle eine große Menge an Speicherplatz in Ihrem Repository beanspruchen. Standardmäßig werden die Protokolle an folgendem Speicherort im Repository gespeichert:
/var/dxml/metadata/outputHistory
Über einen bestimmten Zeitraum hinweg konnte die Gesamtgröße aller Protokolldateien GB erreichen. Mit AEM Guides können Sie einen Zeitraum konfigurieren, während dessen diese Protokolldateien im Repository gespeichert werden. Nach dem angegebenen Zeitraum werden die Protokolle zusammen mit dem Verlauf der Ausgabegenerierung aus dem Repository gelöscht.
Die Konfiguration der Verlaufsbereinigung wirkt sich auf die Ausgabegenerierung für alle DITA-Zuordnungen im Repository aus. Auf der Registerkarte Ausgaben einer DITA-Zuordnung wird der Verlauf nach der angegebenen Anzahl von Tagen und zu dem in der Einstellung angegebenen Zeitpunkt gelöscht.
Verwenden Sie die Anweisungen unter Konfigurationsüberschreibungen, um die Konfigurationsdatei zu erstellen. Geben Sie in der Konfigurationsdatei die folgenden (property)-Details an, um einen Tag und eine Uhrzeit für die Bereinigung des Ausgabegeschichtverlaufs und der Protokolle festzulegen:
com.adobe.fmdita.config.ConfigManager
output.history.purgeperiod
Standardwert: 5
output.history.purgetime
Standardwert: 0:00 (oder 12:00 Uhr Mitternacht)
Ändern des Listenlimits für zuletzt generierte Ausgaben id1679JH0H0O2
Sie können die maximale Anzahl generierter 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 ein, um die Anzahl der in der Liste anzuzeigenden Ausgaben zu ändern:
com.adobe.fmdita.config.ConfigManager
output.historylimit
Standardwert: 25