detailed review extension manual

Download extention via Magento ConnectCheck interactive guide

http://www.magentocommerce.com/magento-connect/detailed-review-6492.html

http://www.magentocommerce.com/magento-connect/detailed-review-6492.html

http://mage-workshop.com/

http://mage-workshop.com/

Table of Contents

Copyright © 2013 MageWorkshop 2

3

4

5

25

26

27

28

29

30

31

32

33

35

36

37

38

39

1. Introducing Detailed Review

2. Detailed Review Installation

3. Detailed Review Extension Configuration

4. Reviews Statistics

5. Adding New Pros and Cons

6. User-defined Pros and Cons Management

7. Ban Functionality

8. Front-end Interface for Posting Review

9. Demonstration of Store Area for Banned Author of Review

10. Configuration of Fields Available for Particular Category

11. My Reviews in My Account Section

12. How to Translate Detailed Review Extension

13. Review Placeholder

14. Using custom theme

15. Javascript Libraries

16. Changing default "Body Type" labels/images on review form

17. Contacts and Support

Introducing Detailed Review1

Detailed Review extension was created to give you more information about customers' opinion and for your customers to express their thoughts and feelings about your products. As specialists discovered, one of the most important factors that influences on customers' decision is the opinion of others. This extension will help to make your store more interactive and attractive for people. Flexible settings set allows you to create different ratings that will reveal the main theme of your site.

Your customers always want to know more about any product they buy. Have somebody already got this? Is it good? Does it really look like on the photo? And people surely want to share their opinion. Detailed Review is the best way to make your store more social. More reviews will attract more people. From now customers will become not just those, who buy, but the community.

Statistics, analysis? What are top-rated or less-rated products? Which reviews were written last month? Need to know top-rated products from particular category? Any information is available via Detailed Review! Do not spend money for nothing, plan your business to get more profit.

Create the review that will show the individuality of yous site. Clothing, computers, media? Whatever your products are - you can customize reviews so they will never look like on other sites. Simple javascript review form not takes place on the page and customers will surely like its' design.

Are you afraid of spam? Need moderation, but have hundreds of products? Guests are disallowed to write reviews by default, pre-moderation of reviews is turned on so nobody will have an ability to write spam instead of real review. Anyway, these features can be turned off - only you can decide whom will have an opportunity to write reviews to your products.


35

2

Copyright © 2012 MageWorkshop

Detailed Review Installation

1. Click on Get Extension Key button to copy the Extension key into clipboard. For Magento 1.5 and above it should look similar to the following one:http://connect20.magentocommerce.com/community/MageWorkshop_DetailedReview2. Switch to Magento Connect Manager at System -> Magento Connect -> Magento Connect Manager or by pointing your browser to http://your-store-name/downloader/.3. Paste Magento Extension key into the first input field "Paste extension key to install".4. Click on the Install button to start installation.5. After successful installation Flush Magento cache to clear cached data and perform Reindex.6. Re-login into Magento backend to reload module permissions for your account.


To Reindex Magento dataLogin to Admin area and follow steps:1. Go to System -> Index Management.2. Click on “select all” in the upper left corner.3. Under “Action” select “Reindex Data” and click Submit button.

To Flush all Magento cacheLogin to Admin area and follow steps:1. Go to System -> Cache Management and2. Click on “select all” in the upper left corner3. Under “action” click on “refresh” and click submit4. Then click on these buttons: a. Flush Magento Cache. b. Flush Cache Storage. c. Flush Catalog Images Cache. d. Flush JavaScript/CSS Cache.

Detailed Review Extension Configuration3

To configure Detailed Review extension you should login into Magento system and navigate to System → Configuration → Detailed Review configuration tab.



This configuration scope contains such sections:

> Settings> Rating Images> Enable/Disable Fields> Social Share> Captcha Options

> Video Preview Options> Email Admin Notification> Sorting Options> Reviews List Options> Recent Reviews in Category

> Statistics Options> Uninstall Extension



> Settings


In Settings section such options are available in drop-down list:


- Enabled- Enable jQuery and Other Plug-ins- Auto Approve Reviews for Custom Group- Allow Guests to Vote for Review- Show Verified Buyer Image

Enabled - this option will turn module on or off (“Yes” is default option, extension turned on). In case you select “No” extension will not be visible on front-end and review-related functionality will degrade to default Magento’s one.

Enable jQuery and Other Plug-ins - this option initialize JS libraries in local scope which will not intersect with external jQuery. If you are advanced user and you have jQuery and/or part of plug-ins already utilized you might want to disable this option and attach required plug-ins manually for optimization purposes. If option is turned on then jQuery with plug-ins will be added to the page without taking into account any other instances which might be already present. It will not cause any conflicts though because everything is initialized in local scope.

Auto Approve Reviews for Custom Group - allows to post review directly without waiting Admin to approve it. You could specify customer groups users participating in could write review without further pre-moderation.

Allow Guests to Vote for Review - allows or denies voting for review for guest users.

Show Verified Buyer Image - this option determines if verified buyer icon will be shown on front-end (under customer's name).



> Rating Images


In Rating Images section default (star) images for rating could be changed. Available states are “Active” and “Inactive”. These images will be displayed near Price, Value, Quality fields on front-end (in case appropriate options are enabled).


> Enable/Disable Fields

Here you can enable or disable additional fields which will be available for user on front-end during writing review.



> Social Share

Here you can enable or disable additional fields for share review in social networks (facebook or twitter) which will be available for user on front-end on product page. Also there you could be configured displaying recommend this product to a friend or not.



> Captcha Options

Here you can enable reCAPTCHA which will be shown for users while applying review.


You will need need to register your domain on reCAPTCHA site and receive Public Key and Private Key to put them in Admin area:

1. Go to www.google.com/recaptcha/admin/list, login with your google account and click on Add a New Site button to register your domain.

2. Enter your domain to Domain field and click Create Key button.

3. Copy Public Key and Private Key from reCAPTCHA website and paste to appropriate fields in Captcha Options section.

4. Turn on Captcha from Admin area and save changes.

Note: To register your domain you should have a Google account.



https://www.google.com/recaptcha/admin/list

https://www.google.com/recaptcha/admin/list



Domain registration for configuration Public and Private Keys.



> Video Preview Options

Here you could configure video size preview. Change preview width and height.




> Email Admin Notification

Here you could configure options which are related to email sending. Event triggered when new review is created.


To allow sending email notification select “Yes” from drop-down (in case you don’t need email notification, select “No”).

New Review Email Sender this field allows to choose sender (to configure a new sender, go to System → Configuration → Store Email Addresses).

New Review Email Template field allows to choose email template to be applied.

New Review Email Copy To adds additional recipient email, who will receive copy of email. If there are more then one recipient then list of emails entered should be comma-separated. If this field is empty then email will be send to “Customer Support” only.

New Review Email Copy Method field gives a possibility to choose preferable email copy method.




> Sorting Options

Here you specify attributes by which user will have an ability to sort with on front-end. In case some fields will not be selected, they will not appear in sorting drop-down on front-end.



> Reviews List Options

Gives an ability to choose default sorting method and quantity of reviews shown in list.

Review per Page by Default - number of reviews per page shown on front-end.Reviews per Page - here should be placed comma-separated values for "Show X per page" block on front-end.Ordering - this option will determine default sorting behavior for front-end.



> Recent Reviews in Category

It gives an ability to configure sidebar slider and visibility of product image.


Display Recent Reviews - option allows/denies displaying of Recent Review block on category page.

Display Recent Reviews in Category - option allows/denies displaying of Recent Reviews by Category for specific category block on category page. The difference between this option and previous one is that previous one will get all reviews store-wide and this one will get only reviews in current category.

Slider Effect - effect to be applied when slides are changed. To see how it affect slider go to front-end check category page, Recent Review and Recent Reviews by Category blocks (you should have some reviews there to check this functionality).

Number of Reviews in Slideshow - set maximum quantity of reviews for Recent Review and Recent Reviews by Category blocks.

Number of Visible Reviews in Slideshow - set maximum of visible reviews for Recent Review and Recent Reviews by Category blocks. According to entered value Recent Reviews block and Recent Reviews by Category block height will be increased if needed.

Rotation Speed - delay in seconds which will determine pause between slides change.

Show Product Image - allows/denies displaying product image in Recent Review and Recent Reviews by Category blocks on category page.




> Statistics Options

Here you could configure options for dashboard which contains statistics for reviews.


Chart Type - this is type of chart to be shown in statistics area. Available chart types: Magento Chart, Line Chart, Column Chart, Area Chart.

Number of Items in Most Reviewed Products Grids - allows to set maximum number of items in Most Reviewed Products Grid.

Number of Items in Most Liked Products Grids - allows to set maximum number of items in Most Liked Products Grid.

Number of Items in Most Disliked Products Grids - allows to set maximum number of Items for most disliked products in Most Disliked Products Grids.

Number of Items in Most Active Customers Grids - allows to set maximum number of items for most active customers in Most Active Customers Grids.





> Uninstall Extension

Will completely uninstall extension and delete all related information. Reviews will get back to original (standard) state.


4


Reviews Statistics

To see Reviews Statistics go to Catalog → Reviews and Rating → Customer Reviews → Reviews Statistics.

Image reviews statistics for Top Most Reviewed Products, Top Most Liked Products, Top Most Disliked Products, Top Most Active Customers. There is an ability to navigate to edit item directly from grid.


5


Adding New Pros and Cons

To add new Pros go to the Catalog → Reviews and Ratings → Customer Reviews → Pros and click Add Pros button.

1. In the Name field enter the title will be shown in the Pros Management page and on Product page.2. In the Status field select Enabled.3. In Wrote By select Administrator.4. In the Store View select the websites where Pros will be displayed.5. The Sort Order field allows specifying the sequence of properties displaying.

Click the Save Pros button.


6


User-defined Pros and Cons Management

Pros and Cons which are added manually, will be included in list and appear in Admin area so Admin will be able to add them as standard ones. To configure Pros and Cons go to the Catalog → Reviews and Ratings → Customer Reviews → User-defined Pros and Cons. There will be a grid with all pros and cons which were predefined previously by Admin as far as manually entered by review author’s.

If you click on Pros or Cons you will be able to edit it. There are options which allowing you to change Name, Status (if “Yes” is chosen this item appear in Pros or Cons section on front-end), Wrote By, Store View and Sort Order.


7


Ban Functionality

There is an ability to ban author of review so he will not be able to write further reviews. You could check review, select "Ban Author of Review from Writing Review" option and choose for how long Author's IP should be banned. In case author was logged in to the system when he was writing review then customer will be banned from writing review. Otherwise IP will be banned. You should be aware that several devices could use same external IP which might lead to false-positive bans.

There are two ways for ban: go to Catalog → Reviews and Rating → Customer Reviews → All Reviews or go to Customer → Manage Customer.For unblock banned author of review do the same steps, but select “Lift Ban” option from drop-down.


8


Front-end Interface for Posting Review

1. Rating section2. Sizing section3. Good and Bad Details section4. Pros and Cons section5. User Defined Pros and Cons section6. Would you recommend to a friend list7. Image section8. Video section9. About you section10. Captcha section11. Administration Response section (to post response to review go to appropriate review in Admin area, input message to “Response” field and save)


Click to here see enlarged image.

http://dl.dropbox.com/u/107550636/JShotscreenshots/screen130329-143411.png

9


Demonstration of Store Area for Banned Author of Review


10


Configuration of Fields Available for Particular Category

For different categories there is an ability to configure available review fields. In this way store owner will gain an ability to have different review options for different categories so for example Body Type will not appear in “Electronics” section. To utilize this feature go to Catalog → Manage Categories → {Category_name} and switch to the second tab Display Settings. Find Available Review Fields select necessary attributes and save changes. If you mark check-box for “Use Parent Category Settings for Review Fields” this attribute will inherit value from parent. Available review fields section becomes not editable.


11


My Reviews in My Account Section

Registered customer has ability to look throw own review from My Account section. Login to the shop and go to My Account → My Reviews. There will be a statistical data about review and all own review.



How to Translate Detailed Review Extension

There are two main ways to translate Detailed Review extension.

In first case you could turn on Translate Inline functionality. Go to Admin area System → Configuration → Developer → Translate Inline section and set Enabled for Frontend to Yes.Inline translate does not always work properly though. So you might want to use second way.


12


In second case if some labels couldn't be translated using Translate Inline feature, go to /app/locale/es_ES/ (if there is no such folder, navigate to Admin area System → Configuration → Design → Themes → Translations and check locale folder name after this create new folder under /app/locale/{LOCALE_FOLDER_NAME}/) then copy to this folder MageWorkshop_DetailedReview.csv file and edit it. There will be a list of items which are already added to CSV file. To translate particular item edit label in second column and save changes. If wording you are looking for is not there, then write it manually in first column in quotes (spelling should match exactly) and in second column write translated value using comma to separate them. When translation is finished, clean Magento cache and reload page to see changes. For example: “Write a Review”, “Оставить отзыв”.


How to Translate Detailed Review Extension12

35Copyright © 2013 MageWorkshop

Review Placeholder13

Detailed Review extension supports review placeholder. You could use this feature at any point in any place on product page. Just insert the next tag <div class="reviews-placeholder"></div> in that place where you want to see review section.Basically for this you need to edit file: app/design/frontend/<THEME_PATH>/template/catalog/product/view.phtml.

36Copyright © 2013 MageWorkshop

Using custom theme14

To use Detailed Review extension in your custom theme, you may need to do the following steps:1) copy files from app/design/frontend/base/default/template/detailedreview to the app/design/frontend/<DEFAULT_THEME_PATH>/template/detailedreview directory. This step is required if some of the review templates have to be modified;2) copy files from skin/frontend/base/default/css/detailedreview to the skin/frontend/<DEFAULT_THEME_PATH>/css/detailedreview directory and skin/frontend/base/default/images/detailedreview to the skin/frontend/<DEFAULT_THEME_PATH>/images/detailedreview directory. This step is required if you need to change CSS styles of the review;3) if you have multiple stores that require different styles then you have to copy all this files to the folder with store theme files, not the default one.

Paths for single store usually look like this: - app/design/frontend/default/default/... - skin/frontend/default/default/...If you have multiple stores then probable path will differ: - app/design/frontend/default/<STORE_THEME_NAME>/... - skin/frontend/default/<STORE_THEME_NAME>/...

15


Javascript Libraries

For now our extension uses such Javascript libraries:1) jQuery 1.8.0;2) jQuery.ui 1.8.23 with such components:

a) UI Core: All;b) Interactions: Draggable, Resizable;c) Widgets: Button, Dialog, Slider;d) Effects: Effects Core, Blind Effect, Fade Effect.

3) jQuery.easing 1.3;4) jQuery.spy;5) jQuery.lightbox 0.5;6) jQuery Placeholder 2.0.7.

jQuery in our extension is defined as DRjQuery global object to prevent conflicts with Magento extensions that also use jQuery libraries. If you use the same libraries you will have to assign your jQuery to it or replace DRjQuery string with jQuery in app/design/frontend/base/default/template/ folder. We recommend to attach required versions of jQuery and plugins by yourself and to use them instead of this file (otherwise most probably you will have 2 jQuery objects in memory and general plugins will be duplicated).If you do not need to load this libraries in one file or you've already got this libraries loaded on your website, you can disable loading DRjQuery by changing "Enable jQuery and Other Plugins" option in detailedreview settings or you can comment/delete ~7th line in app/design/frontend/base/default/layout/detailedreview.xml file (which includes this file to the page content) and replace libraries with your versions. Note that this may cause errors in Javascript if not all needed libraries are included or they have incompatible versions.


16


Changing default "Body Type" labels/images on review form

To change "Body Type" you need to go to the file app/code/local/MageWorkshop/DetailedReview/Model/Review/BodyType.php, change/add/remove options in getOptionArray() method and remove/edit/add constant of this class. Constants and values should be unique. Then go to skin/frontend/base/default/images/detailedreview/bodytypes/ and add here file(s) using such naming convention "[option_name]-shape.jpg"Try not to change constants' value if you need to edit type, because this values are stored in database.If you need to remove some type, you need to execute this SQL script as well (this will delete all information about body type from all reviews):UPDATE `review_detail` SET `body_type`= NULL WHERE `body_type` = [VALUE]Here [VALUE] is the constant that represents body type. For example for BODY_TYPE_TRIANGLE [VALUE] is 1.


17


Contacts and Support

If you found any bugs, you think some functionality is missing or does not work properly or you having issues in extension set up or customization please contact us at [email protected]. We are always happy to help!


mailto:[email protected]

detailed review extension manual

Documents