You will require this information when you would like to create an FAQ section, and populate it with FAQ items.

Step-by-step guide to create an FAQ section

  1. Navigate to the root/home page of your website (make sure that you are logged in, and that you have the appropriate editing privileges).
  2. Use the 'Add new' menu to add a new 'Section'.
  3. Name the section, and save the form.
  4. Once you have saved the section, you will be looking at your new section.
  5. Using the dropdown menu from your account name, in the top right of the page, on the edit bar, select 'Manage behaviours'
  6. You will now see a page with a list of available behaviours, check the box next to 'FAQ section behaviour'.
  7. Scroll down and click 'Save' - the page will reload, and a notice will appear at the top confirming that the changes have saved, you can now navigate back to the newly created section, to begin adding content.

Note: Don't forget that if you are creating this section in the root of your website, and do not want it to show on the main horizontal navigation of your website, that you should go to the 'Settings' tab when creating the section and check the box next to 'Exclude from the navigation'. You will then need to access the new section that you have created, through the folder contents at the root of your website.

Step-by-step guide to create a FAQ item

Firstly, you will need to make sure that you have allowed the use of the FAQ content type - to do this follow the steps below. You will only ever need to carry out these steps once when you first create an FAQ section.

  1. Navigate to your FAQ section (make sure that you are logged in, and that you have the appropriate editing privileges).
  2. Using the 'Add new' dropdown menu on the edit bar, select 'Restrictions'
  3. You will be taken to a page where you will see three fields:
    1. 'Type restrictions'
      1. This will be set to 'Manually' this is how it should be left.
    2. 'Allowed types'
      1. In this field, check the box next to 'FAQ' item.
    3. 'Secondary types'
      1. You do not need to change these.
  4. Scroll to the bottom of the page and click 'Save'

Once you have granted the permission to add FAQ items, follow the steps below to begin populating your FAQ section.

  1. Navigate to your FAQ section (make sure that you are logged in, and that you have the appropriate editing privileges).
  2. Using the 'Add new' dropdown menu on the edit bar, select 'FAQ item'
  3. You will be taken to a page with two tabs. On the first tab 'Default' you will see seven fields:
    1. 'Question'
      1. This field is for writing the question in, this essentially acts as the title for the FAQ item.
    2. 'Short answer'
      1. This field is for a short answer that will be displayed only in search results, content listings, and on the individual FAQ page. This will not chow in the accordion view.
    3. 'Answer'
      1. This field is for the full answer to the FAQ. This will be shown on the individual FAQ item page, as well as in the accordion view.
    4. 'Categories'
      1. This field is populated with the preprepared categories for the FAQ items. To create categories for your FAQ items, go to the 'Taxonomy' on your website and add a new tag list.
    5. 'Sortable name'
      1. This field is not required to be populated, as you will group FAQ's by category.
    6. 'Publishing date' and 'Expiration date'
      1. The publication and expiration dates work as such:

        1. When an item is past its expiration date, it's marked "expired" in red in its document byline when viewed.

        2. An item whose publication date is before the current date doesn't get extra text in its byline.

        3. In both cases, the item is "unpublished", which is not to be confused with a workflow state.

        4. It merely means the item doesn't show up in listings and searches.

        5. These listings include folder listings.

        6. However, the owner of the item will keep seeing it, which is handy because you like to know what you have lying around in your site.

        7. Expired items in a folder are marked as such when viewing the folder_contents.

        8. There's no quick way of seeing if items in a folder listing are not yet published.

        9. When you set an unpublished item as the default view for a folder, that item will be shown.

        10. Unpublishing an item doesn't have any effect for admins. They will always see unpublished items in their listings and searches.

        11. Giving another regular users rights ("can add", can edit", "can review") on the item doesn't make it any less unpublished for those users.

        12. A practical way for a non-admin user to access an unpublished item is directly through its URL.

  4. On the second tab 'Settings' you will see one field:
    1. 'Exclude from the navigation'
      1. If the checkbox for this field is ticked, the FAQ item will not show in the navigation anywhere, but it will still be searchable.
  5. Once you have made all of your changes, click the 'Save' button at the bottom of the page.

    Don't forget to publish the FAQ when you have completed it,s o that all of your website visitors can see it.

Step by step guide to setting the display of your FAQ section

  1. Using the 'Display' tab on the edit bar at the top of the page, select one of the two following options for your FAQ section layout:
    1. 'FAQ - plain listing'
      1. This display will list all of the FAQ's in the section, in alphabetical order - as below:

    2. 'FAQ - Category tabs'
      1. This display will show all of the FAQ's that are in the FAQ section, broken down by the categories that they are tagged with - as below:

  2. Once you have chosen which display you would like to use, you can then define which, if any of the optional filters you would like to use. To do this, navigate to the FAQ section that you have created and click 'Edit' in the top left on the edit bar.
  3. In the 'Edit' view of the section, you will see multiple tabs. Click on the 'View' tab.
  4. On the 'View' tab, you will see four fields.
    1. 'FAQ's path' 
      1. In this field, you can define the path that you want to collect FAQ's from and show in the section. For example, if you have multiople FAQ sections across your website, and you have one section where you wouldlike to list them all, you can enter '/' into the field and it will collect all of the FAQ's from across your website.
    2. 'Select visible FAQ categories'
      1. Whichever FAQ display you are using, this will still work in the same way. If you have all of the categories in the left box, they will all show in the section. If you want to display only some specific categories, then you need to select them and move them into the right box.
    3. 'Select visible listing filters'
      1. This field allows you to display one, both or none of the filters that are available to a user.
        1. 'Keyword searching'
          1. If you enable this filtering (by selecting it and shifting it to the right box), it will allow users to type into a free text search field, and it will filter the results in real time for the user.
        2. 'Selected categories'
          1. If you enable this filtering (by selecting it and shifting it to the right box), it will allow users to select a category from the list, and then display only FAQ's tagged by that category.
    4. 'Show results as accordion'
      1. Checking this box will show the results in an accordion layout - this lists only the questions, and then allows the user to click on it to expand the answer.

Don't forget that, although when you are building this section for the first time it will span the full width of the page, you are able to add portlets in the usual way. The portlets in this section will be 'Primary portlets'.