* ATTENTION Customer Testimonials v3 (version 6.0) users: The v6.0 path is now renamed and maintained under its own download and support section on the oscommerce.net website. The package has been renamed to Scrolling Customer Testimonials v1.0. *

This contribution allows your customer to post a testimonial about your site or your products with the option of uploading an image of them using your products. As the administrator, you will be notified via email that a customer has posted a testimonial and you must allow it in the admin before it will be visible to the public. As the administrator, you will be able to view the text and the image (if an image was uploaded) and have the option to allow the text, image or both. As the administrator, you will be able to edit both the text and the image.

Take a look at the included screenshots to see what will be added to your shop by installing this contribution.

Disclaimer: This OSCommerce contribution (mod) is provided to you free-of-charge and comes with no warranty, expressed or implied. Before making changes to your Website, please back-up your files and your database. The author is not liable for anything you do with this contribution, the code, or any other suggestions contained in the included files or documentation and how it may interact with anything you choose to do with it. Use at your own risk. Help is available, subject to limitations on my free time. Please read these instructions. I have done my best to thoroughly explain how to install this application, how it works, the most common problems and how to fix them. Please do not ask me questions if you have not looked in this doc first. Thank you for downloading this contribution, and I hope that you find it useful!

#################################################################

Support Thread for Customer Testimonials Thread located at:

http://forums.oscommerce.com/topic/348761-contribution-scrolling-customer-testimonials/page__view__findpost__p__1457041

*** NOTE: Please PM me or post in this thread and PM me to let me know you have a question. I am not an OSC expert, but I'll do my best to help you out, time permitting. ***

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

What’s New in Scrolling Customer Testimonials v1.11a?

Minor release change from SCT v1.1a:

New Features

· None

Bug Fixes

· Now correctly displays up to the maximum number of testimonials. Prior to this version, maximum number of testimonials admin setting was ignored.

Other

· None

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Pre-Installation / Preparation

Step 0: Pre-Installation

Pre-installation:

Backup your database!

Backup your shop's files!

NOTE: The reCaptcha Mailhide feature requires the PHP cryptography function MCrypt to be installed on your PHP server, which many hosts do not setup by default. If you wish to use this function, make sure you verify that MCrypt is available in your PHP environment before enabling the Mailhide function. Mailhide conceals the testimonial author's email address unless the user passes a reCaptcha test. If your PHP server does not have the MCrypt function installed or if you are unsure, make sure you set the admin option to “Use reCaptcha anti-spam verification to display author Email address” to OFF.

There are two types of installation methods: 1) New Installation and 2) Upgrade from version 5.0 or 5.1 of Customer Testimonials. Both methods require modifications to your database (via the included scrolling_testimonals_v1 SQL file) using a tool such as phpMyAdmin.

Directory Structure

New installations (not overwriting a previous version of Customer Testimonials), use the files found in the “New Install” folder.

To upgrade an existing version of Customer Testimonials v5.0 or v5.1, based on the Customer Testimonials v3 code tree, use the files found in the “upgrade_5x” folder.

To upgrade an existing version of Scrolling Customer Testimonials v1.0, use the files found in the “upgrade_from_CST_v1.0” folder.

Default Language

There are two places in the SQL files where you may wish to change the default language for this contribution:

1) To change the default language for new testimonials. If CST cannot figure out what language a user is, it will default flagging your testimonials in the database as this language code. The default to the contribution is English, but you can change it to anything you want. If you wish to change this, first look up your languages table and find the language_id column for your preferred default. Cross reference that with your preferred language. For example, English is “1”. To edit this setting in the SQL file, change one line. The “language_id” column in the SCT table stores the value of your store’s website language that your customer was using when they wrote the testimonial.

For New Installs, modify the value (i.e., ‘1’) in this line:

`language_id` int(11) NOT NULL DEFAULT '1',

For Upgrade Installs, modify the value (i.e., ‘1’) in this line:

ALTER TABLE `customer_testimonials` ADD `language_id` INT( 11 ) NOT NULL DEFAULT '1';

2) The SCT contribution will send the Admin emails when a new testimonial is posted. You may wish to change the language that the contribution will use to send those emails. The default is English. To change the Admin Email default language, see the appropriate Admin section.

Alternatively, you may modify the SQL file value (e.g. ‘english’) in this line (highlighted below for emphasis only). Enter the main catalog directory name (includes/languages/<pref language> for your preferred language (i.e. NOT the language directory name under the /admin path):

INSERT INTO `configuration` ( `configuration_id`, `configuration_title`, `configuration_key`, `configuration_value`, `configuration_description`, `configuration_group_id`, `sort_order`, `date_added`, `set_function`, `use_function`) VALUES (NULL, 'Set Admin Language Default (used for email)', 'TESTIMONIAL_ADMIN_EMAIL', 'english', 'Set Admin default language directory. Currently, this is used only for notification emails from the CST module to admin. Enter the language directory name which you would like used to send you emails (e.g. english).<br>', '555', '22', NOW(), NULL, NULL);

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

New Installations

For the purpose of this contribution, “UPGRADING” means upgrading from Customer Testimonials V3 (version 5.0 OR 5.1), or Scrolling Customer Testimonials v1.0. Use the New Install method if you have not previously installed Customer Testimonials v3 – version 5.0 or 5.1, or Scrolling Customer Testimonials v1.0. Upgrade installation instructions are found elsewhere in this guide.

Follow the instructions below for New Installs or use a file compare tool (e.g. Beyond Compare... there are many others) to merge the differences of Modified files.

Step 1: Upload files

Open the “New Install” folder (“New Install”). Upload all of the files from the "New Files" folder to your catalog. Be sure to keep the folder structure intact to match the existing folder structure of your store.

Step 2: Modify Files

Make file modifications to your existing files (Follow each step listed below for "Step 2.1 through 2.12" or use a file comparison utility such as Beyond Compare and compare your files with those files included in the "Modified Files" folder (“New Install\Modified Files”) of this contribution).

################################################

Step 2.1 catalog/admin/includes/filenames.php

Add the following just before the last ?>:

define('FILENAME_TESTIMONIALS_MANAGER', 'testimonials_manager.php');

################################################

Step 2.2 catalog/admin/includes/database_tables.php

Add the following just before the last ?>:

define('TABLE_TESTIMONIALS', 'customer_testimonials');

################################################

Step 2.3 catalog/admin/includes/boxes/tools.php

Find:

'<a href="' . tep_href_link(FILENAME_SERVER_INFO) . '" class="menuBoxContentLink">' . BOX_TOOLS_SERVER_INFO . '</a><br>' .

Add just below it:

'<a href="' . tep_href_link(FILENAME_TESTIMONIALS_MANAGER) . '" class="menuBoxContentLink">' . BOX_TOOLS_TESTIMONIALS_MANAGER . '</a><br>' .

################################################

Step 2.4 catalog/admin/includes/functions/general.php

Add the following just before the last ?>:

// Sets the status of a testimonial

function tep_set_testimonials_status($testimonials_id, $status) {

if ($status == '1') {

return tep_db_query("update " . TABLE_TESTIMONIALS . " set status = '1' where testimonials_id = '" . $testimonials_id . "'");

} elseif ($status == '0') {

return tep_db_query("update " . TABLE_TESTIMONIALS . " set status = '0' where testimonials_id = '" . $testimonials_id . "'");

} else {

return -1;

}

################################################

Step 2.5 catalog/admin/includes/languages/english.php

Add the following just before the last ?>:

// Customer Testimonials

define('BOX_TOOLS_TESTIMONIALS_MANAGER', 'Testimonials Manager');

define('IMAGE_NEW_TESTIMONIAL', 'New Testimonial');

##############################################

Step 2.6 catalog/includes/functions/html_output.php

Find the following near line 185:

// Output a form password field

ADD the following just ABOVE it:

// Output a form filefield

function tep_draw_file_field($name) {

$field = tep_draw_input_field($name, '', '', 'file');

return $field;

}

////

##########################################

Step 2.7 catalog/includes/languages/

english.php

Add the following just before the last ?>:

// Customer Testimonials

define('BOX_HEADING_CUSTOMER_TESTIMONIALS', 'Testimonials');

define('BOX_INFORMATION_CUSTOMER_TESTIMONIALS', 'Testimonials');

define('TABLE_HEADING_TESTIMONIALS_ID', 'ID');

define('TABLE_HEADING_TESTIMONIALS_NAME', 'Name');

define('TABLE_HEADING_TESTIMONIALS_DESCRIPTION', 'Testimonial');

define('TEXT_READ_MORE', '(read more)');

define('TEXT_TESTIMONY_TITLE', 'Title: ');

define('TEXT_TESTIMONY_BY', 'Testimonial by: ');

define('TEXT_TESTIMONY_DATE_ADDED', 'Date added: ');

define('TEXT_TESTIMONY_OF', ' of ');

define('TEXT_MAILTO', 'mailto:');

define('TEXT_EMAIL_AUTHOR', 'Click to email the author');

define('IMAGE_BUTTON_SUBMIT', 'Submit to ' . STORE_NAME);

define('IMAGE_BUTTON_WRITE', 'Write a Testimonial');

// CST v1.11

define('NO_TESTIMONIALS_TEXT', 'No Testimonials available for your language');

// reCaptcha

define('ENTRY_SECURITY_CHECK', 'Security Code:');

define('ENTRY_SECURITY_CHECK1', 'Security Code');

define('ENTRY_SECURITY_CHECK_ERROR', 'The Security Code was not entered correctly:');

espanol.php

Add the following just before the last ?>:

// Customer Testimonials

define('BOX_HEADING_CUSTOMER_TESTIMONIALS', 'Testimonios');

define('BOX_INFORMATION_CUSTOMER_TESTIMONIALS', 'Testimonios');

define('TABLE_HEADING_TESTIMONIALS_ID', 'ID');

define('TABLE_HEADING_TESTIMONIALS_NAME', 'NOmbre');

define('TABLE_HEADING_TESTIMONIALS_DESCRIPTION', 'Testimonio');

define('TEXT_READ_MORE', '(leer más)');

define('TEXT_TESTIMONY_TITLE', 'Titulo: ');

define('TEXT_TESTIMONY_BY', 'Testimonio por: ');

define('TEXT_TESTIMONY_DATE_ADDED', 'Fecha añadido: ');

define('TEXT_TESTIMONY_OF', ' de ');

define('TEXT_MAILTO', 'mailto:');

define('TEXT_EMAIL_AUTHOR', 'Click al email del autor');

define('IMAGE_BUTTON_SUBMIT', 'Enviar ');

define('IMAGE_BUTTON_WRITE', 'Escribe tu Testimonio');

// CST v1.11

define('NO_TESTIMONIALS_TEXT', 'Perdón. No testimonials están disponibles para su idioma.');

// reCaptcha

define('ENTRY_SECURITY_CHECK', 'Código de Seguridad:');

define('ENTRY_SECURITY_CHECK1', 'Código de Seguridad');

define('ENTRY_SECURITY_CHECK_ERROR', 'El código de seguridad no fue introducido correctamente');

french.php (or francais.php) [Optional]

Add the following just before the last ?>:

// Customer Testimonials

define('BOX_HEADING_CUSTOMER_TESTIMONIALS', '   Témoignages');

define('BOX_INFORMATION_CUSTOMER_TESTIMONIALS', 'Témoignages');

define('TABLE_HEADING_TESTIMONIALS_ID', 'ID');

define('TABLE_HEADING_TESTIMONIALS_NAME', 'Nom');

define('TABLE_HEADING_TESTIMONIALS_DESCRIPTION', 'Témoignage');

define('TEXT_READ_MORE', '(lisez plus)');

define('TEXT_TESTIMONY_TITLE', 'Titre: ');

define('TEXT_TESTIMONY_BY', 'Témoignage par: ');

define('TEXT_TESTIMONY_DATE_ADDED', 'La date s\'est ajoutée: ');

define('TEXT_TESTIMONY_OF', ' de ');

define('TEXT_MAILTO', 'courrier à:');

define('TEXT_EMAIL_AUTHOR', 'Clic pour envoyer l\'auteur');

define('IMAGE_BUTTON_SUBMIT', 'Soumettez à ' . STORE_NAME);

define('IMAGE_BUTTON_WRITE', 'Écrivez un Témoignage');

// CST v1.11

define('NO_TESTIMONIALS_TEXT', 'Désolé. N Les témoignages sont disponibles pour votre langue.');

// reCaptcha

define('ENTRY_SECURITY_CHECK', 'Code de Sécurité:');

define('ENTRY_SECURITY_CHECK1', 'Code de Sécurité');

define('ENTRY_SECURITY_CHECK_ERROR', 'Le code de sécurité n\'a pas été écrit correctement:');

german.php (or deutsch.php) [Optional]

Add the following just before the last ?>:

// Customer Testimonials

define('BOX_HEADING_CUSTOMER_TESTIMONIALS', 'Zeugnisse');

define('BOX_INFORMATION_CUSTOMER_TESTIMONIALS', 'Zeugnisse');

define('TABLE_HEADING_TESTIMONIALS_ID', 'ID');

define('TABLE_HEADING_TESTIMONIALS_NAME', 'Name');

define('TABLE_HEADING_TESTIMONIALS_DESCRIPTION', 'Zeugnis');

define('TEXT_READ_MORE', '(lesen Sie mehr)');

define('TEXT_TESTIMONY_TITLE', 'Titel: ');

define('TEXT_TESTIMONY_BY', 'Zeugnis durch: ');

define('TEXT_TESTIMONY_DATE_ADDED', 'Datum fügte hinzu: ');

define('TEXT_TESTIMONY_OF', ' von ');

define('TEXT_MAILTO', 'Post zu:');

define('TEXT_EMAIL_AUTHOR', 'Klicken, zum des Autors zu mailen');

define('IMAGE_BUTTON_SUBMIT', 'Reichen Sie bei ein ' . STORE_NAME);

define('IMAGE_BUTTON_WRITE', 'schreiben Sie einen Zeugnis');

// CST v1.11

define('NO_TESTIMONIALS_TEXT', 'Bekümmert. Nr. Referenzen sind für Ihre Sprache verfügbar.');

// reCaptcha

define('ENTRY_SECURITY_CHECK', 'Sicherheits-Code:');

define('ENTRY_SECURITY_CHECK1', 'Sicherheits-Code');

define('ENTRY_SECURITY_CHECK_ERROR', 'Der Sicherheits-Code wurde nicht richtig eingegeben');

portugues.php [Optional]

Add the following just before the last ?>:

// Customer Testimonials

define('BOX_HEADING_CUSTOMER_TESTIMONIALS', 'Testemunhos');

define('BOX_INFORMATION_CUSTOMER_TESTIMONIALS', 'Testemunhos');

define('TABLE_HEADING_TESTIMONIALS_ID', 'ID');

define('TABLE_HEADING_TESTIMONIALS_NAME', 'Nome');

define('TABLE_HEADING_TESTIMONIALS_DESCRIPTION', 'Apreciações');

define('TEXT_READ_MORE', '(leia mais)');

define('TEXT_TESTIMONY_TITLE', 'Título: ');

define('TEXT_TESTIMONY_BY', 'Testemunho por: ');

define('TEXT_TESTIMONY_DATE_ADDED', 'A data adicionou: ');

define('TEXT_TESTIMONY_OF', ' de ');

define('TEXT_MAILTO', 'email a:');

define('TEXT_EMAIL_AUTHOR', 'Clique para enviar por correio electrónico o autor');

define('IMAGE_BUTTON_SUBMIT', 'Submeta a ' . STORE_NAME);

define('IMAGE_BUTTON_WRITE', 'Escreva a Apreciações');

// CST v1.11

define('NO_TESTIMONIALS_TEXT', 'Desculpe. No Testemunhos estão disponíveis para o seu idioma.');

// reCaptcha

define('ENTRY_SECURITY_CHECK', 'Código de Segurança:');

define('ENTRY_SECURITY_CHECK1', 'Código de Segurança');

define('ENTRY_SECURITY_CHECK_ERROR', 'O código da segurança não foi dado entrada corretamente');

########################################

Step 2.8 catalog/includes/application_top.php

Find the following around line 263:

// include the mail classes

require(DIR_WS_CLASSES . 'mime.php');

require(DIR_WS_CLASSES . 'email.php');

Add just below it:

// Begin Scrolling Customer Testimonials v1.0

// file uploading class

require(DIR_WS_CLASSES . 'upload.php');

// End Scrolling Scrolling Customer Testimonials v1.0

#########################################

Step 2.9 catalog/includes/column_left.php OR catalog/ includes/column_right.php

Add the following wherever you want the CT InfoBox to appear (but before the last ?>):

// Begin Scrolling Customer Testimonials v1.0

// Do not load Testimonials box if page is SSL

// Why? It may trigger SSL warning

if ($request_type != 'SSL') {

include(DIR_WS_BOXES . 'customer_testimonials.php');

}

// End Scrolling Scrolling Customer Testimonials v1.0

#########################################

Step 2.10 catalog/includes/database_tables.php

Add the following just before the last ?>:

define('TABLE_CUSTOMER_TESTIMONIALS', 'customer_testimonials');

###################################

Step 2.11 catalog/includes/filenames.php

Add the following just before the last ?>:

define('FILENAME_CUSTOMER_TESTIMONIALS', 'customer_testimonials.php');

define('FILENAME_CUSTOMER_TESTIMONIALS_WRITE', 'customer_testimonials_write.php');

define('FILENAME_CUSTOMER_TESTIMONIALS_ADMIN_EMAIL', 'customer_testimonials_admin_email.php');

###################################

Step 2.12 catalog/stylesheet.css

Add the following at the end of the file:

/* Begin Testimonials Scroller */

#pscroller_np {

height: 150px;

border: 0px;

padding: 5px;

}

.pscroller_c_np {

font-family: sans-serif;

font-size: 11px;

line-height: 1.5;

}

.marquee_hide {

visibility:hidden;

}

.marquee_show {

visibility:visible;

}

/* End Testimonials Scroller */_write.php');

###################################

Step 3: Install SQL file

For new installs, The “scrolling_testimonials_v1” SQL files contain the admin setup for Testimonials and reCaptcha. Using PHP MyAdmin or a similar utility, upload the file or its contents to your SQL database.

If you are upgrading from Customer Testimonials v5 or v5.1, use “testimonials_v5_upgrade.sql,” located in the upgrade_v5.x directory the SCT v1.1 SQL file will update your old v5/v5.1 SQL installation automatically.

If you are upgrading from SCT v1.0, use “cst_v1_upgrade.sql,” located in the upgrade_from_CST_v1.0 directory.

###################################

Step 4: Register ReCaptcha

1. Signup your website for reCaptcha at http://www.recaptcha.net and record your reCaptcha public and private keys

2. (*OPTIONAL*) Direct your browser to http://mailhide.recaptcha.net. Click "Get an API Key" and record your Mailhide public and private keys. Please read my comments on Mailhide and reCaptcha protection of email addresses before doing this.

3. Using your shop’s admin panel, go to Admin->Configuration->reCaptcha; insert the reCaptcha and Mailhide public and private keys that you noted above. Remember the Mailhide keys are optional and only need to be installed if you will be using this feature, which uses reCaptcha to temporarily hide Testimonial authors’ email addresses.

4. A current version (v1.10 as of this mod writing) of "recaptchalib.php" is included with this contribution under the New Files/includes/classes folder. You are strongly advised to download the most current version of "recaptchalib.php" from http://code.google.com/p/recaptcha/downloads/list?q=label:phplib-Latest

####################################

Step 5: Configure Admin Settings

Follow the "How it works" section at the end of this document to configure Customer Testimonials.

Be sure to test your setup. Entering a testimonial yourself manually gives you the opportunity to test the functionality and your admin settings.

Make sure there were no errors when running the SQL file. If you mistakenly run the file repeatedly it will re-write your v1.1 settings, but you will not lose your existing Testimonials.

If you run into any problems, first check the Common Problems and Troubleshooting section. If you cannot find help there, please post in the support forum or PM me (Richard Cranium).

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

End New Install Instructions

Upgrade from Customer Testimonials v5.0/5.1

Use this method if you have previously installed Customer Testimonials v5.0 or v5.1 (from the contribution Customer Testimonials v3) or Scrolling Customer Testimonials v1.0.

Be sure to use the appropriate Upgrade directory. “upgrade_v5.x” provides upgrade files from Customer Testimonials v3 (version 5.0 or 5.1); “upgrade_from_CST_v1.0” provides upgrade files from Scrolling Customer Testimonials v1.0.

###################################

Step 1: Upload New Files

Upload all files from the "New Files" folder. Overwrite your current Customer Testimonial files with those found in the “New Files” sub-folder, or follow the instructions below for manual updates. Be sure to keep the folder structure intact to match your existing folder structure of your store.

###################################

Step 2: Upgrade CT Files

Overwrite your old files (below). As long as you have not modified your old Customer Testimonials (CT) installation, this will be fine (and easier/faster). Simply copy the “Replaced Files” in the upgrade folder (\Replaced Files) over your old Customer Testimonial files.

Manual Update Method: I strongly suggest you simply replace the older files with these to avoid problems caused by typos. BUT if you still want to DIY then see Appendix A: Manual File Updates. Perform these steps ONLY if you chose not to perform the Easy Method and simply replace the old files.

Replace:

/customer_testimonials.php

/customer_testimonials_write.php

/admin/testimonials_manager.php

/admin/includes/languages/english/testimonials_manager.php

/admin/includes/languages/espanol/testimonials_manager.php

/includes/boxes/customer_testimonials.php

/includes/modules/customer_testimonials.php

/includes/languages/english/customer_testimonials.php

/includes/languages/espanol/customer_testimonials.php

/includes/languages/espanol/images/buttons/button_write_testimonial.gif

###################################

Step 3: Manual File Updates

The following files are core OSC store files and must be modified manually:

/stylesheet.css

/includes/column_left.php OR /includes/column_right.php

/includes/filenames.php

/includes/languages/english.php

/includes/languages/espanol.php

Modify these if present, or add as new files if you desire:

/includes/languages/german.php (or /includes/languages/deutsch.php)

/includes/languages/french.php

/includes/languages/portugues.php

###################################

Edit these files in your store with the instructions below:

Step 3.1 catalog/stylesheet.css

Add the following at the end of the file:

/* Begin Testimonials Scroller */

#pscroller_np {

height: 150px;

border: 0px;

padding: 5px;

}

.pscroller_c_np {

font-family: sans-serif;

font-size: 11px;

line-height: 1.5;

}

.marquee_hide {

visibility:hidden;

}

.marquee_show {

visibility:visible;

}

/* End Testimonials Scroller */_write.php');

###################################

Step 3.2 catalog/includes/column_left.php OR catalog/ includes/column_right.php

Find:

include(DIR_WS_BOXES . 'customer_testimonials.php');

REPLACE with:

// Begin Scrolling Customer Testimonials v1.0

// Do not load Testimonials box if page is SSL

// Why? It may trigger SSL warning

if ($request_type != 'SSL') {

include(DIR_WS_BOXES . 'customer_testimonials.php');

}

// End Scrolling Scrolling Customer Testimonials v1.0

#########################################

Step 3.3 catalog/includes/filenames.php

Add the following just before the last ?>:

define('FILENAME_CUSTOMER_TESTIMONIALS_ADMIN_EMAIL', 'customer_testimonials_admin_email.php');

###################################

Step 3.4 catalog/includes/languages/

english.php

Add the following just before the last ?>:

// CST v1.11

define('NO_TESTIMONIALS_TEXT', 'No Testimonials available for your language');

// reCaptcha

define('ENTRY_SECURITY_CHECK', 'Security Code:');

define('ENTRY_SECURITY_CHECK1', 'Security Code');

define('ENTRY_SECURITY_CHECK_ERROR', 'The Security Code was not entered correctly:');

###################################

espanol.php

Add the following just before the last ?>:

// CST v1.11

define('NO_TESTIMONIALS_TEXT', 'Perdón. No testimonials están disponibles para su idioma.');

// reCaptcha

define('ENTRY_SECURITY_CHECK', 'Código de Seguridad:');

define('ENTRY_SECURITY_CHECK1', 'Código de Seguridad');

define('ENTRY_SECURITY_CHECK_ERROR', 'El código de seguridad no fue introducido correctamente');

###################################

french.php (or francais.php) [Optional]

Add the following just before the last ?>:

// Customer Testimonials

define('BOX_HEADING_CUSTOMER_TESTIMONIALS', 'Témoignages');

define('BOX_INFORMATION_CUSTOMER_TESTIMONIALS', 'Témoignages');

define('TABLE_HEADING_TESTIMONIALS_ID', 'ID');

define('TABLE_HEADING_TESTIMONIALS_NAME', 'Nom');

define('TABLE_HEADING_TESTIMONIALS_DESCRIPTION', 'Témoignage');

define('TEXT_READ_MORE', '(lisez plus)');

define('TEXT_TESTIMONY_TITLE', 'Titre: ');

define('TEXT_TESTIMONY_BY', 'Témoignage par: ');

define('TEXT_TESTIMONY_DATE_ADDED', 'La date s\'est ajoutée: ');

define('TEXT_TESTIMONY_OF', ' de ');

define('TEXT_MAILTO', 'courrier à:');

define('TEXT_EMAIL_AUTHOR', 'Clic pour envoyer l\'auteur');

define('IMAGE_BUTTON_SUBMIT', 'Soumettez à ' . STORE_NAME);

define('IMAGE_BUTTON_WRITE', 'Écrivez un Témoignage');

// CST v1.11

define('NO_TESTIMONIALS_TEXT', 'Désolé. N Les témoignages sont disponibles pour votre langue.');

// reCaptcha

define('ENTRY_SECURITY_CHECK', 'Code de Sécurité:');

define('ENTRY_SECURITY_CHECK1', 'Code de Sécurité');

define('ENTRY_SECURITY_CHECK_ERROR', 'Le code de sécurité n\'a pas été écrit correctement:');

###################################

german.php (or deutsch.php) [Optional]

Add the following just before the last ?>:

// Customer Testimonials

define('BOX_HEADING_CUSTOMER_TESTIMONIALS', 'Zeugnisse');

define('BOX_INFORMATION_CUSTOMER_TESTIMONIALS', 'Zeugnisse');

define('TABLE_HEADING_TESTIMONIALS_ID', 'ID');

define('TABLE_HEADING_TESTIMONIALS_NAME', 'Name');

define('TABLE_HEADING_TESTIMONIALS_DESCRIPTION', 'Zeugnis');

define('TEXT_READ_MORE', '(lesen Sie mehr)');

define('TEXT_TESTIMONY_TITLE', 'Titel: ');

define('TEXT_TESTIMONY_BY', 'Zeugnis durch: ');

define('TEXT_TESTIMONY_DATE_ADDED', 'Datum fügte hinzu: ');

define('TEXT_TESTIMONY_OF', ' von ');

define('TEXT_MAILTO', 'Post zu:');

define('TEXT_EMAIL_AUTHOR', 'Klicken, zum des Autors zu mailen');

define('IMAGE_BUTTON_SUBMIT', 'Reichen Sie bei ein ' . STORE_NAME);

define('IMAGE_BUTTON_WRITE', 'schreiben Sie einen Zeugnis');

// CST v1.11

define('NO_TESTIMONIALS_TEXT', 'Bekümmert. Nr. Referenzen sind für Ihre Sprache verfügbar.');

// reCaptcha

define('ENTRY_SECURITY_CHECK', 'Sicherheits-Code:');

define('ENTRY_SECURITY_CHECK1', 'Sicherheits-Code');

define('ENTRY_SECURITY_CHECK_ERROR', 'Der Sicherheits-Code wurde nicht richtig eingegeben');

###################################

portugues.php [Optional]

Add the following just before the last ?>:

// Customer Testimonials

define('BOX_HEADING_CUSTOMER_TESTIMONIALS', 'Testemunhos');

define('BOX_INFORMATION_CUSTOMER_TESTIMONIALS', 'Testemunhos');

define('TABLE_HEADING_TESTIMONIALS_ID', 'ID');

define('TABLE_HEADING_TESTIMONIALS_NAME', 'Nome');

define('TABLE_HEADING_TESTIMONIALS_DESCRIPTION', 'Apreciações');

define('TEXT_READ_MORE', '(leia mais)');

define('TEXT_TESTIMONY_TITLE', 'Título: ');

define('TEXT_TESTIMONY_BY', 'Testemunho por: ');

define('TEXT_TESTIMONY_DATE_ADDED', 'A data adicionou: ');

define('TEXT_TESTIMONY_OF', ' de ');

define('TEXT_MAILTO', 'email a:');

define('TEXT_EMAIL_AUTHOR', 'Clique para enviar por correio electrónico o autor');

define('IMAGE_BUTTON_SUBMIT', 'Submeta a ' . STORE_NAME);

define('IMAGE_BUTTON_WRITE', 'Escreva a Apreciações');

// CST v1.11

define('NO_TESTIMONIALS_TEXT', 'Desculpe. No Testemunhos estão disponíveis para o seu idioma.');

// reCaptcha

define('ENTRY_SECURITY_CHECK', 'Código de Segurança:');

define('ENTRY_SECURITY_CHECK1', 'Código de Segurança');

define('ENTRY_SECURITY_CHECK_ERROR', 'O código da segurança não foi dado entrada corretamente');

###################################

Step 4: Install SQL file

Using PHP MyAdmin or a similar utility, upload the appropriate SQL file or its contents to your database.

The “testimonials_v5_upgrade_v1.1” SQL file contains the admin setup for Scrolling Customer Testimonials and reCaptcha. This file is ONLY for upgrading CT v5.0/5.1 installs to SCT v1.1.

The upgrade SQL file will update your v5/v5.1 SQL installation automatically and preserve any existing testimonials.

###################################

Step 5: Register ReCaptcha

1. Signup your website for reCaptcha at http://www.recaptcha.net and record your reCaptcha public and private keys

####################################

Step 6: Configure Admin Settings

Follow the "How it works" section at the end of this document to configure Customer Testimonials.

Be sure to test your setup. Entering a testimonial yourself manually gives you the opportunity to test the functionality and your admin settings.

Make sure there were no errors when running the SQL file, and that you ran the correct one (i.e. “upgrade” or the fresh install version). The fresh install version will re-write your settings if you run the file repeatedly. You will not lose your existing Customer Testimonials if you are upgrading from CT3 v5.0 or v5.1.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

End Upgrade from CT 5.0/5.1 Installation Instructions

Upgrade from Scrolling Customer Testimonials v1.0

Use this method ONLY if you have previously installed Scrolling Customer Testimonials v1.0 (a.k.a. Customer Testimonials v6).

Be sure to use the appropriate Upgrade directory “upgrade_from_CST_v1.0”

###################################

Step 1: Add New Files

Upload all files from the "New Files" folder. Be sure to keep the folder structure intact to match your existing folder structure of your store.

###################################

Step 2: Replace Some SCT Files

Overwrite these files in your store with the versions in the “Replaced Files” folder or follow the instructions below for manual updates. These files will replace your SCT v1.0 files. Be sure to keep the folder structure intact to match your existing folder structure of your store.

The following files are replaced:

/customer_testimonials.php

/customer_testimonials_write.php

/admin/testimonials_manager.php

/admin/includes/languages/english/testimonials_manager.php

/admin/includes/languages/espanol/testimonials_manager.php

/includes/modules/customer_testimonials.php

/includes/boxes/customer_testimonials.php

/includes/languages/english/customer_testimonials.php

/includes/languages/espanol/customer_testimonials.php

/includes/languages/french/customer_testimonials.php

/includes/languages/german/customer_testimonials.php

/includes/languages/portugues/customer_testimonials.php

###################################

Step 3: Modified Files

Compare the differences between these files and those in your store with the versions in the “Modified Files” folder. Be sure to keep the folder structure intact to match your existing folder structure of your store.

/includes/filenames.php

/includes/languages/english.php

/includes/languages/espanol.php

/includes/languages/french.php

/includes/languages/german.php

/includes/languages/portugues.php

/includes/languages/french/customer_testimonials.php

################################################

Step 4: Install New Language Support

The admin language files have now been split in order to support separate flow for admin emails. This allows admin emails to be received in the admin’s language instead of the language used by the testimonial author. The text of the customer’s testimonial will still appear in the customer’s native language.

The Admin Email Language is set in the SQL file or via the store’s Admin control panel.

###################################

Step 5: Install SQL file

The “cst_v1_upgrade” SQL file makes a small modification to your database. Using PHP MyAdmin or a similar utility, upload the appropriate file or its contents to your SQL database.

The upgrade SQL file will update your SCT v1.0 SQL installation automatically and preserve any existing testimonials.

####################################

Step 6: Configure Admin Settings

Follow the "How it works" section at the end of this document to configure Customer Testimonials.

Be sure to adjust the new Admin Language setting if necessary (it defaults to language code 1, which is normally English) and the Default Testimonial Language.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

End Upgrade from SCT 1.0 Installation Instructions

Upgrade from Scrolling Customer Testimonials v1.1

Use this method ONLY if you have previously installed Scrolling Customer Testimonials v1.1

Be sure to use the appropriate Upgrade directory “upgrade_from_CST_v1.1”

###################################

Step 1: Replace Some SCT Files

Overwrite these files in your store with the versions in the “Replaced Files” folder. These files will replace your SCT v1.1 files. Be sure to keep the folder structure intact to match your existing folder structure of your store.

The following files are replaced:

/includes/boxes/customer_testimonials.php

/includes/languages/english.php

/includes/languages/espanol.php

/includes/languages/french.php

/includes/languages/german.php

/includes/languages/portugues.php

/includes/languages/french/customer_testimonials.php

###################################

Step 2: Modified Files

Compare the differences between these files and those in your store with the versions in the “Modified Files” folder or follow the instructions below for manual updates. Be sure to keep the folder structure intact to match your existing folder structure of your store.

If editing these files in your store, use the instructions below.

Step 2.1 catalog/includes/filenames.php

Add the following just before the last ?>:

define('FILENAME_CUSTOMER_TESTIMONIALS', 'customer_testimonials.php');

define('FILENAME_CUSTOMER_TESTIMONIALS_WRITE', 'customer_testimonials_write.php');

define('FILENAME_CUSTOMER_TESTIMONIALS_ADMIN_EMAIL', 'customer_testimonials_admin_email.php');

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

End Upgrade from SCT 1.1 Installation Instructions

Configuration: How It Works (Admin Settings)

Guide for v1.1 instructions by Richard Cranium

Once you have installed Scrolling Customer Testimonials v1.1, you will need to adjust settings in one or two areas, depending on your installation choices. The first (required) is Admin > Configuration > Testimonial Manager. The second (optional) settings (for reCaptcha) are found under Admin > Configuration > reCaptcha. ReCaptcha is described in more detail elsewhere in this document.

Here is a screen shot using the excellent contribution Mindsparx Admin 2.0. A standard admin panel will look similar. I have enclosed the screen shot to give you an idea of what the Customer Testimonials admin settings look like.

Customer Testimonials Admin Settings

Enable / Disable Testimonials

In your store Admin panel, go to Configuration > Customer Testimonials > Activate Customer Testimonials Module to turn on or off the contribution. Turning this setting off will disable all Customer Testimonials forms. If a user tries to type in the URL directly to one of the Customer Testimonials PHP files, they will be redirected to the Login screen.

Default Setting (Recommended): Yes

Limit Who May View Testimonials

In your store Admin panel, go to Configuration > Customer Testimonials > Who May VIEW Testimonials to establish which user types may view Customer Testimonials. The choices are All Users / Registered Users only / Disabled (no one). Users who cannot view testimonials due to insufficient permissions (e.g. not logged in) will not see the Customer Testimonials InfoBox. Likewise, such users will be redirected to the Login page if they should somehow arrive at any PHP file which would normally display testimonials.

Default Setting (Recommended): All Users

Limit Who May Write Testimonials

Want to limit who can write testimonials? In your store Admin panel, go to Configuration > Customer Testimonials > Who May WRITE Testimonials to establish which user types may write Customer Testimonials. The choices are All Users / Registered Users only / Disabled (no one). Users who cannot write testimonials due to insufficient permissions (e.g. not logged in) will not see the “Write a Testimonial” button on the Customer Testimonials viewing forms. Likewise, such users will be redirected automatically to the Login page if they should somehow arrive at the testimonial writing form.

Default Setting (Recommended): Registered Users Only

Limit Who May Email Testimonial Authors

This function allows the store admin to place limitations on which user types are able to view the email address of a testimonial author. In your store Admin panel, go to Configuration > Customer Testimonials > Who may send EMAIL to testimonial authors to set the option of your choice. The choices are All Users / Registered Users only / Disabled (no one).

Under the former Customer Testimonials contributions (up through v5.1), anyone could see the email addresses of the testimonial authors. This was obviously a significant hole for email harvesting by spammers. While some former versions of Customer Testimonials addressed this with links to the reCaptcha contribution, version 6.0 integrates reCaptcha into Customer Testimonials and provides two different admin level switches which offer various protection options for authors’ email information.

Disabling this function simply removes the ability to view the testimonial author’s email address. All other functions are retained. “Registered Users only” means that only users who are registered (logged in) will be able to view the author’s email address.

Default Setting (Recommended): Disabled*

* Recommended that you disable this feature. If you do enable it, I strongly recommend you review your Website’s Privacy Policy and update it as necessary.

Enable/Disable Images

In your store Admin panel, go to Configuration > Customer Testimonials > Permit image uploads by testimonial authors to set the option of your choice. The choices are Yes / No.

If this option is enabled (set to “Yes”), and later disabled (set to “No”), any images uploaded prior to switching off the option will remain. That means anyone who views a testimonial with an image will still see the image. It is possible to edit individual testimonial posts and remove or edit the images. This option is discussed below under the section entitled “Removing a Customer’s Image.”

Note that this option only controls whether or not images are permitted to be attached to testimonials. It does not control who may write (submit) testimonials. That option is handled by the another option above, “Limit who may Write testimonials.”

Default Setting (Recommended): No

Maximum Image Width

In your store Admin panel, go to Configuration > Customer Testimonials > Customers testimonials image width to set the option of your choice. An integer value expressing the maximum width (in pixels) of your customers’ uploaded images (associated with Customer Testimonials only).

If you allow uploading images with testimonials, set the size limit for images to limit the width of your customers’ images. This is necessary to prevent large or wide images from possibly distorting the page layout of your shop. You should experiment with this value (ideally in a test environment) before allowing your customers to upload images with their testimonials.

Note this option only controls the width of uploaded images. It does not control whether images may be attached to testimonials or who may write (submit) testimonials. These options are handled by other admin options described above.

Default Setting (Recommended): 120

Display Mode: Scrolling versus Static Customer Testimonials

In your store Admin panel, go to Configuration > Customer Testimonials > Customer Testimonials Display Mode (Static or Scrolling) to set the option of your choice. The choices are Static or Scrolling. Static means testimonials will not scroll and only one randomly selected testimonial will be visible on a page in your store at any given time. Scrolling causes the InfoBox to rotate through a number of randomly selected testimonials, displayed inside the Customer Testimonials InfoBox. When the user moves their mouse over the scrolling text, it will pause. Hyperlinks remain active.

If you select Scrolling, other options need to be setup. See below.

Default Setting: Static

Scroll Box Height

In your store Admin panel, go to Configuration > Customer Testimonials > Scrolling box height to set the height of the InfoBox (in pixels). Recommended range is 150 – 200 for a typical InfoBox. This setting is part of the optional Scrolling text feature, which is optional. If your display mode (“Scrolling Customer Testimonials”) is set to Static, this setting will have no effect.

This setting is part of the optional Scrolling text feature, which is optional. If your Display Mode (Static or Scrolling) is set to Static, this setting will have no effect.

Default Setting: 160

Scrolling Text Speed

In your store Admin panel, go to Configuration > Customer Testimonials > Scrolling text speed to set how rapidly you would like your text to scroll across the InfoBox (must be an integer). Recommended range is 60 – 120.

This setting is part of the optional Scrolling text feature, which is optional. If your Display Mode (Static or Scrolling) is set to Static, this setting will have no effect.

Default Setting: 70

Scroll Direction

In your store Admin panel, go to Configuration > Customer Testimonials > Direction of scrolling testimonials to define which direction you would like your text to scroll across the InfoBox. Your choices are “Up” or “Down.”

This setting is part of the optional Scrolling text feature, which is optional. If your Display Mode (Static or Scrolling) is set to Static, this setting will have no effect.

Default Setting: Up

Minimum Number of Testimonials Before Scroll

In your store Admin panel, go to Configuration > Customer Testimonials > Minimum number of testimonials before scrolling customer testimonials to set the minimum number of testimonials required to be present in the database before scrolling will activate. If you have Scrolling active and the number of qualified testimonials is less than this setting, your testimonials will default to the static method of display. A “qualified” testimonial is one which a) has been approved by the admin; and b) is written in the same language as the viewer (user/customer).

This setting is part of the optional Scrolling text feature, which is optional. If your Display Mode (Static or Scrolling) is set to Static, this setting will have no effect.

Default Setting: 5

Maximum Number of Testimonials (Scrolling Testimonials Only)

In your store Admin panel, go to Configuration > Customer Testimonials > Maximum number of random testimonials to retrieve from database (Scrolling testimonials only) to set the maximum number of testimonials that will be retrieved from the store database each time the Customer Testimonials box is displayed. If you have Scrolling active and the number of qualified testimonials is less than this setting, your testimonials will default to the static method of display. A “qualified” testimonial is one which a) has been approved by the admin; and b) is written in the same language as the viewer (user/customer).

This setting is part of the optional Scrolling text feature, which is optional. If your Display Mode (Static or Scrolling) is set to Static, this setting will have no effect.

Default Setting: 5

Add reCaptcha to your Customer Testimonials Forms

This is a binary option which secures all Customer Testimonial input forms with a reCaptcha image verification process. In your store Admin panel, go to Configuration > Customer Testimonials > Enable reCaptcha anti-spam verification to set the option of your choice. The choices are “Yes” to turn on the reCaptcha screening of all Customer Testimonials forms, and “No” to turn it off.

Default Setting (Recommended): Yes

Use reCaptcha to Protect Customers’ Email Addresses

This is a binary option which prevents users from viewing the email address of a customer who has written a testimonial until after the customer passes a reCaptcha test. After the reCaptcha verification, only then is the email address of the Customer Testimonial visible.

This particular process uses a special reCaptcha process called Mailhide. It requires that your PHP server has a cryptographic function installed called MCrypt. If you attempt to utilize this feature and your PHP does not support MCrypt, the form drawing will fail and you will most likely see a blank or nearly blank page.

To change this setting, in your store Admin panel, go to Configuration > Customer Testimonials > Use reCaptcha anti-spam verification to display author email address to set the option of your choice. The choices are “Yes” to turn on the reCaptcha protection of Customer email addresses, and “No” to disable this feature.

Care should be taken to coordinate your setting of this option with who may write testimonials and who may email testimonial authors.

Default Setting (Recommended): No

Set Admin Language

This feature establishes your preferred language for administrative emails regarding Customer Testimonials. When a customer writes and submits a testimonial, the Admin is automatically notified via email. I fixed a problem in v1.0 where the admin email was localized in the customer’s language. This is not very helpful for the admin. CST v1.1 now processes these emails in the Admin’s language. The SQL setting defaults to language directory “english”, but it can be changed in the Admin panel.

To change this setting, in your store Admin panel, go to Configuration > Customer Testimonials > Set Admin Email Language to set your preferred language (use the language directory name, e.g. english). You must enter a valid directory name.

Default Setting: english

Testimonials Language Display Setting

This feature defines how Testimonials are viewed based on the viewer’s language. If your site has multiple languages, you can allow your users to view testimonials written in all languages or limit their viewing to the language they are using. For example, if your store is available in both English and Spanish, selecting the “All Languages” preference will display testimonials written in both English and Spanish. If you change this setting to “User Language Only,” then English language users will only see English testimonials, and Spanish language users will only view testimonials written in Spanish.

To change this setting, in your store Admin panel, go to Configuration > Customer Testimonials > Testimonials Language Display Setting to set your preference.

Default Setting (Recommended): User Language Only

Testimonials Default Language (Admin Edit/Create)

This feature defines the default language that viewers will see Testimonials. This setting controls the default language setting for testimonials when the admin is creating or editing testimonials. If the admin leaves out a language name, this is the setting that will be filled in by default. If the language selected by the admin is invalid, the system will automatically fill in this default language.

If the admin has changed the language settings in the store, this routine will use the new language codes. As an example, let’s imagine that a store was using language code 1 for English and this SCT setting (default language) is set to English. Later the admin changes the store’s English language code to language code 2. In this scenario, when editing testimonials, SCT will automatically update and correct any testimonials flagged as English and store the testimonials back with the (new) language code (2).

To change this setting, in your store Admin panel, go to Configuration > Customer Testimonials > Testimonials Default Language to set your preference.

Note that this value must be a language directory name and must match a language name used in your store. If this value is invalid, SCT will default your testimonials to English. When in doubt, check your /languages/ directory and look at the directory names for each language (e.g. french). These are the valid values for this setting.

Default Setting (Recommended): english

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Editing, Approving, and Disapproving Customer Testimonials

In your store Admin panel, go to Tools > Testimonial Manager to allow/edit, approve, and disapprove your customers’ testimonials. The toggle buttons work just like the standard on/off buttons throughout the osCommerce admin. If you want to turn off a specific testimonial, simply click on the red circle next to that testimonial. Click green to re-enable it.

It is also possible to edit existing testimonials independently. This is accomplished in the admin tool via Admin > Tools > Testimonial Manager.

Removing a Customer’s Image

It is possible to keep the text of the testimonial but remove the image. Go to Tools > Testimonial Manager and select an existing Customer Testimonial. Click on the Edit button in the upper right corner of the page. Upload a transparent gif of any size. Click on the Update button. Now the image will be gone. Another method would be to search for the image name that was uploaded by your customer and then remove this image from the catalog/images/testimonials folder.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

What is reCaptcha?

ReCaptcha is a security enhancement originally developed at Carnegie Mellon University that uses CAPTCHA to help digitize text books while protecting websites from spam bots attempting to access restricted websites. ReCaptcha is now owned by Google, which purchased it in September 2009. The reCaptcha contribution was originally developed for OSCommerce by olsonsp4c.

ReCaptcha differs in some ways from the traditional Captcha contributions which may also be found on the OSCommerce website. Pros versus typical Captcha implementation: pulls words from thousands of text books, making it easier for humans to type in the code (words versus random character combinations), refreshing the reCaptcha box does not refresh the entire form. If you are looking for a more typical Captcha implementation, I recommend Anti-Robot Registration 1.0 + Images.

The reCaptcha code in this mod was borrowed from olsonsp4c’s excellent reCaptcha adaptation for OSCommerce called “osC reCaptcha.” This mod uses parts of osC reCaptcha version 1.4.4, which may be found here. All credit for the reCaptcha code repository goes to Carnegie Mellon University and the project’s founders - Luis von Ahn, Ben Maurer, Colin McMillen, Mike Crawford, David Abraham, and Edison Tan. ReCaptcha was purchased by Google in September, 2009. Google now maintains the code base.

ReCaptcha may be used on other forms in your store. This mod does not include instructions on how to do so. That is beyond its scope. For information on that subject, you should examine the osC reCaptcha contribution or visit the reCaptcha website.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

ReCaptcha Admin Settings

The reCaptcha admin settings are located under a separate menu item. To find them go to Admin > Configuration > reCaptcha. You must first follow the Registering reCaptcha instructions to setup your reCaptcha keys before you enable the reCaptcha protection of your Customer Testimonial forms,

To learn more about reCaptcha, read my brief description here.

There are 4 admin settings: 2 handle the public and private keys for a normal reCaptcha challenge. The other 2 handle the public and private keys for reCaptcha’s Mailhide feature. Mailhide is reCaptcha’s tool for concealing email addresses until after a user passes the reCaptcha challenge. If you do not plan to allow any users to view the email address of Testimonial authors, then you do not need to install the Mailhide keys.

ReCaptcha How-To Guide

Make Testimonial Authors’ Email Always Visible to Anyone

To allow any user to view Testimonial authors’ email addresses, perform the following steps:

1. Set Configuration > Customer Testimonials > Who May VIEW Testimonials to All Users [Need more info?]

2. Set Configuration > Customer Testimonials > Who may send EMAIL to testimonial authors to All Users [Need more info?]

3. Set Configuration > Customer Testimonials > Use reCaptcha anti-spam verification to display author email address to No [Need more info?]

Make Testimonial Authors’ Email Visible to Anyone after reCaptcha Challenge

First, make sure you have registered reCaptcha and installed your Mailhide keys in your database. To conceal Testimonial authors’ email addresses, but allow them to be viewed after passing a reCaptcha test, perform the following steps:

1. Set Configuration > Customer Testimonials > Who May VIEW Testimonials to All Users. [Need more info?]

2. Set Configuration > Customer Testimonials > Who may send EMAIL to testimonial authors to All Users. [Need more info?]

3. Set Configuration > Customer Testimonials > Use reCaptcha anti-spam verification to display author email address to Yes. [Need more info?]

Make Testimonial Authors’ Email Visible to Registered Users after reCaptcha Challenge

To conceal Testimonial authors’ email addresses, but allow them to be viewed only by Registered (logged in) Users after passing a reCaptcha test, perform the following steps:

1. Set Configuration > Customer Testimonials > Who May VIEW Testimonials to either All Users or Registered Users Only. [Need more info?]

2. Set Configuration > Customer Testimonials > Who may send EMAIL to testimonial authors to Registered Users Only. [Need more info?]

3. Set Configuration > Customer Testimonials > Use reCaptcha anti-spam verification to display author email address to Yes. [Need more info?]

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Adding New Languages

Here are some tips that will provide you with guidance if you wish to add a new language to this contribution, especially with regard to localizing the reCaptcha code. Please note that reCaptcha only supports the following languages as of this writing: Dutch, English, French, German, Portuguese, Russian, Spanish, and Turkish. ReCaptcha will default to English if it cannot match the customer’s current language code.

To setup a new language support – just for this contribution – follow these steps:

1. Add a new language to your store per OSCommerce instructions

2. Copy these two files from /includes/languages/english, place them in your new language directory, and localize the text:

customer_testimonials.php

customer_testimonials_admin_email.php

3. If you are adding one of the supported by reCaptcha languages (identified above), modify the reCaptcha JavaScript so that it will localize the reCaptcha challenge text.

Edit customer_testimonials_write.php.

Find around line 331:

lang : '<?php if (in_array($language_id['code'] ,array('en', 'fr', 'de', 'pt', 'es'))) {echo $language_id['code']; } else {echo 'en'; } ?>',

Change: add your new language code (2 characters), like this:

lang : '<?php if (in_array($language_id['code'] ,array('en', 'fr', 'de', 'pt', 'es', ‘<NEW CODE>’))) {echo $language_id['code']; } else {echo 'en'; } ?>',

If your language code is not supported (i.e. en, nl, fr, de, pt, ru, es, tr) or if your language code does not comply with reCaptcha’s accepted codes, the customer will automatically see an English language translation of reCaptcha.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Testimonials Setup and Testing

Before you begin allowing your customers to submit testimonials, it’s a good idea to enter your own first. This will allow you to examine the relationship between image sizes (if you allow images to be uploaded), the font, text size, etc. and how it looks in your store. You should also experiment with the admin settings to see how they impact your customers’ experience with reading and writing testimonials.

Also note that your Customer Testimonial InfoBox will not display in your shop unless there is at least one testimonial, so if you don’t create one then you end up with a chicken-and-egg problem.

In version 4.0, Bill Kellum suggested that you either create a sample testimonial for your customers to follow or provide a greeting message asking your customers to upload a testimonial. I think he’s right and I encourage you to do the same.

To create a testimonial, go to your home page. Locate the Testimonials InfoBox and click the “Write a testimonial” link. [Note that you must have your admin settings properly configured first in order for this to flow smoothly.]

Next go to your Admin > Tools > Customer Testimonials and approve your testimonial. Also verify that you receive an email from your shop via the store admin’s email address informing you that a new testimonial awaits your approval.

Now, depending on how you’ve setup your SCT preferences, you may want to also create short testimonials in any other languages that your Web store supports. I strongly suggest you review all of the admin functions. They offer you a thorough array of options for controlling how testimonials are written and especially how they are displayed to your customers.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Common Problems and Troubleshooting

Customer Testimonials InfoBox Does Not Appear

1. Verify where you placed the code to call the InfoBox. Most common locations are column_left.php or column_right.php

2. Verify you have installed the SQL code

3. Verify your admin settings. The default settings (just running the included SQL file without making any changes to it first) allow only registered users (logged in) to post a testimonial. Are you logged in?

4. Go back through your install. If you got to this step, most likely you are missing a file or two.

###########

Testimonials InfoBox Visible, but Submitted Testimonials Never Appear

1. Have you approved the new testimonials from within the admin tool (Admin > Tools > Customer Testimonials)?

2. Verify your admin configuration settings (Admin > Configuration > Customer Testimonials). The default settings (just running the included SQL file without making any changes to it first) allow only registered users (logged in) to post a testimonial. Are you logged in?

3. Verify you have installed the SQL code

4. Go back through your install. If you got to this step, most likely you are missing a file or two.

###########

Blank or Nearly Blank Page

1. Check your reCaptcha settings (Admin > Configuration > reCaptcha)

2. Verify your admin configuration settings (Admin > Configuration > Customer Testimonials). The most common cause for this is when Use reCaptcha to Protect Customers’ Email Addresses is set to “Yes” but either the PHP server does not support MCrypt or the Mailhide keys are not setup properly (see reCaptcha Admin Settings).

###########

InfoBox Fails to Render and Receive an Error 1054

1. Did your InfoBox fail to draw and are you receiving an error message in its place similar to the following?

1054 - Unknown column 'language_id' in 'where clause'
select * FROM customer_testimonials WHERE status = 1 AND language_id = 1 ORDER BY rand() LIMIT 5
[TEP STOP]

2. This is caused by upgrading and running the wrong SQL file. Run the SQL file entitled, “testimonials_v5_upgrade” and located in the “Scrolling Customer Testimonials v1.1\upgrade_v5.x” directory. This should resolve your problem.

###########

Error While Running SQL Script

If you are running the SQL script, “testimonials_v5_upgrade” and experience an error similar to the one listed below, you have already previously run the Upgrade SQL file. If you feel that you need to re-run an SQL file for Customer Testimonials, run the “scrolling_testimonials_v1.1” SQL script instead (located in the “New Install” directory).

Error

SQL query:

# Table structure for table `customer_testimonials` v1.1 (Upgrade Version)

# by Richard Cranium

# 15 November 2009

# Add language_id to the customers_testimonials table

# Set default language (id=1)

ALTER TABLE `customer_testimonials` ADD `language_id` INT( 11 ) NOT NULL DEFAULT '1';

MySQL said: Documentation

#1060 - Duplicate column name 'language_id'

###########

Invalid Security Code Error Message (reCaptcha)

Are your users receiving the following error message when they attempt to perform an action which requires a reCaptcha security code authentication (such as writing a testimonial)? This problem will manifest itself with an error message such as:

Security Code: Invalid public key. Make sure you copy and pasted it correctly.

The problem is you have erased (or not installed) your reCaptcha public and/or private keys. In your Admin panel, go to Admin > Configuration > reCaptcha and enter your keys. If your keys are present, go to the reCaptcha website and get new keys. The most common cause of this problem is updating your database settings with one of the included SQL files. These SQL scripts will reset your reCaptcha keys.

###########

Error Message When Trying to View Testimonial Author Email Address (reCaptcha)

This is normal behavior and not an error. If you allow any set of testimonial viewers to see a testimonial author’s email address, AND you have enabled the reCaptcha function to screen this access and prevent bots from harvesting your customers’ emails, you MUST have PHP MCrypt routines installed on your PHP server. If you do not, your customers will see an error message when they attempt to view the testimonial.

When this function is setup properly, upon clicking a link to show an author’s email address, a small, separate window will open (should still work even if the user has popups blocked or turned off in their browser) and prompt them with a reCaptcha challenge. If they pass the challenge, they will be able to view the author’s email address.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Change Log

SCT v1.11a by Richard Cranium (this release)

Released 23 February, 2010

Updated from SCT v1.1

------------------------------

* New Features:

· None

* Bug Fixes:

· Corrected handling of admin setting to control maximum number of scrolled/displayed testimonials.

-------------------------------------------------------------

SCT v1.11 by Richard Cranium

Released 8 December, 2009

Updated from SCT v1.1

------------------------------

* New Features:

· None

* Bug Fixes:

· Corrected one misnamed variable in /includes/boxes/customer_testimonials.php

· Fixed bug where InfoBox would be empty if admin set display of testimonials to user’s language only and there were no matching testimonials (now properly displays a message and Write a Testimonial link if applicable based on other admin settings)

* Other:

· Improved French translation (Thanks to Hexa)

· Cleaned up T.O.C. in these instructions

· Removed manual file appendix (sorry, but I do not have the time to go through these with every change… time is short enough and these steps seemed moot to nearly everyone… therefore, removed)

-------------------------------------------------------------

SCT v1.1 by Richard Cranium

Released 19 November, 2009

Update from SCT v1.0

------------------------------

* Bug Fixes:

1. Language code was always set to English instead of testimonial author’s language.

2. Author emails do not display. No Captcha either. Could this be if MailHide is on but there's no reCaptcha Mailhide key???

3. When no testimonials are present, duplicate "write testimonial" line appears in column right/left beneath SCT InfoBox.

4. Testimonial email notification to Admin localized in testimonial author’s language (incorrect) instead of Admin’s preferred language (correct). New SQL line added to store admin email language preference. Instructions updated.

5. Incorrect directory name spelling for Portuguese language directory under the New Install path.

6. Split admin language files in two. Isolated Admin text messages to support related bug fix. Updated documentation.

* New Features:

1. Added Admin setting to control displaying testimonials based on viewer’s language (setting on your Website). Choices: 1) ALL testimonials (i.e. does not restrict, displays all testimonials); OR 2) shows only localized testimonials (default setting).

2. Added default Viewer language setting. If SCT cannot determine what language a testimonial was written in, it will automatically change it to your default viewer language. This also works when the admin edits a testimonial.

3. Added Language to testimonial details (viewed and editable by admin only).

4. Documented default Admin Email language selection under Admin “How-to” section.

5. Added instructions on how to localize reCaptcha for other languages.

6. Added instructions describing how to change default language for written testimonials.

* Other:

· Changed ‘languages_id’ SQL column from INT to TINYINT

-------------------------------------------------------------

SCT v1.0 by Richard Cranium

Released 12 November, 2009

Added or modified from CT v5.1

-------------------------------

* Modified routine that sends email to admin when a testimonial is posted, so that email is sent from admin mailbox. Why? Old method used testimonial writer's email address. Problem with this approach is that Admin's spam filter may catch the email and prevent timely notification to admin. This change is optional. Do not change the code if you don't want to change this feature (see instructions above).

* Added language id to testimonials, to allow localized viewing of testimonials (i.e. you only see what matches your language)

* Moved admin functions from Configuration >/ Images to its own menu under Configuration > Customer Testimonials

* ReCaptcha admin functions (set public / private keys) have a separate admin area. Why? ReCaptcha code can be used elsewhere on your website. Its use is not limited to Customer Testimonials.

* Created option for scrolling testimonials inside the InfoBox

* CT InfoBox now only appears on non-SSL pages. This prevents a problem where the user can receive a SSL warning from their Web browser that not all of the elements on the page are secure. It also removes the CT box from parts of your store where it is not needed, such as the Checkout process and Account pages.

* Created the following new admin options:

* Enable/Disable Customer Testimonials module ("kill switch")

* Enable/Disable customer image uploads as part of testimonials

* Enable/Disable ability to send email to the testimonial author

* Limit who can view testimonial author email addresses

* Limit Testimonial viewing to registered users

* Limit Testimonial writing to registered users

* Enable/Disable reCaptcha function on testimonial forms

* Enable/Disable reCaptcha to protect testimonial author's email address

* Enable/Disable scrolling testimonials

* Various settings to control scrolling features

-------------------------------------------------------------

V5.0 and v5.1 by escri1

Not provided by authors.

-------------------------------------------------------------

v4.0 by Bill Kellum of Sounds Good Productions

Since v3.62

-------------------------------------------------------------

* Added the option of allowing the customer to upload an image as well as text to the testimonial.

* Added the image fields to the customer testimonial database.

* Added the image setting in the Admin | Configuration | Images table.

* Added the image upload button.

* Added screenshots of the new features of v.4.0

* Added a "How it works" section to the Instructions text.

* Streamlined the installation by adding the modified files for an easy code merge using a file comparison tool such as Beyond Compare.

* Modified the installation instructions for New Installations as well as Upgrades from the previous version.

* Added a Support Thread link to the Instructions

Since v3.6

----------

* Added two versions of catalog/includes/modules/customer_testimonials.php for those concerned about email harvesters

Since v3.5(1)

-------------

* Added further multi-lingual support in all areas

* Added email validation to the catalog and the admin

* Added date added field in the catalog

* Added language defines in catalog/includes/languages/english.php

* Added admin link in testimony submission email

* Removed unnecessary case in catalog

* Removed erroneous language defines

* HTML fixes in both the catalog and the admin

* Adjusted the admin language defines for consistency

* Rewrote code in catalog/customer_testimonials_write.php to make this add-on compatible with my reCaptcha add-on

* Rewrote code in catalog/includes/modules/customer_testimonials.php significantly

* Added screenshots to save bandwidth

* Added a new button in the catalog

* Fixed button define in customer_testomonials.php

Since v3.2

----------

* Modified the SQL to do away with URL and instead use email address

* Modified the catalog InfoBox formatting a little bit

* Modified the layout of the catalog files and functionality

* Added a new button to the catalog and updated all other buttons added by this add-on

* Altogether rewrote error message logic to be consistent with osC standards in the catalog

* Fixed the success page bug so that it redirects to the success page properly

* Fixed the module email address bug, now "mailto:" is automatically added to email addresses

* Fixed the update issue in the Admin where it changed from Update to Insert

* Fixed the update issue in the Admin where it would not append updated info to the database properly

* Added a bunch of language defines that weren't there

* Integrated the email message mod into the base code

* Removed ALOT of superfluous code that had crept into the add-on

* Many, many, many other small things and some larger ones :)