Server Side Includes (SSI) with ASP

Server Side Includes (SSI) with ASP

People often have identical sections of code spread throughout many ASP pages, typically code at the top of the page (usually referred to as the header) and the lower part of the page (the footer). Similarly, you may have code that performs a certain set of instructions that you are repeating across multiple pages. Consider an example:-

<%
If foobar="yes" then
response.write "YES!"
Else
response.write "NOT YES!"
End if
%>

Ok, ok... it's simple, but imagine that you used this on multiple pages. What's wrong with this picture?

Well... you don't have to think about that long before realising that if you ever wanted to change something about that piece of code, you'd have your work cut out. you would have to change every page... everyone has done this at some stage and luckily most usually take the steps to learn a way around this problem.

If we could save our valuable chunk of code into a file and have that file accessed whenever we needed the code, then we no longer have a problem when it comes to changing things, as we simply update one file. Include files or Server Side Includes (SSI) as they are more commonly known are a powerful way to not only save time when it comes to maintaining and updating a site, but also increase efficiency and speed of that site too!

Ok, lets see how we use an include file... to start with we need to use one of two methods. The first one allows for including files relatively. By that I mean relative to the directory the ASP file that is using the include file resides. The second method includes files virtually. Including files virtually means that the path is taken from the root directory.

Consider that we are going to have a file (/main/somefile.asp) include another file (/includes/someinclude.asp).

To demonstrate, relative inclusion, look at this:-

<%
Response.Write "executing included code now"
%>
<!--#include file="../includes/someinclude.asp"-->
<%
Response.write "done executing included code"
%>

And here, we give an example of the other method, virtual inclusion:-

<%
Response.Write "executing included code now"
%>
<!--#include virtual="/includes/someinclude.asp"-->
<%
Response.write "done executing included code"
%>

Note the slight difference between the two methods. With virtual inclusion, you can move the file that calls upon the include file anywhere without affecting the outcome, because the path is always relative to the root. The same cannot be said however for relative inclusion. If you move a file that is using relative inclusion to a different directory, you'll most likely find the relative path is no longer correct.

From the examples above, you may also notice that both methods, when calling the include do so OUTSIDE of the ASP script block. This because #include declarations are not interpreted by ASP. Include files are included before a single line of ASP is processed which means the following WONT work:-

%lt;%
Page=request.form("page")
%>
<!--#include file="../includes/<%=page%>.asp"-->

We were attempting to perform a dynamic include and I would be the first to admit that the above would be very useful indeed if in fact it were possible. I do intend to cover a few methods that work around this set back but I know you will now be itching to get started right away on using include files to even worry about this, so I will cover it in a future article.

I hope that you have found the above informative and hope it inspires you all to write code that's more efficient and more easily maintained.

Rob Collyer, experienced with 20 years programming knowledge and site administrator of www.webforumz.com - Copyright 2003-2004

More Web Development Articles

Functions and Subroutines in ASP
Functions and Subroutines in ASP If you read our Tutorial on Include Files (SSI) then you learned how to encapsulate ASP code within include files and the benefits it brings us. As developers, we should endeavour to make our lives easier wherever possible.

Website Design Info - Part 1
What Will My Site Do?This is the first of eight articles about website design. Our discussion will deal with some of the issues which need to be considered when developing a new online presence.

HTML - A Website Language Explained - For Over 35s
This is a very perfunctory look at the website code HTML, for those who never did any kind of Computer Studies at school and have never had the need or opportunity to look ?under the skirt? of your average website. There's nothing that an experienced webmaster will find here that's not very basic, but for those who have just begun to discover the 'website' and especially those venturing into.

Why Hire a Professional to Design Your Web Site?
Creating an appealing, functional, and effective Web site is much harder than it looks. It's not simply a matter of taking a company brochure or catalog, converting the text to HTML, and throwing in a few pictures (although many sites seem to have been created using this technique!).

How To Shop for a Web Design Firm?
While few companies can boast as we do that our first ten clients are still with us today, many companies often change Web design firms to get a new perspective on how their Web presence could look and perform. The following paragraphs serve as a Buyer?s Guide to use when shopping for a new Web design company.

9 Ways to Gain Your Visitors Respect
The internet is filled with sites and they are good and bad. Some have been known for a long time and some still struggle to get the respect and fame they think they deserve.

How Do We Know When Its Time To Redesign Our Web Site?
A question we frequently get asked is, ?how do we know when it is time to redesign our Web site?? The answer undoubtedly varies.The first thing to analyze is your existing Web presence.

KIS - Keep It Simple
There are many ways to add fancy bells and whistles to your website, but most of them are not going to do you any good. In fact they will slow down the time it takes to load your website and take up valuable space that you are paying for.

Design Your Site For Your Customers
The most important person that you need to please when you design your site is your potential customer. I can not stress that enough.

Effective Web Design Usability Principles
Website Design Usability Tips1. Getting to know about audience membersYou want a site that has personality and quality content based on your audience taste.