Configuring CjBlog badge system

From CjWiki
Jump to: navigation, search

CjBlog comes with integrated badges and points system. We already have corejoomla products integrated and the necessary plugins available for points system and badges system. Apart from corejoomla products, standard Joomla content, User, System and Kunena integrations also available in downloads section. If you would like to integrate your component with CjBlog, please see developer documentation.

Setting up Badges System

Badges system allow you to assign badges to your users for the achievements. It is similar to ranking system, however user can have any number of badges at a time unlike ranks. To assign a badge to user you need to install the corresponding rule for it. For instance we have badges plugin available for Community Answers to assign badges when a user posts N number of questions etc.

There are two variations in badges:

  1. A badge assigned to user only one time
  2. A badge assigned to user any number of times

Consider the following example:

  • Assign badge "Top Answerer" when user answers 10 questions
  • Assign badge "Top Best Answerer" when 5 of user's answers selected as best answers
  • Assign badge "Top Asker" when user asks 20 questions
  • Assign badge "Popular Writer" when one of the user article receives 10k page views

So in above example, a user can have one Top Answerer, one Top Best Answerer, one Top Asker badges assigned to his account. However he can have any number of Popular Writer badge assigned to his account because he can write any number of articles and they can reach 10k page views. In CjBlog, such badge is shown once but a number is shown to display how many times the same badge is won by the user.

So to install a badge rule file, go to Components->CjBlog->Badge Rules page. You can see a file upload box at the bottom of the page. Browse the rule file and click submit to install the rule. Once you install the plugin, you can create badges using the plugin.

There are two steps in creating the badges:

  1. Create Badge
  2. Create Badge Rule

Create Badge

A badge can be used for multiple components. For example "Top User" badge can be used to assign to top poster in Kunena as well as Community Answers. So same badge can be appeared multiple times on user account based on participation on different component functions. If you do not want to assign same badge for different component actions, you can create different badges for different components. Two step process is created to allow assigning same badge for different components.

So follow the below step to create your first badge:

  1. Go to Badges page and click New on Toolbar
  2. Enter Title which is the name of the badge
  3. Enter Alias which is going to form your badge url or leave blank to let system create it
  4. Enter description which is for your reference. This is not shown to users.
  5. Select published status
  6. Select badge style - different color is assigned based on badge style.

Create Badge Rule

The Second step is to create the badge rule so that badges are assigned responding to user achievements

  1. Go to Badge Rules page and click New
  2. You should be shown all installed badge rules. Click on the rule for which you want to add a badge
  3. Enter Title which is for your identification purpose of the badge
  4. Select the Badge you would like to assign when this rule is validated true
  5. Enter description which is unique to this rule - This description is shown to users - enter something meaningful like why this badge is assigned to user for example "Badge assigned for posting 10 questions"
  6. Select status and User access level - only users with selected access level will be assigned the badge. If you do not know what is this, leave it to public.
  7. Based on the rule you selected appropriate input boxes will be shown to take required input from you. For example, badge rule to assign badge for posting N number of questions require the number N - the number of questions. So it will show appropriate box and enter the number in it.
  8. Click Save and Close

Now your badge rule is successfully created and shown in Badge Rules page. When a user met the requirement (eg. the number you enter the previous step), he will be assigned the badge.

Enabling Required Plugins

Please note that appropriate plugins should be enabled for proper functioning. Please note that these are Joomla plugins not the Badge Rule Plugins that you installed from Badge Rules page.

From plugin manager

  1. Enable CjBlog content plugin to allow badges assigned to users for posting articles, reaching N number of page views for his article etc.
  2. Enable CjBlog Kunena plugin to support events in Kunena forum
  3. Community Answers, Community Polls have built-in integration so no need to have any plugins for them.