Javascript Infobox

What does this contribution do & some history...

A recent project I was working on led me to using overLIB javascript info boxes and I felt it would be an excellent tool to have a means of customizing the boxes via the osC admin panel.

I created a complete back end and the necessary code to process the data and create the info box. After consulting with Bobby (Chemo) on a few things we felt it would be an excellent contribution for the osCommerce community. To enhance the performance Bobby converted the front end code to an extremely powerful class.

So not only have we incorporated many of the oveLIB options we have added some robust implementation options. The JS InfoBox can be called by:

A. If you want to replace a single instance of a word or phrase you can wrap the Find with HTML comment tags like:

        

    B. Using the Find and Replace feature. When using this method the script will replace any instance (in specified areas) of the word or phrase with the replace data and call the function.

    C. Manually insert javascript. This option is mainly for pages that do not support the F/R function.

How do I install this contribution?

STEP 1 - Upload the included files

The files should be located in the upload directory of this contribution. You may have to create some folders depending on your osC build.

admin/js_infobox_code.php should be uploaded to your *catalog*/admin/ directory

admin/js_infobox_manager.php should be uploaded to your *catalog*/admin/ directory

admin/includes/select_color.php should be uploaded to your *catalog*/admin/includes/ directory

admin/includes/javascript/overlib.js should be uploaded to your *catalog*/admin/includes/javascript/ directory

admin/includes/reset_meta_cache.php should be uploaded to your *catalog*/admin/includes/ directory

admin/images/icons/color.gif should be uploaded to your *catalog*/admin/images/icons/ directory

admin/images/icons/help.gif should be uploaded to your *catalog*/admin/images/icons/ directory

includes/classes/jsib.class.php should be uploaded to your *catalog*/includes/ directory

includes/includes/javascript/overlib/overlib.js should be uploaded to your *catalog*/includes/javascript/overlib/ directory

includes/includes/javascript/overlib/overlib_shadow.js should be uploaded to your *catalog*/includes/javascript/overlib/ directory

includes/includes/javascript/overlib/overlib_centerpopup.jss should be uploaded to your *catalog*/includes/javascript/overlib/ directory

STEP 2 - Edit admin/includes/boxes/catalog.php

Find this code:
'<a href="' . tep_href_link(FILENAME_PRODUCTS_EXPECTED, '', 'NONSSL') . '" class="menuBoxContentLink">' . BOX_CATALOG_PRODUCTS_EXPECTED . '</a>'
Replace with this:
'<a href="' . tep_href_link(FILENAME_PRODUCTS_EXPECTED, '', 'NONSSL') . '" class="menuBoxContentLink">' . BOX_CATALOG_PRODUCTS_EXPECTED . '</a><br>'. '<a href="' . tep_href_link('js_infobox_manager.php', '', 'NONSSL') . '" class="menuBoxContentLink">' . 'JS InfoBox Manager' . '</a>'

STEP 3 - Edit includes/application_top.php

Add before last ?> on the page:

# JSIB --------------------------------------# if (JS_INFOBOX=='true') { include('includes/classes/jsib.class.php'); $jsinfobox = new jsib; } #--------------------------------------------#

STEP 4 - Edit includes/footer.php

Find this code:
echo FOOTER_TEXT_BODY
Add this code ABOVE it:

# JSIB ------------------# if (JS_INFOBOX=='true') { $jsinfobox->init_js(); } #------------------------#

STEP 5 - Edit product_info.php

Find this code:
echo stripslashes($product_info['products_description']);
Replace this code with:

# JSIB ----------------------------------------------------------# if (JS_INFOBOX=='true') { echo $jsinfobox->convert(stripslashes($product_info['products_description'])) . "\n"; }else{ echo stripslashes($product_info['products_description']); } #----------------------------------------------------------------#

STEP 4 (optional) - Edit index.php

If you are using category descriptions -> Find this code:
echo $category['categories_description'];
Replace this code with:

# JSIB ----------------------------------------------------------# if (JS_INFOBOX=='true') { echo $jsinfobox->convert($category['categories_description']) . "\n"; }else{ echo $category['categories_description']; } #----------------------------------------------------------------#

STEP 5 (optional) - Edit dynamic content page(s)

If you have a contribution installed like Information Pages Unlimited or a FAQDesk or NewsDesk you can apply the JS InfoBox tools to the content that is drawn form the database. We ar showing you one example of how to implement this in the Information Pages Unlimited contribution.

Find this code (information.php):
echo $INFO_DESCRIPTION;
Replace this code with:

# JSIB ----------------------------------------------------------# if (JS_INFOBOX=='true') { echo $jsinfobox->convert($INFO_DESCRIPTION) . "\n"; }else{ echo $INFO_DESCRIPTION; } #----------------------------------------------------------------#

STEP 6 - Configure basic parameters

Go to admin/js_infobox_manager.php and follow on screen instructions. After the installation is completed go to the Configuration settings and set up JS InfoBox for your store.

Support

Because of the development time and the wide range of customizing that can be done we will be primarily offer commercial support only for this contribution. There is an osCommerce support thread for public support but the authors will only be offering support there as time permits.

If you need custom help or priority help please contact one of the authors (Chris LaRocque (clarocque) & Bobby Easland (Chemo) or go to our commercial support site at: http://forum.oscommerce-freelancers.com.

Documentation on the InfoBoxes can be found at: overLIB

Javascript InfoBox for osCommerce-MS2