DITA "Used By" Properties
The Used By tab displays on every asset item, including non-DITA assets. This tab contains information about DITA content that references the currently selected DITA or non-DITA asset.
For example, if a DITA topic includes a reference to the currently select image asset, then that The topic will display as a usage reference dependency in the Used By tab list of entries. Also, the image asset's Used By tab list entries will include the DITA map that references the DITA topic, as the linking relationship correlates to the image asset's hierarchical relationship structure (for example, the dependency route).
The term "usage reference" represents a DITA asset that is referencing another asset. This means the asset item corresponding with the Used By tab is the dependency being referenced by that DITA asset.
To review dependencies referenced within other DITA content:
- Choose one of the following filter options.
Option Description Direct Usage References Displays only direct parent usage references (i.e., distance 1 dependencies) that link to the currently selected item. All Usage References Displays all ancestor usage references associated with the currently selected asset. This data includes parent dependencies, grandparent dependencies, etc. If the currently selected item contains zero usage references, this filter option displays as inactive.
- Select or clear the Show Errors Only
checkbox.
If selected, this option displays only usage references that have errors
in the list. Errors are indicated in the Validity
column. - Review the usage references within the list.
Data includes:
Data Type
Description
Name The file name, file extension, and ID of the asset item referenced.
TipSelect the column entry to navigate to the referencing DITA asset.Distance The hierarchical relationship distance between the current asset item and the referencing DITA item. For example, if the distance is 1, then the usage reference entry links directly to current asset item.
If the distance is 2, then the usage reference entry is a grandparent within the dependency structure. In other words, the usage reference entry links to another DITA item that, in turn, directly references the currently selected asset item (the grandchild dependency).
NoteSelect the All Usage References filter option to display dependencies with distances greater than 1.Dependency Route The hierarchical relationship structure of the current DITA item. This route indicates the dependency chain of DITA items that ultimately links to the current item.
For example, let's say the DITA item garage-1.ditamap is a usage reference entry with the following dependency route:
garage-1.ditamap/washingthecar.dita/rinsingthecar.dita
In this example, the file rinsingthecar.dita is the currently selected DITA item. The DITA map garage-1.ditamap references washingthecar.dita, which references rinsingthecar.dita.
Type The type of usage reference. The Type value represents the DITA element (e.g., xref, conref, keydef) in the usage reference that links to the current asset item. Confirmed The Dependency Confirmed for Publish check mark indicates the system has registered the dependency within the DITA content and will include the dependency in the next publish. The pipeline requires the confirmation of all dependencies before publishing the DITA collection.
NoteUsers can only publish DITA content at the map level. See Publishing DITA Assets for details.Keep the following in mind:
- Publishes do not include unconfirmed dependencies. However, if the Show all pages preview option is selected at the time of preview generation, then DITA Preview includes the unconfirmed dependencies.
- All dependencies of newly created items remain unconfirmed until you check in those new assets.
- If you or other users add dependencies to checked-out items, the new dependencies remain unconfirmed until checked in.
- If you or other users remove dependencies from checked-out items, the removed dependencies remain confirmed until checked in.
Validity If the asset item has conflicts with a usage reference, an error icon displays within this column entry. Hover over the icon to view error details.