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