Back to top

YITH WooCommerce Compare Documentation

Thank you so much for using our plugin.

YITH WooCommerce Compare - Wordpress plugin

This document covers the installation and use of this plugin and reveals answers to common problems and issues - I encourage you to read this document if you are experiencing any difficulties.

Get started!


 

Getting started

To install this plugin you must have a working version of WordPress already installed. For information in regard to installing the WordPress platform, please see the WordPress Codex - http://codex.wordpress.org/Installing_WordPress

Installation

Upload via ftp:

First, unzip the zip archive you downloaded on your computer. Upload the folder to your server via ftp to the   /plugins/ directory on your Wordpress installation. (wp-content > plugins)

Upload via Wordpress admin:

Go to your Wordpress admin, and in the Plugins-panel, choose Add New. Click Upload in the below the title "Install Plugins". Upload the plugin zip.

Installing WordPress  http://codex.wordpress.org/Installing_WordPress

Activation

Once you have uploaded the plugin, activate your plugin in Plugins > Installed plugins.
This plugin will work only if WooCommerce - excelling eCommerce is installed and active.

The plugin is now active and can be included in your theme.

Usage

After install the plugin, by default it add a compare button in the single product page, where the user can add the specific product in list for compare. Compare button By default also, after have clicked in "Compare" button, will be open a popup with the compare table. Compare popup All settings can be changed as shown in the table below.

Plugin Settings

You can find the settings of the plugin in Woocommerce -> Settings -> Products Compare

.

Here an screenshot of default settings.

Plugin settings

Shortcode

You can also place the compare button inside your theme or plugin. The shortcode is: [yith_compare_button] or you can even set the product that will be added to the compare list: [yith_compare_button product=""] In the attribute product you can specify:

  • the Product ID;
  • the Product slug.

Use the Widget

You can also add a widget in your pages where list the products the user added in the compare list.
The widget hasn't any configuration, it's only a display widget.

You can add the widget in Appearance > Widgets and it's called "YITH Woocommerce Compare".

You can also add your link "Compare" in the menu, useful to open the popup compare from any page of your website.
You can do it by setting the class "yith-woocompare-open" in the menu item. You can see the screenshot:

Codex

Custom stylesheet

If you need to customize the style of Colors and Labels you just need to copy the assets/css/style.css file, paste it inside the folder "woocommerce" of your theme folder and rename it as "compare.css". Now you can easily customize the code by editing this file.

Custom template

You can customize the compare list template that appears inside the popup, by copying the templates/compare.php file and pasting it inside the "woocommerce" folder of your theme folder. After this, you can edit the html of compare list in this new file.

FAQ

Can I customize the compare table?

Yes, you can choose what fields to show in the compare table. You can do it in Woocommerce -> Settings -> Products Compare.

Can I select what fields show inside the compare table?

Yes, you can copy the template from the plugin folder and paste it inside the folder "woocommerce" of your theme folder.

Can I order the fields in the compare table?

Yes, you can sort the fields in the compare table. You can do it in Woocommerce -> Settings -> Products Compare.

Localization

This plugin is ready for localization via .po/.mo files.

If you are not familiar with translating Wordpress plugins, I recommend you reading this article: http://codex.wordpress.org/Translating_WordPress

Change the language of YITH WooCommerce Compare Languages for dummies

  1. Check the values of your wp-config, the language of this file must match to your translation;
  2. Find the folder languages of the plugin
  3. Duplicate default.po
  4. Rename your copy of default.po example: yit-fr_FR.po for France, yit-en_EN.po for English, yit-he_HE.po for hebraic, and so on.
  5. Download POEdit
  6. Open your file with the POEdit software
  7. Update the catalog using the POT file (Catalog -> Update from POT file...)
  8. Translate your file (edit catalog properties using POEdit to add your credits)
  9. In File click on Preferences and tick Automatically generate mo
  10. Save your file
  11. Send the new .mo and .po via FTP to your server, in the folder languages of the plugin
  12. Send the new .mo and .po via email to plugins@yithemes.com so we can improve the quality of the plugin and you can help other users. We will thank you with official credits

Version 1.2.1 - Released: Set, 17 - 2014

  1. Added: Support to WC 2.2.3

Version 1.2.0 - Released: Set, 16 - 2014

  1. Added: Support to WC 2.2.2
  2. Update: Compare Template
  3. Updated: Plugin Core Framework
  4. Tweek: WPML Support improved
  5. Fixed: Fields orders

Version 1.1.4 - Released: Jun, 30 - 2014

  1. Fixed: Horizontal scroll bar issue: show at the end of iframe
  2. Updated: Colorbox Library Version 1.5.10

Version 1.1.3 - Released: Jun, 05 - 2014

  1. Added: RTL Support

Version 1.1.2 - Released: Mar, 21 - 2014

  1. Fixed: WPML Support on Compare Widget

Version 1.1.1 - Released: Feb, 19 - 2014

  1. Fixed: Add to cart Button on Compare page

Version 1.1.0 - Released: Feb, 13 - 2014

  1. Added: Support to WooCommerce 2.1.x
  2. Added: French translation by Paumo

Version 1.0.5

  1. Added: Persian translation by Khalil Delavaran
  2. Added: Compare table title option
  3. Added: Compatibility with WPML plugin
  4. Added: Brazilian Portuguese translation by hotelwww
  5. Updated: Dutch translation by Frans Pronk
  6. Fixed: Responsive features
  7. Fixed: Dequeued wrong JS scripts

Version 1.0.4

  1. Added: complete Dutch translation. Thanks to Frans Pronk
  2. Sortable scripts included only in the plugin admin page
  3. Fixed: products list in popup don't update after have added a product

Version 1.0.3

  1. Minor bugs fixes

Version 1.0.2

  1. Improved: trigger in javascript file for add to compare event

Version 1.0.1

  1. Added: Link/Button text option in plugin options
  2. Added: ability to add a link in the menu top open the popup
  3. Fixed: bug with attributes added after installation
  4. Fixed: bug with plugin activated but not working for multisites

Version 1.0.0

  1. Initial release.