キー定義の作成
マップ内の変数をキーとして定義し、そのキーをマップ内の任意の数のトピックに挿入できます。
このタスクについて
キーは、コンテンツの一貫性を管理し、効率化を図るのに役立ちます。キーを使用して、プロダクト名や機能などのアイテムを定義し、そしてそのプロダクト名または機能名を定義するマップでキーを編集します。
コンテンツにキーを定義・追加する 2 つの一般的な方法は：
- マップでキーを定義してからそのキーをマップトピックに追加します。
- サブマップでキーを定義してから、定義されたキーを必要とするトピックで他のマップに追加することで、サブマップを再利用できます。
キーの複数の定義を持っていることもできます。同じキーで名称の定義が異なる2つのマップがある場合、そのキーを持つトピックは、そのトピックが含まれているマップの正しいプロダクト名または機能名に自動的に更新されます。
マップ内にキーの定義が複数存在する場合、このデフォルトを変更するような特定のスコープをキーに設定しない限り、最初の定義がそれ以降の定義よりも優先されます。
新しいキー定義が有効になる前に、マップをチェックインする必要があります。
キー定義を作成するには、
手順
-
マップ内でキーを追加したい場所を選択し、
をクリックします。
マップでは、ほとんどどこにでもキー定義を追加できます。視覚的な観点からは、トピックナビゲーションの「邪魔」にならないよう、マップの最後に追加するのが便利です。
ブックマップでは、キー定義をフロントマターまたはバックマターに追加するのが最も一般的です。また、appendix、chapter、draftintro、glossarylist、notices、part、prefaceに追加することもできます。
タスクの結果
定義した値で<keydef>要素がマップに含まれます。