Testimonial Manager Support Thread

[countrycharm]

Ok so what about the sql patch? The 139 folder has an upgrade folder with a upgrade_testimonial_manager.sql file in it... there is no upgrade sql file in the 150 folder. What do I do? Run the install patch? Run the 139 upgrade patch? I really think this would have been a much better release if it was consistent between the two ZC versions. It's very confusing when you read a file telling you to open a file that doesn't exist, for example.

This is all in the folder zen_1.5.0.
7) Run the included install_testimonials_manager 1.3.x_Upgrade.sql using the Zen-Cart Sql Patches tool
(admin -> tools -> install sql patches) For best results, copy-and-paste the code into the query field and press 'Send'.

[WebKat]

The part that made this whole thing frustrating was the readme in the main folder of the unzipped file:

INSTALLATION:

See the install text depending on what version you are installing:

install.txt
upgrade.txt
uninstall.txt

This should be made more clear, since it is NOT the correct directions for 1.5.0.

And the bit you just quoted is for upgrading ZEN CART from 1.3x to 1.5.0, right? If not it's confusingly worded. I've never used ZC 1.3.x; I started out my whole Zen Cart odyssey with ZC 1.5.0--so in my case, what file do I run? If this is the one I'm supposed to run it's badly named: install_testimonials_manager new_install.sql since this is not a new install--I already have Testimonial Manager installed. On 1.5.0.

Actually, I can't even find that file anywhere. I found a 1.3.x_Upgrade.sql (which sounds wrong since I'm not, and never have been, on 1.3.x) and new_install.sql (which sounds wrong, since it's not a new install). So the instructions are not clear at ALL about how to upggrade Testimonial Manager under a ZC 1.5.0 installation. The directions in the 1.3.9 folder may be clearer, but they don't apply to me so that doesn't matter much.

[DivaVocals]

See if these install instructions help:

Notes:

1. BACKUP THE DATABASE BEFORE INSTALLING!!!
2. You should test this on TEST SITE before going live
3. Two files were added to make this work on zen cart 1.5.
   
   • admin/includes/extra_datafiles/testimonials_manager.php
   • admin/includes/languages/english/extra_definitions/testimonials_manager.ph
   
   

New Install Instructions

1. Unzip the contribution.
2. Open the New_installation folder
3. Before uploading change the YOUR_TEMPLATE folders to match the name of your custom template.
   
   • includes/languages/english/extra_definitions/YOUR_TEMPLATE
   • includes/languages/english/YOUR_TEMPLATE
   • includes/languages/english/html_includes/YOUR_TEMPLATE
   • includes/modules/sideboxes/YOUR_TEMPLATE
   • includes/templates/YOUR_TEMPLATE
   • (The files are arranged in the same structure as Zen Cart so you can FTP the admin, images and includes folders to your server.)
   
   
4. Login in to your admin panel admin -> tools -> layout boxes contoller and activate the new sidebox.
5. Run the included new_install.sql using the Zen-Cart Sql Patches tool (admin -> tools -> install sql patches).

Upgrading Testimonial Manager from 1.3x compatible version to v1.5.0 ready version

1. If you are upgrading from an older Zen Cart v1.3.x compatible version of Testimonial Manager run the included 1.3.x_Upgrade.sql using the Zen-Cart Sql Patches tool (admin -> tools -> install sql patches)
   
   For best results, copy-and-paste the code into the query field and press 'Send'.
2. Delete the files in admin/includes/boxes/extra_boxes/ (these files are now are obsolete and should be deleted in their entirety!!)

[WebKat]

Ok so the difference is that the previous Testimonials Manager was for 1.3.9 and the new one is for 1.5.0, and that is the upgrade they're referring to? That makes sense written out that way, but is not clear at all in the text file that came in the zip for the new version. Those instructions made it look like this is what you should do if you're upgrading ZC from 1.3.x to 1.5.0.

I hope I'm not coming across as cranky or anything (I'm not cranky, I promise!)--I am legitimately trying to help make the upgrade package more user-friendly which will lead to fewer people coming to the support thread asking questions, and less time for the developers to spend answering them. I have some suggestions for how to make this package better and confusion-proof.

Basically I recommend this:

The zen_1.3.9 folder is very well laid out:

Folder structure:

/new_installation

/admin
/images
/includes
install_testimonials_manager.sql

/upgrade

/admin
/images
/includes
upgrade_testimonial_manager.sql

install.sql
install.txt
uninstall.sql
uninstall.txt
upgrade.txt

That is so clear and unconfusing. The filenames are intuitive and it's obvious what they mean/do. There is a separate folder for install and upgrade (even though they likely have many duplicate files). This is a well put together package.

The zen_1.5.0 folder, on the other hand, is much less organized and more confusing:

Folder structure:

/admin
/images
/includes
1.3.x_Upgrade.sql
install.txt
new_install.sql
uninstall.sql
uninstall.txt

• The upgrade instructions are buried in a rather muddy way within the install instructions file--nonintuitive.
• The sql patch looks like it's for a different ZC version--nonintuitive.
• There is no obvious breakdown of which files need to be uploaded for an upgrade (probably some subset of the total new install files); a separate folder like the 1.3.9 folder would solve this cleanly. Putting the upgrade sql patch in that folder would make things much clearer as well.
• install.txt includes the instruction: "3) Run the included install_testimonials_manager new_install.sql using the Zen-Cart Sql Patches tool (admin -> tools -> install sql patches) for New Installs" yet there is no file with that name in the zipped package--erroneous text.
• Step 4 prefix "Upgrading from 1.3x to zen cart v1.5.0" is unclear--it should be reworded to make it clear that it's referring to the module compatibility version, not to your ZC install version--unclear.
• I'd rename "1.3.x_Upgrade.sql" to just "upgrade.sql" or "1-5-3c-upgrade.sql" or similar for clarity.

Sorry to be so long-winded, I just wanted to be extremely clear about what I am recommending be changed. If the package were set up the way I describe, I would not have needed to ask *any* questions in this thread, and would have been able to simply upgrade my module on my own, confident that I had done it correctly. I hope my advice is taken in the spirit in which it is offered and not as a slam of any kind.

If the package were reorganized using the 1.3.9 folder as a model for the 1.5.0 folder, and the instructions were broken down into install vs upgrade, etc--the changes I've suggested--and then upload that newly reorganized zip to the addons page, I bet you will experience many fewer support questions in this thread, and fewer frustrated users (it's always frustrating when you have to wait for your support question to be answered, in the meantime you can't proceed with your install/upgrade). Between the changes I've suggested and making the clarifications that the previous post made, this would be a much stronger release.

I apologize if this has sounded overly critical--it's just that I'm trying to be clear. When you've written instructions yourself, they always make sense to you. It's hard to gauge how a 3rd party will do with them until one tells you. You've gone 50% of the way with the well-organized 1.3.9 folder. Take it the rest of the way and organize the 1.5.0 folder just as well and you'll be golden. It's a great module--I have it installed on two different sites and really like it.

[WebKat]

By the way, I hope it isn't considered bad form, but if you don't want your customers' last names to show up on their testimonials (privacy issues) you can follow these edits that I made to my installation which makes it just show the first name:

File to edit:
/includes/modules/pages/testimonials_add/header_php.php

Replace the default code to this new code; line numbers may be approximate--make sure the one you're replacing is very similar to the replacement code:

Line 126

$account_query = "select customers_firstname, customers_email_address

Line 132

$extra_info=email_collect_extra_info($name,$email_address, $account->fields['customers_firstname'] . ' ' . $account->fields[''] , $account->fields['customers_email_address'] );

Line 150

$sql = "SELECT c.customers_id, c.customers_firstname, c.customers_email_address, c.customers_default_address_id, c.customers_telephone, ab.customers_id, ab.entry_street_address, ab.entry_company, ab.entry_city, ab.entry_postcode, ab.entry_zone_id, ab.entry_country_id, z.zone_id, z.zone_code, cn.countries_id, cn.countries_name FROM " . TABLE_CUSTOMERS . " c, " . TABLE_ADDRESS_BOOK . " ab, "  . TABLE_ZONES  . " z, " . TABLE_COUNTRIES . " cn WHERE c.customers_id = :customersID AND ab.customers_id = :customersID AND ab.entry_country_id = cn.countries_id";

Line 155

$testimonials_name = $check_customer->fields['customers_firstname'] . ' ' . $check_customer->fields[''];

That should do it. It should never call their last name in the first place, so you don't need to "hide" it in the displayed testimonial, since that bit of information isn't there to begin with.

[DivaVocals]

And if you look JUST ABOVE your post I re-wrote the instructions to help make it clear what to do.. DO THEY make more sense to you?? (that would help the current author who is doing this in their FREE TIME)

or

Since you seem to have some very good and strong ideas here, how about contributing to the community by making the very changes you suggest including re-writing the readme instructions.. My first Zen Cart contributions were more about a reorganization of the files and a re-write of the readme files and less about upgrades and improvements.. why not make these changes you suggest and re-submit this add-on??

Ok so the difference is that the previous Testimonials Manager was for 1.3.9 and the new one is for 1.5.0, and that is the upgrade they're referring to? That makes sense written out that way, but is not clear at all in the text file that came in the zip for the new version. Those instructions made it look like this is what you should do if you're upgrading ZC from 1.3.x to 1.5.0.

I hope I'm not coming across as cranky or anything (I'm not cranky, I promise!)--I am legitimately trying to help make the upgrade package more user-friendly which will lead to fewer people coming to the support thread asking questions, and less time for the developers to spend answering them. I have some suggestions for how to make this package better and confusion-proof.

Basically I recommend this:

The zen_1.3.9 folder is very well laid out:



That is so clear and unconfusing. The filenames are intuitive and it's obvious what they mean/do. There is a separate folder for install and upgrade (even though they likely have many duplicate files). This is a well put together package.

The zen_1.5.0 folder, on the other hand, is much less organized and more confusing:

• The upgrade instructions are buried in a rather muddy way within the install instructions file--nonintuitive.
• The sql patch looks like it's for a different ZC version--nonintuitive.
• There is no obvious breakdown of which files need to be uploaded for an upgrade (probably some subset of the total new install files); a separate folder like the 1.3.9 folder would solve this cleanly. Putting the upgrade sql patch in that folder would make things much clearer as well.
• install.txt includes the instruction: "3) Run the included install_testimonials_manager new_install.sql using the Zen-Cart Sql Patches tool (admin -> tools -> install sql patches) for New Installs" yet there is no file with that name in the zipped package--erroneous text.
• Step 4 prefix "Upgrading from 1.3x to zen cart v1.5.0" is unclear--it should be reworded to make it clear that it's referring to the module compatibility version, not to your ZC install version--unclear.
• I'd rename "1.3.x_Upgrade.sql" to just "upgrade.sql" or "1-5-3c-upgrade.sql" or similar for clarity.

Sorry to be so long-winded, I just wanted to be extremely clear about what I am recommending be changed. If the package were set up the way I describe, I would not have needed to ask *any* questions in this thread, and would have been able to simply upgrade my module on my own, confident that I had done it correctly. I hope my advice is taken in the spirit in which it is offered and not as a slam of any kind.

If the package were reorganized using the 1.3.9 folder as a model for the 1.5.0 folder, and the instructions were broken down into install vs upgrade, etc--the changes I've suggested--and then upload that newly reorganized zip to the addons page, I bet you will experience many fewer support questions in this thread, and fewer frustrated users (it's always frustrating when you have to wait for your support question to be answered, in the meantime you can't proceed with your install/upgrade). Between the changes I've suggested and making the clarifications that the previous post made, this would be a much stronger release.

I apologize if this has sounded overly critical--it's just that I'm trying to be clear. When you've written instructions yourself, they always make sense to you. It's hard to gauge how a 3rd party will do with them until one tells you. You've gone 50% of the way with the well-organized 1.3.9 folder. Take it the rest of the way and organize the 1.5.0 folder just as well and you'll be golden. It's a great module--I have it installed on two different sites and really like it.

[WebKat]

And if you look JUST ABOVE your post I re-wrote the instructions to help make it clear what to do.. DO THEY make more sense to you?? (that would help the current author who is doing this in their FREE TIME)

Yes, I know--I acknowledged that and pointed out that your instructions were far easier to follow, and suggested that they change the instructions to be more like yours. Don't know why you're getting all worked up. I specifically said that with those instructions and better folder structure I'd have had no questions at all about the upgrade.

or

Since you seem to have some very good and strong ideas here, how about contributing to the community by making the very changes you suggest including re-writing the readme instructions.. My first Zen Cart contributions were more about a reorganization of the files and a re-write of the readme files and less about upgrades and improvements.. why not make these changes you suggest and re-submit this add-on??

...is that kosher? I mean that seems like it could be stepping on some toes. Also, I don't have enough information. For example, I don't know which files need to be uploaded for upgrading and which can be left as the old versions.

[DivaVocals]

Yes, I know--I acknowledged that and pointed out that your instructions were far easier to follow, and suggested that they change the instructions to be more like yours. Don't know why you're getting all worked up. I specifically said that with those instructions and better folder structure I'd have had no questions at all about the upgrade.

Worked up?? Really?? that's what you got out of my post??? I always FAIL to understand how folks read emotions and sentiments into posts that JUST AREN'T there.. I just asked you a question because honestly in that long post you wrote I didn't see anything that looked like you had seen what I wrote.. (which is why I asked the question..) But okay.. thanks for the response..

...is that kosher? I mean that seems like it could be stepping on some toes.

It's open source.. which means it's OPEN to anyone who wants to volunteer to contribute.. Now if you want to make sure you're not stepping on anyone's toes you can approach it one of two ways..

1. Contact the author and offer to help by implementing the suggestions you made. You guys can coordinate how you will work together..
   
   
   OR
   
   
   
2. post a message to the current author in the support thread of your desire/intent to make the changes you suggest.. Then again you guys can coordinate and decide how you will work together..

This is PRECISELY how I got started submitting updates to add-ons.. I offered publicly to help the person who was re-writing IH2 to be PHP 5.3 compatible. I offered to take on re-writing the user documents and reorganizing the installation files. It's how the current "team" of folks working on IH4 got together..

So YES you sure can do this!

Also, I don't have enough information. For example, I don't know which files need to be uploaded for upgrading and which can be left as the old versions.

I thought this was made clear in the sample instructions I posted.. Are you saying it's NOT??

Either way if you decide to contact the current author, you can work on this TOGETHER..

[countrycharm]

Worked up?? Really?? that's what you got out of my post??? I always FAIL to understand how folks read emotions and sentiments into posts that JUST AREN'T there.. I just asked you a question because honestly in that long post you wrote I didn't see anything that looked like you had seen what I wrote.. (which is why I asked the question..) But okay.. thanks for the response..


It's open source.. which means it's OPEN to anyone who wants to volunteer to contribute.. Now if you want to make sure you're not stepping on anyone's toes you can approach it one of two ways..

1. Contact the author and offer to help by implementing the suggestions you made. You guys can coordinate how you will work together..
   
   
   OR
   
   
   
2. post a message to the current author in the support thread of your desire/intent to make the changes you suggest.. Then again you guys can coordinate and decide how you will work together..

This is PRECISELY how I got started submitting updates to add-ons.. I offered publicly to help the person who was re-writing IH2 to be PHP 5.3 compatible. I offered to take on re-writing the user documents and reorganizing the installation files. It's how the current "team" of folks working on IH4 got together..

So YES you sure can do this!

I thought this was made clear in the sample instructions I posted.. Are you saying it's NOT??

Either way if you decide to contact the current author, you can work on this TOGETHER..

I will take what WebKat said into consideration. The install.txt could be bettered outline. to a upgrade.txt. Thanks Diva for that.

I've never used ZC 1.3.x; I started out my whole Zen Cart odyssey with ZC 1.5.0--so in my case, what file do I run? If this is the one I'm supposed to run it's badly named: install_testimonials_manager new_install.sql since this is not a new install--I already have Testimonial Manager installed. On 1.5.0.

If you where already on a zen cart v1.5.0 and had Testimonials Manager installed why are you trying to install it again? That is what doesn't make since.

[WebKat]

If you where already on a zen cart v1.5.0 and had Testimonials Manager installed why are you trying to install it again? That is what doesn't make since.

Because it was a newer version, I figured some things had changed.