Collect and answer frequently asked questions

This package implements the typical FAQ functionality, which allows you to provide users with information about typical issues, workarounds, tips and tricks as question-answer pairs right on the website.

Each FAQ article can be grouped by category, which facilitates their search and navigation.

The FAQ articles can be displayed in two modes:

  • Links: The FAQ articles are presented as a list of links. The FAQ article's details open when the user clicks a link.
  • Anchors: The FAQ articles are presented both a list of links and a list of detailed FAQ articles below. The FAQ article gets in focus when the user clicks a link.

Technical description

This package installs:

  • 1 function:
    • Composite.Lists.FAQ.LinksToDetail: Displays FAQ items on a page
  • 1 global datatypes:
    • Composite.Lists.FAQCategory: Stores FAQ categories
  • 1 page data folder:
    • Composite.Lists.FAQ: Store FAQ items (articles)

How to implement

  1. In the Content perspective, add a new page that will serve as a "FAQ" page.
  2. For its page type, select "FAQ page".

The page type adds the Composite.Lists.FAQ page data folder under the page and the Composite.Lists.FAQ.LinksToDetail function on the page.

If you want to implement the FAQ on an existing page, you should add the type and the function manually:

  1. Right-click an existing page, and click Add datafolder in the context menu.
  2. Select "FAQ" for the data folder type and click OK.
  3. Edit this page.
  4. Insert the Composite.Lists.FAQ.LinksToDetails function ( Insert | Function), or add the similar code: 
     
<f:function name="Composite.Lists.FAQ.LinksToDetails" xmlns:f="http://www.composite.net/ns/function/1.0"> 
  <f:param name="Mode" value="Links" /> 
</f:function>

  5. If necessary, sets its optional parameter:

How to add FAQ items

  1. Expand the "FAQ" page.
  2. Select the "FAQ" data folder and click Add Data on the toolbar.
  3. On the Settings tab, specify the values for the following fields:
    • Question Heading: The title of a FAQ item that appears on a page an in an URL.
    • Date Added: The date the FAQ item was added.
    • Question Category: The category the FAQ item belong to.
  4. On the Question tab, write the detailed question.
  5. On the Answer tab, write the detailed answer.
  6. Click Save.

How to add categories

  1. In the Content perspective, expand Website Items.
  2. Select "FAQ Category" and click Add Data on the toolbar.
  3. In the Category Name field, enter the name for a new category.
  4. Click Save.

Customization

You can customize the layout by editing the style sheets:

~/Frontend/Composite/Lists/FAQ/Styles.css

Requirements

Composite C1 version 2.1.1 or later

SHARE