[[PageOutline(2-5,Contents,pullout)]]

= FAQ Management Plugin for Trac =

== Description ==
[[BR]]
A Trac plugin to create FAQs and organize them in categories.

[[BR]]
[[BR]]
[[Image(faq_screen01.png)]]
[[BR]]
'''FAQ Plugin overview'''
[[BR]]
[[BR]]

=== Creating a new FAQ category ===
[[BR]]
[[BR]]

To create a new FAQ category, enter the name for the category in the text field and click "Add a Category".

[[BR]]
[[BR]]
[[Image(faq_screen05.png)]]
[[BR]]
'''Creating a FAQ Category - step 1'''
[[BR]]
[[BR]]

A new wiki page will be created and opened for editing.
[[BR]]
[[BR]]
The first line represents the category title. You can freely edit it, but do not remove it.
[[BR]]
[[BR]]
This is a normal Wiki page, so you can can use WikiFormatting here, as well as attach documents and images.
[[BR]]
[[BR]]
When you have finished editing the FAQ category description, save the wiki page.

[[BR]]
[[BR]]
[[Image(faq_screen06.png)]]
[[BR]]
'''Creating a FAQ Category - step 2'''
[[BR]]
[[BR]]

=== Creating a new FAQ ===
[[BR]]
[[BR]]

To create a new FAQ inside a particular category, first click on the category to open it, then enter the title for the FAQ in the appropriate text field and click "Add a FAQ".

[[BR]]
[[BR]]
[[Image(faq_screen03.png)]]
[[BR]]
'''Creating a FAQ - step 1'''
[[BR]]
[[BR]]

Like for FAQ categories, this action will also create a new wiki page and open it for editing.
[[BR]]
[[BR]]
This is a also normal Wiki page, so you can can use WikiFormatting here, as well as attach documents and images.

[[BR]]
[[BR]]
[[Image(faq_screen04.png)]]
[[BR]]
'''Creating a FAQ - step 2'''
[[BR]]
[[BR]]

=== Editing a FAQ ===
[[BR]]
[[BR]]

To modify a FAQ, you can usually edit the corresponding wiki page once opened.
[[BR]]
Alternatively, you can do it directly from the tree view, clicking on the pencil icon that appears as soon as you go with the mouse on a FAQ.

[[BR]]
[[BR]]
[[Image(faq_screen02.png)]]
[[BR]]
'''Editing a FAQ from the tree view'''
[[BR]]
[[BR]]

== Security ==
[[BR]]
The FAQ management capabilities are protected by a set of new Trac permissions:
 * FAQ_CREATE : Allows for creating and editing FAQs
 * FAQ_VIEW : Allows for viewing FAQs

[[BR]]
[[BR]]
== Bugs/Feature Requests == 

Existing bugs and feature requests for FaqPlugin are 
[report:9?COMPONENT=FaqPlugin here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=FaqPlugin&owner=seccanj new ticket].

== Download ==

Download the zipped source from [download:faqplugin here].

== Source ==

You can check out FaqPlugin from [http://trac-hacks.org/svn/faqplugin here] using Subversion, or [source:faqplugin browse the source] with Trac.

== Recent Changes ==

[[ChangeLog(faqplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:seccanj] [[BR]]
'''Maintainer:''' [wiki:seccanj] [[BR]]
'''Contributors:'''