“Sabai Discuss” Documentation by “SabaiApps” v1.3.0

---

“Sabai Discuss”

---

Table of Contents

1. Overview
2. Plugin Requirements
3. Installation
4. Quick Tour
5. Configuring Sabai Discuss
6. Localization
7. Update Sabai Discuss
8. FAQ

---

A) Overview - top

Sabai Discuss 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.

Sabai Discuss 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.

Resources

• Sabai Discuss demo site
• Sabai Discuss project page at CodeCanyon

---

B) Plugin Requirements - top

Before installing the plugin, please check that the following conditions are met on your server.

• PHP 5.2 or greater (with mbstring and curl extensions, and at least 128M memory_limit)
• MySQL 5.0.3 or greater
• WordPress 3.4 or greater
• WordPress permalink URL structure must be something other than Default

---

C) Installation - top

The 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 Step 1: Install Sabai and go straight to Step 2: Install Sabai Discuss.

Step 1: Install Sabai

1. Login to your website if not yet logged in and go to the WordPress administration dashboard.
2. Select Plugins -> Add New from the side menu.
3. Click the Upload link.
4. Upload the sabai.zip file included in the downloaded package.
5. Click the Activate Plugin link.

Step 2: Install Sabai Discusss

Now that the Sabai plugin is installed and active, you can install the Sabai Discuss plugin.

1. Login to your website if not yet logged in and go to the WordPress administration dashboard.
2. Select Plugins -> Add New from the side menu.
3. Click the Upload link.
4. Upload the sabai-discuss.zip file included in the downloaded package.
5. Click the Activate Plugin link.

Step 3: Permalink Setting

Our plugins require the WordPress permalink setting to be set to other than the default. In order to do so, 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 Sabai Discuss on WordPress.

---

D) Quick Tour - top

Here we learn briefly about the content that Sabai Discuss adds to your WordPress installation.

Pages

Sabai Discuss creates a single new WordPress page:

• Questions (slug: questions) - displays the main index page of the plugin. The title and path may be different from that you actually have on your site depending on what you specified during installation.

Other than the ordinary WordPress pages above, here are some of the pages that the plugin generates internally and display them on the frontend.

• Single Question Page (slug: questions/question/[question_slug]) - displays a single question with answers posted to the question.
• Ask Question Page (slug: questions/ask) - displays a form for submitting questions.
• Tag Listing Page (slug: questions/tags) - displays a sortable list of question tags used on site as tag cloud.
• Category Listing Page (slug: questions/categories) - displays a list of all question categories.
• Single Tag Page (slug: questions/tags/[tag_slug]) - displays the detailed description of a tag with list of questions related to that tag.
• Single Category Page (slug: questions/categories/[category_slug]) - displays the detailed description of a category with list of questions posted in that category and its sub categories.
• User Page (slug: questions/users/[user_name]) - shows questions and answers posted and favorited by a particular user.
• Flag Listing Page (slug: questions/flags) - displays a list of all question and answers that have been flagged.

Administration Pages

This is where you will create and manage listings, and adjust your settings. Let’s take a brief look at the menu items under the Questions section:

• Questions - manage questions and question fields.
• Add Question - direct link to add a new question.
• Answers - manage answers and answer fields.
• Categories - manage categories and category fields.
• Tags - manage and add question tags.
• Settings - all the settings you need to manage the Sabai Discuss plugin.

---

E) Configuring Sabai Discuss - top

You should be able to run Sabai Discuss without any problem with the default settings already configured out of the box. However, if you want customization, Sabai Discuss settings can be found under the Settings page in the Questions menu.

General Settings (under the "General" tab)

- 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 Sabai Discuss handles undesirable questions and answers.

- Page Title Settings -
Allows you to define custom page title for Sabai Discuss frontend and administration index pages.

- Label Settings -
Allows you to define custom labels for common words used in the plugin.

- Page Title Settings -
Allows you to define custom page titles for various Sabai Discuss pages.

Search Settings (under "Search" tab)

• Keyword Search Settings - Configure how search keywords are handled.
• Category Search Settings - Disable/enable category search.
• Search Filter Settings - Configure how the search filter form is displayed.

Access Control Settings (under the "Access Control" tab)

- Restrict Access -
Allows you to restrict access to Sabai Discuss 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.

Email Templates Setings (under the "Emails" tab)

- 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.

---

F) Localization - top

Sabai Discuss 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:

• wp-content/plugins/sabai/languages/sabai.pot
• wp-content/plugins/sabai-discuss/languages/sabai-discuss.pot

Translate these files using a software like POEdit (recommended) and save the generated MO (.mo) files under wp-content/langauges/plugins (or under WP_LANG_DIR/plugins if WP_LANG_DIR 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.

Resources

• POEdit
• Plural Forms

---

G) Update Sabai Discuss - top

Step 1: Update Files

All of our 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 (and possibly other sabai-xxx plugins if you have them installed as well) to the same version. The best way to ensure that is to use the bulk update feature of WordPress.

IMPORTANT! Updating from 1.2 to 1.3 - Unfortunately updating from version 1.2 to 1.3 is not possible using the online update. You must manually delete the sabai and sabai-discuss folders from the wp-content/plugins directory using an FTP software. Also if you have been using cloned add-ons, make sure to delete all files under wp-content/sabai/System/clones. Then, upload the new plugin folders (sabai and sabai-discuss folders) to wp-content/plugins. You should NOT deactivate nor delete any sabai plugins from the Plugins page of WordPress dashboard. After uploading the folders, go to the Plugins page of WordPress dashboard. You may or may not see an error message saying that certain add-ons are not installed or a white screen. However, do not worry and reload the page a few number of times until the page displays correctly, and then activate the Sabai Discuss plugin.

Step 2: Update Data

Next, go to Sabai -> Settings from the Wordpress administration dashboard and under the Sabai Add-ons 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. 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-highlighted.

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 list of installed add-ons so you can click the Install button for each of them to make them active.

Step 3: Clear Cache

The last step is very simple. Go to Settings -> Sabai from the Wordpress administration dashboard and under the System Settings section, click the button labelled Clear Cache. If the cache is successfully cleared, you should see a green check button displayed next to the button that you just clicked.

That's it, you should have now successfully updated Sabai Discuss to the latest version.

---

H) FAQ - top

Please visit our online FAQ

---

Go To Table of Contents

---