Wiederverwendbarkeit von Inhalten in AEM Guides

Adobe AEM Guides nutzt die Stärken von DITA, um eine benutzerfreundliche Oberfläche für die Wiederverwendung von Inhalten bereitzustellen.

In diesem Artikel würden wir über Folgendes sprechen:

Wiederverwendbarkeit mit Themenverweisen (topicref)

Nehmen wir an, Sie sind ein Hersteller und haben allgemeine Themen für Sicherheitsvorkehrungen oder Fehlerbehebungstechniken.

Diese können in spezifischen Benutzerhandbüchern für jedes Maschinenmodell referenziert und angepasst werden, wodurch Redundanz reduziert und sichergestellt wird, dass die grundlegenden Sicherheitsinformationen konsistent bleiben.

<map id="user_manual_model 100" title="ABC Model 100 User Manual ">


<topicref href="Safety_Information.dita" format="dita">
</topicref>
.
.
.
.
.
</map>

Ähnlich für Modell 200

<map id="user_manual_model 200" title="ABC Model 200 User Manual ">

<topicref href="Safety_Information.dita" format="dita">
</topicref>
.
.
.
.
.

</map>

Wiederverwendbarkeit mithilfe der Inhaltsreferenz (conref & conkeyref)

Mit dem Attribut content reference (conref) können Sie Links zu anderen Teilen Ihres Inhalts erstellen. Dies fördert die Wiederverwendbarkeit und reduziert die Redundanz.

Zum Beispiel:

Nehmen wir einmal an, Sie sind ein Finanzunternehmen und haben ein allgemeines Thema für KYC, das KYC-Verfahren für Einzelpersonen, Unternehmen usw. enthält.

Sie möchten ein einzelnes KYC-Fragment für Ihre Themen "Konto speichern"und "Konto abrufen"wiederverwenden.

<section id="kyc_requirements_saving_account">
  <title>Know Your Customer (KYC) Requirements</title>
  <p>To comply with regulations and ensure customer identification, all individual applicants for savings  accounts must fulfill the KYC requirements as outlined below</p>
  <p conref=kyc_procedures.dita#individual_kyc></p>
</section>

Hier ist conref=kyc_procedures.dita#indvidual_kyc kyc_operations.dita die Dateikennung und #individuelle_kyc die Fragmentkennung.

Kyc_procedure.dita ist weiterhin die einzige Informationsquelle. Wenn es Änderungen am KYC-Prozess gibt, wie es von den Vorschriften gefordert wird, müssen Sie einfach ein Thema aktualisieren, und diese Änderungen werden automatisch in allen Themen übernommen, die darauf verweisen.

Mit AEM Guides werden die beiden Klicks

Schritt 1: Klicken Sie auf Wiederverwendbaren Inhalt einfügen

Schritt 2: Wählen Sie die Datei und das Fragment aus, die wiederverwendet werden sollen.

Ähnlich wie "conref"können Sie auch "conkeyref"verwenden, wobei Sie, anstatt einen Inhaltspfad anzugeben, Inhalte über Schlüssel referenzieren können.

Codebeispiel :

<section conkeyref="kyc_procedure/individual_kyc_procedure" id="individual_kyc_procedure"></section>

Die Schlüsseldefinition sieht wie folgt aus:

<map id="ABC_manual">
  <title>ABC_Manual</title>
  <topicref href="kyc_procedure_2020.dita" keys="kyc_procedure" processing-role="resource-only" type="concept">
  </topicref>
  <topicref href="savings_account.dita" type="concept">
  </topicref>
</map>

Schlüssel - "Kyc_procedure" wird weiterhin die einzige Informationsquelle sein. Wenn es Änderungen am KYC-Prozess gibt, wie es von Verordnungen gefordert wird, müssen Sie einfach einen Themenpfad mit einem neuen Themenpfad aktualisieren. Diese Änderungen werden automatisch in allen Themen übernommen, die darauf verweisen.

<map id="ABC_manual">
  <title>ABC_Manual</title>
  <topicref href="kyc_procedure_2024.dita" keys="kyc_procedure" processing-role="resource-only" type="concept">
  </topicref>
  <topicref href="savings_account.dita" type="concept">
  </topicref>
</map>

Hier wird der Themenpfad aufgrund aktueller Änderungen der Verordnung von "kyc_procedure_2020.dita"zu "kyc_procedure_2024.dita"geändert.

Mit AEM Guides werden die beiden Klicks

Schritt 1: Klicken Sie auf Wiederverwendbaren Inhalt einfügen

Schritt 2: Wählen Sie die Stammzuordnung (optional), den Schlüssel und das Fragment aus, die wiederverwendet werden sollen.

Hier wurde die Stammzuordnung automatisch ausgewählt, da sie bereits in der Kartenansicht geöffnet war.

Wiederverwenden von Inhalten mit nur einem Klick in AEM Guides

AEM Guides bietet die Funktion "Wiederverwendbare Inhalte", mit der Inhaltsverweise durch einen Klick hinzugefügt werden können.

Schritt 1: Hinzufügen eines allgemeinen Themas zu wiederverwendbaren Inhalten

Schritt 2: Ziehen Sie das Fragment, das Sie in einem Ihrer Zielthemen wiederverwenden möchten, nach dem Hinzufügen per Drag-and-Drop.

Häufig gestellte Fragen

Sie müssen IDs Fragmenten (DITA-Elementen ) zuweisen, die Sie in anderen Themen wiederverwenden möchten

Stellen Sie sicher, dass Sie die Stammzuordnung/die übergeordnete Zuordnung in der Zuordnungsansicht geöffnet haben, die über eine Schlüsseldefinition verfügt, oder fügen Sie den Pfad der Stammzuordnung manuell im selben Dialogfeld hinzu.

Post in der AEM Guides-Community forum für alle Abfragen.