Creating a link within a file

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.

Your need

You need to refer to content within a file. This can be done by creating a link to the content.

The possibility

It is possible to create a link to content at a certain location within the same file. The location is an element, for example a section element, marked with an element ID. The link is represented by a link element referring to the element ID.

About this task

What you will learn

This instruction tells you how to create a link to content within a file.

The result

This is the file content before creating a link within a file:

This is the file content after creating a link within a file:

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

Overall steps

Open the file, then create a link to a location marked with an element ID within the file.

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, put the caret where you want to create the link.

3. On the top toolbar, click Block > Paragraph.

An empty paragraph element is created.

4. On the top toolbar, click Inline > Link, or press Ctrl+L.

The To tab on the link toolbar opens.

5. On the To tab, click Target id.

All available element IDs in the file are displayed.

It is possible to click the available element IDs to expand and preview the element content.

6. Click to select the desired ID.

The selected ID is shown in the Id box.

7. If you want the stylesheet to style the link when publishing, click the Type arrow and select Reference.

This assumes that there is stylesheet support for the link type Reference.

8. Click Apply.

An empty link element is created.

9. Type some link text.

10. To verify your link, double-click the link to expand it.

Alternative procedure: Creating a link, of selected text, within a file

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, select the text which shall be your link text.

3. On the top toolbar, click Inline > Link (or press Ctrl+L).

The To tab on the link toolbar opens.

4. On the To tab, click Target id.

All available IDs in the file are displayed.

5. Click to select the desired ID.

The selected ID is shown in the Id box.

6. If you want the stylesheet to style the link when publishing, click the Type arrow and select Reference.

This assumes that there is stylesheet support for the link type Reference.

7. Click Apply.

A link element is created.

8. To verify your link, double-click the link to expand it.