Location: PHPKode > scripts > E-Store Kit-2 > e-store-kit-2/manual/manual.htm
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<title>E-Store Kit manual.</title><link href="1.css" type="text/css" rel="stylesheet">
</head>
<body topmargin="0" leftmargin="0" text="#c0c0c0" bgcolor="#ffffff"><a name="#7"></a>
<div align="center">
<center>
<table border="1" cellpadding="0" cellspacing="1" style="BORDER-COLLAPSE: collapse" bordercolor="#111111" width="620" id="AutoNumber1">
<tr>
<td width="100%" bgcolor="#dee9f5">
<h3 align="center">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;E-Store Kit-2 Manual</h3>
<blockquote>
<b>Content</b>
<ul>
<li><A href="#1">Installation</a>
<li><A href="#2">Customizing  Catalog Pages</a>
<li><A href="#3">Customizing Catalog Main Page</a>
<li><A href="#4">Customizing Menu</a>
<li><A href="#5">Customizing View Details Page</a>
<li><A href="#11">Customizing Shopping Cart Page</a>
<li><A href="#10">Customizing Checkout Page</a>
<li><A href="#9">Customizing Download Page</a>
<li><A href="#6">Files Map</a>
<li><A href="#8">Tips</a></li>
</ul>
<hr noshade color="#808080" size="1">
<br>
<a name="#1">Installation</a>
<br>
<br>
Server Requirements:
<ul>
<li>PHP/MySQL support. 
<li>MySQL database. 
<li>Zend Optimizer version 2.1.0 or later (get <a href="http://magicscripts.com/getfree.php?pid=zotest">free script</a> to check you server).
</li>
</ul>
We recommend <a href="http://www.yourmagichost.com/">www.YourMagicHost.com</a><br>
<br>
<br>
Installation Steps:
<ol>
<li>Unzip archive on your hard drive (You'll get <i>catalog</i> folder containing all necessary 
          files). 
          
<li>Upload <i>catalog</i> 
          folder to your site's root directory using any FTP client. 
          
<li>Set read/write/execute permissions to <i>catalog/productimages</i>, <i>catalog/productthumbnails</i> directories and <i>mp2vars.php</i> file (Chmod&nbsp;777) using FTP client.<br>
<u>Note</u>: If 
          you do not have privileges to assign appropriate permissions to your 
          files, you should ask server administrator of your web-host provider 
          to do it for you. 
          
<li>Run <b>catalog/install.php</b> to configure your MySQL database.<br>
You will be asked to enter host name or IP address of MySQL server, username , password and database name.<br>
Ask your host provider about this information if you don't have it.<br>
<b>Important:</b><br>
<i>Delete <b>catalog/install.php</b> and <b>catalog/uninstall.php</b> after installation.</i>
<li>Open admin page (catalog/adm/index.htm) and make all necessary settings according to you preferences.<br>
<br>
Default Control Panel password: <i>admin</i><br>
<ul>
<li>Change this password A.S.A.P. and keep it in a safe place!
<li>Enter&nbsp;your payment gateway settings.
<li>Create categories and subcategories of your Catalog.
<li>Enter your products data into the Catalog 
            database.</li>       
</ul></li>
</ol><u>Please note</u>:
<ul>
  <li>Default MySQL server settings for maximum file size that can be stored in 
  database is limited to 1 megabyte (for more info please visit <a target="_blank" href="http://www.mysql.com/">MySQL</a> official site). 
 
  <li>Default PHP web server settings for maximum size of uploaded file is limited to 2 megabytes (for more info please visit <a target="_blank" href="http://www.php.net/">PHP</a> official site). 
 
  <li>If you need to bypass these limitations ask your server administrator (web 
  host provider) to increase values for the following server variables: 
  <i>max_allowed_packet</i> (for MySQL) and <i>upload_max_filesize</i> (for PHP).</li>
</ul>
        <A href="../help/help.htm">Control Panel Help</a> contains detailed instructions 
        on how to manage your web-store.<br>
        <br>
        Now you are ready to call your Catalog from anywhere on your site:<br>
     &lt;a href="/catalog/catalog.php"&gt;Our Products&lt;/a&gt;
<A href="#7"><IMG height=14 src="back.jpg" width=82 align=right border=0></a><hr noshade color="#808080" size="1">
<br><a name="#2">Customizing  Catalog Pages</a><br>
        <u><br>
        </u>Design and layout of your Catalog pages can be 
        changed by editing the following files:
        <P></P>
        <ul>
          <li><i>catalog/style.css</i> - Style sheet file. 
          <li><i>catalog/menuvars.js</i> - DHTML dropdown menu settings. 
          <li><i>catalog/catalogtemplate.htm</i> - Catalog Main Page template. 
          <li><i>catalog/menutemplate.htm</i> - Menu template (edit only if you use your own menu). 
          <li><i>catalog/viewdetailstemplate.htm</i> - View Details Page template.
          <LI><i>catalog/viewcarttemplate.htm</i> - Shopping Cart Page template.
          <LI><i>catalog/ordertemplate.htm</i> - Checkout Page template.
          <li><i>catalog/download/return.htm</i> - Download Page template.</li>
        </ul>
        <font color="#ff3300"><b>Very Important: Do not edit any other files!</b></font><br>
        <br>
        Open template files in any HTML editor and make all necessary changes to 
        adjust design/layout of your Catalog according to your preferences. Also 
        you can design your own styles by editing style sheet
        file <i>catalog/style.css<br>
        <br>
        </i>Meta-variables (###variables###) and meta-tags (meta-variables inside 
        HTML comments) are used to display attributes of your products. If you 
        delete some variables - corresponding data won't be displayed.<font color="#ff3300"><b><br>
        <br>
        Do not delete meta-tags even if you don't need any variables to be 
        displayed (just put two meta-tags together with a space character 
        between).</b></font><A href="#7"><IMG height=14 src="back.jpg" width=82 align=right border=0></a><hr noshade color="#808080" size="1">
       <br>
         <a name="#3">Customizing Catalog Main Page</a><br>
        <br>
        <i>catalog/catalogtemplate.htm</i> -  Catalog Main Page template file 
        displays list of products, you can edit this page in any HTML editor.<br>
        Please don't remove or edit "catalogue" form and it's hidden inputs 
        - 
        it may cause an error.<br>
        <br>
        You can use the following meta-variables to display your products: <br>
        <br>
        <b>General</b><ul>
          <li>###Menu###
        - Container for Menu.
        If you want to use our dynamic DHTML menu, do not change or remove any &lt;script&gt; 
        tags 
          between &lt;HEAD&gt;&lt;/HEAD&gt; HTML tags of template file and&nbsp;in the bottom of 
        HTML code (just before &lt;/BODY&gt; tag).
        If you want to use your own menu - you can put it wherever you need (see <a href="#4">Customizing Menu</a>). 
          <li>###ShowCart### - Keep this variable if you want to display shopping cart everytime the new product is added. 
          <li>###ViewCartURL### - 
          Link to view MagicScripts shopping cart (you can use text link, 
          graphic image or standard button and place it wherever you want on your page). 
          <li>"JavaScript: sortColumn('title','###ToSortOrder###');"<br>
          "JavaScript: 
          sortColumn('price','###ToSortOrder###');" - Built-in functions for 
          sorting list of products by Title and by Price. You can put this 
          meta-variables wherever you want on your page and design your own text 
          links or graphic buttons.</li>
         </ul>
        <b>Navigation</b><u><br>
        </u>All available pages of your product list are 
        displayed using HTML code inside &lt;!--###NAVDATA###--&gt; meta-tags 
        and the following meta-variables: 
        <UL></UL>
        <P></P>
        <ul>
          <li>###Previous### and ###Next###
        - navigation buttons to browse through product list. If there are no 
          corresponding links, "Previous" and "Next" 
        buttons turn invisible (transparent blank image <i>images/blank.gif</i> 
        is used for that). If you want to use custom buttons, simply replace 
          existing image files <i>images/prev.jpg,</i> <i>images/next.jpg</i> and 
          <i>images/blank.gif</i> with your own images. 
          <li>###Page###
        - Links to jump directly to the specific page of the product list.
        The maximum number of pages shown in navigational bar can be set in Control 
          Panel (see <A href="../help/help.htm#3">Control Panel Help</a> for details).</li>
        </ul>
        You can put navigation bar wherever you want on your Catalog Main Page. <br>
        <br>
        <b>Search</b><br>
        Please don't rename the form "search" and it's input "keyword". You can place 
        this form wherever on your page, just make sure not to put it inside the 
        main form - "catalogue".
        If you don't want to use search on Catalog Main Page - just remove this form.<br>
        <br>
        <b>Product list</b><br>
        All products are displayed using HTML code inside 
        &lt;!--###ROWDATA###--&gt; meta-tags and the following meta-variables:
        <P></P>
        <ul>
          <li>###productnumber### - displays product number 
          (article number). 
          <li>###title### - displays product title. 
          <li>###description### - displays product 
          description. 
          <li>###price### - displays product price. 
          <li>###thumbnail### - displays product thumbnail image with link to View 
          Details Page (see Customizing View Details Page). Settings of how to 
          display this page can be set in Control Panel (see
          <A href="../help/help.htm#3">Control Panel Help</a> for 
          details). 
          <li>###image### - displays product image. 
          <li>"JavaScript: addToCart(###productID###); return false;" - Built-in function to add a product to shopping cart (you can use text link, graphic image or standard button).</li>
        </ul>
        <A href="#7"><IMG height=14 src="back.jpg" width=82 align=right border=0></a><hr noshade color="#808080" size="1">
        <br><a name="#4">Customizing Menu</a><br><br>
        Open <i>catalog/menuvars.js</i> file in any text editor. You'll see variables 
        and their descriptions to 
        customize a dropdown DHTML menu according to your preferences. <br>
        <i>catalog/menutemplate.htm</i> is a dropdown DHTML menu file - do not edit this file if you 
        would 
        like to use our dropdown menu.<br>
        <br>
        If you're going to use a permanent tree of Categories/Subcategories of 
        your Catalog, you can create graphic buttons and assign  them direct 
        links to corresponding Categories or Subcategories using Link Codes from 
        Control Panel. The sample of such technique is shown in
        <a href="http://www.sitesoutlet.com/demo/catalogue1/catalogue.asp">Demo 2</a> 
        of E-commerce Kit-1. You can 
        also use this technique to create a custom dropdown menu using Dreamweaver. In this case you don't need 
        to use container
        ###Menu### and
        <i>menutemplate.htm</i> file.<br>
        <br>
        If you have some programming skills and want to create your own custom 
        dynamic menu - a simple basic menu template is included in package: <i>catalog/blank_menutemplate.htm</i>.<br>
        This is how it works:<br>
        Main 
        Catalog Page outputs full list of categories/subcategories stored in 
        catalog database ordered by title: 
        <P></P>
        <ul>
          <li>###CID### - category ID. 
          <li>###CT### - category title. 
          <li>###SID### - subcategory ID. 
          <li>###ST### -
        subcategory title.</li>
        </ul>
        &lt;!--###Data###--&gt; - meta-tag delimits header/footer parts of a menu template.<br>
        &lt;!--###CatData###--&gt; - meta-tag of category.<br>
        &lt;!--###SubData###--&gt; - meta-tag of subcategory.
<a href="#7"><IMG height=14 src="back.jpg" width=82 align=right border=0></a><hr noshade color="#808080" size="1">
<p><a name="#5">Customizing View Details Page</a></p>
        <br>
        <i>catalog/viewdetailstemplate.htm</i> is a product View Details Page 
        template file.<br>
        You can edit this page in any HTML editor.
        If you delete some meta-variables, corresponding data won't be displayed.<br>
        <br>
        <b>The following meta-variables are used to display product details</b>:
        <P></P>
        <P></P>
        <ul>
          <li>###productnumber### - displays product 
          number. 
          <li>###title### - displays product title. 
          <li>###description### - displays product 
          description. 
          <li>###price### - displays product price. 
          <li>###thumbnail### - displays a product thumbnail image with link to 
          View Details Page (link settings can be set in Control panel. See <A href="../help/help.htm#3">Control 
          Panel Help</a> for details).
          <li>###image### - displays product image. 
        </ul>
<a href="#7"><IMG height=14 src="back.jpg" width=82 align=right border=0></a><hr noshade color="#808080" size="1">
<p><a name="#11">Customizing Shopping Cart Page</a></p>
        <i>catalog/viewcarttemplate.htm</i> is a Shopping Cart Page template file.<br>
        You can edit this page in any HTML editor. Do not delete any of 
        meta-tags, meta-variables, form or JavaScript in this template.<br>
        <br>
        <b>The following meta-tags are used to handle Shopping Cart Page</b>:
		<ul>
          <li>&lt;!--###ROWDATA###--&gt; - Shopping Cart Page displays cart content between these meta-tags if 
          cart is not empty. 
          <li>&lt;!--###NODATA###--&gt; - Shopping Cart Page displays code between these meta-tags if cart is empty. 
          <li>&lt;!--###ROWS###--&gt; - Shopping Cart Page displays product details between these meta-tags. 
        </ul>
        <b>The following meta-variables are used to handle Shopping Cart Page</b>: 
        <p></p>
        <p></p>
        <ul>
          <li>###title### - displays product title.</li>
          <li>###productID### - displays product number.</li>
          <li>###quantity### - displays product quantity.</li>
          <li>###price### - displays product price.</li>
          <li>###subtotal### - displays product subtotal (price x quantity).</li>
          <li>###total### - displays order total.</li>
        </ul>
<a href="#7"><IMG height=14 src="back.jpg" width=82 align=right border=0></a><hr noshade color="#808080" size="1">
<p><a name="#10">Customizing Checkout Page</a></p>
        <i>catalog/ordertemplate.htm</i> is a Checkout Page template file.<br>
        You can edit this page in any HTML editor. Do not delete any of 
        meta-tags and meta-variables in this template.<br>
        <br>
        <b>The following meta-tags are used to handle Checkout Page</b>:<ul>
          <li>&lt;!--###ROWDATA###--&gt; - Checkout Page displays order details between these meta-tags if 
          order contains products. 
          <li>&lt;!--###NODATA###--&gt; - Checkout Page displays code between these meta-tags if order is empty. 
          <li>&lt;!--###ROWS###--&gt; - Checkout Page displays product details between these meta-tags. 
          <li>&lt;!--###GATEWAY###--&gt; - Checkout Page displays purchase buttons code between these meta-tags. 
        </ul>
        <b>The following meta-variables are used to handle Checkout Page</b>: 
        <p></p>
        <p></p>
        <ul>
          <li>###num### - displays order number.</li>
          <li>###title### - displays product title.</li>
          <li>###product### - displays product number.</li>
          <li>###quantity### - displays product quantity.</li>
          <li>###price### - displays product price.</li>
          <li>###subtotal### - displays product subtotal (price x quantity).</li>
          <li>###total### - displays order total.</li>
          <li>###CALL### - displays payment gateway button to process current order.</li>
        </ul>
<a href="#7"><IMG height=14 src="back.jpg" width=82 align=right border=0></a><hr noshade color="#808080" size="1">
<p><a name="#9">Customizing Download Page</a></p>
        <i>catalog/download/return.htm</i> is a Download Page template file.<br>
        You can edit this page in any HTML editor. Do not delete any of 
        meta-tags and meta-variables in this template.<br>
        <br>
        <b>The following meta-tags are used to handle secure download 
        process</b>:<ul>
          <li>&lt;!--###DATA###--&gt; - Download Page 
          displays code for instant download between these meta-tags if 
          customer's payment is received successfully. 
          <li>&lt;!--###NODATA###--&gt; - Download Page 
          displays code between these meta-tags if some data are missing. 
          <li>&lt;!--###WARNING###--&gt; - Download Page 
          displays code between these meta-tags while waiting for response from 
          Payment Gateway (sometimes up to several minutes). 
          <li>&lt;!--###ROWSINST###--&gt; - Download Page 
          displays code between these meta-tags for instant download of 
          purchased product. 
          <li>&lt;!--###ROWSMAIL###--&gt; - Download Page displays code between these 
          meta-tags if purchased product must be delivered via e-mail.</li>
        </ul>
        <b>The following meta-variables are used to handle secure download 
        process</b>: 
        <p></p>
        <p></p>
        <ul>
          <li>###1name### - displays customer's first name. 

          <li>###2name### - displays customer's last name. 
          <li>###TID### - displays transaction number that 
          your customer can use to download purchased product later. 
          <li>###ProductNumber### - displays Product ID. 
          <li>###ProductSize### - displays product's file 
          size. 
          <li>###PID### - product number used for download.</li>
        </ul>
        <br>
<a name="#6"></a><A href="#7">
<IMG height=14 src="back.jpg" width=82 align=right border=0></a><hr noshade color="#808080" size="1">
<br>
<table border="0" cellspacing="1" cellpadding="4" bordercolor="#999999" bgcolor="#999999">
<tr><td bgcolor="#006699" align="middle" colspan="2"><p>Files Map</p> </td>
  </tr>
<tr><td bgcolor="#eeeeee" align="middle"><b>Location</b></td><td bgcolor="#eeeeee" align="middle"><b>Description</b></td></tr>
<tr><td bgcolor="#eeeeee">catalog/catalog.php</td><td bgcolor="#eeeeee">Main script</td></tr>
<tr><td bgcolor="#eeeeee">catalog/viewdetails.php</td><td bgcolor="#eeeeee">View Details script</td></tr>
<tr><td bgcolor="#eeeeee">catalog/viewcart.php</td><td bgcolor="#eeeeee">Shopping Cart script</td></tr>
<tr><td bgcolor="#eeeeee">catalog/order.php</td><td bgcolor="#eeeeee">Checkout Page script</td></tr>
<tr><td bgcolor="#ffffff">catalog/mp2vars.php</td><td bgcolor="#ffffff">Variables for MySQL connection</td></tr>
<tr><td bgcolor="#ffffff">catalog/style.css</td><td bgcolor="#ffffff">Style sheet</td></tr>
<tr>
 <td bgcolor="#ffffff" valign="top">catalog/menuvars.js</td>
 <td bgcolor="#ffffff" valign="top">DHTML dropdown menu settings<br>(you can delete this file if you use your own menu)</td>
</tr>
<tr><td bgcolor="#ffffcc">catalog/download/</td><td bgcolor="#ffffcc">Payment confirmation and secure download scripts folder</td></tr>
<tr><td bgcolor="#eeeeee">catalog/adm/</td><td bgcolor="#eeeeee">Control Panel folder</td></tr>
<tr><td bgcolor="#ffffff">catalog/adm/top.htm</td><td bgcolor="#ffffff">Logo frame file</td></tr>
<tr><td bgcolor="#ffffff">catalog/adm/1.css</td><td bgcolor="#ffffff">Style sheet file</td></tr>
<tr><td bgcolor="#ffffff">catalog/adm/help.gif</td><td rowspan="3" bgcolor="#ffffff">Control Panel images</td></tr>
<tr><td bgcolor="#ffffff">catalog/adm/help_sm.gif</td></tr>
<tr><td bgcolor="#ffffff">catalog/adm/logo.jpg</td></tr>
<tr><td bgcolor="#eeeeee">catalog/cls/</td><td bgcolor="#eeeeee">Classes folder</td></tr>
<tr><td bgcolor="#eeeeee">catalog/manual/</td><td bgcolor="#eeeeee">E-store Kit Manual</td></tr>
<tr><td bgcolor="#eeeeee">catalog/help/</td><td bgcolor="#eeeeee">Control Panel Help</td></tr>
<tr><td bgcolor="#eeeeee">catalog/images/</td><td bgcolor="#eeeeee">Images folder</td></tr>
<tr><td bgcolor="#eeeeee">catalog/productimages/</td><td bgcolor="#eeeeee">Product images folder </td></tr>
<tr><td bgcolor="#eeeeee">catalog/productthumbnails/</td><td bgcolor="#eeeeee">Product thumbnails folder </td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/</td><td bgcolor="#eeeeee">JavaScript files folder</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/catalog.js</td><td bgcolor="#eeeeee">Catalog navigation JavaScript</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/viewcart.js</td><td bgcolor="#eeeeee">Shopping Cart JavaScript</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/ie4.js</td>
  <td rowspan="9" bgcolor="#eeeeee">Dropdown menu JavaScript files.<br>(You can delete these files if you want to use your own menu)</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/ie5.js</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/moz.js</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/ns4.js</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/op5.js</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/op6.js</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/menu.js</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/menuinit.js</td></tr>
<tr><td bgcolor="#eeeeee">catalog/res/menustyle.js</td></tr>
<tr><td bgcolor="#ffffff">catalog/catalogtemplate.htm</td><td bgcolor="#ffffff">Pre-designed Catalog Main Page template</td></tr>
<tr><td bgcolor="#ffffff">catalog/viewdetailstemplate.htm</td><td bgcolor="#ffffff">Pre-designed View Details Page template</td></tr>
<tr><td bgcolor="#ffffff">catalog/viewcarttemplate.htm</td><td bgcolor="#ffffff">Pre-designed Shopping Cart Page template</td></tr>
<tr><td bgcolor="#ffffff">catalog/ordertemplate.htm</td><td bgcolor="#ffffff">Pre-designed Checkout Page template</td></tr>
<tr><td bgcolor="#ffffff">catalog/download/return.htm</td><td bgcolor="#ffffff">Pre-designed Download Page template</td></tr>
<tr><td bgcolor="#ffffff">catalog/menutemplate.htm</td><td bgcolor="#ffffff">Pre-designed dropdown menu template</td></tr>
<tr><td bgcolor="#ffffff">catalog/blank_catalogtemplate.htm</td><td bgcolor="#ffffff">Blank Catalog Main Page template</td></tr>
<tr><td bgcolor="#ffffff">catalog/blank_menutemplates.htm</td><td bgcolor="#ffffff">Blank Menu template</td></tr>
</table>
        <br>
        <b>Legend</b>:<ul>
          <li>White color indicates that you can edit these 
          files. 
          <li>Yellow color indicates that you can rename 
          these files according to your payment gateway (merchant) settings. 
          <li>Do not edit or rename all other files and folders.</li>
        </ul></A><A href="#7"><IMG height=14 src="back.jpg" width=82 align=right border=0></a><hr noshade color="#808080" size="1">        
        <br>
        <a name="#8">Tips</a><ul>
          <li>You can use E-store Kit-2 to create a 
          non-commercial database-driven website (for example: Gallery of 
          pictures), to do that simply hide "Add to Cart" and "View Cart" 
          buttons. 
          <li>You can insert HTML tags into "Product Description" field (for&nbsp; 
          example: insert additional images and/or links). Using this technique 
          can dramatically extend possibilities of E-store Kit.</li>
        </ul>
        <hr noshade color="#808080" size="1">
        We can customize E-store Kit-2 for you for an additional 
        negotiable charge.<br>
        <br>
     <BR>Good Luck and Best Wishes!<br>&nbsp;
        <P></P>
        <P></P>
        <P></P>
        <hr noshade color="#808080" size="1">
        © MagicScripts, 2003-2005</blockquote>
      </td>
    </tr>
  </table>
  </center>
</div>
</body>
</html>
Return current item: E-Store Kit-2