Changes between Version 1 and Version 2 of FaqPlugin


Ignore:
Timestamp:
Jan 7, 2012 8:24:41 PM (3 years ago)
Author:
seccanj
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • FaqPlugin

    v1 v2  
    11[[PageOutline(2-5,Contents,pullout)]] 
    22 
    3 = FAQ Plugin for Trac = 
     3= FAQ Management Plugin for Trac = 
    44 
    55== Description == 
    6  
     6[[BR]] 
    77A Trac plugin to create FAQs and organize them in categories. 
    88 
     9[[BR]] 
     10[[BR]] 
     11[[Image(faq_screen01.png)]] 
     12[[BR]] 
     13'''FAQ Plugin overview''' 
     14[[BR]] 
     15[[BR]] 
    916 
     17To create a new FAQ category, enter the name for the category in the text field and click "Add a Category". 
     18 
     19[[BR]] 
     20[[BR]] 
     21[[Image(faq_screen05.png)]] 
     22[[BR]] 
     23'''Creating a FAQ Category - step 1''' 
     24[[BR]] 
     25[[BR]] 
     26 
     27A new wiki page will be created and opened for editing. 
     28[[BR]] 
     29[[BR]] 
     30The first line represents the category title. You can freely edit it, but do not remove it. 
     31[[BR]] 
     32[[BR]] 
     33This is a normal Wiki page, so you can can use WikiFormatting here, as well as attach documents and images. 
     34[[BR]] 
     35[[BR]] 
     36When you have finished editing the FAQ category description, save the wiki page. 
     37 
     38[[BR]] 
     39[[BR]] 
     40[[Image(faq_screen06.png)]] 
     41[[BR]] 
     42'''Creating a FAQ Category - step 2''' 
     43[[BR]] 
     44[[BR]] 
     45 
     46To 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". 
     47 
     48[[BR]] 
     49[[BR]] 
     50[[Image(faq_screen03.png)]] 
     51[[BR]] 
     52'''Creating a FAQ - step 1''' 
     53[[BR]] 
     54[[BR]] 
     55 
     56Like for FAQ categories, this action will also create a new wiki page and open it for editing. 
     57[[BR]] 
     58[[BR]] 
     59This is a also normal Wiki page, so you can can use WikiFormatting here, as well as attach documents and images. 
     60 
     61[[BR]] 
     62[[BR]] 
     63[[Image(faq_screen04.png)]] 
     64[[BR]] 
     65'''Creating a FAQ - step 2''' 
     66[[BR]] 
     67[[BR]] 
     68 
     69To modify a FAQ, you can usually edit the corresponding wiki page once opened. 
     70[[BR]] 
     71Alternatively, 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. 
     72 
     73[[BR]] 
     74[[BR]] 
     75[[Image(faq_screen02.png)]] 
     76[[BR]] 
     77'''Editing a FAQ from the tree view''' 
     78[[BR]] 
     79[[BR]] 
     80 
     81== Security == 
     82[[BR]] 
     83The FAQ management capabilities are protected by a set of new Trac permissions: 
     84 * FAQ_CREATE : Allows for creating and editing FAQs 
     85 * FAQ_VIEW : Allows for viewing FAQs 
     86 
     87[[BR]] 
     88[[BR]] 
    1089== Bugs/Feature Requests ==  
    1190 
     
    24103You can check out FaqPlugin from [http://trac-hacks.org/svn/faqplugin here] using Subversion, or [source:faqplugin browse the source] with Trac. 
    25104 
    26 == Example == 
    27  
    28 a 
    29  
    30105== Recent Changes == 
    31106