Redmine

h1. ezFAQ Plugin 

A FAQ management plugin to collect the frequently asked questions.

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).

Current version: 0.3.4. ONLY compatible with Redmine last devel. 

If you use redmine 0.8.3, please use ezFAQ 0.0.2.1 at http://www.redmine.org/boards/3/topics/5113

h2. New version notes (2011-06-01)

Dear all, this message is from original author Zou Chao Qun. For some reason, I am too busy to update this plugin. So many thanks to all of you who like this plugin.

I have found updating bug-fix version from kind Anson Chen at https://github.com/ansoncat/ezfaq_plugin and from kind Furgas at github: https://github.com/Furgas/ezfaq_plugin

Please refer to their github page to find the latest one.

h2. Feature

1. Ask question and request a user to answer it.

2. FAQ is grouped by categories.

3. FAQ's modification has history logs.

4. Send notify email to the author and the assigned user who should answer the question.

5. FAQ creation or update is added to redmine's activity.

6. FAQ and FAQ-list can be exported to PDF document.

7. FAQ are searchable using redmine's search engine.

The plugin archive is attached here.

It can also be downloaded at github: http://github.com/zouchaoqun/ezfaq/tree/master

Screenshot:

!ezfaq_tn.png!:/attachments/download/863 

h2. Plugin installation

1. Copy the plugin directory(ezfaq_plugin) into the vendor/plugins directory

NOTE: The plugin directory must be ezfaq_plugin!

2. Migrate plugin:

   rake db:migrate_plugins

3. Start Redmine

4. In your project in Redmine, go to "Project settings" : On the "Modules" tab, enable the module by checking "Ezfaq".

h2. Note

Since the plugin applies a patch to redmine core, it can only run properly under

production environment. When runs under development envrionment, the faq with attachments

will fail to show.

Redmine currently doesn't support plugin to extend its search scope, so you have to

modify redmine's search controller to search FAQ.

(Edit ln51 in search_controller.rb, add faqs to the @object_types)

Also see issue #3021

h2. Using ezFAQ

# Registered users can add new faqs by click the 'New FAQ' link.

# Privileged users can modify faqs, modify faq categories by click the appropriate link.

# Privileged users can modify the FAQ list's note which will be displayed before the list and exported to the pdf document.

# When a faq is created and assigned to someone, the assigned user will receive a notify email to complete the answer.

# In faq list page and faq show page, use the export to pdf link to generate a pdf file.

# FAQ can be searched using redmine's search page. (See NOTE section)