Getting Started with Paligo

Adding Cross-References and Links

You can cross-reference other topics, elements within topics, and web sites/documents/email addresses.

  1. Under the Insert tab, select Link.

  2. Select the type of link. For a cross-reference, you can also use the keyboard shortcut directly AltR.

  3. For a cross-reference, you'll have the option to link to a topic ("External" tab), or to an element within the same topic ("Internal" tab).

    1. The External tab lets you browse or search for a topic to link to. 

      Note

      You do not have to put anything in the Link field unless you want a different text than the title. The link will automatically use the title of the target topic (which is usually what you want). And it will be updated automatically if you change that title later.

    2. If you choose the Internal tab, you get a list of the elements you can link to within the same topic, e.g figures, steps or the like.

  4. For links to external web sites or documents, just type the url in.

    Tip

    If you want to make sure the link opens in a new browser tab in HTML/HTML5 output, just add an attribute called xlink:show in the Attributes panel. Set the value to "new".

  5. When you have inserted the link, you have a popup toolbar to edit it when the link is selected:

    If auto is checked (default), the link will automatically get the target topics's title as link text. If you want another link text, just uncheck it and type directly in the link.

  6. To edit the target of the link, just click the blue pen icon to the right. This opens a Content Manager browser widget that shows you the currently selected target, and you can select another one.

  7. If you want to go to the target topic, just click the icon on the left.

Turning images and other elements into links

You can also make images work as links. There is however no selection dialog to insert that type of link. You do it by adding the link target as an attribute on the image itself:

  1. Select the mediaobject or inlinemediaobject element.

  2. Add an xlink:href attribute.

  3. Add the target value using the following syntax:

    urn:resource:component:31214.

    The first part is always the same, and the last part (the numbers) is the id of the target topic.

    Tip

    You can get the id of the target topic by opening the Structure View for that topic, where you find it at the top of the metadata.

    Another way to get the entire link value is to simply make a regular ("dummy") cross-reference, and then copy the value from there and then delete the dummy cross-reference.

Cross-references to elements inside other topics

In general with single-sourcing content, it is recommended not to make cross-references more than you have to, as you create dependencies. And when you do cross-reference, it's recommended to make them to entire topics.

However, if you do at some point feel the need to cross-reference another topic on a more granular level, i.e to an internal element inside another topic, it's possible, but you need to add the internal element id manually.

  1. In your "source topic" (the one with the link), create a regular cross-reference to a topic.

    This will create an attribute for the link called xlink:href with a value that points to the topic, looking something like this: urn:resource:component:31214.

  2. Now get the id of the internal element in the other (target) topic, e.g a figure or a procedure step. If it doesn't have an id (xml:id) you can add it and give it a value.

    Note

    The value should be a unique id, and not begin with "uuid" as that is used for topic ids by Paligo. If you don't know what id to give it, you can always create a dummy internal reference to it within the same topic, and it will get a unique id.

  3. In the source topic where you want to link to this element in the other topic, now add a slash ("/") and then the element id you just got at the end of the xlink:href attribute value. I.e it could look something like this:

    urn:resource:component:31214/N1501789600448

Note

Currently a cross-reference to an element inside another topic does not show the content of that element, like an internal link in the same topic does. But it will do so when you publish.