Questions and answers for frequently asked questions

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:

Viewing existing FAQ entries

Adding a new FAQ entry

Searching FAQ entries

FAQ Macro

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

where filter allows specifying some filtering parameters, as shown in the examples below.

Examples:

• filter="space=FAQ" would list only FAQ entries located in the FAQ space.
• filter="tag=test" would list only FAQ entries having a test tag.
• filter="space=FAQ&tag=test" would list only FAQ entries located in the FAQ space and tagged with test.

Example result:

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.
• Copy the search page FAQ.FAQSearch to that space.

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).

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.4.1

The following translations have been updated with this release:

• German

v8.4

v8.3

v8.2

v8.1.3

v8.1.2

v8.1.1

v8.1

Dependencies

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

• org.xwiki.platform:xwiki-platform-rendering-macro-velocity 8.4
• org.xwiki.platform:xwiki-platform-rendering-macro-include 8.4
• org.xwiki.rendering:xwiki-rendering-macro-box 8.4
• org.xwiki.rendering:xwiki-rendering-macro-message 8.4
• org.xwiki.rendering:xwiki-rendering-macro-html 8.4
• org.xwiki.platform:xwiki-platform-localization-source-wiki 8.4
• org.xwiki.platform:xwiki-platform-rendering-wikimacro-store 8.4
• org.xwiki.platform:xwiki-platform-livetable-ui 8.4
• org.xwiki.platform:xwiki-platform-search-ui 8.4
• org.xwiki.platform:xwiki-platform-panels-ui 8.4