User Manual

The FAQ Builder Plugin for WordPress is provides an innovative and interactive way respond to your readers questions. The basic Idea is that reader will submit questions, which you can later answer and then display on your FAQ page complete with search capabilities and categories.

FAQ Builder for WordPress plugin is composed of four main parts:

  1. The Categories Manager (backend),
  2. The Question Manager (backend),
  3. The FAQ Ask Form, and
  4. The FAQ Page

Breifly, the Categories Manager is where you will set up the categories for your questions, the Questions Manager is where you will manage submitted questions (as well as your own), the FAQ Ask Form is where your readers will ask questions (optional), and the FAQ Page is where your approved questions will be visible to your readers (complete with pagination and search functionality). We discuss each of these four sections below starting with the backend. This manual assumes that you have already successfully Installed FAQ Builder for WordPress on your own site and that you are familiar with WordPress functionality (see http://demoblog.listpipe.com if you need to learn about WordPress).

To access the backend of FAQ Builder (after you have activated it in the plugins menu), click on the ‘FAQ Builder’ tab on the lower left hand side of your WordPress admin. It should look something like this:
FAQ Builder - Acessing the Backend

Categories Manager

FAQ Builder - Categories Manager

The Categories Manager is where you want to start after you have installed FAQ Builder. To access the Categories Manager click on the ‘FAQ Builder’ tab (shown above) and then select ‘Categories’:
FAQ Builder - Managing Categories

As each question is in one and exactly one category, you nor your readers will be able to add questions untill you have set up your categories.  Managing categories is simple and should be fairly intuitive. To add a new category simply click the ‘Add New Category’, enter the desired name for the category, add a description if desired (The category name will be displayed on both the FAQ Page and the FAQ Ask Form, but the category description is simply for your own use and is not visible on the public side.), and click ‘Save’ to save the category.  To edit an existing category, simply click the ‘edit’ button for that desired category on the right hand side of the manager and then update the name or description as desired and finish by clicking the ‘Save’ button. You can also delete categories but need to be careful when doing so. When you delete a category, all questions inside of that category will also be deleted, as such when you delete a category, a confirmation message will appear and tell you how many questions are currently in that category (that will also be deleted). To delete a category simply click the ‘ delete’ button for that desired category on the right hand side of the manager and confirm that you do want to delete the category, following which the category and all questions in it will be permanently deleted (no ‘undo’ here).

Please note that when you first install FAQ Builder, a ‘General’ category will automatically be inserted. The ‘General’ category can be edited or deleted as desired.

Questions Manager

FAQ Builder - Questions Manager

The Question Manager you will set questions to be visible on the FAQ Page. Question Manager allows you to add and manage your own questions, as well as to answer and manage your readers questions (should you deside to display the FAQ Ask Form). Questions display on the public side as dictated by their status. There are four statuses:

  1. Pending: By default a question is set to the ‘Pending’ status (questions submitted by your readers are ‘Pending’). The ‘Pending’ questions appear at the top of the Question Manager and are not visible on the public side.
  2. Displayed: Questions with a ‘Displayed’ status will appear by default on the FAQ Page. Questions that have been answered that you want your readers to see should be set to the ‘Displayed’ status.
  3. Active: ‘Active’ questions are questions that will not appear by default on the FAQ Page, but are visible to your readers if they search for them. Questions that have been answered that you want your readers to have access to, but are not common enough questions to be displayed by default should be set to the ‘Active’ status.
  4. Inactive: ‘Inactive’ questions are questions that are not visible to your readers. The ‘Inactive’ questions appear at the bottom of the Question Manager.

To manage questions simply click ‘Add New Question’ at the top of the manager (to add a new question) or click the ‘edit’ button on the right hand side of the manager for the desired question (to edit an existing question) and fill out or update the desired fields. Most of the fields are self-explanatory, but here is a quick explanation of each:

  • Name: The name of the person submitting/asking the question. FAQ Builder keeps track of the question by the submitters name, so it is necessary to fill out even when you are submitting the question.
  • Email: The email where the answer will be sent to.
  • Website: The submitters website (optional).
  • State/Province: The submitters location (optional).
  • Display Personal Info Checkbox: If selected, then the submitter’s name (with a link to their site) and location will appear with the question.
  • Category: The category that the question will be tagged in.
  • Question: The question.
  • Tags: Searchable keywords for the question.
  • Answer: The answer to the question
  • Status: The display status of the question (see above for more details).
  • Send Email Checkbox: If selected then an email will be sent to the submitter (at the entered email) containing the answer to the question.

To manage questions simply click ‘Add New Question’ at the top of the manager (to add a new question) or click the ‘edit’ button on the right hand side of the manager for the desired question (to edit an existing question) and fill out or update the desired fields. Most of the fields are self-explanatory, but here is a quick explanation of each:

To manage questions simply click ‘Add New Question’ at the top of the manager (to add a new question) or click the ‘edit’ button on the right hand side of the manager for the desired question (to edit an existing question) and fill out or update the desired fields. Most of the fields are self-explanatory, but here is a quick explanation of each:

Simply fill out or update the question as desired and click ‘Answer’ at the bottom to save your changes.

Please note that currently no HTML, scripting, line breaks, backslashes, or multiple successive quotes (i.e. you cannot have more than one double quote or single quote in immediate successive order.) are permitted in any of the fields. We are considering the possibility of allowing basic HTML and line breaks in the answer field in the future.

FAQ Ask Form

FAQ Builder - Ask Form

The FAQ Ask Form is a public side form where your readers can submit their own questions. The FAQ Ask Form can be displayed using ‘shortcode’ on any page or post. To display the FAQ Ask Form on any of your page or post, simply add the following ‘shortcode’/text to your post: [faq_build_ask] (do not copy and paste this ‘shortcode’; find out why). Your FAQ Ask Form can be displayed on the same page/post as the FAQ Page.

FAQ Page

FAQ Builder - FAQ Page

The FAQ Page is a public side element where your approved questions will appear as an ‘FAQ Page’. To display the FAQ Page on any of your page or post, simply add the following ‘shortcode’/text to your post: [faq_build_page] (do not copy and paste this ‘shortcode’; find out why). The FAQ Page will automatically display the search form and will also automatically paginate if you have more than 20 questions set to the ‘Displayed’ status.

To manage questions simply click ‘Add New Question’ at the top of the manager (to add a new question) or click the ‘edit’ button on the right hand side of the manager for the desired question (to edit an existing question) and fill out or update the desired fields. Most of the fields are self-explanatory, but here is a quick explanation of each:

Post a Comment

Your email is never published nor shared. Required fields are marked *

*
*

You may use these HTML tags and attributes <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>