Changes between Version 21 and Version 22 of FaqPlugin
- Timestamp:
- May 2, 2015, 11:59:03 AM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
FaqPlugin
v21 v22 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 2 3 = FAQ Management Plugin for Trac =3 = FAQ Management Plugin for Trac 4 4 5 == Description == 6 [[BR]] 7 A Trac plugin to create FAQs and organize them in categories. 8 [[BR]] 9 FAQs are actually Wiki pages, created automatically and using a naming convention that allows the plugin to display them in a tree view. 10 [[BR]] 11 Categories and sub-categories allow for organizing the FAQs based on topics. 12 [[BR]] 13 [[BR]] 5 == Description 6 7 This is a Trac plugin to create FAQs and organize them in categories. FAQs are actually Wiki pages, created automatically and using a naming convention that allows the plugin to display them in a tree view. Categories and sub-categories allow for organizing the FAQs based on topics. 8 14 9 The plugin adds a "FAQs" tab in the upper-right Trac navigation menu. Clicking on it displays the main FAQs page shown in the following figure. 15 [[BR]]16 10 The FAQs home page aggregates all the FAQ wiki pages and displays them in a single page. 17 [[BR]] 11 18 12 The page is divided in two halves: 19 13 * The upper half shows only the category and FAQ titles. Clicking on any title links to the corresponding page. 20 14 * The lower half shows the full category and FAQ page contents, as in a usual FAQ page. 21 15 22 [[BR]]23 [[BR]]24 16 [[Image(faq_screen01.png)]] 25 17 [[BR]] 26 18 '''FAQ Plugin overview''' 27 [[BR]]28 [[BR]]29 19 30 [[BR]] 31 === Creating a new FAQ category === 32 [[BR]] 20 === Creating a new FAQ category 21 33 22 To create a new FAQ category, enter the name for the category in the text field and click "Add a Category". 34 23 35 [[BR]]36 24 [[BR]] 37 25 [[Image(faq_screen05.png)]] 38 26 [[BR]] 39 27 '''Creating a FAQ Category - step 1''' 40 [[BR]]41 [[BR]]42 28 43 29 A new wiki page will be created and opened for editing. 44 [[BR]]45 [[BR]]46 30 The first line represents the category title. You can freely edit it, but do not remove it. 47 [[BR]]48 [[BR]]49 31 This is a normal Wiki page, so you can can use WikiFormatting here, as well as attach documents and images. 50 [[BR]]51 [[BR]]52 32 When you have finished editing the FAQ category description, save the wiki page. 53 33 54 [[BR]]55 34 [[BR]] 56 35 [[Image(faq_screen06.png)]] 57 36 [[BR]] 58 37 '''Creating a FAQ Category - step 2''' 59 [[BR]]60 [[BR]]61 38 62 [[BR]] 63 === Creating a new FAQ === 64 [[BR]] 39 === Creating a new FAQ 40 65 41 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". 66 42 67 [[BR]]68 43 [[BR]] 69 44 [[Image(faq_screen03.png)]] 70 45 [[BR]] 71 46 '''Creating a FAQ - step 1''' 72 [[BR]]73 [[BR]]74 47 75 48 Like for FAQ categories, this action will also create a new wiki page and open it for editing. 76 [[BR]]77 [[BR]]78 49 This is a also normal Wiki page, so you can can use WikiFormatting here, as well as attach documents and images. 79 50 80 [[BR]]81 51 [[BR]] 82 52 [[Image(faq_screen04.png)]] 83 53 [[BR]] 84 54 '''Creating a FAQ - step 2''' 85 [[BR]]86 [[BR]]87 55 88 [[BR]] 89 === Editing a FAQ === 90 [[BR]] 56 === Editing a FAQ 57 91 58 To modify a FAQ, you can usually edit the corresponding wiki page once opened. 92 [[BR]]93 59 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. 94 60 95 [[BR]]96 61 [[BR]] 97 62 [[Image(faq_screen02.png)]] 98 63 [[BR]] 99 64 '''Editing a FAQ from the tree view''' 100 [[BR]]101 [[BR]]102 65 103 [[BR]] 104 == Security == 66 === Security 105 67 106 68 The FAQ management capabilities are protected by a set of new Trac permissions: 107 * FAQ_CREATE : Allows for creating and editing FAQs108 * FAQ_VIEW : Allows for viewing FAQs69 * `FAQ_CREATE`: Allows for creating and editing FAQs. 70 * `FAQ_VIEW`: Allows for viewing FAQs. 109 71 110 [[BR]] 111 [[BR]] 112 [[BR]] 113 == Bugs/Feature Requests == 72 == Bugs/Feature Requests 114 73 115 74 Existing bugs and feature requests for FaqPlugin are … … 119 78 [http://trac-hacks.org/newticket?component=FaqPlugin&owner=seccanj new ticket]. 120 79 121 [[TicketQuery(component=FaqPlugin, format=table,col=summary|status|severity|priority|milestone|type|owner|time|description)]]80 [[TicketQuery(component=FaqPlugin,group=type,format=progress)]] 122 81 123 [[BR]] 124 == Download == 125 [[BR]] 82 == Download 126 83 127 84 Download Egg files and the zipped source from [https://sourceforge.net/projects/faq4trac/files/ the project on SourceForge]. 128 85 129 [[BR]] 130 == Source == 131 [[BR]] 86 == Source 132 87 133 88 You can check out FaqPlugin from [https://sourceforge.net/p/faq4trac/code/ the repository on SourceForge] using Git. 134 89 135 [[BR]] 136 == Recent Changes == 137 [[BR]] 90 == Recent Changes 138 91 139 92 [[ChangeLog(faqplugin, 3)]] 140 93 141 == Author/Contributors ==94 == Author/Contributors 142 95 143 96 '''Author:''' [wiki:seccanj] [[BR]] 144 '''Maintainer:''' [ wiki:seccanj] [[BR]]97 '''Maintainer:''' [[Maintainer]] [[BR]] 145 98 '''Contributors:'''
