cbe_helpful

Table of contents

• Credits
• Prerequisites
• Features
• Download and support
• Installation and setup
• Admin side usage
• Client side usage
• Examples
• Changelog

Credits

• Walker Hamilton, for wlk_helpful on which this plugin is based
• Jukka Svahn, for rah_external_output (v1.0 minimum) on which the plugin heavily relies on
• Pat64, who took time to test, feedback, test, feedback, test ... feedback ... and so on

Prerequisites

This plugin requires

• the jQuery library
• the plugin rah_external_output v1.0 minimum

Features

• just install and activate, no need to worry about additional scripts
• automatically retrieves data from wlk_helpful if installed and active
• set time threshold between two votes having the same IP
• define your own presentation

Download and support

Download from the plugin page.

Visit the forum thread for support.

Installation and setup

rah_external_output v1.0 minimum must be installed and active otherwise cbe_helpful won't be activated and you will receive a message stating that you have to install/activate rah_external_output.

Copy/paste in the Admin > Plugins tab to install.

Setup is automatic at activation.

Admin side usage

Client side usage

The jQuery library must be loaded, anywhere in the page.

• <txp:cbe_helpful />
• <txp:cbe_helpful_label />
• <txp:cbe_helpful_score />
• <txp:cbe_helpful_yes />
• <txp:cbe_helpful_no />
• <txp:cbe_helpful_total_votes />
• <txp:cbe_helpful_list />

Vote widget: <txp:cbe_helpful />

Just put it in an individual article where you want it to appear. Can be used either as a single tag or as a pair.

Used as a single tag, outputs the minimal markup needed as an unordered list.

Used as a pair or with the form attribute, lets you customize the way it is displayed with the following tags :

<txp:cbe_helpful_label />

Displays the widget label as defined in admin side. Can also be used as a standalone tag (i.e. outside <txp:cbe_helpful>).

<txp:cbe_helpful_score />

Displays the score formatted as specified in admin side : absolute value, ratio or percentage of positive votes

Can be used as a standalone tag or enclosed in cbe_helpful or cbe_helpful_list.

<txp:cbe_helpful_yes />, <txp:cbe_helpful_no />, <txp:cbe_helpful_total_votes />

Displays number of positive [resp. negative, total] votes, for <txp:cbe_helpful_yes /> and <txp:cbe_helpful_no /> only a link to click if the vote if possible.

Must be enclosed in cbe_helpful or cbe_helpful_list.

In a list based on time (see <txp:cbe_helpful_list />), the displayed values are for the considered period only.

Tops and flops: <txp:cbe_helpful_list />

Can be used either as a single tag or as a pair.

Displays an ordered list of article titles selected and sorted as follows (default is the titles of the 5 best rated articles):

Examples

Simple widget

<txp:cbe_helpful />

More elaborate widget

<txp:cbe_helpful labeltag="h2">
  <p><txp:cbe_helpful_score /> people found this article useful. Do you ?</p>
  <p>
  <txp:cbe_helpful_yes class="green" />
  <txp:cbe_helpful_no class="red" />
  </p>
</txp:cbe_helpful>

Detailed Top 10

<txp:cbe_helpful_list label="Top 10" labeltag="h2" limit="10">
  <txp:permlink><txp:title /></txp:permlink>
  <txp:excerpt />
</txp:cbe_helpful_list>

or

<txp:cbe_helpful_list limit="10" form="topten" />

with the accurate "topten" form.

Flop5 beginning with the worst

<txp:cbe_helpful_list which="flop" order="asc" />

Display only count in article list context

In your article form:

<txp:if_article_list>
  <txp:cbe_helpful showonly="1">
    <txp:cbe_helpful_yes labelshowonly="people find this useful" />
    <txp:cbe_helpful_no labelshowonly="people find this useless" />
  </txp:cbe_helpful>
<txp:else />
  <txp:cbe_helpful>
    <txp:cbe_helpful_yes />
    <txp:cbe_helpful_no />
  </txp:cbe_helpful>
</txp:if_article_list>

Changelog

• 30 Apr 13 - v0.6
  • display only (not clickable) the separate yes and no numbers in an article-list context - thx douglgm. Added attributes:
    showonly (cbe_helpful, cbe_helpful_yes, cbe_helpful_no)
    labelshowonly (cbe_helpful_yes, cbe_helpful_no, cbe_helpful_score, cbe_helpful_total_votes)
  • Added too: labelclass (cbe_helpful, cbe_helpful_list)
  • Fix attempt: markup as spotted here - thx Susanne
• 18 Jul 12 -v0.5.1- Fixed: path for /?rah_external_output=cbe_helpful_{js|ajax} - thx douglgm
• 16 Jul 12 - v0.5 - Now supports rah_external_output v1.0 new db structure. Previous structure is no longer supported. Plugin not activated if an error occurs on rah_external_output controls. Checks if all tables are present and restore them if not.
• 30 May 12 - v0.4 - Total votes - thx milosevic, list based on time - thx tye, fixed: miscalculation in cbe_helpful_list when sorting on score
• 04 Jan 12 - v0.3 - fixed: unwanted markup if just displaying score, thx milosevic; fixed: cbe_helpful_label not working if standalone; fixed: avoid multiple calls to _cbe_helpful_foot when displaying a list; JS code slightly revisited
• 19 Jul 11 -v0.2.1- fixed: non-valid html output for article id and unit - thx Pat64
• 13 Jul 11 - v0.2 - cbe_helpful_list can now display cbe_helpful_score, cbe_helpful_yes, cbe_helpful_no; fixed: bug in list sorting when using ratio or percent display; repopulate table prefs with defaults if damaged or destroyed
• 12 Jul 11 -v0.1.1- Added control on value returned by getRows (cbe_helpful_list)
• 08 Jul 11 - v0.1 - Initial release