Embed Size (px)
Citation preview
Rating with Rich Snippet
Prestashop Module
User Guide
eGrove Systems Corporation
Phone: 603 791 4890 | Website: www.egrovesys.com | Email: [email protected]
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
Table of Contents
DESCRIPTION .................................................................................................................................................. 3
FEATURES ........................................................................................................................................................ 3
REQUIREMENTS .............................................................................................................................................. 5
COMPATIBILITY .............................................................................................................................................. 5
PACKAGE CONTENT ....................................................................................................................................... 5
INSTALLATION & CONFIGURATIONS ......................................................................................................... 5
INSTALLATION................................................................................................................................................ 5FACEBOOK APP ID AND SECRET KEY CREATION...............................................................................................6MODULE SETTINGS......................................................................................................................................... 6
General Settings..................................................................................................................................................6Attribute Settings.................................................................................................................................................8Attribute Language..............................................................................................................................................9Review Management..........................................................................................................................................9Product Attribute...............................................................................................................................................10Rich Snippet Settings.........................................................................................................................................11
USAGE ............................................................................................................................................................ 12
SUPPORT ........................................................................................................................................................ 13
2
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
Description
Product Rating with Rich Snippet module for Prestashop facilitates merchants to generate Rich
snippets for user given rating and reviews in their website and include them in Search Engines to give
convenient summary information about Product information in Search Engines with dynamic content on
user ratings and reviews.
This module integrates with the PrestaShop eCommerce Software and enables buyers or
registered users or any visitors of the websites to give ratings and reviews to the products for different
criteria defined by the store administrator.
Administrator or merchants can manage the reviews submitted by users and can configure
whether admin approval required or not to publish user reviews. The ratings given by users can be
viewed in all pages of the products listing pages and also can be displayed in any third party modules
product display section by placing widget code in that particular module’s script.
The administrator can also able to configure rating unit scale texts as they desire like, Marvelous
for 5 stars, Excellent for 4 star etc., instead of default text. It can be configured for each product specific
text also. Admin can approve the ratings and reviews given by user either individual review and approval
process or as a bulk select and approve. In Product Detailed view page, the ratings can be viewed with
more detailed statistics as like the Amazon Rating System i.e. rating count for each star scale unit along
the overall average rating score.
The module also supports multiple language for rating texts, product attribute. In addition to
these features, the buyers can also post their reviews to their Facebook wallboard along the product
image and URL of the product with their review comment. The visitors can also able to give feedback on
the reviews they read using the thumbs up or thumbs down style interface through AJAX.
Features
Registered users, Visitors and buyers who bought the product and can post rating & reviews for
the products as per administrator settings
Improve your product lisitng, user comments listing, product information etc., in Search Engines
through Rich Snippet support
Best Rating Rich Snippet support
3
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
Aggregate Rating Rich Snippet support
User Comments Rich Snippet support
Product Information Rich Snippet support
Visitors can give feedback on reviews they read through thumbs up/ thumbs down
Graphical Star rating display for ratings
Customizable star colors among available star colors
Customized text for rating scale units as like Amazon rating system
Customizable product rating criteria for different product - so flexible rating/ review facility
based on products.
Customized thumbs up / thumbs down images setting and upload your own images
Can enable verified buyer display features to give visitors a trust on verified ratings for products
Customized verifier image upload facility
Facebook Social integration facility through Facebook Post of Product Review along product
image, product URL and user comment to buyer’s Facebook account
Display of Aggregate Rating of products in various listing pages, excluding third-party modules
product display.
Can display Aggregate Rating of products in third-party modules product display with minor
code update in those modules.
Aggregate Rating display in Product Listing pages
Aggregate Rating display in Category Listing pages
Aggregate Rating display in Product Search listing pages
Aggregate Rating display in Offer listing pages
Aggregate Rating display in New Products listing pages
Aggregate Rating display in Products by Manufacturer listing
Aggregate Rating display in Best selling products section
More detailed statistics graph display of ratings received as like Amazon rating
Supports individual rating count for each scale unit
User reviews listing in review tab of product page
User rating and posted date in reviews tab of product page
4
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
Administrator configuration for auto-publish reviews in website or admin intervention required
for approval
Administrator control to allow user reviews publish or not
Administrator control for Facebook post allowed or not
Administrator control for User Thumbs up feature required or not
Administrator defined custom text for each scale unit configuration
Administrator feature for bulk selection and approval of user reviews
Administrator feature for editing user review contents
Widget code facility to display rating in third-party modules product display sections
Multiple language support
Requirements
The Prestashop eCommerce Version 1.4.0 and above is required for this module to work.
Facebook Application account (Application ID and Secret Key) if Facebook Post is required.
The application can be created at http://developers.facebook.com/ (Check below steps for
creating Facebook application id)
Compatibility
The module is compatible with Prestashop eCommerce Version 1.4.0 and above
Package Content
The ZIP file contains a folder content named, ‘egrratingrichsnippet’ which has the module
source code as installable package and
A Readme or Guide document
Installation & Configurations
Installation The module is compatible with the general Prestashop module installation mechanism.
You can install the module through Module install feature in Administrator end
5
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
After login to the website, go to Admin -> Modules -> Add a module from my computer
Then upload `Module file` from your computer (the zip archive of egrratingrichsnippet.zip) and
Click `Upload this module`
Then search for `egrratingrichsnippet` under `Front Office Features` category in the module
listing page and install `Product Rating with Rich Snippet`.
Alternatively you can install the module manually by following steps,
Unzip the downloaded module archive file.
Copy the folder "egrratingrichsnippet" from the path "YOUR_PrestaShop_ROOT/MODULE" and
paste to the related path in your PrestaShop folder.
Go to Admin section, select the module under 'Front Office Features' and install 'Product Rating
with Rich Snippet' (egrratingrichsnippet).
Facebook App ID and Secret Key Creation Login to your Facebook account
Go to https://developers.facebook.com/apps
Click on + Create New App
Enter your APP Display Name, App Name Space and click on continue.
Enter the security word and click on continue.
Enter your website details and save changes.
On the top you can find your APP ID and APP Secret for your website.
You can use this APP ID and App Secret for Facebook connect
Module Settings
General SettingsIn Back-office, tab general settings of the module offers following configurations:
Admin Approval - if it is 'Yes', then review will be published after admin approval in 'Review
Management tab'. If it is set 'No', review will be published instantly.
Who can review - if it is 'Buyer', only buyer can leave review to a product, if it is 'Registered
User', only buyer or registered user can leave review to a product, if it is set as 'Anyone' then
any site visitor can leave reviews to product.
6
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
Email Notification Settings - if it is set to 'On', then product link will be sent to buyer to leave
review automatically. Set 'Off' to turn off this feature.
Facebook Approval - if it is set to 'Yes', then product link will be posted on customer Facebook
wall. Set 'No' to turn off this feature.
Facebook App Id – Your Facebook application Id – for help read requirements section
Facebook Secret key - Your Facebook application secret key – for help read requirements
section above
Thumbs Approval - if it is set to 'Yes', then thumbs up/down or like or dislike feature will be
available in the product review section, so visitors can able to like or dislike the review posted.
Set 'No' to turn off this feature.
Thumb Images – We are providing four different set of thumbs images, you can select any one
of them otherwise admin can upload their own thumbs images set. Preview images displayed.
Verifier Images - We are providing three different verifier images, you can select any one of
them otherwise admin can upload their own verifier image. Preview image displayed.
Star Color - We are providing seven different set of star images, you can select any one of them
otherwise admin can upload their own star images set. Preview images displayed.
Display on Product Listing - if it is set to 'Yes', then rating will be displayed on product list pages.
Set 'No' to turn off this feature.
Rating Widget – This is a unique feature, we cannot display ratings on product based modules,
in such cases you can place one line of code in your module template file. You can view sample
preview in configure settings.
For example, in the module, homefeatured, browse through the module folder,
"YOUR_PrestaShop_ROOT/MODULE/homefeatured, select and open the file, homefeatured.tpl
and paste the below code within the foreach block of the product display [you may require
some knowledge in PHP scripting for this]
Script:
<script type="text/javascript">
eGroveRating.show('{$modules_dir}',{$product.id_product});
</script>
7
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
Figure 1 - General Settings
Attribute SettingsIn Back-office, tab Attribute Settings of the module offers attribute based ratings to
products as like in Amazon. Unlimited attributes can be added and options provided to modify
& delete attributes.
8
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
Figure 2 - Attribute Settings
Attribute LanguageIn Back-office, tab Attribute Language of the module offers to specify attribute values
and star rating value for each star with multilingual options.
Figure 3 - Attribute Language Settings
Review ManagementIn Back-office, tab Review Management of the module provides options to
Single or bulk reviews approval
Single or bulk reviews delete
Ajax based inline edit review.
9
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
Figure 4 - Sample Rating Display in front end
Product AttributeIn Back-office, tab Product Attribute of the module offers to specify attributes to
selected products.
Figure 5 - Product Attribute Settings
10
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
Rich Snippet SettingsRich Snippets give users convenient summary information about their product
information in Search Engines for Rich Snippet tags and dynamic review information in search
results. The module currently supports data about product reviews and people who gave
reviews. When searching for a product or service, users can easily see reviews and ratings in
search engines through the Rich Snippet tags included in the website through this module. The
merchants can preview their product ratings and reviews displayed in search engines through
Google’s Test environment for Rich Snippet.
In Back-office, tab Rich Snippet settings of the module offers the below parameters:
Rich Snippet - if it is set 'Yes', then review rich snippet Meta-tags will be rendered in product
details page. Set 'No' to turn off this feature.
Best Rating - if it is set 'Yes', then best rating rich snippet Meta-tags will be rendered in product
details page. Set 'No' to turn off this feature.
Aggregate Rating - if it is set 'Yes', then aggregate rating rich snippet Meta-tags will be rendered
in product details page. Set 'No' to turn off this feature.
User Comments - if it is set 'Yes', then user reviews rich snippet Meta-tags will be rendered in
product details page. Set 'No' to turn off this feature.
Product Information - if it is set 'Yes', then product information snippet Meta-tags will be
rendered in product details page. Set 'No' to turn off this feature.
You can preview of your product search results new rendering in the
http://www.google.com/webmasters/tools/richsnippets
The product URL should have at least one review to see the preview otherwise no Google rich
snippet Meta-tags will be rendered.
The below is the example of how the product Rich Snippet information being rendered
in search results:
11
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
Figure 6 - Rich Snippet information for a product review - Sample
Usage
We have done our best to have this module as functional and as stable as possible. This module
has been delivered as Commercial Open-source. You are granted for a license of using this module in a
single domain/ website. You are not allowed to install and use it on more than one website and you
12
Prestashop Module for 'Product Rating with Rich Snippets' - User Guide
need to purchase additional license to install on additional websites. You can modify the source code to
adapt it to your exact need. You are not allowed to redistribute it, resell and share the module / source
code or part of the module / source code in whatever way of redistribution to others.
Support
If you have any queries on module functionality or having any issues, please drop in an email
with your website details to [email protected]
We provide module functionality issues support excluding styling or CSS fixing support.
13
