キー定義の作成

マップ内の変数をキーとして定義し、そのキーをマップ内の任意の数のトピックに挿入できます。

キーは、コンテンツの一貫性を管理し、効率化を図るのに役立ちます。たとえば、キーを使用してプロダクトまたはプロダクト機能名を定義できます。名称が時間の経過とともに変化する場合は、それらのプロダクトや機能を含むすべてのトピックを編集する必要はありません。プロダクト名または機能名を定義するマップのキーを編集するだけで済みます。さらに、同じキーで名称の定義が異なる2つのマップがある場合、そのキーを持つトピックは、そのトピックが含まれているマップの正しいプロダクト名または機能名に自動的に更新されます。

注: 新しいキー定義が有効になる前に、マップをチェックインする必要があります。

キーを定義し、コンテンツに追加する2つの一般的な方法は:

  • マップでキーを定義し、そのキーをマップ内のトピックに追加します。
  • サブマップでキーを定義します。以降、定義されたキーを必要とするトピックを持つ他のマップにサブマップを追加することで、サブマップを再利用できます。
注: マップ内にキーの定義が複数存在する場合、このデフォルトを変更するような特定のスコープをキーに設定しない限り、最初の定義がそれ以降の定義よりも優先されます。

キー定義を作成するには、

  1. マップ エディター構造ビューで編集をクリックします。
  2. マップ内でキーを追加したい場所を選択し、をクリックします。
    ポップアップメニューが表示されます。
  3. ポップアップ メニューから新しい要素を選択し、選択した項目の兄弟または子としてキーを作成する必要があるかどうかに基づいて、同じレベルまたはサブレベルを選択します。
    新しい要素ダイアログが開きます。
  4. 新しい要素ダイアログで、要素ドロップダウンメニューをクリックし、<keydef>を選択します。
  5. キーネームフィールドに、キーの名前を入力します。
  6. には、以下のオプションのいずれかを選択します:
    • キーワードは、キーのマップに追加を提供し、そのキーの参照として使用する値を入力することを要求します。
    • オブジェクト参照は、画像、トピック、またはマップ リソースへの参照の挿入をサポートしていますが、DITAで定義されているスコープ(ローカル、ピア、または外部)を入力する必要があります。
    • 新規トピック参照は、設定したトピック条件に基づいて、ターゲット キーの作成をサポートします。
    • Web リンクは、ライブのウェブサイト リンクを参照するためのサポートを提供します。
  7. 挿入をクリックします。

定義した値で<keydef>要素がマップに含まれます。

マップにチェックインすると、定義したキーをトピックに挿入できます。