Custom Option Description for Magento

version 1.0.0

• created: 02/12/2014
• latest update: 02/26/2014
• by: Solide Webservices
• email: contact@solidewebservices.com

This extension adds a description field to custom product options which allows you to add extra information about the custom option.

This is the installation and user manual for the Custom Option Description extension created by Solide Webservices. Although great care has been taken to ensure the accuracy and completeness of this manual, Solide Webservices is unable to accept any legal responsibility concerning errors or ommisions in this document.

You are not allowed to copy or edit the content or the layout of this document. If you would like to redistribute the content of this document please contact Solide Webservices through email: contact@solidewebservices.com

The zip package you have downloaded from the webshop of Solide Webservices contains this manual and a .tzg file. This .tzg file will be used to install the extension from the Magento backend.

System Requirements

• Magento version 1.4.x or higher
• PHP version 5.2.0 or higher

Installation through Magento Connect

With these steps you will be able to install the Custom Option Description extension in your webshop.

1. Extract the .tzg file from the zip file you have downloaded from the webshop from Solide Webservices.
2. Go to http://www.yourdomain.com/downloader/ where yourdomain.com is the URL where your Magento installation is located and log into your Magento Connect Manager with your admin credentials. If you have a previous version of the Custom Option Description extension installed and you are upgrading to a newer version please follow the de-installation steps from the next chapter first. This will remove the old extension files but wil keep your data intact.
3. Select the .tzg file you have extracted in step one in the browse field under the option “Direct package file upload” as shown below and then click the upload button.
4. Wait until the upload and installation process is finished and click the refresh button below the command line textarea afterwards.
5. Go the http://www.yourdomain.com/admin/ where yourdomain.com is the URL where your
   Magento installation is located. If you are already logged in to the backend please log out and login
   again as this will prevent you from getting a 404 error on the extension pages due to permissions that have not been set for the logged in user. After logging in again please refresh your cache settings under "System > Cache Management". This is necessary to avoid any caching problems after the installation of an extension. The installation or upgrade is now completed. If you are upgrading dont forget to re-enable the extension under "System > Configuration > Advanced". You can view the description field for custom options under the custom options tab when adding or editing a custom option of a product.

Deinstallation through Magento Connect

With these steps you will be able to remove the Custom Option Description extension from your webshop. These steps are also needed when upgrading to a newer version.

1. Disable the extension under "System > Configuration > Advanced". On this page you will find the Custom Option Description extension and you can disable it.
2. Go to http://www.yourdomain.com/downloader/ where yourdomain.com is the URL where your Magento installation is located and log into your Magento Connect Manager with your admin credentials.
3.  Scroll down to the list of existing extensions and select the "Uninstall" option next to the Custom Option Description extension as shown below. Then click the "Commit Changes" button at the end
   of the list.
4. Click the refresh button after the de-installation process has finished. The Custom Option Description extension is now uninstalled. In case you are upgrading you can continue the steps in the previous chapter.

After you have installed the extension you can start adding descriptions to the custom options of products in your store. Go to "Catalog > Manage Products" and select the product where you wish to add a description to the custom option.

1. After selecting a product click on the "Custom Options" tab from the left menu.
2. Click on the "Add New Option" button and add a custom option as desired.
3. Add the description you want to show below the custom option on the product page

In this section you will find answer to common issues.

This is a common issue when installing Magento extensions. It is caused because the permission for using the new extension havent been set for the currently logged in admin user. The solution is to logout and login again in the admin backend.

For the description to show edits have to be made to the frontend templates. In the installation package of the extension 4 edited template files where included and added to the location /design/frontend/default/default/template/catalog/product/view/options/type/. If your descriptions arent showing you most likely have customized versions of these template files in your own theme which override the edits of this extension. You can fix this by adding the following code to your customized template files.

		<?php if ($_option->getDescription()): ?>
			<div class="option-description">
				<?php echo $_option->getDescription() ?>
			</div>
		<?php endif; ?>