キー定義の作成

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

キーは、コンテンツの一貫性を管理し、効率化を図るのに役立ちます。キーを使用して、プロダクト名や機能などのアイテムを定義し、そしてそのプロダクト名または機能名を定義するマップでキーを編集します。

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

  • マップでキーを定義してからそのキーをマップトピックに追加します。
  • サブマップでキーを定義してから、定義されたキーを必要とするトピックで他のマップに追加することで、サブマップを再利用できます。

キーの複数の定義を持っていることもできます。同じキーで名称の定義が異なる2つのマップがある場合、そのキーを持つトピックは、そのトピックが含まれているマップの正しいプロダクト名または機能名に自動的に更新されます。

マップ内にキーの定義が複数存在する場合、このデフォルトを変更するような特定のスコープをキーに設定しない限り、最初の定義がそれ以降の定義よりも優先されます。

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

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

  1. Map EditorStructureビューで編集をクリックします。
  2. マップ内でキーを追加したい場所を選択し、をクリックします。
  3. 結果ポップアップメニューから New Element を選択し、選択した項目の兄弟または子としてキーを作成する必要があるかどうかに基づいて、Same Level または Sub Level を選択します。
  4. 結果New Elementダイアログで、Element ドロップダウンメニューをクリックし、<keydef>を選択します。
  5. Keynameフィールドに、キーの名前を入力します。
  6. Valueには、以下のオプションのいずれかを選択します:
    • Keywordは、キーのマップに追加を提供し、そのキーの参照として使用する値を入力することを要求します。
    • Object Referenceは、画像、トピック、またはマップ リソースへの参照の挿入をサポートしていますが、DITAで定義されているスコープ(ローカル、ピア、または外部)を入力する必要があります。
    • New Topic Referenceは、設定したトピック条件に基づいて、ターゲット キーの作成をサポートします。
    • Web Linkは、ライブのウェブサイト リンクを参照するためのサポートを提供します。
  7. 挿入をクリックします。

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

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