Creating a link to another 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.
You have created another content file to link to.

Your need

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

The possibility

It is possible to create a link to another file or to content at a certain location in another file. The location is an element, for example a section element, marked with an element ID in the other file. The link is represented by a link element referring to the element ID. It is also possible to create a link to a media file that is version controlled in Skribenta, for example a movie.

About this task

What you will learn

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

The result

This is the content before creating a link to another file:

This is the content after creating a link to another 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 another file or to a location marked with an element ID in another 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 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 Browse.

A folder and file structure is displayed.

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

7. Click to select the desired file.

The resource ID and name of the selected file 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.

8. If the link shall go to an element ID within the file, click Target id on the To tab. Otherwise, go to step 11.

All available IDs in the selected file are displayed.

9. Click to select the desired element ID.

The selected element ID is shown in the Id box.

10. 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.
directed the link to a media file (in step 7) that is version controlled in Skribenta, such as a movie, click the Type arrow and select Media.

The media file will be published to an output folder together with the publication.

11. Click Apply.

A link element containing the file name (without file extension) is created.

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

Alternative procedure: Creating a link, of selected text, to another 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 Browse.

A folder and file structure is displayed.

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

6. Click to select the desired file.

The resource ID and name of the selected file 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.

7. If the link shall go to an element ID within the file, click Target id on the To tab. Otherwise, go to step 10.

All available IDs in the selected file are displayed.

8. Click to select the desired element ID.

The selected element ID is shown in the Id box.

9. 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.
directed the link to a media file (in step 6) that is version controlled in Skribenta, such as a movie, click the Type arrow and select Media.

The media file will be published to an output folder together with the publication.

10. Click Apply.

A link element is created.

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