Everywhere Add-on Manual

Last update: January 9th, 2014

Copyright © 2010-2014 ClickFWD LLC

Chapter 1 Everywhere Add-on Overview & Installation

1.1 Overview

The Everywhere add-on for JReviews extends the user review system functionality of JReviews to other Joomla components such as: business directories, galleries, e-commerce stores, file repositories, social networking and more.

Integration is convenient and incredibly powerful!

Manage all of your site's reviews and ratings with one system and a uniform, themeable look. You don't lose flexibility because the configuration for each component can be different:

Multiple sets of rating criteria: each category in your component can have a different rating criteria set. For example, in a business directory, suppliers of services could have different rating criteria than suppliers of goods.

Custom fields in reviews: you can use JReviews’ custom fields system for reviews to expand the review form by asking additional questions such as: date of purchase, pros/cons, experience with product, would you recommend?, etc. All the custom field types used for jReviews can also be used for jReviewsEverywhere in reviews.

Comprehensive MyReviews page: Reviews submitted in all components are shown together in a user's MyReviews page and they link back to the appropriate component detail page.

Moderate reviews in one place: All component reviews are moderated in the JReviews administration.

Important: The Everywhere add-on does not integrate with 3rd party component rating systems, it remains a separate rating system. For example, a top rated list for your 3rd party component will not use user ratings from Everywhere add-on. Also, the Everywhere add-on doesn't enable searching for user reviews in 3rd party components.

1.2 List of components currently integrated with the Everywhere Add-on

JomSocial for profile reviews

EasySocial for profile reviews

Community Builder for profile reviews

Eventlist for event and venue reviews

EZ Realty for agent and property reviews

Jomres for property reviews

JoomlaLMS

Sobi2

K2

Virtuemart 1.x

1.3 Examples of Everywhere Add-on usage

Using the Everywhere Add-on for EasySocial profile reviews:

1.4 Installation

The Everywhere Add-on doesn't require installation. For convenience it is integrated into JReviews and unlocked only if the addon is purchased for the JReviews license. If active, you'll find the link for the addon in the JReviews administration:

If you first purchased JReviews and later ordered the add-on, go to the JReviews admin license screen, clear the local key text area and re-submit the license number. This will fetch a new local key that includes the addon information.

Chapter 2 Integrating with EasySocial profile system

When you integrate JReviews Everywhere add-on with EasySocial profile system, members of your site will be able to rate and review each other.

2.1 Creating a JReviews listing type for EasySocial profiles

The first step is to create a listing type for members in JReviews Listing Types Manager:

Click the New button in top right corner to create a new listing type:

Title - enter the listing type title.

Comments & Ratings - 3 options are available:

Allow comments and ratings - users will be able to rate and review each other.

Allow comments without ratings - users will be able to review each other without ratings.

Disable comments and ratings - reviews and ratings disabled - don't choose this.

Select all the field groups you want to associate to this listing type - here you can select review field groups in case you want to include extra review fields besides the standard "Comments" text area.

Display in Advanced Search Page - choose No, this is only for JReviews listings.

Rating Criteria - create rating criteria based on which users will review each other:

Rating Criterion - enter the title of the rating criterion.

Required - uncheck if you want the criterion to be optional.

Weight - criteria weights for weighted average rating calculation. The total must add to 100, do not enter the % character. If left blank a simple average will be calculated.

Tooltip - hints for users on how to rate in the review form.

Under Advanced Setup you will find many settings. Since this listing type will be used with EasySocial profiles, only the review related settings will be used:

It is recommended to set Stop users from reviewing their own listings to Yes so that users won't be able to review themselves.

The integration includes only user reviews functionality, editor reviews are not available, so none of the editor related settings will be used.

2.2 Assigning the JReviews listing type to EasySocial categories (profile types)

Next step is to go to the Everywhere add-on:

Click the Select Extension dropdown, choose EasySocial - Profiles and click the Setup New button:

In the popup form select the listing type that you created and choose EasuSocial profile type(s) for which you want to enable reviews:

By default, EasySocial has only one profile type called "Registered Users". If you want, you can create multiple profile types in EasySocial administration, Profiles page:

2.3 Displaying the review form and reviews in EasySocial profiles

To display the review form in EasySocial profiles, it is necessary to install the Review Me app for EasySocial which can be found in the JReviews package that you downloaded from the Client Area. The file that you need to install is this:

/package_jreviews_2.4.x_unzip_first/plugins_everywhere_addon/easysocial/reviewme.zip

To install it, go to the EasySocial Application Installer:

After you install the app, publish it and make it a default application, the Review Me app will show up in all profiles for which you enabled the integration:

Chapter 3 Integrating with JomSocial profile system

When you integrate JReviews Everywhere add-on with JomSocial profile system, members of your site will be able to rate and review each other.

3.1 Creating a JReviews listing type for JomSocial profiles

The first step is to create a listing type for members in JReviews Listing Types Manager:

Click the New button in top right corner to create a new listing type:

Title - enter the listing type title.

Comments & Ratings - 3 options are available:

Allow comments and ratings - users will be able to rate and review each other.

Allow comments without ratings - users will be able to review each other without ratings.

Disable comments and ratings - reviews and ratings disabled - don't choose this.

Select all the field groups you want to associate to this listing type - here you can select review field groups in case you want to include extra review fields besides the standard "Comments" text area.

Display in Advanced Search Page - choose No, this is only for JReviews listings.

Rating Criteria - create rating criteria based on which users will review each other:

Rating Criterion - enter the title of the rating criterion.

Required - uncheck if you want the criterion to be optional.

Weight - criteria weights for weighted average rating calculation. The total must add to 100, do not enter the % character. If left blank a simple average will be calculated.

Tooltip - hints for users on how to rate in the review form.

Under Advanced Setup you will find many settings. Since this listing type will be used with EasySocial profiles, only the review related settings will be used:

It is recommended to set Stop users from reviewing their own listings to Yes so that users won't be able to review themselves.

The integration includes only user reviews functionality, editor reviews are not available, so none of the editor related settings will be used.

3.2 Assigning the JReviews listing type to JomSocial categories (user groups)

Next step is to go to the Everywhere add-on:

Click the Select Extension dropdown, choose JomSocial - Access Groups and click the Setup New button:

In the popup form select the listing type that you created and choose user groups for which you want to enable reviews:

3.3 Displaying the review form and reviews in JomSocial profiles

To display the review form in JomSocial profiles, it is necessary to install the Reviews of Me plugin for JomSocial which can be found in the JReviews package that you downloaded from the Client Area. The file that you need to install is this:

/package_jreviews_2.4.x_unzip_first/plugins_everywhere_addon/jomsocial/jreviews_reviewme.zip

To install it, go to the Joomla Extension Manager:

After you install the plugin, go to the Joomla Plugin Manager and publish the Reviews of Me plugin. Then the plugin will show up in all profiles for which you enabled the integration:

Chapter 4 Integrating with Community Builder profile system

When you integrate JReviews Everywhere add-on with Community Builder profile system, members of your site will be able to rate and review each other.

4.1 Creating a JReviews listing type for Community Builder profiles

The first step is to create a listing type for members in JReviews Listing Types Manager:

Click the New button in top right corner to create a new listing type:

Title - enter the listing type title.

Comments & Ratings - 3 options are available:

Allow comments and ratings - users will be able to rate and review each other.

Allow comments without ratings - users will be able to review each other without ratings.

Disable comments and ratings - reviews and ratings disabled - don't choose this.

Select all the field groups you want to associate to this listing type - here you can select review field groups in case you want to include extra review fields besides the standard "Comments" text area.

Display in Advanced Search Page - choose No, this is only for JReviews listings.

Rating Criteria - create rating criteria based on which users will review each other:

Rating Criterion - enter the title of the rating criterion.

Required - uncheck if you want the criterion to be optional.

Weight - criteria weights for weighted average rating calculation. The total must add to 100, do not enter the % character. If left blank a simple average will be calculated.

Tooltip - hints for users on how to rate in the review form.

Under Advanced Setup you will find many settings. Since this listing type will be used with EasySocial profiles, only the review related settings will be used:

It is recommended to set Stop users from reviewing their own listings to Yes so that users won't be able to review themselves.

The integration includes only user reviews functionality, editor reviews are not available, so none of the editor related settings will be used.

4.2 Assigning the JReviews listing type to Community Builder categories

Next step is to go to the Everywhere add-on:

Click the Select Extension dropdown, choose Community Builder and click the Setup New button:

There are two different ways to setup the Everywhere integration with Community Builder:

4.2.1 Using access groups as categories

This approach would allow you to assign a listing type to specific user groups. If you want to enable reviews for registered users, but not for other types of user, this is the best approach.

After you click the Setup New button, in the popup form select the listing type that you created and choose user groups for which you want to enable reviews:

4.2.2 Using CB custom field options as categories

If you need to differentiate users of a specific user group and enable reviews only for specific users based on their field values, it is possible to use CB field options as categories. You would even be able to assign different listing type with different rating criteria and fields to different users. This would be useful for example in:

Student/Teacher site

Freelancer site: professionals/employers

Community site where businesses sign up to the site to offer their services. Businesses in different industries can have different rating criteria

The first step for this approach is to create a new CB field. Go to the Community Builder component and click the Field Managemet. Click the New Field button, enter the values and click the Save button:

Next, you will need to edit this file:

/components/com_jreviews/jreviews/models/everywhere/everywhere_com_comprofiler.php

Near the top you will find two configuration variables:

var $integrationMode = 'fields'; // groups | fields

var $cbCustomField = 'cb_membertype';

You will need to change the $integrationMode to "fields" and $cbCustomField to reflect the name of the CB field that you created.

Now when you go to the Everywhere Add-on, select Community Builder and click the Setup New button, you will see those field values as categories:

You can assign the listing type to the specific field options or assign different listing type to each field option (member type).

4.3 Displaying the review form and reviews in Community Builder profiles

To display the review form in Community Builder profiles, it is necessary to install the CB JReviews Everywhere plugin for Community Builder which can be found in the JReviews package that you downloaded from the Client Area. The file that you need to install is this:

/package_jreviews_2.4.x_unzip_first/plugins_everywhere_addon/community_builder/plug_cbjreviews_everywhere.zip

To install it, go to the Community Builder component, click the Plugin Management and at the bottom of the page you will find the plugin installer:

Publish the CB JReviews Everywhere plugin on the Plugin Management page and then go to the Tab Management page and make sure that the Profile Reviews tab is published as well. Then the Profile Reviews will show up in all profiles for which you enabled the integration:

Chapter 5 Theme Customizations

The Everywhere add-on uses this theme file:

/components/com_jreviews/jreviews/views/themes/default/everywhere/reviews.thtml

If you want to customize it, first copy it to your custom theme in jreviews_overrides as shown in JReviews Code Overrides:

/templates/jreviews_overrides/views/themes/{your_theme}/everywhere/reviews.thtml

Individual reviews in Everywhere add-on use the same theme file as reviews of JReviews listings:

/components/com_jreviews/jreviews/views/themes/default/reviews/review_layout.thtml

Copy it to the custom theme before customizing:

/templates/jreviews_overrides/views/themes/{your_theme}/reviews/review_layout.thtml

Remember to clear the File Registry in JReviews administration every time you add a new theme file to your custom theme.