Creating a link including a cross-reference

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 another content file if the cross-reference shall go to another file.

Your need

You need to refer to content within a file or in another file. The reference shall display element title text, page number or, for example, section or figure number. This can be done by creating a link, containing one or several reference elements, to the target content.

The possibility

It is possible to create a link to content at a certain location including a cross-reference. The location can be a file or an element marked with an ID. The link is represented by a link element referring to the ID, and the cross-reference is represented by a reference element. The cross-reference can be of three types showing the page number, title text or object number (for example section number or table number) when published.

About this task

What you will learn

This instruction tells you how to create a link including a cross-reference.

The result

This is a paragraph before creating a link including a cross-reference:

This is a paragraph after creating a link including a cross-reference:

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, including a cross-reference, to another file or to an element ID in another file or in the current file.

Time

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 a link including a cross-reference.

3. On the top toolbar, click Inline > Reference.

The reference toolbar opens.

4. If the link target is:

within the current content file, leave the File box empty.
another file, or an element ID in another file:
1. Click Browse.

A folder and file structure is displayed.

2. To browse higher in the folder and file structure, click the button.

3. Click to select the desired target file.

The selected file's resource ID and name are displayed in the File box.

An alternative to get the desired file's resource ID, is to copy the file or an include element to the file, in the Workspace or Publications view, and then paste it into the File box.

5. If the link target is an element ID:

1. Click Target id.

All available element IDs are displayed.

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

2. Click to select the desired element ID.

The selected element ID is shown in the Id box.

6. Click the Type arrow to select reference type.

A list opens showing the different reference types:

Page number - shows the page number after publishing.
Title text - shows for example a section title after publishing.
Object number - shows for example a section number after publishing.

7. Select the desired reference type from the list.

8. Click Apply.

A link element containing a reference element is created.

9. If you want to create another reference element inside the same link:

1. Put the caret inside the link at the desired place.

2. On the top toolbar, click Inline > Reference.

The reference toolbar opens.

The File and Id boxes are pre-filled according to the current link element.

3. Click the Type arrow to select reference type from a list.

4. Click Apply.

Another reference element is created.

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

After publishing, the output is: