Repair an invalid component reference

After you include the content of an element in a component, such as phrases, topics, images, and maps, you can change the reference later if you need to. To change a reference, you can delete it and then recreate it, or simply edit it by using the browse option to locate new elements that you want to use.

Tips and Tricks

  • Although you can do this action from the Components browser or a project, these instructions tell you how to do it from the Components browser.
  • You can only create relationships to elements with ID values. For more information read Repair component relationships.
  • If you aren't sure what to select using the Manage Relationships screen, you can open the component in the Oxygen editor and use the Validation pane to learn more about the error and fix it in the editor. Follow the steps in Check for errors in the Validation pane.

  • When you repair a self-referencing link, the following syntax is used:

    • If a cross-reference is pointing to content in a separate file, Inspire includes the file name:
      <filename>#<rootid>/<elementid>
    • If a cross-reference is pointing to content that exists in the same file, DITA assumes it's the same, so Inspire drops the file name:
      #<rootid>/<elementid>

To change a component reference:

  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 that has an invalid relationship that you want to repair.
    Components with an invalid relationship display an Invalid icon .
  4. Right-click the component's row and select Details...
    You can also click the Options menu, and then select Details...
  5. Click the References tab.
  6. If the number of references is large, to find a reference:
    • Sort the list by selecting a column title.
    • Filter the list by words in the component name by entering text in the Search text box and clicking Search search_button.
    • See more details by adding other columns to the list.
    • Limit the number of references in the list using filtering options.
    • Moving to the next or previous page in the list using the page navigation options at the bottom of the list.
  7. On the References tab, look in the Status column and select a component that has an Invalid relationship.
  8. In the component's row, right-click and select Browse.
    You can also click the Options menu and select Browse.
  9. On the Select Component screen, in the Folders pane, navigate to the folder that contains the component you want to reference.
  10. In the Components pane, select the component that has a valid reference that you want to use in place of the broken one.
  11. In the Target Element pane, select the element you want to use, and then click Select.
    If you aren't sure what to select or what you want isn't listed, you can open the component in the Oxygen editor and use the Validation pane to learn more about the error and fix it in the editor.
    Results:
    • On the Manage Component Relationships screen, the relationship is now listed as Valid.
    • The target attribute value for the components is updated to the repaired target component file name.
    • The component is saved.
  12. Repeat steps 7-11 to fix all invalid relationships.
  13. To close the Component Details dialog, click Cancel.