View source for Using the FAQ Manager plugin

== Accessing the FAQ Manager plugin ==

# Log into your website as an administrator.
# Click the <I>FAQ Manager</i> link in the [[Admins Block|Admins Only]] block.

== Categories ==

FAQ Manager organizes FAQ entries by categories. Categories need to be added before FAQ entries are added. A list of the categories is generated by the plugin. The list is hotlinked, and clicking on a category will take you to a page with a list of all the questions in that category.

=== Adding a category ===

# Log into your website as an administrator.
# Click the <I>FAQ Manager</i> link in the [[Admins Block|Admins Only]] block.
# Click the <I>Add a Category</i> link.
# Complete the Category Name and Category Description fields.
# Click the Add It! button.

=== Editing a category ===

# Log into your website as an administrator.
# Click the <I>FAQ Manager</i> link in the [[Admins Block|Admins Only]] block.
# Click the <I>Edit a Category</i> link.
# Select the category you want to edit.
# Click the Proceed! button.
# Make you changes.
# Click the Edit It! button.

=== Deleting a category ===

<B>Warning: When a category is deleted, all of the FAQ entries in that category are also deleted.</b> If you want to keep the entries, move them to another category firstly.

# Log into your website as an administrator.
# Click the <I>FAQ Manager</i> link in the [[Admins Block|Admins Only]] block.
# Click the <I>Delete a Category</i> link.
# Select the category you want to delete.
# Click the Proceed! button.
# To confirm the delete, click the Yes button.

== Topics ==

FAQ Manager allows you to add Topics, which holds the question and answer and belongs to a category. FAQ Manager will automatically create a list of all questions within a category. The questions are hotlinked, and clicking on the question will take you to a page with the question and the answer.

=== Adding a topic ===

# Log into your website as an administrator.
# Click the <I>FAQ Manager</i> link in the [[Admins Block|Admins Only]] block.
# Click the <I>Add an FAQ Topic</i> link.
# Select the Category to which the topic belongs.
# Complete the Question, Answer and Keyword fields. 
# Click the Add It! button.

==== Keyword stop list ====

The keywords are subject to the MySQL stop list. This list contains 570 words and can be found in the public_html/plugins/faqman/data/stopwords.inc.php file.

The following is an excerpt from the file which explains the stop list:

<I>This file contains an array of the complete default MySQL stop list, there are 570 words. Editing this list WILL NOT remove them from the stop list, so they still cannot be used in searches, the only way to do that is to edit the MySQL source file myisam/ft_static.c and then recompile MySQL

This is NOT my fault, so please do not email me about it, but if you know any easier way to get the MySQL stoplist please let me know.</i>

=== Editing a topic ===

# Log into your website as an administrator.
# Click the <I>FAQ Manager</i> link in the [[Admins Block|Admins Only]] block.
# Click the <I>Edit an FAQ Topic</i> link.
# Select the Category to which the Topic belongs.
# Click the <I>Proceed!</i> button.
# Select the Topic you want to edit.
# Click the <I>Proceed!</i> button.
# Make the changes and click the <I>Update it!</i> button.

=== Deleting a topic ===

# Log into your website as an administrator.
# Click the <I>FAQ Manager</i> link in the [[Admins Block|Admins Only]] block.
# Click the <I>Delete an FAQ Topic</i> link.
# Select the Category to which the Topic belongs.
# Click the <I>Proceed!</i> button.
# Select the Topic you want to delete.
# You will be asked whether you are sure you want to delete the Topic. You will <I>not</i> be shown the full topic text at this point, so be sure you're deleting the Topic you want to delete.
# To confirm the deletion, click the <I>Yes</I> button. You will only be asked once, so be careful!

== Templates ==

THIS NEEDS TO BE COMPLETED


Back to [[FAQ Manager Plugin]]


[[Category:Plugins]]