Skriftlig InfoDITA publishingDITA library topicsInserting a text fragment from a library topic

Inserting a text fragment from a library topic

DITA libraries give you the opportunity to reuse small text fragments in many topics. Your XML editor has its own functionality to retrieve a text fragment from a library and insert it into the topic you are working with.

(This procedure is based on the Tridion Docs database repository and Oxygen XML editor. Other tools have similar functionality.)

Prerequisites

You have all the tools available, and the necessary rights to develop new content. You have a library available, and this has one or more text fragments. In the library, all the text is contained in <p><ph> structures.

Context

To retrieve and reuse a text fragment, the conref functionality is used.

Text fragment

A text fragment denotes each individual component of an information element. The text fragment consists of a multimodal text, and can for example contain a word, a sentence or an illustration. As part of the information element, the fragment can be reused in different contexts. Reuse takes place by electronic linking in a tool that supports such functionality.

What kind of element you can bring in depends on where you want to use it in the topic.

Procedure

  1. In the topic you are working with, place the cursor inside the element where you want to reuse the text element.

  2. From the editor's main menu, select Tridion DocsInsert conref.

    Or:

    Click the conref icon on the toolbar.

    Icon

  3. In the Reuse Content dialogue box that opens, click the green icon on the far right to open the database.

    Reuse Content

  4. In the database, find the library from which you want to retrieve the text fragment.

  5. Double-click the object to retrieve it.

  6. Back in the Reuse Content dialogue box, set Show elements of type to the type of element you want to retrieve.

    Reuse Content

    The dialogue box now lists all the relevant items, and provides you a preview of the contents.

  7. To retrieve the item, do one of the following actions:

    1. Double-click the element.
    2. Click the item you want to import, then click Insert.
    3. Click the item you want to import, then click Insert and close.

Related texts

About DITA library topics

How does it work?

When is it a good idea to establish a library?

Where should the library be located?

Make small libraries!

Basic rules for using libraries

Content types for library topics

Metadata for library topics


All external links open in a new window. I take no responsibility for information on external websites, even if I have linked to them. Please report links that do not work.

The information on this page represents my personal opinions and my understanding of the topic being described. Feel free to link to the page, but do not copy large parts of the content without permission. I take no responsibility for any errors, misunderstandings or missing information. I also take no responsibility for any mistakes you may make or cause as a result of incorrect or missing information. You are welcome to contribute with comments, relevant experiences or additional information. See Editor and contact information.