AEM ガイドでのコンテンツの再利用性
Adobe AEM Guides は DITA の強みを活かし、コンテンツの再利用に役立つ使いやすいインターフェイスを提供します。
この記事では、以下について説明します。
トピック参照(topicref)を使用した再利用性
製造会社で、安全上の注意やトラブルシューティング技術に関する一般的なトピックがあるとします。
これらは、各機械モデルの特定のユーザーマニュアルで参照および適応でき、冗長性を削減し、コア安全情報の一貫性を確保できます。
<map id="user_manual_model 100" title="ABC Model 100 User Manual ">
<topicref href="Safety_Information.dita" format="dita">
</topicref>
.
.
.
.
.
</map>
モデル 200 でも同様
<map id="user_manual_model 200" title="ABC Model 200 User Manual ">
<topicref href="Safety_Information.dita" format="dita">
</topicref>
.
.
.
.
.
</map>
コンテンツ参照(conref および conkeyref)を使用した再利用性
コンテンツ参照(conref)属性を使用すると、コンテンツの他の部分にリンクできます。 これにより、再利用性が向上し、冗長性が軽減されます。
次に例を示します。
金融企業で、KYC の一般的なトピックがあり、個人、企業などの KYC 手順が含まれているとします。
個々の KYC フラグメントを「アカウントの保存」および「アカウントの破損」のトピックに再利用する場合。
<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>
こちら conref=kyc_procedures.dita#indvidual_kyc
kyc_procedures.dita はファイル識別子、#individual_kyc はフラグメント識別子です。
Kyc_procedure.dita は、引き続き唯一の情報ソースです。 規制の要求に応じて KYC プロセスに変更がある場合は、1 つのトピックを更新するだけで、その変更はそれを参照しているすべてのトピックに自動的に反映されます。
AEM Guides を使用した 2 回のクリック
手順 1:「再利用可能なコンテンツを挿入」をクリックする
手順 2:再利用が必要なファイルとフラグメントを選択する。
「conref」と同様に、「conkeyref」も使用できます。ここで、コンテンツパスを指定する代わりに、キーを使用してコンテンツを参照できます。
コードの例:
<section conkeyref="kyc_procedure/individual_kyc_procedure" id="individual_kyc_procedure"></section>
キー定義は次のようになります。
<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>
キー – 「Kyc_procedure」は引き続き唯一の情報源です。 規制の要求に応じて KYC プロセスに変更がある場合は、1 つのトピックパスを新しいトピックパスで更新するだけで、その変更はそれを参照しているすべてのトピックに自動的に反映されます。
<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>
ここで、トピックパスは、最近の規制の変更により、「kyc_procedure_2020.dita」から「kyc_procedure_2024.dita」に変更されています。
AEM Guides を使用した 2 回のクリック
手順 1:「再利用可能なコンテンツを挿入」をクリックする
手順 2:再利用が必要なルートマップ(オプション)、キー、フラグメントを選択する。
このルート マップは、マップ ビューで既に開かれているため、自動的に選択されています
AEM Guides で 1 回クリックしてコンテンツを再利用
AEM Guides には、コンテンツ参照をワンクリックで追加できる「再利用可能なコンテンツ」機能が用意されています。
手順 1:再利用可能なコンテンツに汎用トピックを追加する
手順 2:追加したら、宛先トピックで再利用するフラグメントをドラッグ&ドロップします。
FAQ
-
コンテンツを再利用ダイアログでファイル/キーを選択した後、すべてのコンテンツが表示されない
他のトピックで再使用するフラグメント (Dita エレメント)に ID を割り当てる必要があります
-
コンテンツを再利用ダイアログでキーが表示されない
キー定義を持つマップビューでルートマップ/親マップを開いているか、同じダイアログでルートマップパスを手動で追加していることを確認します。
AEM Guides コミュニティに投稿 フォーラム (すべてのクエリの場合)。