Updated: February 1st, 2014
By: onokazu
Website: http://sabaidiscuss.com/
Thank you for purchasing my plugin. If you have any questions that are beyond the scope of this help file, please feel free to post questions on the comments page at codecanyon. Thanks so much!
SabaiDiscuss is a premium questions and answers plugin for WordPress. The plugin features the ability for users to ask and answer questions similar to Stack Overflow or Yahoo Answers.
SabaiDiscuss is an ideal tool not only for building a community driven question-and-answer website but also for building a discussion forum, a knowledge base, or even a helpdesk portal for WordPress.
ResourcesBefore installing the plugin, please check that the following conditions are met on your server.
The SabaiDiscuss plugin runs on top of an application framework called Sabai. Because of that, you must first install and activate the Sabai plugin.
If you already have the Sabai plugin installed and activated, please skip the Install Sabai part and go straight to the Install SabaiDiscuss section.
Now that the Sabai plugin is installed and active, you can install the SabaiDiscuss plugin.
You do not need to activate the plugin. Instead, the Questions add-on needs to be installed from the Sabai add-ons list page.
SabaiDiscuss requires the WordPress permalink setting to be set other than the default. Go to Settings -> Permalinks and under the Common Settings section, select any other option but the Default option.
That's it! You have now successcully installed SabaiDiscuss on WordPress.
Here we learn briefly about the content that SabaiDiscuss adds to your WordPress installation.
SabaiDiscuss creates a single new WordPress page:
Questions (path: /questions) - displays the main index page of SabaiDiscuss. The title and path may be different from that you actually have on your site depending on what you specified during installation.
Note that this page is only used as the placeholder for content generated by SabaiDiscuss. Modifying the title or slug of the page will have no effect. If you need to change the display title or slug of the page, go to Questions -> Settings.
Other than the ordinary WordPress pages above, here are some of the pages that SabaiDiscuss generates internally and display them on the frontend. Note that the path of these pages on your site may be different from shown here depending on what you specified during installation.
Single Question Page (path: /questions/question/[question_slug]) - displays a single question with answers posted to the question.
Ask Question Page (path: /questions/ask) - displays a form for submitting questions.
Tag Listing Page (path: /questions/tags) - displays a sortable list of question tags used on site as tag cloud.
Category Listing Page (path: /questions/categories) - displays a list of all question categories .
Single Tag Page (path: /questions/tags/[tag_slug]) - displays the detailed description of a tag with list of questions related to that tag.
Single Category Page (path: /questions/categories/[category_slug]) - displays the detailed description of a category with list of questions posted in that category and its sub categories.
User Profile Page (path: /questions/users/[user_name]) - shows questions and answers posted and favorited by a particular user.
Search Form (path: /questions/search) - shows a form for searching questions and answers with some basic options.
This is where you will create and manage questions and answers, adjust your settings.
Let’s take a brief look at the menu items:
SabaiDiscuss adds a new group of menu items to the WordPress Toolbar for easier access to the frontend.
Questions - links to the top page of SabaiDiscuss frontend.
All Questions - same as the "Questions" menu explained above.
Categories - links to the category listing page of SabaiDiscuss frontend.
Tags - links to the tag listing page of SabaiDiscuss frontend.
Flags - links to a page where all the flagged questions and answers are listed. This menu item is only visible to users with the "Manage Flagged Questions" or "Manage Flagged Answers" permission.
You should be able to run SabaiDiscuss without any problem with the default settings already configured out of the box. However, if you want customization, SabaiDiscuss settings can be found under the Settings page in the Questions menu.
- Display Settings -
This section allows you to configure how questions are displayed on various pages of the plugin.
- Reputation Settings -
Reputation is a rough measurement of how much the community trusts users. Here you can configure reputation points users gain or lose on certain events or actions.
- Search Settings -
Allows you to configure the search form settings.
- Spam Settings -
Allows you to configure how SabaiDiscuss handles undesirable questions and answers.
- Page Title Settings -
Allows you to define custom page title for SabaiDiscuss frontend and administration index pages.
- Label Settings -
Allows you to define custom labels for common words used in the plugin.
- Slug Settings -
Allows you to define custom slugs for various SabaiDiscuss pages.
- Restrict Access -
Allows you to restrict access to SabaiDiscuss pages by user roles. It is also possible to completely disable frontend access by any user.
- Permissions -
Configure permissions by user roles, including guest users. If Permissions granted based on reputation points is checked, then you can define how many reputation points are required for each permission to be granted to users in each role.
- Question Answered Notification Email -
Set up the template used for notification e-mail sent to the question author when his/her question is answered by another user.
- Answer Accepted Notification Email -
Set up the template used for notification e-mail sent to the answer author when his/her answer is marked as accepted.
- Comment Posted Notification Email -
Set up the template used for notification e-mail sent to the question/answer author when his/her post has received a comment by another user.
- Published Post Notification Email -
Set up the template used for notification e-mail sent to the question/answer author when his/her post has been approved and published by an administrator.
- Question Posted Notification Email -
Set up the template used for notification e-mail sent to the members of selected user roles whenever a new question is posted.
- Answer Posted Notification Email -
Set up the template used for notification e-mail sent to the members of selected user roles whenever a new answer is posted.
- Question Posted Admin Notification Email -
Set up the template used for notification e-mail sent to the administrators whenever a new question that requires approval is posted.
- Answer Posted Admin Notification Email -
Set up the template used for notification e-mail sent to the administrators whenever a new answer that requires approval is posted.
- Question Flagged Admin Notification Email -
Set up the template used for notification e-mail sent to the members of selected user roles whenever a question is flagged.
- Answer Flagged Admin Notification Email -
Set up the template used for notification e-mail sent to the members of selected user roles whenever an answer is flagged.
SabaiDiscuss is fully internationalized so that it can be translated into many languages.
Translatable files are in the Gettext format, which is the standard format used in WordPress. There are 2 Gettext POT (.pot) files:
Translate these files using a software like POEdit (recommended) and save the generated MO (.mo) files under wp-content/langauges (or under WP_LANG_DIR if this is defined in your wp-config.php). Make sure that you append the lang code of your language to the file names. For example, if you are translating sabai.pot into French, save the generated MO file as sabai-fr_FR.mo.
Limitations
Currently, the MO files must be present prior to installation for SabaiDiscuss to be fully localized. This is because some phrases are stored in database during installation and thus are not translatable at runtime. However, those are very few and you should be able to modify them through the user interface.
To update SabaiDiscuss to the latest version, what you need to do first is to backup all your SabaiDiscuss files and data. You can do so by backing up sabai and sabai-discuss plugin folders and all your mysql data. After doing so, overwrite the old plugin files with the new ones included in the latest package.
As of version 1.1.4, there is no need to manually upload files to your server. Both the sabai and sabai-discuss plugins can be updated from the Plugins page of WordPress dashboard just like other plugins distributed from wordpress.org. Make sure that you have a valid license code configured for the CodeCanyon.net Purchase Code Settings section on the Setings -> Sabai page. Also when updating, you must always update both sabai and sabai-discuss plugins to the same version. The best way to ensure that is to use the bulk update feature of WordPress.
Next, go to Sabai -> Settings from the Wordpress administration dashboard and under the Sabai Add-ons list section, upgrade all add-ons that are highlighted and have the Upgrade button displayed. Press the Upgrade button for each of these add-ons and follow the instructions displayed on the pop-up window. As of version 1.1.0, you can also do a bulk upgrade by checking the checkboxes on the left and pressing the Upgrade Checked button. Note that some add-ons may not be upgraded until certain add-ons have been upgraded first. Make sure to upgrade all add-ons until all add-ons are de-highlited.
Also, depending on the upgrade package, there may be some add-ons that are newly available for installation. These add-ons will be listed on the Installable Add-ons table below the installed add-ons table so you can click the Install button for each of them to make them active.
That's it, you should have now successfully updaded SabaiDiscuss to the latest version.
Please visit our online FAQ