Products Specifications User's Manual
Contents
1. Left scrolls the images to the left and then stops Backandforth scrolls right until the end then reverses and scrolls left continuously Endlessloopright scrolls right and loops back to the beginning when it hits the end This is the default Endlessloopleft scrolls left and loops back to the beginning when it reaces the end Visible Hotspots This controls whether the hotspots control arrows show blank never shows the controls Not recommended Onstart shows the controls for a specified time when the page loads then hides them See Hotspots Visible Time Always shows the controls This is the default Hotspots Visible Time The time in seconds that the controls are shown Requites Visible Hotspots set to onstart The default value is 5 but is not used since Visible Hotspots is set to always Modular Front Page 15 Auto Scroll Step The number of pixels that each image moves per step in automatic scrolling mode Keep this low for smooth scrolling This setting combined with Auto Scroll Interval controls how fast the automatic scrolling runs The default value is 1 Auto Scroll Interval The time in milliseconds between automatic scrolling steps This setting combined with Auto Scroll Step controls how fast the automatic scrolling runs The default value is 10 Manual Scroll Step The number of pixels that each image moves per step in manual scrolling mode mouse cursor is over one of the control2. A 5 Scroller The scroller uses a helper file located in Catalog ext modules front_page scroller jquery smoothDivScroll 1 1 min js This is the Javascript library that along with the jQuery and jQuery UI scripts provides the basic functions of the scroller If you need to make changes to the javascript use the jquery smoothDivScroll 1 1 js version that is also included in the same directory You may also want to make changes to the stylesheet The styles are included in catalog includes modules front_page scroller php Don t change the PHP constants in the styles or the associated Admin functions will stop working More documentation on using the scroller script can be found at http www maaki com Modular Front Page
3. Order Enter a number to set the position on the page where you want this module to appear Important The sort order will be random if even one of these modules has a sort order of 0 You must enter a number here to control the order in which the modules appear Fade Time The time it takes for one banner to fade into another 1000 1 second The default is 500 half a second Hold Time The time each banner is shown 1000 1 second The default is 4000 four seconds Banner Order The order in which the banners are shown The default is banners_id which shows the banners in the order in which they were installed in the Banner Manager The other option is rand random e Banner Rotator Group The name of the banner group to select images from This must match the group selected in the Banner manager e Banner Rotator Max Banners The maximum number of banners the rotator will show This can be used to show a random selection from a larger group of banners by setting the Banner Order to rand and this value to a smaller number than the number of images This module uses two helper files in addition to the regular module files See Appendix A for information on changing these files 3 2 2 Categories Images Categories Images provides a graphical navigation tool for your top level categories The image is the same as the image you seleted for that category s listing page The image and the category name are optional and can be
4. a sufficient demand for your change If you re the only person who wants this you re still free to make those changes yourself or to pay someone else to do it for you Modular Front Page 2 0 INSTALLATION 2 INSTALLATION 2 1 Backup Backup your database and your files Backup to a different computer than your store runs on Do it now Continue doing this throughout the life of your store Yes it s that critically important 2 2 Files 2 2 1 Add New Files Upload the files listed under New Files below to your store keeping the directory structure the same as the installed copy of your store Note that some of the directories listed do not exist in a stock copy of osCommerce and will need to be created Note If you are starting with an unmodified copy of osCommerce 2 3 you can simply upload all of the New and Modified files in the Catalog directory of this Distribution to your site copying over any existing files You can now skip to the Configuration section of these instructions For the rest of you read on 2 2 2 Modify Files Modify the file listed in 2 2 4 There is a single block of changes near the bottom of the file For modifying files recommend a good file comparison utility such as Beyond Compare WinMerge or Meld There are free open source products available for your computer Use your favorite search engine to find one of these programs and use it to make these changes The changes to the existing file in t
5. arrows Keep this low for smooth scrolling This setting combined with Manual Scroll Interval controls how fast the manual scrolling runs The default value is 5 Manual Scroll Interval The time in milliseconds between manual scrolling steps This setting combined with Auto Scroll Step controls how fast the manual scrolling runs The default value is 15 Mouse Down Speed This controls the speed multiplier activated by clicking on one of the control arrows One is no change two is twice as fast etc The default value is 3 Max Products The maximum number of products to show in the scroller If the number of products selected is less than this only that number will be shown Note The scroller will not run if there are not more than enough images to fill it The default value is 20 Products Shown This controls the selection of product images shown All shows all products Not recommended for large stores This is the default Specials shows your store s current specials New shows the newest products Featured shows the products that you select in the Scroller Product pulldowns below Products Order This controls the order the images are shown in Random shows a random selection This is the default Date added shows products in order that they were added to your store newest first Last modified shows products in the order that the listing was last updated latest first Scroller Product n These allow
6. disable this module e Sort Order Enter a number to set the position on the page where you want this module to appear Important The sort order will be random if even one of these modules has a sort order of 0 You must enter a number here to control the order in which the modules appear Modular Front Page 13 e Title The title to appear at the top of the module on the front page The title in the Admin will remain Featured Products Max Featured Products Set the number of products that you want to show on the front page e Number of Columns Set the number of columns of products that you want to show e Featured Product 1 10 Select up to 10 products that you want to show on the front page If you have Max Featured Products set to less than 10 only that number of products will show 3 2 5 Heading Title This module produces a heading at the top of the page Welcome to lt Store Name gt where lt store name gt is the name you have assigned your osCommerce store This module is usually set first of all the installed modules but can be used anywhere you like To install the module click its name to highlight it then click the Install Module button Once it is installed click the Edit button to change the parameters e Enable Heading Title This should normally be left at True Set to False to disable this module e Sort Order Enter a number to set the position on the page where you want this module to appear Impo
7. scroller catalog includes languages english modules front_page banner_rotator php catalog includes languages english modules front_page categories_images php catalog includes languages english modules front_page customer_greeting php catalog includes languages english modules front_page featured php catalog includes languages english modules front_page heading_title php catalog includes languages english modules front_page new_products php catalog includes languages english modules front_page scroller php catalog includes languages english modules front_page specials php catalog includes languages english modules front_page text_main php catalog includes languages english modules front_page upcoming_products php catalog includes modules front_page banner_rotator php catalog includes modules front_page categories_images php catalog includes modules front_page customer_greeting php catalog includes modules front_page featured php catalog includes modules front_page heading_title php catalog includes modules front_page new_products php catalog includes modules front_page scroller php catalog includes modules front_page specials php catalog includes modules front_page text_main php catalog includes modules front_page upcoming_products php 2 2 4 Modified Files catalog index php One edit near the bottom of the file 2 3 Database All database changes are made automatically by installing a module and editing the module s configuration No manual da
8. you to select products to show in the scroller They require Products Shown set to Featured These are not set by default You may need to experiment with some of these settings to find the ones that look the best with your product images Make changes one or two at a time and test before making changes If you get stuck uninstall the module and instal it again This will restore all of the settings to the defaults Remember that you need to have enough products to fill the box plus one to get the scroller to run It looks best when there are at least twice as many products as would be needed to fill the scroller box If you don t have enough products try increasing the Image Padding a bit Modular Front Page 16 3 2 8 Specials This module displays a set number of your store s specials The selection of specials is random selction from all of the specials you have set in your store You can limit the number of specials that yo want this module to display To install the module click its name to highlight it then click the Install Module button Once it is installed click the Edit button to change the parameters e Enable Specials This should normally be left at True Set to False to disable this module e Sort Order Enter a number to set the position on the page where you want this module to appear Important The sort order will be random if even one of these modules has a sort order of 0 You must enter a number here to control t
9. 0 3 2 Mod le araa ae amena Daa raai aaan a AAA ea aaaeaii inaa aahi 10 3 2 Banner Rotator saser a A as tato 10 3 2 2 Categories IMAGES ici TEES E A pind eta ban 11 32 3 Gustomer Greeting eena A dad 12 3 2 4 num nes casas 12 3 2 5 Heading Title een ne nennen 13 3 2 6 1 A and 13 A A O 14 A 01210 NOS 16 3 2 9 2 o a 16 3 2 10 Upcoming Prfoducts unsre aE a nen 16 4 TROUBLESHOOTING teens cdatacetuiduaicesseedeiadectcesbeiiesceussdadsceGubentotestasiessis 20 4 1 0scTemplate Erf rs unee een caida indica 20 4 2 Modules Not in Desired 20 A ADDITIONAL MODIFICATIONS 4444444400nH4HHHnnnnnnnnnnnnnnnnnn nen nnnnnnnn nn nnnnnnnnnnnnnnnneenn nennen 22 AGA Banner Rotator e 22 A 2 Categories Images miii ii A A EA 22 A 3 Customer Greeting dile a na OR A anna 22 Bi Heading Title ana a a een 22 A A EP en anne ann stdaveecudeadvaes 22 1 0 GENERAL INFORMATION 1 GENERAL INFORMATION 1 1 System Overview This addon is d
10. endix A ADDITIONAL MODIFICATIONS 22 A ADDITIONAL MODIFICATIONS Further changes to the format may be made by editing some of the files This section will provide some guidance as to what to change and where to find the files A 1 Banner Rotator You can make more changes to the behavior of the Banner Rotator by editing these files e catalog ext modules banner_rotator banner_rotator js This file contains the Javascript that controls the rotation of the images e catalog ext modules banner_rotator stylesheet css This file contains the stylesheet for the Banner Rotator Make changes here for different banner sizes different controls etc A 2 Categories Images You can make more changes to the appearance of the categories in catalog ext modules categories_images stylesheet css This file contains the styles for the categories Make changes here for different image sizes outline color etc A 3 Customer Greeting You can change the text in this message by editing catalog includes languages lt anguage gt php where lt gt is the language you wish to edit e g english Note that there are three defines that can be edited TEXT_GREETING_PERSONAL TEXT_GREETING_PERSONAL_RELOGON and TEXT_GREETING_GUEST A 4 Heading Title You can change the text in this message by editing the text in catalog includes languages lt anguage gt ndex php where lt gt is the language you wish to edit e g english
11. esigned to make changes to the front page of an osCommerce store easy and simple is particularly intended for new users of the software but can be used by anybody Elements in the center section of the page can be added removed and reordered from the Admin panel No code editing is needed unless the site has been modified already in which case only one simple edit is needed 1 2 Software Compatibility This software package was developed using osCommerce Version 2 3 1 Use with older versions may cause errors unless modifications are made to accommodate the older version Some versions of the pre release 2 3 package will work and some will not If in doubt check your copy of catalog includes classes osc_template php against the one in the most recent version If there are any major differences this addon will probably not work If you don t have that file at all this addon will certainly not work recommend that you update to at least version 2 3 1 before attempting to add this software package 1 3 Terminology 1 3 1 Definition of Terms This manual uses some terms that you may not be familiar with The following definitions are important to understanding the rest of this document Module Front page elements are referred to as modules Most modules consist of two files but some may require additional support files The two main files will usually have the same name so take care to put them in the proper directories Language Fi
12. f the GNU General Public License along with this program If not see http www gnu org licenses A copy of this license is included in the file gpl txt Documentation All of the included documentation including but not limited to this manual is SA licensed under a Creative Commons Attribution Noncommercial Share Alike 3 0 United States License For a copy of this license see http creativecommons org licenses by nc sa 3 0 us A copy of this license is included in the file cc txt TABLE OF CONTENTS Page 7 GENERAL INFORMA TION vecccsessseccsevivecesiecistzenssaccectocsssstesdevecepindeececencanstaasavevedeasscedizesedsrsiesans 2 TA System Overview A di a 2 1 2 Software Compatibility iii ii 2 13 TEMIDO O Vania ai ii ii 2 EA Terms 2 1 3 2 Acronyms and 2 EST A A O 3 1 5 Bug REPO Sist iaa id iO dd 3 Z INSTALLATION itn caxciepitetiesacecunsetedesscedisteieccvecasUscsiussseuesierededsiaisiveceduuseevasbilesanvexsesestesrecs 6 A OT 6 A ARA O O A O 6 221 Replace A OS 6 22 2 MOify EMOS coi A A oi T 6 2 23 NEWS it A ae ed 6 2 24 Modified Fil E E 7 2 3 A ETEA 7 3 CONFIGURATION iii daa 10 O 1
13. he order in which the modules appear Max Specials Set the number of special products that you want to display e Title The title to appear at the top of the module on the front page The title in the Admin will remain Specials Make this blank for no title Number of Columns Set the number of columns of specials that you want to show Link to Specials Page Makes the title of the specials module a link to the specials page Requires Title to be set 3 2 9 Text Main This module produces a block of text on the front page Actually since HTML can be used in this block it can contain text images and just about anything else that a static web page can contain For dynamic content such a s a list of products you should select a different module To install the module click its name to highlight it then click the Install Module button Once it is installed click the Edit button to change the parameters e Enable Text Main This should normally be left at True Set to False to disable this module e Sort Order Enter a number to set the position on the page where you want this module to appear Important The sort order will be random if even one of these modules has a sort order of 0 You must enter a number here to control the order in which the modules appear e lt language gt Text Enter the text that you want to show on the front page for the given language HTML is allowed in this box You may find it easier to com
14. his distribution are marked with Modular Front Page for single line changes and Start Modular Front Page lt code gt End Modular Front Page for multiline changes 2 2 3 New files catalog admin includes functions modules front_page featured php catalog admin includes languages english modules cfg_modules cfgm_front_page php catalog admin includes modules cfg_modules cfgm_front_page php catalog ext modules front_page banner_rotator banner_rotator js catalog ext modules front_page banner_rotator stylesheet css catalog ext modules front_page categories_images stylesheet css catalog ext modules front_page scroller jquery smoothDivScroll 1 1 min js Modular Front Page catalog images banners test_banner_1 png used for testing the banner rotator only catalog images banners test_banner_2 png used for testing the banner rotator only catalog images cursors cursor_arrow_left cur used by the scroller catalog images cursors cursor_arrow_right cur used by the scroller catalog images icons arrow_left png used by the scroller catalog images icons arrow_right png used by the scroller catalog images icons dotDark png used by the banner rotator catalog images icons dotLight png used by the banner rotator catalog images icons pause png used by the banner rotator catalog images icons play png used by the banner rotator catalog images icons transBlack png used by the banner rotator catalog images big_transparent gif used by the
15. le osCommerce keeps language dependent files in separate directories organized by language The language files for the customer side can be found in catalog includes languages and the files for the Admin side in catalog admin includes languages Front Page The Web page that you see when you point your browser to the place you ve installed your osCommerce store It has nothing to do with a certain WYSIWYG editor Table 1 Modular Front Page 1 3 2 Acronyms and Abbreviations RTFM Read The Fine Manual Seriously Read the whole thing Now Table 2 1 4 Support Read this manual first Read the Troubleshooting section if you are seeing error messages or if the code isn t working the way this manual says it should If you can t find it here check the support thread in the osCommerce forum at http forums oscommerce com topic 367042 addon modular front page 1 5 Bug Reports Bug reports and requests for new features can be made at the osCommerce Forum support thread at http forums oscommerce com topic 367042 addon modular front page Bug reports are always appreciated Code to fix the bug that you found is even more appreciated Please note that this is open source software You are free to create any modifications of this software that you wish provided that you adhere to the terms of the software license This does not mean that we are required to create such modifications for you We might if you ask nicely and we feel there is
16. oming Products Expected Sort Field This controls the order the products in this module are shown Products can be listed by products_name or date_expected The default is date_expected Expected Sort Order This further controls the sort order either ascending asc descending desc The default is desc Products Expected This sets the maximum number of products shown in this module The default is 10 Modular Front Page 4 TROUBLESHOOTING 20 4 TROUBLESHOOTING If you are having problems with your installation check this section first If you don t find your problem here search the osCommerce support forum thread If you still can t find a solution post a question in that thread 4 1 oscTemplate Errors If you see any error message that contains oscTemplate you are probably not running osCommerce version 2 3 x or you have an early version from Github The solution is to upgrade to the latest version in the 2 3 series 4 2 Modules Not in Desired Order If the modules on your front page are out of order you have one of the following errors You have two modules with the same Sort Order Solution Change one or both numbers You have modules with the wrong Sort Order Solution Change the numbers to sort in the correct order The smallest number will be at the top of the page You have one or more modules with a Sort Order of 0 Solution Change to a non zero number Modular Front Page App
17. oscommerce USER S MANUAL Modular Front Page for osCommerce Online Merchant v2 3 1 Version 1 2 6 January 2011 REVISION HISTORY a N 20101113 Original release O 1 1 20101117 Added config items to set the title on the front page and the number of columns in applicable modules Added subcategory option to Categories Images 20101117 Replaced language file that was in the wrong directory 1 2 20101118 Fixed bugs in Categories Images module 20101118 Fixed bug in the Featured module 1 4 20101118 Fixed bugs in the Categories Images module and tweaked its stylesheet 20101121 Fixed bugs in the Featured module 1 2 20101122 Added a horizontal scroller module Cleaned up code and moved files in the ext directory to the correct subdirectory oscommerce osCommerce Online Merchant Copyright Notice Software This software is Copyright 2010 osCommerce Online Merchant ERE This program is free software you can redistribute it and or modify it under the terms of the GNU General Public License as published by the Free Software Foundation either version 3 of the License or at your option any later version This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the GNU General Public License for more details You should have received a copy o
18. pose your text in a text editor first and copy and paste the finished product into this box There will be one entry for each language that you have enabled in your store Important If you want to add additional language s you will have to uninstall and reinstall this module It would be easier to add your language s first 3 2 10 Upcoming Products This module produces the standard osCommerce upcoming products box that starts with Upcoming Products lt shows the products that have an Expected date in the future up to the maximum number set The date expected 15 set in your store Admin gt Catalog gt Categories Modular Front Page 17 Products Edit your product and enter a future date in the Date Available box A list of these items can be seen in Admin gt Catalog gt Products Expected To install the module click its name to highlight it then click the Install Module button Once it is installed click the Edit button to change the parameters Enable Upcoming Products This should normally be left at True Set to False to disable this module Sort Order Enter a number to set the position on the page where you want this module to appear Important The sort order will be random if even one of these modules has a sort order of 0 You must enter a number here to control the order in which the modules appear e Title The title to appear at the top of the module on the front page The title in the Admin will remain Upc
19. r product images The selection of products can be specials new products your selection or all products Most of the features can be set in the Admin module setup To install the module click its name to highlight it then click the Install Module button Once it is installed click the Edit button to change the parameters Enable Scroller This should normally be left at True Set to False to disable this module Sort Order Enter a number to set the position on the page where you want this module to appear Important The sort order will be random if even one of these modules has a sort order of 0 You must enter a number here to control the order in which the modules appear Scroller Height The height of the scroller box This should normally be set to the height of your product images The default value is 80 Image Padding This adds some space between images Increase this value if your images look crowded The value is in pixels Note Padding is added to both sides of each image so the space added will be twice this number The default value is 0 AutoStart Sets how the scroller starts Onstart starts the scrolling when the page loads and stops it when the customer s mouse cursor is over the scroller Always makes the scroller run constantly and turns off the control arrows on each side The default is onstart AutoStart Direction This controls how the scroller operates Right scrolls the images to the right and then stops
20. rtant The sort order will be random if even one of these modules has a sort order of 0 You must enter a number here to control the order in which the modules appear For more advanced changes see Appendix A 3 2 6 New Products This module produces the standard osCommerce new products box that starts with New Products For lt current month gt It actually shows a selection of the most recently added products not necessarily those added this month To install the module click its name to highlight it then click the Install Module button Once it is installed click the Edit button to change the parameters Enable New Products This should normally be left at True Set to False to disable this module Sort Order Enter a number to set the position on the page where you want this module to appear Important The sort order will be random if even one of these modules has a sort order of 0 You must enter a number here to control the order in which the modules appear Max New Products Enter the number of products that you want to show The module will show this number of the newest products Multiples of the Number of Columns usually look best here Title The title to appear at the top of the module on the front page The title in the Admin will remain New Products Modular Front Page 14 Number of Columns Set the number of columns of products that you want to show 3 2 7 Scroller This module displays a set number of you
21. s a title usually the top of the page New Products This shows the stock osCommerce new products box Scroller This shows a horizontal scrolling array of product images e Specials This shows a configurable number of your store s specials Text main This shows a block of text e Upcoming products This shows the stock osCommerce upcoming products box See the following sections for more details on each of these modules 3 2 1 Banner Rotator The banner rotator shows a series of images sequentially with a set fade between images There is a control panel shown that allows the customer to view individual images and stop and start the rotation Images are added through the Banner Manager Admin panel Tools gt Banner Manager All of the banners used by the Banner Rotator must be in the same banner group and must be loaded into the catalog images banners directory suggest naming this banner group rotator All images must be the same size for the rotator to work properly There are two test images Modular Front Page 11 supplied with this package that can be used to test this module See the catalog images banners directory for the test images To install the module click its name to highlight it then click the Install Module button Once it is installed click the Edit button to change the parameters Enable Banner Rotator This should normally be left at True Set to False to disable this module e Sort
22. selected here To install the module click its name to highlight it then click the Install Module button Once it is installed click the Edit button to change the parameters e Sort Order Enter a number to set the position on the page where you want this module to appear Important The sort order will be random if even one of these modules has a sort order of 0 You must enter a number here to control the order in which the modules appear e Enable Categories Images This should normally be left at True Set to False to disable this module Title The title to appear at the top of the module on the front page The title in the Admin will be different Box Style The categories can be presented in three different styles Modular Front Page 12 Grid The categories are displayed in rows and columns The number of columns be set below Float Similar to Grid except the categories are floating and will occupy as many columns as will fit There is also a mousover style to attract attention to the categories Rows Categories are listed one per row Box Mouseover Turns the mouseover effect on and off This only works if Float is selected as the Box Style Number of Columns The number of columns of categories that the box will contain This only works if Grid is selected as the Box Style e Show Image Show the category images e Show Name Show the category e Show Subcategories Sho
23. tabase changes are necessary Modular Front Page 3 0 CONFIGURATION 10 3 CONFIGURATION This section covers the capabilities and basic configuration of the included modules 3 1 Overview There are ten modules supplied with this Addon Five of them duplicate the features of the stock osCommerce 2 3 front page The extra modules are a banner rotator the Categories Images box Featured Products a side scroller and a Specials box All of these modules can be presented on the front page of your store in any order or left out Each module can be set up in the store Admin without changing any code just like the boxes in the left and right column Of course you can make code changes to further alter the appearance if you wish 3 2 Module Admin Navigate to your store s Admin panel and click on Modules in the left column Find Front Page in the list that just appeared and click on it Now click on the Install Module button in the upper right corner of the page This will show you a list of the modules that can be installed The modules are Banner Rotator This module shows a series of graphics images that fade into each other at a set interval Categories Images This shows an image and the category name for each of your top level categories Customer Greeting This shows the stock osCommerce greeting message Featured Products This shows a configurable number of products that you select Heading Title This show
24. w list of subcategories under each top level category Note This only works with a Box Style of Float Only second level categories are listed This module uses a helper file in addition to the regular module files See Appendix A for more information on changing this file 3 2 3 Customer Greeting This module produces the standard osCommerce greeting message Welcome Guest Would you like to log yourself in Or would you prefer to create an account To install the module click its name to highlight it then click the Install Module button Once it is installed click the Edit button to change the parameters e Enable Customer Greeting This should normally be left at True Set to False to disable this module e Sort Order Enter a number to set the position on the page where you want this module to appear Important The sort order will be random if even one of these modules has a sort order of 0 You must enter a number here to control the order in which the modules appear See Appendix A for more information on changing this greeting text 3 2 4 Featured Products This module displays a group of products that you select The product image name and price are displayed in a grid format To install the module click its name to highlight it then click the Install Module button Once it is installed click the Edit button to change the parameters Enable Featured Products This should normally be left at True Set to False to
Download Pdf Manuals
Related Search