Project

General

Profile

PluginEzfaq » History » Version 14

Gonzalo Fernández-Victorio, 2010-09-03 15:21

1 7 Chaoqun Zou
h1. ezFAQ Plugin 
2 1 Chaoqun Zou
3
A FAQ management plugin to collect the frequently asked questions.
4
Using ezFAQ, you can add a question, assign someone to answer it, or modify the answer, ezFAQ will record each modifications. ezFAQ will send notify email to the author and the assigned user. And in version 0.2.0, you can export faqs to pdf(both single faq and the faq list can be exported).
5 13 Chaoqun Zou
Current version: 0.3.4. ONLY compatible with Redmine last devel. 
6 12 Chaoqun Zou
If you use redmine 0.8.3, please use ezFAQ 0.0.2.1 at http://www.redmine.org/boards/3/topics/5113
7 1 Chaoqun Zou
8 7 Chaoqun Zou
h2. Feature
9 1 Chaoqun Zou
10 7 Chaoqun Zou
1. Ask question and request a user to answer it.
11
2. FAQ is grouped by categories.
12 1 Chaoqun Zou
3. FAQ's modification has history logs.
13
4. Send notify email to the author and the assigned user who should answer the question.
14 8 Chaoqun Zou
5. FAQ creation or update is added to redmine's activity.
15 7 Chaoqun Zou
6. FAQ and FAQ-list can be exported to PDF document.
16 8 Chaoqun Zou
7. FAQ are searchable using redmine's search engine.
17 1 Chaoqun Zou
18 8 Chaoqun Zou
The plugin archive is attached here.
19
It can also be downloaded at github: http://github.com/zouchaoqun/ezfaq/tree/master
20 7 Chaoqun Zou
21 1 Chaoqun Zou
Screenshot:
22
23
!ezfaq_tn.png!:/attachments/download/863 
24 2 Chaoqun Zou
25 8 Chaoqun Zou
h2. Plugin installation
26 4 Chaoqun Zou
27 2 Chaoqun Zou
1. Copy the plugin directory(ezfaq_plugin) into the vendor/plugins directory
28 8 Chaoqun Zou
NOTE: The plugin directory must be ezfaq_plugin!
29 3 Chaoqun Zou
30 1 Chaoqun Zou
2. Migrate plugin:
31
   rake db:migrate_plugins
32
33
3. Start Redmine
34
35
4. In your project in Redmine, go to "Project settings" : On the "Modules" tab, enable the module by checking "Ezfaq".
36 3 Chaoqun Zou
37 8 Chaoqun Zou
h2. Note
38
39
Since the plugin applies a patch to redmine core, it can only run properly under
40
production environment. When runs under development envrionment, the faq with attachments
41
will fail to show.
42
43 13 Chaoqun Zou
Redmine currently doesn't support plugin to extend its search scope, so you have to
44 8 Chaoqun Zou
modify redmine's search controller to search FAQ.
45
(Edit ln51 in search_controller.rb, add faqs to the @object_types)
46
47 14 Gonzalo Fernández-Victorio
Also see issue #3021
48
49 7 Chaoqun Zou
h2. Using ezFAQ
50 2 Chaoqun Zou
51
# Registered users can add new faqs by click the 'New FAQ' link.
52 3 Chaoqun Zou
# Privileged users can modify faqs, modify faq categories by click the appropriate link.
53
# Privileged users can modify the FAQ list's note which will be displayed before the list and exported to the pdf document.
54
# When a faq is created and assigned to someone, the assigned user will receive a notify email to complete the answer.
55 8 Chaoqun Zou
# In faq list page and faq show page, use the export to pdf link to generate a pdf file.
56
# FAQ can be searched using redmine's search page. (See NOTE section)