New Template information

Template Variations

Template variables

These variables listed below would usually be used in the parent include for a subsite. This ensures that each subsite has consistent settings.

Colour, Coat of Arms combinations

prefHeader

The header is available either in the preferred red layout or in the alternative white layout. To select the white option set prefHeader to white


wordMark

Schools may wish to include their word mark in the top banner. When including a word mark it is important to select an image that will blend in with the banner colour.
Usage:

<!--#set var="wordMark" value="<a href='http://www.waikato.ac.nz/smpd/'<img src='/images/coa_wm_smpd.gif' border='0' alt='school of Maori and Pacific Development'></a>"-->

Search Variables

searchCat

This is to specifiy which search catalogue the site will use, it is defined in the parent include file, if nothing is specified then it will default to the htdig catalogue which covers the entire university website.
Usage:


	<!--#set var="searchCat" value="calendar"-->

searchRestrict

This is to restrict the search, it is defined in the parent include file, if nothing is specified then it will default to empty string.
Usage:


	<!--#set var="searchRestrict" value="www.waikato.ac.nz/law/"-->

searchAction

If there is a catalogue setup for the particular subsite then the variable searchAction must be set. htsearch script is not being called directly as a CGI program, but indirectly from within a dynamic .shtml page using SSI directives.
Usage:


	<!--#set var="searchAction" value="/search/result.shtml"-->

showSearch

In exceptional circumstances the search box can be suppressed. The search form should be suppressed when having a search form in the page banner will cause confusion.
Usage:


	<!--#set var="showSearch" value="no" -->

Subsite Names

textOrgUnit

Use the textOrgUnit variable to include the name of the sub-site division, unit or school at the bottom of the page.
Usage:

pageTitle

Is the title that appears in the red bar at the top of the screen. If it is not specified then the $subSiteTitle will be used. For individual pages that need a different title, it is best to specify $pagetitle in the page itself, and must be specified before the parent include file. $pagetitle is been used on this page to display "New Template Guide" in the red banner.
Usage:

subSiteTitle

Is defined in the parent include file and refers to the title that appears at the top of the page within the red navigation bar. If specified then it will apply to all pages that include that parent include file, unless $pagetitle is specified within a page before the parent include file. If $subSiteTitle is not defined then the banner title defaults to "Haere Mai Welcome". eg. $subSiteTitle is used within the Calendar site.
Usage:

Navigation

footerNav

To set additional "bottom of page" navigation features, use the footerNav variable. The value of footerNav will included at the bottom of the page between two horizontal rules and above the standard footer.
Usage: 

navLocal

To create left hand navigation, use the navLocal variable. When the navLocal variable is set the global include will auto-magically create the left hand column and place the contents of navLocal in it.
Usage:

<!--#set var="navLocal" value="<div class = 'sidemenu'>
 
	<p
	class = 'sidemenutitle'>Template Details</p> 

	<p><a href
	= '/guidelines/2004_web-templates/development.shtml'>Web Template Development
	Process</a></p>
 
	</div>" -->

learningLink
researchLink
libraryLink
enrolmentLink
newsLink
aboutLink
contactLink

This dictates what pages are to be linked in at the top of the page, if not defined in the parent include then the defaults are used. They can be defined within the parent include file in the following format.


learningLabel
researchLabel
libraryLabel
enrolmentLabel
newsLabel
aboutLabel
contactLabel

This dictates what label is on the Menu items at the top of the screen, if not defined in the parent include then the defaults are used.


$learningLink ='no'

If less than the seven links across the top of the page are required then, this can be supressed by setting the appropriate link variable to 'no'. This page has


addressLink

If you would like the address link in the footer to go to an address page for your subsite. Then use the variable addressLink to set the subsite address page


extraFooter

This is any extra text that is added to the global footer, for example who the page was designed by. It must include the | to seperate it plus a space.


urlGrandParentHome
labelGrandParentHome

The grandparent home for a subsite may be a organisational unit, for example the grandparent for the School of Science and Technology site might be "Schools and Academic Faculties". Alternatively the gradparent for a site might be type of information that the subsite holds, for example the gradparent for the University Calendar might be "Official University Inofrmation"
usage: 

ParentHome and SubsiteHome

There are also variables to specify the url and label of the parent and subsite homes. GradParentHome/ParentHome and SubsiteHome are used to create the Breadcrumbs/Backpath. If additional links are required then the variable navReverseLocal can be used.
usage: 

Others

showLastModified

If you wish to suppress the last modified statment included in the page footer set showLastModified = no. The last modified date is displayed in the form Wed Mar 24 10:57:58 2004


pageContent

The pageContent variable can take two values to select a different type of template either minimal or popup. The minimal template is for use when the page contains secured content. In this case people will know that they are at the University of Waikato and so a minimal top banner can be used. The popup template is for use on popup windows. This template includes a simplified version of the red header shape.
Usage: 

suppressCharset

In rare curcumstances it might be necessary to use a specific charset, eg If you need to have a page written in japanese then you would nned to use the shift_jis charset. In this case suppressCharset would be set to yes.
Usage: 

margin

Refers to the margin running down the left side of the page within the content section of the page. This is set to be on by default, although it can be turned off if required by using:
