Web Services

Web Services Internal Development Standards

Include Files

All Web Services pages will use server-side include files (separate HTML files that are included in the main page by the Web server) for common page regions that are repeated on every page in the site. These include

Page banner (header.html)
Left hand navigation bar (leftnav.html)
Search Box [if present] (search.html)
Page footer (footer.html)

In order for the server to know to include the include file when the page is requested, the page must have the extension ".shtml" (except for ASP files and files generated in Collage). Do not change this extension.

Using Include Files

The easiest way to use the include files is to use the pre-built template files for the site. You can access the templates here.

To manually add include files to a document, you will need to add a reference to the include file to your HTML page and make sure that the file's extension is changed to ".shtml."

Open the file you wish to edit.
Locate the place on the page where you want the include to appear.
In code view, add the correct include statement. The path should be in the form of a root referenced path (see below). For the Web Services site, the include statement will look as follows: 
Be sure to change the file extension to ".shtml" (except for ASP files, which will be unchanged). Note: Changing the file extension effectively changes the name of the file. Bookmarks that users have made will no longer work, and will have to be updated.

Root References

All externally referenced files, including includes, JavaScript files and style sheets will be referenced in the same manner using root-based file references. Root-based references are based on the domain level. For pages residing on the main Chico State Web server, the domain level is www.csuchico.edu. For pages residing on the Aphid server, the root level is aphid.csuchico.edu.

To use a root reference, you must include the entire path of the desired file that comes after the domain. All root-based references must begin with a "/". For a file located at:

http://aphid.csuchico.edu/tlpvirtual/atec/_scripts/scripts.js

the root referenced path would be everything after the domain:

/tlpvirtual/atec/_scripts/scripts.js

Links to style sheets should appear as:

<link href="/tlpvirtual/atec/_styles/styles.css" media="screen" rel="stylesheet" type="text/css" />

Links to Javascript files should appear as:

<script type="text/javascript" src="/tlpvirtual/atec/_scripts/scripts.js"></script>

Links to include files should appear as:

Top