「キーおよびキー参照」ダイアログボックス

このダイアログボックスで、DITA マップ、およびそのマップが参照するトピックまたはマップ内のキー定義およびキー参照に関する情報を確認できます。現在のマップのキーコンテキストが別の DITA マップに設定されている場合、ダイアログボックスの情報は現在のマップのものではなく、キーコンテキストであるマップの情報です。このダイアログボックスは DITA トピックから開くこともできますが、現在のキーコンテキストであるマップで定義されているように、この場合ダイアログボックスには該当のトピックに含まれるキー参照についての情報と、これらの参照に関連する定義のみが含まれます。ダイアログボックスでのキー情報の収集と表示に時間がかかる場合は、進捗状況バーが表示されます。

キー参照にそのキー定義に関する情報を持たせるためには、キー参照がアクティブなキーコンテキストを持ち、さらに関連するキーがそのコンテキスト内で定義されていることが必要です。キーコンテキストは、キー定義を含む DITA マップです。ditakeycontext 設定オプションに割り当てられた値によって、文書のキーコンテキストが決定されます。このオプションは明示的に設定することもでき、特定のケースでは Arbortext Editor によって自動的に設定される場合もあります。たとえば、キー定義を含むマップから参照されるトピックを開くと、そのマップがキーコンテキストになります。

このダイアログボックスは、「ツール」 > 「キーおよびキー参照」メニュー項目から呼び出します。また、カーソルを含むタグ内で定義されているキーのみの DITA マップの「ツール」メニューとショートカットメニューの両方にある「キー参照の検索」メニュー項目を使用して、このダイアログボックスを開くこともできます。

「キーおよびキー参照」ダイアログボックスには、次のオプションが表示されます。

ダイアログボックスのこの領域には、マップで定義されているキー定義と、マップから参照される文書で使用されるキーの場所の両方が表示されます。また、現在のキーコンテキストに関連のキー定義を持たない現在のマップから参照される文書で定義されている、その他すべてのキー参照も表示されます。定義を持つキーおよびキー参照については、ツリー内で定義または参照をクリックして選択し、「移動」ボタンを使用してそのキー定義または参照を含む文書を開くことができます。

定義を持つキーについては、キーアイコンが表示され

、その後ろに定義内のキー名および href 属性値が表示されます。マップまたはマップから参照される文書内にこのキーへの参照が存在する場合、これらの参照はキー定義の下にネストされます。キーの下の参照のリストは、展開したり、折りたたむことが可能です。リストのキー参照を含むエレメントは、以下のアイコンで示されます。

これと、その他のキー参照 (keyref 属性内) については、アイコンの後ろにキー参照を含むエレメントの名前と、さらに参照を含む文書のファイル名が付けられます。参照を含む文書がファイルシステム上ではなくコンテンツ管理システム (CMS) にある場合、名前は CMS オブジェクト名または論理 ID となります。

コンテンツキー参照については (conkeyref 属性内)、アイコンの後ろにコンテンツ参照のターゲットである文書内のエレメントの名前と、さらに参照を含む文書のファイル名が続き、その後に「(conkeyref)」という文字が続きます。

関連の定義を持たないキー参照については、赤い X が付いたキーアイコンが表示され

、その後ろにキー参照内のキー名と、さらに「(定義がありません)」という文字が続きます。この下は、現在のマップから参照される文書内に発見された未定義のキーへの参照です。