Insert one XInclude link

When you're ready to assemble an individual DocBook module into a larger valid document, you can do it by using an XInclude link. When you want to insert one link, you can select the component, and the XInclude dialog opens so you can select a specific element.

If you want to insert multiple files at once, follow the steps in Insert multiple XInclude links at once. Keep in mind that when you want to insert multiple links at the same time, you can only select the components. You won't see the XInclude screen and the first element in each component is selected by default.

To insert one XInclude link:

  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. To open the file in the Oxygen editor, double-click the component.
    Note: You can also open a component in the following ways:
    • To select the row, click it, then right-click and select Edit...
    • To select the row, click it, then click and select Edit...
  5. To use the center pane to insert an XInclude link:
    1. In the content, place your cursor where you want to insert a link.
    2. In the toolbar menu, click Oxygen_xreflink Link, and then select Insert XInclude...
    3. On the Select Components screen, find the DocBook modular file you want to add, and then click Select.
    4. On the XInclude screen, in the Sel column, select the radio button for the element you want to link to.
    5. On the XInclude screen, click OK.
      In the editor you see a link icon and the name of the component if you added it.
  6. To use the Outline pane to insert an XInclude link:
    1. If not already displayed, open the panel by clicking Outline .
    2. In the Structure, right-click an element, select Append child, and then select xi:include.
    3. On the Insert Reference screen, choose one of the following:
      • To create a new component to reference, select New and enter the required information for a new component.
      • To create a reference to an existing component, click Reference.
        1. Find the DocBook modular file you want to add, and then click Select.
        2. On the XInclude screen, in the Sel column, select the radio button for the element you want to link to.
        3. On the XInclude screen, click OK.
      • To create a link without a reference that you can edit later, click Empty.

      In the editor you see a link icon and the name of the component if you added it.

  7. To test an XInclude link, when you click on it, the linked content opens in another Oxygen tab.

    Tips

    • You can edit the linked content in the newly opened Oxygen tab.
    • If the document is locked, the content is shown in Oxygen as read-only.