Creating a cross-reference to a file or website

You can insert a cross-reference that creates a link to websites, remote systems, FTP sites, or local files outside the Content Store. You create a cross-reference by inserting an <xref> element.

When you link to files outside the repository, you may use either absolute or relative pathnames. However, keep in mind that setups vary in different machines. When you specify the path for your cross-referenced file, make sure that the path makes sense with regard to the machine (and the local network) where the files will be installed.

To create a link to a file or website:

  1. Open the topic.
  2. In Author mode, highlight a word or phrase where you want to insert the xref.
    Note: The text you highlight must be within an element that allows <xref> elements.
  3. Do one of the following:
    • Click the Link icon (Link icon) and select either File Reference or Web Link.
    • Click DITA > Link and select either File Reference or Web Link.

    If you selected File Reference, the File Reference dialog appears, where you can enter the file's location.

    If you selected Web Link, the Web Link dialog appears, where you can enter the website's URL.

  4. Enter the location of what you want to reference:
    • For files, enter the file location in the Location field.
    • For websites, enter the URL in the URL field.

    Use the following syntax depending on the location:

    Location type Syntax
    Website http://sitename
    Secure website https://sitename
    FTP site ftp://sitename
    Secure FTP site ftps://sitename
    Local file file://driveletter/filename
  5. Click OK.
A cross-reference is inserted at the selected location.