Using UKOLN SSIs |
|
Using UKOLN SSIs |
|
This document describes how to use the UKOLN server-side include (SSI) files located under:
Two sets of SSI files are provided - one for XHTML 1.1 pages, one for HTML 4.01 pages. The use of XHTML 1.1 is strongly encouraged for new UKOLN Web pages. The HTML 4.01 SSIs are provided primarily to support UKOLN's existing Web pages and for the use of tools that do not yet support XHTML.
Two page templates are available. Use these templates for any new pages that you create. The templates are available at:
Copy the template and edit it as required by dragging them from the locations above.
The outline of a basic XHTML page is:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <!--#config errmsg="" --> <!--#include virtual="/resources/ssi/basemeta.ssi" --> <!--#include virtual="meta.ssi" --> <!--#set var="title" value="UKOLN basic page" --> <!--#set var="h1" value="UKOLN" --> <!--#set var="h2" value="Basic page" --> <!--#set var="creator" value="Andy Powell" --> <!--#set var="creatorurl" value="http://www.ukoln.ac.uk/ukoln/staff/a.powell/" --> <html> <head> <title><!--#echo var="title" --></title> <!--#include virtual="/resources/ssi/xhtml11/stylesheet.ssi" --> <!--#include virtual="/resources/ssi/xhtml11/printmeta.ssi" --> </head> <body bgcolor="#ffffff"> <!--#include virtual="/resources/ssi/xhtml11/header.ssi" --> <!-- start of page content --> <p>...page content goes here...</p> <!-- end of page content --> <!--#include virtual="/resources/ssi/xhtml11/footer.ssi" --> |
Every page should have a correct DOCTYPE declaration. This can be done in two ways. Either explicitly include the declaration or include the appropriate SSI, as follows:
| XHTML 1.1 | HTML 4.01 |
|---|---|
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <!--#include virtual="/resources/ssi/xhtml11/doctype.ssi" --> | <!--#include virtual="/resources/ssi/html401/doctype.ssi" --> |
In general, the explicit declaration is preferred because otherwise tools that validate may have problems validating the page content.
The following SSI variables may be set:
| Variable | Description |
|---|---|
| title | The page title. |
| creator | The author's name - e.g. 'Andy Powell'. |
| creatorurl | The author's home page URL. |
| description | A short (one or two sentence) description of the page content. |
| subject | A set of keywords (less than 15) for the page content. |
| publisher | The name of the publisher - default 'UKOLN, University of Bath'. |
| h1 | The main title on the page - default 'UKOLN'. |
| h2 | The sub-title on the page. |
| pagelogo | For pages like http://rssxpress.ukoln.ac.uk/, the URL for the page logo. |
| pagelogourl | For pages like http://rssxpress.ukoln.ac.uk/, the URL to link to from the page logo. |
| pagelogoalt | For pages like http://rssxpress.ukoln.ac.uk/, the 'alt' text for the page logo. |
| funderlogo | For pages like http://www.ukoln.ac.uk/distributed-systems/jisc-ie/arch/, the URL of the funder's logo. |
| funderlogourl | For pages like http://www.uk oln.ac.uk/distributed-systems/jisc-ie/arch/, the URL to link to from the funder's logo. |
| funderlogoalt | For pages like http://www.uk oln.ac.uk/distributed-systems/jisc-ie/arch/, the 'alt' text associated with the funder's logo. |
These variables should either be set in an SSI file called meta.ssi in the same folder as your Web page, or in the page itself, immediately after the:
<!--#include virtual="meta.ssi" -->
line. The correct syntax for setting a variable is:
<!--#set var="title" value="A UKOLN page title" -->
All pages must set the title variable.
The SSI files et the following CSS classes: