Creating links in documents and artifacts

You can create links in documents (or in any text-based artifact), to other artifacts in your project repository, files that are uploaded from your local file system, or any URL.

About this task

This topic describes how to link to artifacts and URLs. To link to requirements or embed requirement text, see Creating requirements from document content and Linking to requirements from documents and artifact elements.

Procedure

  1. Highlight the text in the document (or in any text-based artifact) to use as the link text or place the cursor where you want to add the link.
  2. Click the Create Link icon in the toolbar or right-click in the editor and click Create Link.
  3. In the "Link to" window, select one of the following options:
    • Click Choose Existing Artifact and browse to a project and folder in the repository or type a partial entry for an artifact name in the Search field. Select a target artifact and click OK.
    • Click Create New Artifact. Enter the artifact type, location, optional tags, and name. Click OK.
    • Click Specify External Resource. Type or paste a URL and click OK. Optionally, leave the Link Description field blank to display the URL as the link text.
    • Click Choose a File to Upload. Enter the upload information and click OK. The artifact is linked to the new uploaded artifact. For more information, see Uploading files to a repository.

Results

A link to the artifact is inserted into the document. To navigate to the target artifact, press the Ctrl key and click the link.

Feedback