View component references

In DITA, a reference lets you include the content of an element in a component, including phrases, topics, images, and maps. You can see all references a component includes without having to open the component using the Details option. The References tab provides a list of components that are referenced in the selected component using a content reference (conref), key reference (conkeyref), or crossreference (xref) . You can also export the list of referenced components.

To view component references:

  1. Click Components_TopMenuOpt Components.
  2. In the Folders pane, navigate to the folder where you've saved the component.
  3. In the Components pane, select the component you want to open.
    Note: You can verify you have the correct component by looking in the Content details pane at the preview. 

    If the pane isn't open, click the down arrow in the pane's title bar.

    If you think the preview isn't showing the latest version, click Refresh .

  4. Right-click a component, and then click Details...
    Note: You can also access this option from the component's Options menu.
  5. On the Components Details dialog, click the References tab.

    Tips and tricks

    • Select a column title to sort the list.
      • You can also add additional columns to the list.
    • If the number of references is large:
      • Use filtering options to limit the number of references in the list.
      • Use the page navigation options at the bottom of the list to move to the next or previous page in the list.
  6. Optionally, to filter the list of references by words in the component name, enter text in the Search text box and click Search search_button.
  7. Optionally, to save the list of component relationships to a CSV file:
    1. Click Save as CSV ExportCSV.
      You can filter the list of components before saving the list to a CSV file.
      • In the Search field, enter key words.
      • In Saved Queries, select a query.
      This creates a CSV file that contains relationship details only for the results of the search.
    2. To choose what time zone is used, on the Convert time confirmation screen, select one of the following:

      You see the date displayed in the header of the CSV as: All date/times are shown in {timezone} or UTC.

      UTC is a time zone standard used as a basis for all time zones worldwide. It is a constant time scale and does not change for Daylight Saving Time.

      • To use your local time, click Yes.
      • To use UTC time, click No
  8. Optionally, to open the referenced component in the Oxygen-based editor, click the reference's Options menu and select Edit.
  9. Optionally, to open the referenced component in a read-only viewer, click the reference's Options menu and select View.
  10. Optionally, to locate the referenced component in the Components browser, click the reference's Options menu and select Go to.
  11. Optionally, to automatically repair an invalid reference, click the reference's Options menu and select Auto-Repair.
  12. Optionally, to change the referenced component and to locate a new component, click the reference's Options menu and select Browse.
  13. To save any changes you made, click Save.
  14. To close the Component Details dialog, click Cancel.