DITA "Depends On" Properties


Prerequisites:

The asset item schema type must be DITA Content. The Depends On tab displays for only DITA items.


The Depends On tab provides dependency information about DITA and non-DITA content that the currently selected DITA item references.

For example, let's say the currently selected DITA content contains a cross reference to another DITA topic and a reference to an image asset. Both dependency links display within the Depends On tab list entries. Also, let's say the referenced DITA topic contains dependency links. The currently selected asset will include these links in the Depends On tab list entries, as the links correlate to the asset's hierarchical relationship structure (for example, the dependency route).

See Dependencies Overview for more details about DITA dependency linking.

Version Notes: CMS 10.6.378 vs. CMS 10.6.308–10.6.342
Dependency functionality differs between CMS 10.6.378 and CMS 10.6.308–10.6.342.
  • In CMS 10.6.378, dependencies are accounted for based on the DITA asset's latest content version and versions marked to publishing targets. To filter dependencies based on version in the Depends On tab, you can use the Dependency Version drop-down list.

  • In CMS 10.6.308–10.6.342, dependencies are only accounted for based on the current version of the DITA asset item. If you make and save changes to an asset item's dependencies via the Edit tab, the Depends On list entries update to reflect the new changes, no matter if the asset is checked in or out. If you mark an older version of the DITA asset item for publish, the CMS dependency system will not account for the dependencies in that version.

See CMS DITA Versioning Functionality for more details about CMS 10.6 dependency functionality changes.

To review dependencies referenced within other DITA content:

  1. Navigate to Assets > Assets Tree.
  2. Select the DITA item, and select the DITA Properties > Depends On tab.
    The Depends On tab displays the list of dependencies associated with the currently selected DITA item.
  3. Choose one of the following filter options.

    Option

    Description

    Direct Dependencies

    Displays only direct child dependencies (i.e., distance 1 dependencies) that the currently selected DITA map references.

    All Dependents

    Displays all descendant dependencies associated with the currently selected DITA map. This data includes child dependencies, grandchild dependencies, etc.

    If the currently selected DITA content contains zero dependencies, this filter option displays as inactive.

    DITA Properties > Depends On Tab

  4. Select or clear the Show Errors Only checkbox.

    If selected, this option displays only dependencies that have errors Validity Error Icon in the list. Errors are indicated in the Validity column.

  5. Choose one of the following filter options from the Dependency Version drop-down list:
    Version Notes: CMS 10.6.378
    The Dependency Version drop-down list is exclusive to CMS 10.6.378. If you have CMS 10.6.308–10.6.342, skip this step.

    In CMS 10.6.378, you can filter dependencies based on the latest version or based on a publishing target.

    Option

    Description

    Show All

    Provides a comprehensive list of dependencies associated with the DITA asset item, regardless of version or publishing target.

    The Show All option displays all dependency entries, including the dependencies referenced in the Latest Version and those referenced in any version of the asset marked to a publishing target.

    If no dependency entries display, this indicates the DITA asset does not have any dependencies in the latest version or in any marked-for-publish version.

    Latest VersionDisplays dependencies referenced in the latest content version of the DITA asset. The Dependency Version column in the list will indicate targets where the latest content is marked.
    Note
    • This version filter includes any dependency changes that have been saved but have not been checked in to the DITA asset.
    • If no dependency entries display, this indicates the DITA asset does not have any dependencies in the latest version.

    Name of Publishing TargetDisplays only dependencies referenced in the version of the asset item marked to the publishing target you select from this drop-down list.

    In the drop-down list, the publish icon displays next to publishing target options.

    Note
    • If the latest version of the DITA asset is marked to a publishing target, the CMS will only account for the latest checked-in changes marked to that publishing target.
    • If no dependency entries display for the publishing target, this indicates either the DITA asset is not marked to the target or that the marked DITA asset version does not have any dependencies.
  6. Optional: To search for individual dependencies, enter keywords in the Search field based on the Name, Dependency Route, or Type column.
  7. Review the dependencies within the list.

    Data includes:

    Data Type

    Description

    NameThe file name, file extension, and ID of the asset item referenced.
    Tip
    You can click the file name to navigate to the referenced asset item.

    Distance

    The hierarchical relationship distance between the currently selected DITA item and the dependency.

    For example, if the distance is 1, then the current DITA item directly references the dependency within its content.

    If the distance is 2, then a direct child dependency of the current DITA item references the dependency in question (i.e., dependencies with a relationship distance of 2 are grandchildren of the current DITA asset).

    Note
    You can select the All Descendents filter option to display all dependencies, including those with distances greater than 1.

    Dependency Route

    The hierarchical relationship structure of the dependency stemming from the current DITA asset. This route indicates where the DITA assets reference the dependency within the hierarchy.

    For example, let's say the asset item rinsingthecar.dita is a dependency entry with the following dependency route:

    garage-1.ditamap/washingthecar.dita/rinsingthecar.dita

    In this example, the file garage-1.ditamap is the currently selected DITA item. This content contains a dependency reference to washingthecar.dita, which contains the reference to rinsingthecar.dita.

    Version Notes: CMS 10.6.308–10.6.342
    To display each entry's dependency route in CMS 10.6.308–10.6.342, select the All Descendents filter option.
    Type

    The type of dependency. The Type value represents the DITA element (e.g., xref, conref, keydef) that references the dependency.

    Confirmed
    Version Notes: CMS 10.6.378 vs. CMS 10.6.308–10.6.342
    The Confirmed column is deprecated in CMS 10.6.378 and is only available in CMS 10.6.308–10.6.342.

    The Dependency Confirmed for Publish checkmark 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.

    Note
    Users can only publish DITA content at the map level. See Publishing DITA in Ingeniux CMS 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 assets remain unconfirmed until you check in those new assets.
    • If you or other users add dependencies to checked-out assets, the new dependencies remain unconfirmed until checked in.
    • If you or other users remove dependencies from checked-out assets, the removed dependencies remain confirmed until checked in.
    Dependency Version
    Version Notes: CMS 10.6.378
    The Dependency Version column is only available in CMS 10.6.378. This column indicates the version of the DITA asset where each dependency is referenced.

    You can filter the Depends On list to only display dependencies for a particular version by using the Dependency Version drop-down list.

    ValidityIf the dependency has conflicts, an error icon Validity Error Icon displays within this column entry. Hover over the icon to view error details. See DITA Dependency Validity Errors for details about troubleshooting errors.
    Version Notes: CMS 10.6.378
    CMS 10.6.378 indicates errors not only for unresolved assets, but also indicates errors for dependencies not marked to publishing targets and for dependencies in the Assets Manager Recycle folder. You can use the Show Errors Only filter to check for any dependency conflicts before running DITA publishing pipeline and preview processes.
  8. Optional: Select Download CSV to download a .csv file of this data to your local machine.
    Note
    • Download CSV accounts for your filtering selections. For example, if you select Direct Dependents, then only direct dependencies of the DITA asset will be included in your CSV download.
    • The Download CSV button becomes inactive when the Show Errors Only checkbox and Search filter options are applied. Clear these filter options in order to use the download tool.