DITA Best Practices : Create a Top FAQs/Important Message tile

Created by Kelly Mankenberg, last modified on Feb 21, 2018

A Top FAQs tile displays a list of the top frequently asked questions for your document.

The Important Message tile is similar, except it displays a message

This is provided as a service to the customer to help them quickly find the information they are looking for.

Step-by-step guide

To add a Top FAQs/Important Message tile to your WebHelp home page:

  1. Create a new concept DITA file for containing your FAQs.
    This file can be named anything. The filename itself is irrelevant to the processing of its content.

  2. Within the topic:
    1. Verify the concept title is "Top FAQs" (without quotes); "Important Message" for the corresponding tile.
    2. For Top FAQs: create your FAQ questions and answers as described in Creating FAQ entries in an FAQ topic.
    3. For Top FAQs: Within the shortdesc element, place an xref to each question div element.
      For Important Message: Within the shortdesc element, place the message to be displayed in the tile.

When the transformed page (HTML) is loaded in the browser, the code automatically formats the tile to distinguish it from the other topic tiles. 



Attachments:

topfaqs.png (image/png)