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 wird Folgendes behandelt:

Wiederverwendbarkeit mithilfe von Themenreferenzen (topicref)

Nehmen wir an, Sie sind ein Produktionsunternehmen und haben allgemeine Themen zu Sicherheitsvorkehrungen oder Fehlerbehebungstechniken.

Diese können in spezifischen Benutzerhandbüchern für jedes Maschinenmodell referenziert und angepasst werden, um Redundanz zu reduzieren und sicherzustellen, 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 mit Inhaltsreferenz (conref und conkeyref)

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

Zum Beispiel:

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

Sie möchten einzelne KYC-Fragmente für die Themen „Sparkonto“ und „Dematkonto“ 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_procedure.dita die Dateikennung und #individual_kyc die Fragmentkennung.

KYC_Procedure.dita ist weiterhin die einzige Informationsquelle. Wenn Änderungen der Vorschriften Aktualisierungen des KYC-Prozesses erfordern, aktualisieren Sie den Themenpfad mit dem neuen. Die Änderungen werden automatisch in allen Themen übernommen, die darauf verweisen.

Die beiden Klicks von AEM Guides

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, wenn Sie Inhalte über einen Schlüssel referenzieren, anstatt einen Inhaltspfad anzugeben

Code-Beispiel :

<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' ist weiterhin die zentrale Informationsquelle. Wenn es Änderungen am KYC-Prozess gibt, die durch Vorschriften erforderlich sind, müssen Sie einfach einen Themenpfad mit einem neuen Themenpfad aktualisieren, und 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 kürzlich erfolgter Regeländerungen von „kyc_procedure_2020.dita“ zu „kyc_procedure_2024.dita“ geändert.

Die beiden Klicks von AEM Guides

Schritt 1: Klicken Sie auf Wiederverwendbaren Inhalt einfügen .

Schritt 2: Wählen Sie Ihre Stammzuordnung (optional), Ihren Schlüssel und Ihr Fragment aus, die wiederverwendet werden müssen.

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

Wiederverwenden von Inhalten mit einem Klick in AEM Guides

AEM Guides bietet die Funktion „Wiederverwendbare Inhalte“, mit der Sie mit einem Klick Inhaltsreferenzen hinzufügen können.

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

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

Häufig gestellte Fragen

Weisen Sie Fragmenten (Ditelementen) IDs zu, die Sie in anderen Themen wiederverwenden möchten

Posten Sie bei der AEM Guides Community Forum für alle Fragen.