Key Reference Information Dialog Box
This dialog box enables you to view information about the key definition associated with a key reference in a DITA topic or map. You invoke this dialog box from either the > menu choice or the matching shortcut menu choice. The menu choice is only available if the cursor is in an element that contains a key reference.
Note that for a key reference to have information about its key definition, it must have an active key context and the associated key definition must be in that context. A key context is a DITA map containing key definitions. If that map is a DITA Key Definition Map, then additional information is available for the definitions.
The value assigned to the ditakeycontext set option determines the key context for a document. This option can be set explicitly or Arbortext Editor sets it automatically for certain cases. For example, if you open a referenced topic from a map that contains key definitions, Arbortext Editor sets that map as the key context.
The Key Reference Information dialog box contains the following options:
• Key definition information — Provides information about the key definition.
If that map is a DITA Key Definition Map, then additional information might be available for the definitions. The following information is provided:
◦ Key — Provides the name of the key.
◦ href — Provides the full path to the document identified by the href attribute in the key definition.
If no href is assigned, (none) is displayed.
◦ Scope — Provides the value scope attribute from the key definition that is in effect for this key reference.
◦ Format — Provides the value format attribute from the key definition that is in effect for this key reference.
◦ Text — Displays the text content defined by the key definition.
For key references used for text replacement, this option also shows any markup provided in the key definition. For other key references, this option shows text from the target of the reference.
◦ Description — Provides a description of the key.
If the key is defined in a DITA Key Definition Map and the keydescription element is specified, the description comes from that element. Otherwise, the description comes from the content of the navtitle element, the navtitle attribute, or the linktext element in that order.
◦ Element ID — Provides the ID value for the element that is intended to be used as the target of the key definition.
This information is only available for a DITA Key Definition Map that has a value assigned to the keysubelementid element in the key definition.
◦ Tags — Provides a list of the elements for which the key is defined to provide a reference.
This information is only available for a DITA Key Definition Map that has a value assigned to the keyreftags element in the key definition.
◦ Defining Map — Provides the path to the map in which the key definition is located.
• Go to Definition — Opens the map containing the key definition in a new Arbortext Editor window and highlights the key definition in the map.
Related information