Difference between revisions of "Using the FAQ Manager plugin"

Latest revision as of 14:26, 11 May 2009

Accessing the FAQ Manager plugin

1. Log into your website as an administrator.
2. Click the FAQ Manager link in the 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

1. Log into your website as an administrator.
2. Click the FAQ Manager link in the Admins Only block.
3. Click the Add a Category link.
4. Complete the Category Name and Category Description fields.
5. Click the Add It! button.

Editing a category

1. Log into your website as an administrator.
2. Click the FAQ Manager link in the Admins Only block.
3. Click the Edit a Category link.
4. Select the category you want to edit.
5. Click the Proceed! button.
6. Make you changes.
7. Click the Edit It! button.

Deleting a category

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

1. Log into your website as an administrator.
2. Click the FAQ Manager link in the Admins Only block.
3. Click the Delete a Category link.
4. Select the category you want to delete.
5. Click the Proceed! button.
6. 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

1. Log into your website as an administrator.
2. Click the FAQ Manager link in the Admins Only block.
3. Click the Add an FAQ Topic link.
4. Select the Category to which the topic belongs.
5. Complete the Question, Answer and Keyword fields.
6. 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:

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.

Editing a topic

1. Log into your website as an administrator.
2. Click the FAQ Manager link in the Admins Only block.
3. Click the Edit an FAQ Topic link.
4. Select the Category to which the Topic belongs.
5. Click the Proceed! button.
6. Select the Topic you want to edit.
7. Click the Proceed! button.
8. Make the changes and click the Update it! button.

Deleting a topic

1. Log into your website as an administrator.
2. Click the FAQ Manager link in the Admins Only block.
3. Click the Delete an FAQ Topic link.
4. Select the Category to which the Topic belongs.
5. Click the Proceed! button.
6. Select the Topic you want to delete.
7. You will be asked whether you are sure you want to delete the Topic. You will not be shown the full topic text at this point, so be sure you're deleting the Topic you want to delete.
8. To confirm the deletion, click the Yes button. You will only be asked once, so be careful!

Templates

THIS NEEDS TO BE COMPLETED

Back to FAQ Manager Plugin