Setting an element ID to make an element unique

Background

Starting point

The procedure in this topic assumes Skribenta is installed and configured for normal operation, and:

You have logged into Skribenta.
You are assigned to one of the following user roles: content provider, technical writer or administrator.
You have selected the workspace you want to work in.
A content file or a configuration file is created in the workspace.
You have browsed to and opened the file in the Workspace view or the Publications view.
You have created an element, for example, a paragraph or an ordered or unordered list.

Your need

You want to make a certain XML element, such as a section or table, uniquely identifiable in the content file. This, so you can address it specifically, for example, make a cross-reference link from a paragraph to a table.

The possibility

It is possible to make an element uniquely identifiable in the content file or configuration file. An element ID is represented by a unique value for the id attribute on the element.

An element ID is unique since several elements in the same content file or configuration file cannot have the same element ID.

To make a link to another target element, the target element must have an element ID.

The first character in the element ID must be a letter or an underscore.

About this task

What you will learn

This instruction tells you how to make an XML element, such as a section or table, uniquely identifiable by setting an ID on the element.

Overall steps

Open the file, then set an ID on an element in your file content.

This is knowledge level

Time

Less than 1 minute

Procedure

In the shown images, the XML tags are visible. To show XML tags, see Turning XML element tags on or off.

1. Make sure that the step(s) in section "Starting point" (see section "Background" above) are performed.

2. In your file content, right-click the element that you want to set an ID on.

A pop-up list opens.

3. In the pop-up list, select the element icon.

A toolbar opens.

4. On the toolbar, click Attributes > Id.

The Id tab opens.

5. In the Id box, type an element ID or click the Id arrow and select an element ID from the list.

An element ID must only contain letters, digits, underscores, hyphens and periods.

6. Click Apply.

The element ID is set on the element.

Alternative procedure: Setting an element ID to make an element unique using a keyboard shortcut

In the shown images, the XML tags are visible. To show XML tags, see Turning XML element tags on or off.

1. Make sure that the step(s) in section "Starting point" (see section "Background" above) are performed.

2. In your file content, put the caret inside the element that you want to set an element ID on.

3. Press Ctrl+Shift+Down Arrow.

The element Attributes toolbar opens.

4. On the element Attributes toolbar, click Id.

The Id tab opens.

5. In the Id box, type an element ID value or click the Id arrow and select an element ID value from the list.

An element ID must only contain letters, digits, underscores, hyphens and periods.

6. Click Apply.

The element ID is set on the element.