Redmine

h1. ezFAQ Plugin (current version 0.0.2)

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.

Futher more, ezFAQ can generate a pdf document of all the valid FAQs(version 0.0.3).

It can be downloaded from github:

  http://github.com/zouchaoqun/ezfaq/tree/master

It also can be downloaded here as attachment.

Screenshot:

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

h2. To install from git:

(Git Version < 1.5.3)

<pre>

cd {RAILS_ROOT}/vendor/plugins

git clone git://github.com/zouchaoqun/ezfaq.git

</pre>

(Git Version >= 1.5.3 -- Because the "git-rails" gem uses Git Submodules introduced in ver. 1.5.3)

<pre>

gem install git-rails

git-rails install git://github.com/zouchaoqun/ezfaq.git

</pre>

h2. Plugin setup

1. Install will_paginate gem

  gem install will_paginate

2. Add will_paginate to the last of enviroment.rb

  require 'will_paginate'

3. Install the plugin as described "here":http://www.redmine.org/wiki/redmine/Plugins (this plugin *requires* migration). 

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

5. Migrate plugin:

  rake db:migrate_plugins

6. Start Redmine

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

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.