Reference links - AcceleratorKMS - Version 5.0 - Help - Hexagon

AcceleratorKMS Traditional Content Writing

Language
English
Product
AcceleratorKMS
Search by Category
Help
AcceleratorKMS Version
5.0

Add a reference link that will take the reader to another item within the same document. The target item can be a single step, a block containing steps, note, hazard statement, and so forth.

Reference links are supported in documents, but not in flows.

Before you begin

  • Open the document in edit mode

  • Click +Item or edit an existing statement

Procedure

  1. Place the cursor where you want the reference link to appear.

  2. Select {#ref} from the formatting toolbar.

    You can also create the reference link manually by typing {#}.

    Statement editor toolbar {#ref}

  3. Ensure your statement is complete and click Create.

    A reference link must have a target value defined for it. Otherwise, a notification appears indicating that an undefined reference link exists. This prevents the document from being published.

  4. Click on the reference link that must be defined.

    A window appears for selecting the target.

  5. Click Select target.

    The same document appears in a separate window with checkboxes beside each target item.

  6. Find your target item and select its checkbox.

    Reference link

  7. Click Select.

    The target item will automatically be entered into the Select Target text box.

  8. Determine what part of the target item is displayed in the reference link:

    • Number if only the target number must appear

    • Text if only the target text must appear

    • Both Number and Text if they must both appear

    If only Number is selected but the target item is not a numbered item, then it will show the text instead.

    Reference link 4

    SHARED Tip If a targeted item is edited or moved within the document, then the reference link text or number automatically updates.

    SHARED Tip Reference link names can be used as-is, e.g. {#ref}. However, they do behave like single-use variables, so if there is more than one in a statement with the same name, then they will use the same target. If they must point to different targets, then use different names, e.g. {#ref1} and {#ref2}.