FAQ Application

Last modified by Vincent Massol on 2017/12/11 00:01

helpQuestions and answer for frequently asked questions
Recommended
TypeXAR
CategoryApplication
Developed by

Vincent Massol, XWiki Development Team

Active Installs262
Rating
Rate!
6 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

Requires XWiki 7.4.2+

Installable with the Extension Manager

Description

The FAQ application has the following features:

  • View and filter all existing FAQ entries
  • Add a new FAQ entry
  • Search for FAQ entries
  • FAQ Macro to display a list of FAQ entries
  • Ability to create several FAQs in the same wiki (one per space) New in 5.0M1
  • Updated design New in 6.4M1

Main view:

faq.png

Viewing existing FAQ entries

viewfaq1.png

viewfaq2.png

Adding a new FAQ entry

addfaq1.png

addfaq2.png

Searching FAQ entries

searchfaq1.png

searchfaq2.png

FAQ Macro

Usage: {{faq filter="..."/}}

where filter is HQL "where" portion. For example: filter="space=FAQ" would list only FAQ entries located in the FAQ space.

Example result:

faqmacro.png

Create multiple FAQs

XWiki 5.0M1 By default this application creates a FAQ space in FAQ.WebHome. However you can easily transform any other space into a FAQ space by editing that space's WebHome page and adding an Object of type FAQCode.FAQHomeClass.

Internationalization

To internationalize this application, navigate to the FAQCode.Translations page and edit it for the language you wish to provide a translation for (check the keys to translate from the default language content).

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
3.3XWiki Enterprise 3.3
5.4.5XWiki Enterprise 5.4.5
6.2.4XWiki Enterprise 6.2.4
6.4XWiki Enterprise 6.4
7.1.2XWiki Enterprise 7.1.2
8.1.2XWiki Enterprise 9.1.2

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes

v8.1.3

    v8.1.2

    • Closed FAQ-13 FAQ entries not displayed anymore in livetable

    v8.1.1

    • Closed FAQ-12 Add a space in the french translations between 'La Foire Aux Questions' and '(FAQ)'

    v8.1

    • Closed FAQ-1 Relocate under the org.xwiki.contrib:application-faq* extension ids

    Dependencies

    Dependencies for this extension (org.xwiki.contrib:application-faq-ui 8.1.3):

    Tags:
    Created by Vincent Massol on 2011/11/17 16:04
        

    Get Connected