PluginEzfaq » History » Version 5
Chaoqun Zou, 2008-08-14 16:02
1 | 5 | Chaoqun Zou | h1. ezFAQ Plugin (current version 0.0.2) |
---|---|---|---|
2 | 2 | Chaoqun Zou | |
3 | 1 | Chaoqun Zou | A FAQ management plugin to collect the frequently asked questions. |
4 | 5 | Chaoqun Zou | 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. |
5 | |||
6 | Futher more, ezFAQ can generate a pdf document of all the valid FAQs(version 0.0.3). |
||
7 | 2 | Chaoqun Zou | |
8 | It can be downloaded from github: |
||
9 | 4 | Chaoqun Zou | |
10 | 3 | Chaoqun Zou | http://github.com/zouchaoqun/ezfaq/tree/master |
11 | 2 | Chaoqun Zou | |
12 | Screenshot: |
||
13 | |||
14 | 3 | Chaoqun Zou | !ezfaq_tn.png!:/attachments/download/863 |
15 | 2 | Chaoqun Zou | |
16 | h2. To install from git: |
||
17 | |||
18 | (Git Version < 1.5.3) |
||
19 | <pre> |
||
20 | cd {RAILS_ROOT}/vendor/plugins |
||
21 | git clone git://github.com/zouchaoqun/ezfaq.git |
||
22 | </pre> |
||
23 | |||
24 | (Git Version >= 1.5.3 -- Because the "git-rails" gem uses Git Submodules introduced in ver. 1.5.3) |
||
25 | 1 | Chaoqun Zou | <pre> |
26 | 4 | Chaoqun Zou | gem install git-rails |
27 | 2 | Chaoqun Zou | git-rails install git://github.com/zouchaoqun/ezfaq.git |
28 | </pre> |
||
29 | |||
30 | h2. Plugin setup |
||
31 | 1 | Chaoqun Zou | |
32 | 2 | Chaoqun Zou | 1. Install will_paginate gem |
33 | 3 | Chaoqun Zou | |
34 | gem install will_paginate |
||
35 | 1 | Chaoqun Zou | |
36 | 2 | Chaoqun Zou | 2. Add will_paginate to the last of enviroment.rb |
37 | 3 | Chaoqun Zou | |
38 | require 'will_paginate' |
||
39 | 1 | Chaoqun Zou | |
40 | 3 | Chaoqun Zou | 3. Install the plugin as described "here":http://www.redmine.org/wiki/redmine/Plugins (this plugin *requires* migration). |
41 | 2 | Chaoqun Zou | |
42 | 1 | Chaoqun Zou | 4. Copy the plugin directory(ezfaq_plugin) into the vendor/plugins directory |
43 | 3 | Chaoqun Zou | |
44 | 4 | Chaoqun Zou | 5. Migrate plugin: |
45 | 1 | Chaoqun Zou | |
46 | rake db:migrate_plugins |
||
47 | 2 | Chaoqun Zou | |
48 | 4 | Chaoqun Zou | 6. Start Redmine |
49 | 2 | Chaoqun Zou | |
50 | 4 | Chaoqun Zou | 7. In your project in Redmine, go to "Project settings" : On the "Modules" tab, enable the module by checking "Ezfaq". |
51 | 2 | Chaoqun Zou | |
52 | h2. Using ezFAQ |
||
53 | |||
54 | 3 | Chaoqun Zou | # Registered users can add new faqs by click the 'New FAQ' link. |
55 | # Privileged users can modify faqs, modify faq categories by click the appropriate link. |
||
56 | # Privileged users can modify the FAQ list's note which will be displayed before the list and exported to the pdf document. |
||
57 | # When a faq is created and assigned to someone, the assigned user will receive a notify email to complete the answer. |