`<linkpool>`

A link pool is a group of links. The order that the links are rendered in the output is determined by the processor.

Rendering expectations

The order in which links in a <linkpool> element are rendered is processor-specific. A processor might sort links based on role or type. A processor might move or remove links based on the context. For example, prerequisite links might be rendered at the beginning of a Web page, or links to the next topic might be removed if the two topics are rendered on the same page in a PDF.

Processing expectations

Attributes that cascade between topic references in a map, such as the @scope and @format attributes, also cascade from this element to contained links.

Attributes

The following attributes are available on this element: universal attributes, @collection-type, @duplicates, @format, @otherrole, @role, @scope, and @type.

Example

The following code sample shows how a <linkpool> element is used to group a set of conceptual information. The order in which the links are rendered in the output is processor-dependent. In this example, the @type attribute on the <linkpool> element cascades to nested <link> elements.

<related-links>
  <linkpool type="concept">
    <link href="czez.dita#czez" role="next"/>
    <link href="czunder.dita"/>
    <link format="html" href="czover.htm#sqljsupp" role="parent">
      <linktext>Overview of the CZ</linktext>
    </link>
    <link format="html" href="czesqlj.htm#sqljemb">
      <linktext>Working with CZESQLJ</linktext>
      <desc>When you work with CZESQLJ, you need to know...</desc>
    </link>
  </linkpool>
</related-links>