Contributions

Features (Category Index)
Search: 

Simple Template System (STS)

Simple Template System (STS) README.txt v1.3

-----------------------------------------------------------------------------
WHAT IT DOES:
-----------------------------------------------------------------------------
Lets you create simple HTML templates to customize the look and feel of OSC.

You simply create an HTML page that looks the way you want it to and put in
placeholders for the various elements wherever you want to position them.

For example, you would put "$cartbox" wherever on the page you want the
Shopping Cart box to appear. Put "$categorybox" where you want the Categories
box to appear. Put "$content" wherever you want the main page
content (the central part where all the magic happens) to appear, etc.

It does this by changing only a few /catalog/includes/ files, leaving all
other files untouched, making it easy to add other contributions later.

-----------------------------------------------------------------------------
BONUS FEATURES: Simple HEADER TAG CONTROLLER Integration
-----------------------------------------------------------------------------
This contribution also allows you to use WebMakers.com's
Header Tag Controller contribution without having to modify every file on
the system. Just copy the Header Tag Controller's include files into place
and STS will automatically add them to all pages without having to modify
every PHP script in the /catalog/ directory.

STS will auto-detect if Header Tag Controller is installed and use it if
available.

-----------------------------------------------------------------------------
HOW TO INSTALL:
-----------------------------------------------------------------------------

Installation Instructions are found in the readme.txt file included in the package. Please read the readme.txt file for a list of installation instructions, new features, new variables and other enhancements to STS.

-----------------------------------------------------------------------------
HOW TO USE:
-----------------------------------------------------------------------------
Just modify the

/catalog/includes/sts_template.html

file to look however you want. Use stylesheet settings or HTML setting to
provide a custom look and feel to your site and arrange elements wherever you
like them.

-----------------------------------------------------------------------------
SUPPORTED TAGS:
-----------------------------------------------------------------------------
Here are the tags that are supported so far (more sure to come in later
versions):

$headcontent: Put this string in your <head> section so that it can insert
the dynamic head content and javascript on pages that require it. This will
probably require putting the $headcontent in the <head> section in the source
code. It's a pain to do it this way, but it was the only way I could get it
working. Sorry!

<!--$headcontent--> : You can use this commented format of $headcontent to
keep the word "$headcontent" from displaying in your web authoring software.

NOTE: Do not put <title>...</title> tags in your header. It will be added
as part of the $headcontent variable, along with the Description and Keywords
meta tags if you have the WebMakers.com's Header Tag Controller contribution
installed.

$cataloglogo: The OSC logo and link
$urlcataloglogo: The URL used by the $catalog logo.
$myaccountlogo: The MyAccount graphic and link
$urlmyaccountlogo: The URL used by the My Account function
$cartlogo: The Cart graphic and link
$urlcartlogo: The URL used by the Cart function
$checkoutlogo: The Checkout graphic and link
$urlcheckoutlogo: The URL used by the Checkout function
$breadcrumbs: The "Top > Catalog > whatever..." breadcrumbs text and links
$myaccount: The text version of "My Account" and link. Changes to "Logoff" if logged on.
$urlmyaccount: The URL used by the MyAccount function.
$cartcontents: The text version of the "Cart Contents" function.
$urlcartcontents: The URL used by the MyAccount function.
$checkout: The text version of the "Check Out" function.
$urlcheckout: The URL used by the "Check Out" function.

$categorybox: The Category box
$manufacturerbox: The Manufacturer box
$whatsnewbox: The What's New box
$searchbox: The Search box
$informationbox: The Information box
$cartbox: The Shopping Cart box
$maninfobox: The Manufacturer Info box (blank if not used on a page)
$orderhistorybox: The Order History box (blank if not used on a page, ie: use not logged in)
$bestsellersbox: The Best Sellers box
$specialfriendbox: Either the Specials box or the Tell A Friend box (depending on page viewed)
$reviewsbox: The Reviews box
$languagebox: The Languages box
$currenciesbox: The Currencies box
$content: The main content of the page (the middle of the page)
$date: The current date
$numrequests: The "XXX requests Since DATE" text
$counter: The page view counter
$footer: The footer output from footer.php
$banner: The banner output from footer.php

$sid: The string for the Session ID in the format "SessionIdVarName=WhateverTheSessionIdIs"


-----------------------------------------------------------------------------
DEBUGGING:
-----------------------------------------------------------------------------
In the /catalog/includes/application_bottom.php file you can see the
following settings (near the top of the file):

$display_template_output = 1;
$display_normal_output = 0;
$display_debugging_output = 0;

Display_Template_Output (the default setting) will cause it to display the
template versions of the pages.

Display_Normal_Output will cause it to display the non-template version of
the pages.

Display_Debugging_Output will cause it to display debugging information
showing all of the blocks of data that it is using and how it translates
them into template variables.

You can use any or all of the settings in any combination. If you have both
Normal and Template output, the Template output will be displayed first.

-----------------------------------------------------------------------------
REMOTE DEBUGGING:
-----------------------------------------------------------------------------
You can toggle the debugging options via URL options. You can use the
following parameters in your URL to turn on/off options from your browser

sts_template=1 Turns on the Template display
sts_template=0 Turns off the Template display
sts_normal=1 Turns on the Normal display
sts_normal=0 Turns off the Normal display
sts_debug=1 Turns on the Debugging display
sts_debug=0 Turns off the Debugging display
sts_version=1 Turns on Version Number display
sts_version=0 Turns off Version Number display

-----------------------------------------------------------------------------
SUPPORT:
-----------------------------------------------------------------------------

For support, please post to the Simple Template System thread here:

http://forums.oscommerce.com/index.php?showtopic=58541

Expand All / Collapse All

Latest version of STS is 4.5.8 bkellum 13 Apr 2008

The latest version of STS is STSv4.5.8 Dated Jan 23, 2008.

By the way, STSv4.5.8 does not have any "missing files". All the files are there that need to be there.

If you are interested in add-ons for STS, look to the STSv4 Power Pack download site located at: http://www.oscommerce.com/community/contributions,4456. The Power Pack site has new STS tags, tips, other contribution integration, etc.

This was posted so as not to confuse where to download the latest version of the Simple Template System (STS).

Header Tags Fix Info raphaellogan 13 Apr 2008
STS Support Links bkellum 23 Mar 2008
STSv4.5.8 for all osC 2.2 versions bkellum 23 Jan 2008
STSv4.5.8 bkellum 23 Jan 2008
STSv4.5.8 bkellum 16 Dec 2007
STSv4.5.8 bkellum 29 Oct 2007
STS 4.5.7 for 2.2MS2 and RC1 Fredrik.r 23 Oct 2007
STS 4.5.6 for 2.2MS2 and RC1 iRAY 12 Sep 2007
french translation for sts 4.5.5 elkhalil 1 Sep 2007
STS v4.5 SP5 rigadin2 22 Aug 2007
STS 4.5.4 for 2.2MS2 and RC1 rigadin2 22 Aug 2007
STS v4.5.3 for osC Online Merchant RC1 bkellum 15 Jul 2007
STS v4.5.3 for osC Online Merchant RC1 bkellum 5 Jul 2007
STS v4.5.3 for osC Online Merchant RC1 bkellum 4 Jul 2007
Dutch language package enturion 21 May 2007
STS v4.5.2 philbar 9 Apr 2007
Top SEarch for STS gmltw 6 Apr 2007
STS v4.5 SP2 rigadin2 4 Apr 2007
STS v4.5 SP1 rigadin2 3 Apr 2007
STS v4.5 rigadin2 29 Mar 2007
STS v4.4 rigadin2 31 Jan 2007
STS v4.3.3 User Manual bkellum 28 Dec 2006
STS v4.3.3 Core Files bkellum 28 Dec 2006
SP3 for STS v4.3 rigadin2 12 Dec 2006
SP2 for STS v4.3 rigadin2 7 Dec 2006
STS v4.3.2 with Header Tags Controller v2.6.0 DOCUMENTS bkellum 2 Dec 2006
STS v4.3.2 with Header Tags Controller v2.6.0 bkellum 2 Dec 2006
v4.3 SP2 Revised dainbramaged05 30 Nov 2006
v4.3 SP2 again rigadin2 29 Nov 2006
v4.3 SP2 rigadin2 29 Nov 2006
osC MS2 060817 Module Patch for STSv4.2 & 4.3 bkellum 24 Nov 2006
STS v4.3 SP1 rigadin2 15 Nov 2006
STS v4.3 with Header Tags Controller v2.5.9 DOCUMENTS bkellum 6 Nov 2006
STS v4.3 with Header Tags Controller v2.5.9 bkellum 6 Nov 2006
STS v4.3 rigadin2 2 Nov 2006
060817 osCommerce patch for STSv4.2 bkellum 22 Oct 2006
clean, standard-looking sts_template.html stevegt 8 Oct 2006
Infobox Templates for use with STSv4.2 bkellum 25 Aug 2006
STS v4.2 with Header Tags Controller 2.5.9 bkellum 19 Aug 2006
STS v4.2 bkellum 10 Aug 2006
Infobox Templates for STS Grinya 8 Jun 2006
Infobox Templates for STS Grinya 8 Jun 2006
Infobox Templates for STS Grinya 8 Jun 2006
Product info module v1.0.6 rigadin2 5 Jun 2006
Index module v1.0.3 for STS4 rigadin2 8 May 2006
STS v4.1 (sts.php typo) cally 14 Apr 2006
small STS v4.1 update cally 14 Apr 2006
STS v4.1 rigadin2 12 Apr 2006
PopUps STS v3 beta fix kiss2000 4 Jan 2006
PopUps STS v3 beta v2 kingsleyh 4 Jan 2006
PopUps STS v3 beta kingsleyh 18 Dec 2005
Adding Static Content JonnyCalcutta 24 Nov 2005
Multiple Category Template? fibra 19 Nov 2005
STS 2.1 with SEO Metatags dasruud 20 Oct 2005
Register Global ellis 19 Oct 2005
Simple Template System (STS) v3.00 Beta 2 DiamondSea 31 Jul 2005
Simple Template System (STS) v3.00 Beta DiamondSea 25 Jul 2005
Updated STS A. Fernandes 2 Jul 2005
How to use pop up or click to enlarge with the product_info.php.html file sjones 10 Jun 2005
Additional template options Greg K 26 May 2005
STS and Master Products WITH product_info.php.html template Stot 19 May 2005
Popup Image from product_info.php.html template Stot 19 May 2005
STS fix for SEF and Ultimate SEO URLs ACE 14 May 2005
sts_header_tag_fix ITNetwork Designs 24 Apr 2005
STS + Dynamic Information Pages Steve Oliveira 25 Mar 2005
STS + DHTML Categories Menu Addon Steve Oliveira 16 Mar 2005