Create a cross-reference to an external file or web site

You can insert links to web pages, remote locations, FTP sites, or files outside the repository.

You can use absolute or relative paths to cross-reference documents outside the repository; however, make sure that the path will work when the link is clicked from its published location. For example, if you are inserting a cross-reference to a file, the file must be in a location that can be accesses when someone clicks the link in your published output.

To create an external link:

  1. Highlight a word or phrase where you want to insert the cross-reference.
    Note: The text you highlight must be within an element that allows the xref element.
  2. Right-click the highlighted text, and then select Links > Insert Xref.
    Note: This wraps the text in an xref element, but its attributes must be edited so it references the external document.
  3. Open the Attribute Inspector:
    1. In the main menu click Window > Show View > Other.
    2. In the Show View dialog box, expand the XMetaL Editor folder and click Attribute Inspector.
    3. Click OK.
  4. Place your cursor on the newly created cross-reference.
  5. In the Attribute Inspector, edit the attributes as required to create the link such as configuring the href or keyref attribute and setting the scope attribute to external.
    Use the following syntax for the URL depending of the type of external document:
    Location Syntax
    Web site http://sitename
    Secure web site https://sitename
    FTP site ftp://sitename
    Secure FTP site ftps://sitename
    Local file file://driveletter/filename

    For example: