Configuration options
The KU Template runs by using server-side includes (SSI) and settings that affect the template. Below is a list of all customizeable template settings within the KU Template. These settings should be placed either in your header file OR in the web page itself before calling your myheader include.
Basic Site-Wide Settings
You will likely want to define all these settings in your header file. These settings are used on every page of your site.
abovemain
URL to file to include below the top grey-lined bar but above the left-navigation and main content
areas.
See a demo example
See a demo example
Default Value: none
Example
<!--#set var="abovemain" value="/~accountname/myssi/abovemain.shtml" -->
bgoption
Select the type of header to use. Header options can be seen on the page layouts and styles section of the template documentation.
Valid Values:
- background1 - blue header with top navigation bar
- background2 - blue header without top navigation bar
- background3 - grey header with top navigation bar
- background4 - grey header without top navigation bar
- background5 - blue & red without top navigation bar
Default Value: background1
Example
<!--#set var="bgoption" value="background3" -->
leftnav
URL to your navigation file containing the navigation links. This navigation is displayed in the left column of your site. You can also try some fancy-schmancy left navigation styles.
Default Value: none
Example
<!--#set var="leftnav" value="/~accountname/myssi/leftnav.shtml" -->
logo
Logo that appears in the upper left of your page. If not defined, the normal KU logo will be used.
Valid Values: Find your logo here
Default Value: ku
Example
<!--#set var="logo" value="comms" -->
logoalt
Image "alt" tag for your logo. This should be your department's full name as shown in your logo.
Default Value: The University of Kansas
Example
<!--#set var="logoalt" value="Information Technology" -->
logourl
When a user clicks on your logo, they will be taken to this URL. This should be set to your department's homepage URL.
Default Value: http://www.ku.edu
Example
<!--#set var="logourl" value="http://www.mysite.ku.edu/" -->
mybuilding
Optional building icon that appears at the top-center of the header (e.g. a Fraser Hall Icon.)
Valid Values:
- fraser - Fraser Hall
- off - No icon
Default Value: fraser
Example
<!--#set var="mybuilding" value="off" -->
mycss (5 total)
URL to your own Cascading Style Sheets from a separate file. These stylesheets are included within the <head> tag of the template. Up to 5 stylesheets can be included.
Default Value: none
Example
<!--#set var="mycss" value="/~accountname/css/mystyle.css" -->
<!--#set var="mycss2" value="/~accountname/css/mystyle2.css" -->
<!--#set var="mycss3" value="/~accountname/css/mystyle3.css" -->
<!--#set var="mycss4" value="/~accountname/css/mystyle4.css" -->
<!--#set var="mycss5" value="/~accountname/css/mystyle5.css" -->
<!--#set var="mycss2" value="/~accountname/css/mystyle2.css" -->
<!--#set var="mycss3" value="/~accountname/css/mystyle3.css" -->
<!--#set var="mycss4" value="/~accountname/css/mystyle4.css" -->
<!--#set var="mycss5" value="/~accountname/css/mystyle5.css" -->
mycss_media (5 total)
Cascading Style Sheets allow different styles to be applied in display situations, such as viewing from a browser, mobile phone or when printing. If the stylesheet you're including with the mycss setting is targeting a specific medium, specify it here. Use the number corresponding to your above mycss file. (e.g. mycss_media3 specifies the media for mycss3)
Valid Values: Read more here
Default Value: all
Example
<!--#set var="mycss_media" value="all" -->
<!--#set var="mycss_media2" value="screen, print" -->
<!--#set var="mycss_media3" value="tv, projection" -->
<!--#set var="mycss_media4" value="handheld" -->
<!--#set var="mycss_media5" value="screen" -->
<!--#set var="mycss_media2" value="screen, print" -->
<!--#set var="mycss_media3" value="tv, projection" -->
<!--#set var="mycss_media4" value="handheld" -->
<!--#set var="mycss_media5" value="screen" -->
myfooter
URL to your footer file. This file is embeded within the template footer.
Default Value: none
Example
<!--#set var="myfooter" value="/~accountname/myssi/myfooter.shtml" -->
myjs (5 total)
Add JavaScript files to be included within the <head> tag by specifying the URL to a JavaScript file. These files should be libraries you wish to include on ALL pages of your site. If you only need to include a library on a single page and not every page, use the pagejs variable. Up to 5 JavaScript files can be included in this way.
NOTE: If you want to include JavaScript libraries such as Prototype, YUI or TinyMCE, search the KU Web Media JavaScript Library for the KU-hosted URL. You are free to (and encouraged to) link to any file(s) within the Web Media Library.
NOTE: If you need to include an alternate version of jQuery other than the default version 1.3.2 included by the KU Template, use the jquery KU Template variable.
NOTE: If you want to include JavaScript libraries such as Prototype, YUI or TinyMCE, search the KU Web Media JavaScript Library for the KU-hosted URL. You are free to (and encouraged to) link to any file(s) within the Web Media Library.
NOTE: If you need to include an alternate version of jQuery other than the default version 1.3.2 included by the KU Template, use the jquery KU Template variable.
Default Value: none
Example
<!--#set var="myjs" value="/~accountname/js/myscript.js" -->
<!--#set var="myjs2" value="/~accountname/js/myscript2.js" -->
<!--#set var="myjs3" value="http://webmedia.ku.edu/js/swfobject/swfobject-2.2/swfobject.js" -->
<!--#set var="myjs4" value="http://www.remotesite.com/javascript/links.js" -->
<!--#set var="myjs5" value="/~accountname/js/myscript5.js" -->
<!--#set var="myjs2" value="/~accountname/js/myscript2.js" -->
<!--#set var="myjs3" value="http://webmedia.ku.edu/js/swfobject/swfobject-2.2/swfobject.js" -->
<!--#set var="myjs4" value="http://www.remotesite.com/javascript/links.js" -->
<!--#set var="myjs5" value="/~accountname/js/myscript5.js" -->
sitedescription
Description to be appended to pagedescription on every page of your site. Use sparingly.
Default Value: none
Example
<!--#set var="sitedescription" value="At the University of Kansas." -->
sitekeywords
List of meta-keywords and phrases search engines use to describe your entire site. Use sparingly, as keywords repeated on every page of your site might lessen your search engine ranking. Examples might be "biology department, science classes".
Default Value: none
Example
<!--#set var="sitekeywords" value="Your metadata keywords here, separated by commas" -->
sitetitle
Title appended to the pagetitle of every page on your site. The <title> tag will appear as <title>pagetitle sitetitle</title> This documentation site has a sitetitle of " - Web Developers Toolkit"
Default Value: none
Example
<!--#set var="sitetitle" value=" - My Department" -->
titleheader
Displays a title heading just below the top navgiation, but above the left navigation. Many departments populate this variable as their Department Name.
Default Value: none
Example
<!--#set var="titleheader" value="My Department" -->
topnav
URL to file of top navigation bar links. See a demo example.
Default Value: none
Example
<!--#set var="topnav" value="/~accountname/myssi/topnav.shtml" -->
weather
Add a weather icon and temperature to the top of your site, similar to the KU Homepage.
Valid Values:
- Lawrence Campus Weather:
- frasierlawrenceblue - Fraser Hall w/ Blue Background
- frasierlawrencegray - Fraser Hall w/ Gray Background
- statuelawrenceblue - KU Statue w/ Blue Background
- statuelawrencegray - KU Statue w/ Gray Background
- lawrence - Colored Fraser Hall, for use with bgoption background5 only
- Overland Park/Edwards Campus Weather:
- frasieropblue - Fraser Hall w/ Blue Background
- frasieropgray - Fraser Hall w/ Gray Background
- statueopblue - KU Statue w/ Blue Background
- statueopgray - KU Statue w/ Gray Background
- Kansas City/Med Center Weather:
- statuekcblue - KU Statue w/ Blue Background
- statuekcgray - KU Statue w/ Gray Background
- Email webservices@ku.edu if you need another city's weather
Default Value: none
Example
<!--#set var="weather" value="frasierlawrenceblue" -->
Per-Page Settings
These settings are unique for each page of your website and should be defined at the top of your source code before your header file include. It is important to define variables like pagetitle, pagekeywords, and pagedescription on every page because they are used by search engines to find your website.
breadcrumb (5 total)
Breadcrumbs appear in the bottom bar of the footer as links. These page/section titles should be in an order that allows your user to traverse back up the navigational hierarchy of your website. Use in conjunction with breadcrumburl variables.
For example, breadcrumb1 as "My Homepage" and breadcrumburl1 as "http://www.mydepartment.ku.edu" would create the link My Homepage
NOTE: When breadcrumb1 is used, the KU logo and url will appear at the beginning of the breadcrumb list
For example, breadcrumb1 as "My Homepage" and breadcrumburl1 as "http://www.mydepartment.ku.edu" would create the link My Homepage
NOTE: When breadcrumb1 is used, the KU logo and url will appear at the beginning of the breadcrumb list
Default Value: none
Example
<!--#set var="breadcrumb1" value="My Homepage" -->
<!--#set var="breadcrumb2" value="Link 2" -->
<!--#set var="breadcrumb3" value="Link 3" -->
<!--#set var="breadcrumb4" value="Link 4" -->
<!--#set var="breadcrumb5" value="Link 5" -->
<!--#set var="breadcrumb2" value="Link 2" -->
<!--#set var="breadcrumb3" value="Link 3" -->
<!--#set var="breadcrumb4" value="Link 4" -->
<!--#set var="breadcrumb5" value="Link 5" -->
breadcrumburl (5 total)
Breadcrumbs appear in the bottom bar of the footer as links. These page/section URLs should coincide with the equivalent breadcrumb variable to create a breadcrumb link.
For example, breadcrumb1 as "My Homepage" and breadcrumburl1 as "http://www.mydepartment.ku.edu" would create the link My Homepage
For example, breadcrumb1 as "My Homepage" and breadcrumburl1 as "http://www.mydepartment.ku.edu" would create the link My Homepage
Default Value: none
Example
<!--#set var="breadcrumburl1" value="http://www.myhomepage.ku.edu" -->
<!--#set var="breadcrumburl2" value="http://myhomepage.ku.edu/link2/" -->
<!--#set var="breadcrumburl3" value="http://myhomepage.ku.edu/link2/link3/" -->
<!--#set var="breadcrumburl4" value="http://myhomepage.ku.edu/link2/link3/link4/" -->
<!--#set var="breadcrumburl5" value="http://myhomepage.ku.edu/link2/link3/link4/link5/" -->
<!--#set var="breadcrumburl2" value="http://myhomepage.ku.edu/link2/" -->
<!--#set var="breadcrumburl3" value="http://myhomepage.ku.edu/link2/link3/" -->
<!--#set var="breadcrumburl4" value="http://myhomepage.ku.edu/link2/link3/link4/" -->
<!--#set var="breadcrumburl5" value="http://myhomepage.ku.edu/link2/link3/link4/link5/" -->
pagecss (5 total)
Includes stylesheet files within the <head> tag after the site-wide mycss stylesheets are included.
These variables should be used on a page-by-page basis to include external stylesheets that you don't want to load on every page of your site.
These variables should be used on a page-by-page basis to include external stylesheets that you don't want to load on every page of your site.
Default Value: none
Example
<!--#set var="pagecss" value="/~accountname/css/mystyle.css" -->
<!--#set var="pagecss2" value="/~accountname/css/mystyle2.css" -->
<!--#set var="pagecss3" value="/~accountname/css/mystyle3.css" -->
<!--#set var="pagecss4" value="/~accountname/css/mystyle4.css" -->
<!--#set var="pagecss5" value="/~accountname/css/mystyle5.css" -->
<!--#set var="pagecss2" value="/~accountname/css/mystyle2.css" -->
<!--#set var="pagecss3" value="/~accountname/css/mystyle3.css" -->
<!--#set var="pagecss4" value="/~accountname/css/mystyle4.css" -->
<!--#set var="pagecss5" value="/~accountname/css/mystyle5.css" -->
pagecss_media (5 total)
Cascading Style Sheets allow different styles to be applied in display situations, such as viewing from a browser, mobile phone or when printing. If the stylesheet you're including with the pagecss setting is targeting a specific medium, specify it here. Use the number corresponding to your above pagecss file. (e.g. pagecss_media3 specifies the media for pagecss3)
Default Value: all
Example
<!--#set var="pagecss" value="/~accountname/css/mystyle.css" -->
<!--#set var="pagecss_media" value="all" -->
<!--#set var="pagecss2" value="/~accountname/css/mystyle2.css" -->
<!--#set var="pagecss_media2" value="screen" -->
<!--#set var="pagecss3" value="/~accountname/css/mystyle3.css" -->
<!--#set var="pagecss_media3" value="print" -->
<!--#set var="pagecss4" value="/~accountname/css/mystyle4.css" -->
<!--#set var="pagecss_media4" value="mobile" -->
<!--#set var="pagecss5" value="/~accountname/css/mystyle5.css" -->
<!--#set var="pagecss_media5" value="screen" -->
<!--#include virtual="/~accountname/ssi/my_header.shtml" -->
<!--#set var="pagecss_media" value="all" -->
<!--#set var="pagecss2" value="/~accountname/css/mystyle2.css" -->
<!--#set var="pagecss_media2" value="screen" -->
<!--#set var="pagecss3" value="/~accountname/css/mystyle3.css" -->
<!--#set var="pagecss_media3" value="print" -->
<!--#set var="pagecss4" value="/~accountname/css/mystyle4.css" -->
<!--#set var="pagecss_media4" value="mobile" -->
<!--#set var="pagecss5" value="/~accountname/css/mystyle5.css" -->
<!--#set var="pagecss_media5" value="screen" -->
<!--#include virtual="/~accountname/ssi/my_header.shtml" -->
pagedescription
Description to be prepended to meta-tag description for sitedescription to describe the current page. Search engines will display this text when it's available, so it's important to describe the contents of your page in about 100 words or less.
Every page of your website should have a unique pagedescription defined, which greatly increases the ability for search engines to find your site.
Every page of your website should have a unique pagedescription defined, which greatly increases the ability for search engines to find your site.
Default Value: none
Example
<!--#set var="pagedescription" value="A description of your page here." -->
pagejs (5 total)
Add JavaScript files to be included within the <head> tag by specifying the URL to a JavaScript file. These files will be included after your myjs files. Up to 5 JavaScript files can be included in this way.
NOTE: If you want to include JavaScript libraries such as Prototype, YUI or TinyMCE, search the KU Web Media JavaScript Library for the KU-hosted URL. You are free to (and encouraged to) link to any file(s) within the Web Media Library.
NOTE: If you need to include an alternate version of jQuery other than the default version 1.3.2 included by the KU Template, use the jquery KU Template variable.
NOTE: If you want to include JavaScript libraries such as Prototype, YUI or TinyMCE, search the KU Web Media JavaScript Library for the KU-hosted URL. You are free to (and encouraged to) link to any file(s) within the Web Media Library.
NOTE: If you need to include an alternate version of jQuery other than the default version 1.3.2 included by the KU Template, use the jquery KU Template variable.
Default Value: none
Example
<!--#set var="pagejs" value="/~accountname/js/myscript.js" -->
<!--#set var="pagejs2" value="/~accountname/js/myscript2.js" -->
<!--#set var="pagejs2" value="http://webmedia.ku.edu/js/swfobject/swfobject-2.2/swfobject.js" -->
<!--#set var="pagejs4" value="http://www.remotesite.com/javascript/links.js" -->
<!--#set var="pagejs5" value="/~accountname/js/myscript5.js" -->
<!--#set var="pagejs2" value="/~accountname/js/myscript2.js" -->
<!--#set var="pagejs2" value="http://webmedia.ku.edu/js/swfobject/swfobject-2.2/swfobject.js" -->
<!--#set var="pagejs4" value="http://www.remotesite.com/javascript/links.js" -->
<!--#set var="pagejs5" value="/~accountname/js/myscript5.js" -->
pagekeywords
Keywords to be prepended to meta-tag keywords defined in sitekeywords to describe the current page.
Keywords and phrases should be separated by commas. Having unique keywords on each page greatly increases the ability for search engines to find your site.
Keywords and phrases should be separated by commas. Having unique keywords on each page greatly increases the ability for search engines to find your site.
Default Value: none
Example
<!--#set var="pagekeywords" value="Page specific metadata keywords here, separated by commas" -->
pagetitle
Title of your individual web page to display in the <title> tag. This value is prepended to your sitetitle.
Every page of your website should have a unique pagetitle defined, which greatly increases the ability for search engines to find your site. Look in the title bar of the browser, and see this page has a pagetitle of "Configuration Options for the KU Template".
Every page of your website should have a unique pagetitle defined, which greatly increases the ability for search engines to find your site. Look in the title bar of the browser, and see this page has a pagetitle of "Configuration Options for the KU Template".
Default Value: none
Example
<!--#set var="pagetitle" value="Your Page Title Here" -->
Advanced Site-Wide Settings
These settings will not be used by every website, and are for advanced developers.
bodyoptions
Add custom HTML attributes to the <body> tag. Variable contents are written directly inside the <body> tag as:
<body <!--#echo var="bodyoptions"-->>
<body <!--#echo var="bodyoptions"-->>
Default Value: none
Example
<!--#set var="bodyoptions" value="class='secondlevel' onLoad='myfunction()'" -->
breadcrumbinclude
If you do not wish to use the default breadcrumb variables, you can include your own file containing the
correct breadcrumbs. This is useful if you are using a script to auto-generate your breadcrumbs.
Default Value: none
Example
<!--#set var="breadcrumbinclude" value="/~myaccount/cgi-bin/breadcrumbs.php" -->
copyright
Set the copyright at the very bottom of the footer. Will appear as: © Your copyright text
Default Value: none
Example
<!--#set var="copyright" value="2009 The Department of Website Design" -->
favicon
URL to your favicon image. What is a favicon?
Default Value: http://www.ku.edu/favicon.ico
Example
<!--#set var="favicon" value="http://www2.ku.edu/~accountname/favicon.ico" -->
googleanalytics
Include your site in Google Analytics statistics gathered for the entire KU Web. This allows KU IT to view statistics about your website for purposes of analyzing traffic trends and how visitors use the KU website as a whole.
In addition, if you would like to view the statistics yourself, you will need a Google Account, then complete the Request Google Analytics form. We will generate a googlecode for you to add to your site.
In addition, if you would like to view the statistics yourself, you will need a Google Account, then complete the Request Google Analytics form. We will generate a googlecode for you to add to your site.
Default Value: none
Example
<!--#set var="googleanalytics" value="1" -->
googlecode
Adds your website's Google Analytics tracking code. This will allow you to see statistics about how users use your site, such as what pages are most visited, which web browser they use and how many new visitors your website attracts.
To view your statistics, you will need a Google Account, then complete the Request Google Analytics form. We will generate a googlecode for you to add to your site.
To use the this variable, the googleanalytics variable must be set to a value of 1.
To view your statistics, you will need a Google Account, then complete the Request Google Analytics form. We will generate a googlecode for you to add to your site.
To use the this variable, the googleanalytics variable must be set to a value of 1.
Default Value: UA-876256-5 (default KU code)
Example
<!--#set var="googleanalytics" value="1" -->
<!--#set var="googlecode" value="UA-555555-5" -->
<!--#set var="googlecode" value="UA-555555-5" -->
gridtoggle
Adds a "Show Grid" button to the top left of your page. When clicking the button, the CSS layout grid framework Blueprint is visible. This should be used during development/testing only. See CSS Layout & positioning using the Blueprint Framework for an example.
Default Value: 0
Example
<!--#set var="gridtoggle" value="1" -->
http
Print the HTTP protocol used by the page. Auto-populates with value "http" or "https" based on if the page is accessed as http:// or https://.
Should be used when including absolute-URL items on an HTTPS page, such as JavaScript or CSS libraries on from the KU Web Media Library. Doing this will ensure all content is delivered over the correct HTTP protocol no matter what page it is viewed from, and accesses all page content using a secure-connection. Not doing so usually causes IE to display an error message, or a broken-SSL lock in other browsers.
Should be used when including absolute-URL items on an HTTPS page, such as JavaScript or CSS libraries on from the KU Web Media Library. Doing this will ensure all content is delivered over the correct HTTP protocol no matter what page it is viewed from, and accesses all page content using a secure-connection. Not doing so usually causes IE to display an error message, or a broken-SSL lock in other browsers.
Default Value: http
Example
<!--#set var="pagejs" value="<!--#echo var="http"-->://webmedia.ku.edu/path/to/file.js" -->
jquery
Specify which version of jQuery to include, or set to "off" to disable including jQuery. The version you specify must exist in the KU Web Media JavaScript Library.
NOTE: jQuery is included by default to power dynamic functionality in the KU Template. Turning off jQuery, or setting to a version earlier than the default, may break some non-critical functionality in the KU template.
NOTE: The default jQuery instance used in the template is accessible using $kuj instead of the jQuery default $
Visit the jQuery documentation for how to use jQuery.
NOTE: jQuery is included by default to power dynamic functionality in the KU Template. Turning off jQuery, or setting to a version earlier than the default, may break some non-critical functionality in the KU template.
NOTE: The default jQuery instance used in the template is accessible using $kuj instead of the jQuery default $
Visit the jQuery documentation for how to use jQuery.
Default Value:
1.3.2
Example
<!--#set var="jquery" value="1.2.6" -->
kuoldcompatible
Set to 1 to support old CSS styles and SSI variables from the previous KU template. This is useful when converting a site to the new KU Template quickly, but will not be supported in the next iteration of the template.
Default Value: 0
Example
<!--#set var="kuoldcompatible" value="1" -->
lang
Specify what language you would like your page/site to use.
Default Value:
EN-US
Example
<!--#set var="lang" value="i-navajo" -->
mycharset
Specify what character set you would like your page/site to load.
Default Value:
UTF-8
Example
<!--#set var="mycharset" value="iso-8859-1" -->
mygoogle
If you have a Google subcollection for your web site, enter the name of the subcollection here. The search menu in the KU Template banner will include that subcollection as the default choice. How to add Google Search to your web site.
Default Value: none
Example
<!--#set var="mygoogle" value="subcollection_name_here" -->
mygooglelabel
Text to appear in the drop down search box at the top of the template for your mygoogle subcollection.
NOTE: Putting too much text in this variable may cause layout issues in the template.
NOTE: Putting too much text in this variable may cause layout issues in the template.
Default Value:
Search this site
Example
<!--#set var="mygooglelabel" value="Search the toolkit" -->
noprintstyles
Set to 1 to turn disable the default KU template print stylesheet (which hides the template header and footer when printing the page.) Setting to 1 would cause your pages to print with the header and footer.
Default Value: none
Example
<!--#set var="noprintstyles" value="1" -->
otherheaderinfo
URL to a file with additional code to add within the <head> tag. This file is included right before </head>.
Default Value: none
Example
<!--#set var="otherheaderinfo" value="/~accountname/myssi/otherheaderinfo.shtml" -->
top
