|
"ONLINESHOP" MANUAL With "OnlineShop" a basic knowledge of HTML coding and uploading files to your server using FTP is required.
Knowledge in these areas is assumed simply because it is much faster more flexible to design a site with your own code rather than filling in complex forms. We also do not restrict you to using our web space.
If you require any assistance installing or configuring "OnlineShop" please contact us. We will be happy to talk you through any issues you have. |
|
INSTALLATION The "OnlineShop" package contains all the instructions, files and scripts required to install, configure and use your "OnlineShop" software. The scripts are for use on your (Unix) based Internet server. They will not work on your PC. It is however, a good idea to copy the contents of this CD or download file to a directory on your computer as a back-up. For the purposes of this manual where CD is mentioned it also refers to the download file. |
README BEFORE INSTALLING INSTALLING "ONLINESHOP" RE-INSTALLING "ONLINESHOP" UPLOADING THE STANDARD GRAPHICS UPLOADING THE STANDARD INI FILES |
|
THE ADMIN MENU
The "Admin Menu" is a web page interface and the heart of "OnlineShop". The "Admin Menu" enables you to configure the "onlineshop.pl script" online without any CGI programming knowledge, update and administer the daily running of the site. It has two levels of access "login" which is intended for authorised staff that use the software on a daily basis and "admin" that provides full access to all of the "OnlineShop" configuration features. Admin access is only intended for use by the sites administrator or webmaster. To gain access to the "Admin Menu" you need to login using the "login web page". This is located in your sites home directory under the name of "login.html". You will need to enter either your "login" or "admin" password to gain entry. Full online help is available for all of its features. If "OnlineShop" has just been installed you are prompted to read our basic rules and site configuration page. This is displayed in big red text at the top of the screen. This text disappears after you have entered a main product category and at least one suppliers details. If you are your own supplier then enter your own name. The full features of the "Admin Menu" are described here.
If you are new to "OnlineShop" then we recommend that you first visit our basic rules and set-up procedure before you start.
|
SITE SET-UP
VIEW CURRENT HOME PAGE
SITE BACK-UP
TO ADD or EDIT an EXISTING SUPPLIER
CONTENT MANAGEMENT
TO ENTER A NEW PRODUCT
INVOICE PAYMENT
CHOOSING YOUR PAYMENT GATEWAY |
|
READ ME
Before you start installing "OnlineShop" please ensure that:
Other considerations before starting full installation
Deciding your directory structure
Deciding on the number of sub category levels a main category should include.
Making scripts executable
Checking for Remote or Local Photo Uploading. From your web browser now enter the http:// URL to the script "IM_test.pl".
If "IM_test.pl" did not work now try the script "GD_test.pl". From your web browser enter the http:// URL to the script "IM_test.pl".
If either one of the two test programs work select the "local" option, when installing the main "OnlineShop" software.
If in doubt select the "remote" option this is guaranteed to work.
Using your FTP software upload the files "onlineshop.pl" and "productupload.pl" to your servers "cgi-bin". Do not forget to make them executable or they will not work (see above). The files are located in the CD's "cgi-bin" directory.
Now make sure that you are online and open up your Internet web browser.
To start the installation process for the first time you need to now enter a simple command that calls the "onlineshop.pl" script on your server and tells it exactly where it is located on the Internet so the script can save the information to an INI file. To do this you need to call the script and pass it a variable that states it's exact URL location. The variable that does this is "af".
Please Note: If the first part of this command is not correct (before ?) you will get a "page not found" error message. If the second part of this command is not correct (after ?af=) you will get a "page not found" error message at the second stage of the installation. If you have not made the "onlineshop.pl" script executable you will get a server error message.
If you need to re-install the software at a later date see "Re-installing the software" section below. It requires a different command from that used above.
NEW SITE CONFIGURATION FORM
ENTER YOUR CD AUTHORISATION CODE
ENTER A MAIN DIRECTORY NAME
CURRENCY SYMBOL
PRICE CHECKER (cost & sale price must be entered when adding new products).
SITE MAP FORMAT.
Create dynamic site map.
Create HTML web page site map.
USE LOCAL OR REMOTE SITE FOR UPLOADING PRODUCT PHOTOS.
THE SERVER PATH Example server paths:
If you get this path wrong your information will not be saved. It can be edited later if required.
ENTER YOUR "MAILPROG" PATH.
YOUR "ADMIN" PASSWORD
CONTINUE TO THE NEXT STAGE
YOUR CONTACT DETAILS
Here you need to enter at least some basic information about yourself. The information is used by the default contact form that we create for you and for correspondence to your site where required. It is essential to enter your correct email address.
The minimum details you need to enter are;
Your VAT (Value Added Tax) Number.
To finish the installation process, press the "SUBMIT " button at the bottom of the page.
THE ADMIN MENU
Back to installation menu
In certain circumstances you may want to re-install the software. To do this you simply repeat the process described above. The only difference is that the initial command is slightly different. We add two new parameters to it. This is your "admin" password and "rdo". "Rdo", is simply an abbreviation for "re-do" and lets the script know that it is being re-installed with the same authorisation code.
Example of the new command line
The site uses graphics for certain links such as "Add to Basket", "Checkout" etc and some Java scripts that perform special zoom effects. These files now need to be uploaded to your servers, main directory. This is where your sites home page will be located. The graphics can be altered at a later date should you want to replace them with your own. If they are not uploaded then you may get error boxes instead of the graphic when configuring the site.
All the standard graphics and special effect files are located in the "home directory" directory on your CD. Open this directory to display all of the files then using your FTP software copy them all to your servers main directory where your home page is located. ONLY COPY THE CONTENTS OF THIS DIRECTORY not the directory itself. Unlike scripts they do NOT need to be made executable.
When you start to configure the site settings with "OnlineShop" all of the form parameters are blank by default and require you to enter them from scratch. We provide some default INI files that will give you basic default settings. We expect you to change them. They are simply there to help you understand and identifying what the relevant parameters do.
If you wish to use our standard INI files they are located in the "dat" directory. The files contained in this directory then need to be copied to the sites "dat" directory where your sites home page will be located using your FTP software. Unlike scripts you do not have to make them executable.
This manual is designed to provide you with help at every stage of the scripts configuration process. “HELP” links are always available to the appropriate sections of this manual at all stages.
When you open any “HELP” pages it is created in a new browser window. To go back to where you were located just simply minimise or close the “HELP” window you are in. All help pages are written as simply as possible to avoided confusing technical jargon.
We expect that you have a reasonable knowledge of HTML or Flash, Java and can write, copy, cut or paste (CTRL+V) the code or content that is required in the appropriate fields.
This script produces both "DYNAMIC" and "STATIC" HTML web pages. Dynamic web pages are created by the script. Any changes you make when configuring or adding to the site will instantly take effect in viewing mode because the script is producing them.
Site Map links (dynamic or html) will only be upgraded when you press the "REFRESH SITE" link.
It is important to keep your site map up to date as it is used by Internet search engines to drive traffic to your site.
OnlineShop uses templates to display the sites web site content.
WHEN USING DEFAULT TEMPLATES
WHEN CREATING CUSTOM TEMPLATES
If you are using OnlineShop as a "Shopping Site":
If you are using OnlineShop just as a "Content Management Site": To view any changes you make it is a good idea to have 2 browser windows open. One for making changes and the other to view them. A link to your "DYNAMIC" home page is included in your "Admin Menu".
Some of the replace commands used to create custom templates use the default settings here. We especially draw your attention to creating the top and side category menus along with the “top 10” facility.
These can be configured in this section and then imported into your custom pages where required using special replace commands.
From here you can;
If you have uploaded our default INI files you will have some default data entered into the fields.
This is just to give you an idea of what the various options can do and the type of coding that can be entered. You should of course change them to suite your needs and design requirements.
After designing a site using “Default Templates” you can now take a look at producing your own “Custom Templates”. Here there are virtually no design restrictions.
If you are using online shopping by selecting “ADD BASKET” “yes” from the “CREATE DEFAULT SITE TEMPLATE” input form, the rest is done automatically using either default or custom site templates. If you are using the "DEFAULT SITE TEMPLATE" option background and border colours for these sections are defined in the “CREATE DEFAULT SITE TEMPLATE” global settings. See “Table Background colour for centre pages” in global settings.
CONFIGURING YOUR PAYMENT GATEWAY FOR CREDIT CARD TRANSACTIONS
If you wish your customers to be re-directed to the site after payment and have your invoice loged "AUTOMATICLY" this can be done also for an extra fee. Costs depend on your chosen payment gateway and what you want the script to do. The basic return payment scripts for PayPal and WorldPay are included free (see paypal_payment.pl and worldpay_payment.pl in your CD's cgi-bin directory). The default is “MANUAL ORDER PAYMENT”. This is where the “payment gateway” sends you a confirmation email with your purchase order number on it. To view the order you just login to your “ADMIN MENU” and enter the order number into the “MANUAL ORDER PAYMENT” field. The order is then displayed and saved. The rest is up to you or your client. Basic order searches are available that suite most companies. See our “Shopping” section in your “Admin Menu”.
VIEW CURRENT HOME PAGE
In the “ADMIN MENU” we provide a link to your sites “dynamic home page” after it has been created.
Your "dynamic home page" can be produced by the following methods.
IMPORTANT!!
This is the main default site configuration page
From here you can;
This feature allows you to experiment with different site and column widths.
The left column is (optional) although important, as this is the column width that your main categories will be displayed in.
When you enter the “Left col” parameter it dictates the width of this column.
It also provides the maximum width of any “custom HTML” that you enter in this area.
For example graphics or tables etc. If they exceed this width then again your site may not be displayed properly.
The right column is (optional) if you set this to “0” you will be creating a 2 column site. If you wish to have a 3 column site the “Right col” parameter dictates the width of this column.
It also provides the maximum width of any “custom HTML” that you enter in this area.
For example graphics or tables etc.
PLEASE NOT: The right column is the (default) column that your shopping basket and TOP 10 Products will be displayed in. If this column is set to “0” width the shopping basket (where selected) will be then displayed at the top of the left column. Any TOP 10 options or custom HTML for this area will be ignored.
The centre column width where required is automatically worked out based on the settings above.
The “Cellspacing for columns section” allows you to enter “cellspacing” between the columns contained within the sites “main table”. The “cellspacing” will then be displayed in the colour entered in the “Global Background Colour” (see below). This is the background colour for your site. We recommend that this value should not exceed more than 10.
It is useful for providing spaces between columns. If you do not want this then set the option to “0”.
Centre column border. This is only required if you are using a shopping basket.
It effects the “cellspacing” when displaying the shopping basket/cart confirm results. Center column "width" manual override
The center column width is basically calculated by deducting the left column and right column values from the total width. Back to main menu
When you enter your products we provide you with the Meta commands for that product. The META commands here are used as an extension or (Default) phrase that is always tagged to the beginning of every web page. If you leave it blank your “home page” will have no META Commands as it is not a product page. It is a good idea to put generic “Meta” commands here. For example your main line of business or company name etc.
Back to main menu
GLOBAL SETTINGS
Please Note: The font sizes here are in pixel sizes. This is because they are being used by a "Style Sheet". Unless otherwise specified the rest of the font sizes on this site are set in standard HTML format 1-6.
Global
Table Settings Only
URL links normal
URL links HOVER Back to main menu
Enter Custom HTML Code to Create your "Top" header.
Please Note; The width of this area is dictated by the code you enter. It is always a good idea to contain it in a “table”. This is so you can easily change the width if required.
Back to main menu
The "Top Menu" once configured here can also be imported into your custom templates using the <#top_menu#> command.
Please Note: Main categories are always displayed in the left column. If you select a single column site then this will be the only means of linking to your product categories. The option to also display them across the top of the page is up to you if you have selected either a two or three column site. It is useful for search engine optimization and also where large amounts of sub categories are displayed by provideing a quick link for the customer to the main categories.
Display main categories at the top
If you select "YES".
You now need to decide if you want your main categories displayed in fixed width tables or as centred links.
Display main categories in fixed width tables
Display main categories as centred text links
Space between centred links in pixels Show drop-down sub categories DROP DOWN DISPLAY OPTIONS IF SELECTED
Drop-down font size in pixels
Drop-down font name
Drop-down font colour normal Drop-down font colour hover Drop-down border width 0-9 Drop-down border colour Drop-down background colour (normal) Drop-down background colour (hover)
MAIN CATEGORY DISPLAY OPTIONS IF SELECTED
Categories per line
Border color for set width option or table background colour for the centred links option.
Background Colour
Override Global default "URL links normal" settings Back to main menu
This site uses two types of searches. A category search is when you press a main category link. This shows you sub categories and products listed under the main category heading. We also provide a “Keyword” search. This behaves in a different way. It goes through all the products listed on the site and displays the results only if the words entered match the products content text.
If you want a keyword search then simply select “Yes” if not you may wish to still use this area and enter some custom HTML to display additional information, graphics etc. If this is the case you should also select “Yes”.
If you want this area to be blank then select “No”.
If you select “YES”.
To create a “Keyword Search” simply enter the description of the search in the “Search text for keyword search” input field.
If you want to use this space for your own custom HTML enter it in the box below called “OVERIDE with custom text”. This will then disable the keyword search and show your html code instead.
You can create default settings for this tables background colour and font styles using the fields provided. If you enter your own custom HTML the default settings may be overriden.
Please Note: We have many areas where you can include your own custom HTML code. You may like to display a "Keyword" search box else where.
To do this you can simply generate the Keyword search and copy our "Keyword search" input forms source code and use it where you want.
Back to main menu
Left Column Settings
The "Main Menu" once configured here can also be imported into your custom templates using the <#main_menu#> command.
Please Note; If you select a 2 column display and also select “Add Basket” Yes, then the shopping basket table is displayed at the top of this column.
Enter the number of sub-categories that you want to display.
Table Background Colour
Top box description for main categories
Table settings for MAIN Categories
Enter custom code below left main menu
Table settings for SUB categories. Back to main menu
Customised your scripts home page html code
When writing your custom code please remember the basic rules below.
Where you enter links, scripts or graphics in your “Custom html” code. Just make sure they have the full URL path. In other words they begin with http://. Relative links will not work simply because you are using a script and you are in a “cgi-bin” directory.
If you are using "OnlineShop" as a “Shopping Site”:
If you are using "OnlineShop" just as a “Content Management Site”: Back to main menu
Right Column Settings
Add Basket
Check Out Box Table settings.
R-Font
L-Font
Table Background Colour.
TOP 10 Products
This feature is optional. If you wish to feature your TOP products then you simply enter the “site reference number” for the product into 1 of the ten boxes provided. They are displayed in the order 1-10. Number one being at the top of the list. The site reference number is provided when you add your product to the database. It is a unique number that we provide for you and should not be confused with your suppliers product reference number.
Ruler colour.
Top 10 settings
OR Display Custom HTML
Enter custom html code below top 10 results. Back to main menu
Enter Custom HTML Code to Create your "Bottom" header.
Please Note; The width of this area is dictated by the code you enter. It is always a good idea to contain it in a "table". This is so you can easily change the width if required.
Back to main menu
Apart from the main categories that are displayed in the main menu, you may also want to include the following links to additional web pages that are standard on most sites.
The "HTML Text" entered here is only displayed in the results column. It is also used by your custom templates where the <#results#> command is used.
Create a Delivery and Returns page.
Create a Terms & Conditions page.
Create a "Contact" page.
Create an "About Us" page.
Please Note: The main category links that are displayed in the main menu by default link to the “category search” facility. If you want to override this and produce a custom introduction page for your chosen main category then see “CREATE CUSTOM CATEGORY PAGES” in the “Admin” menu.
Back to main menu
Viewing your Alterations
Please Note: We provide standard graphics for this site. If you wish to change them see “EDIT SITE GRAPHICS” in the “Admin” menu.
Saving your Alterations. Back to main menu
This area allows you to create your own custom site template. You design it just like you would any normal web page. Do not feel restricted!
How does it work?.
It really is that simple.
All you need to do is make sure they are available and properly configured first so we know what you want the commands to do and if required, how they are to be displayed.
NOTE: If you are using custom templates for the first time we strongly recommend that you first create a very simple template that includes the replace commands you wish to use. Once you are confident and understand how they work then proceed to include them in your desired custom template code.
A very simple example of how to use replace commands is displayed at the bottom of this section.
To save a custom template and make it active always ensure that the “YES” button is ticked at the top of the page. If it is not the default template will still be used.
IMPORTANT! If you are using the site as a shopping basket and need to enter internal links other than those imported from the "DEFAULT SITE TEMPLATE".
REPLACE COMMANDS DESCRIBED IN DETAIL
The main command you must use here is : Other (optional)commands that can be used are;
Shopping Basket
META tags
To add Keyword search
|
|
Enter your custom site html below. This is the area that you enter your template code. A very basic template is shown below that illustrates how the various replace commands work and lists them down the page.. It assumes that the data required is available or the replace commands will be ignored and not displayed. Copy it to your site to see how it works with your configuration. |
| <#main_menu#> | <#results#> |
<#top_10#>
The number of items in your shopping basket = <#basket_items#> The total cost of items in your shopping basket = <#basket_total#> View Basket Go to checkout meta title text = <#meta_title#> meta description text = <#meta_description#> meta keywords text = <#meta_keywords#> Hidden Keywords = <#hidden_keywords#> |
Back to main menu