Related links example - Fluid Topics - Latest

Fluid Topics Designer Guide

Category
Reference Guides
Audience
public
Version
Latest

The Related links feature shows a list of documents which share a common metadata key value with the current document. It is a feature of the classic Reader page.

It is possible to recreate it in a designed Reader page using a Search block component.

To do so:

  1. Open the Reader designer.
  2. Add a Search block component.
  3. Open the component's Settings.
  4. Under Search scope, select In other documents.
  5. Under Content locale, select Use current document's content locale.
  6. Under Filters, enter or select the metadata key whose value related documents should share.
  7. In the Value field, select Contextual.

    By selecting Contextual, the metadata key value is the one of the current document.

  8. Add a Search results component inside of the Search block component.

  9. Save and publish.

This creates the following result:

A sidebar interface with 'Related links' selected, under the headings 'Product: Fluid Topics' and 'Category: Reference Guides'. It lists links such as 'Adobe FrameMaker Connector Reference Guide', 'Antora Connector Reference Guide', 'Author-it Connector Reference Guide', 'Confluence Connector Reference Guide', 'Cosima Connector Reference Guide', and 'DITA Connector Reference Guide'. Other sidebar options are 'Table of contents', 'Search in documents', and 'Attachments'.

Create a Result template for related links, and apply it in the Search results component's Settings.