Source Code for http://authors.aspalliance.com/brettb/ASPDocumentationTool.asp
<html>
<!--Begin ASPAlliance Document Header-->
<head>
<title>An ASP Documentation Tool™</title>
<link type="text/css" rel="stylesheet" href="ASPKitchen.css" />
<meta name="description" content="The ASP Documentation Tool™ automates the documentation of web applications developed using ASP 2.0 or 3.0 and the VBScript and JScript scripting languages">
<meta name="keywords" content="ASP, documentation, tool, utility, VBScript, JScript">
</head>
<!--Begin ASPAlliance Document Article-->
<body topmargin="0" leftmargin="0">
<div align="center"><center>
<script language="JavaScript">
function SubmitSearch() {
document.frmSearch.submit();
}
</script>
<table border="0" cellpadding="0" width="100%" cellspacing="0">
<tr>
<td width="30%" bgcolor="#CC0000"><a href="http://authors.aspalliance.com/"><img
src="images/ASPAllianceLogo.gif" width="142" height="57" alt="ASPAlliance" border="0"></a></td>
<td width="40%" bgcolor="#CC0000" align="center"><!-- 468x60 Banner Ad Tag Start -->
<iframe src="http://ads.aspalliance.com/displayad.aspx?t=1&m=1" height="60" width="468" marginwidth="0" marginheight="0" frameborder="0" scrolling="no"><script type="text/javascript" src="http://ads.aspalliance.com/displayad.aspx?t=1&m=1&target=_parent&js=1"></script></iframe>
<!-- 468x60 Banner Ad Tag End --></td>
<td width="30%" bgcolor="#CC0000" align="right" class="HeaderBar"><font size="4">ASP Kitchen</font> <br><form name="frmSearch" method="POST" action="http://www.brettb.com/ASPAllianceSearch.asp">Search: <input type="text" name="Query"> <a href="javascript:SubmitSearch()">Go</a> </form>
</td>
</tr>
<tr>
<td colspan="3" bgcolor="#CCCCCC" style="BORDER: #270D30 1px solid;"><div class="menu-top"
id="TopMenu" align="left"><a href="Default.asp" title="Home"><p>Home</a> | <a
href="ClassicASPArticles.asp" title="ASP Articles">ASP Articles</a> | <a
href="ASP.NetArticles.aspx" title="ASP.NET Articles">ASP.NET Articles</a> | <a
href="Tools.asp" title="Tools">Tools</a> | <a
href="TableOfContents.asp" title="Table Of Contents">Table Of Contents</a> | <a href="What'sNew.aspx" title="What's New">What's
New</a></p>
</div></td>
</tr>
</table>
</center></div>
<table border="0" cellpadding="8" width="100%" cellspacing="0">
<tr>
<td valign="top" align="left"><!--start article-->
<h1>An ASP Documentation Tool™</h1>
<p>This article describes the <a
href="http://www.winnershtriangle.com/w/Products.ASPDocumentationTool.asp" target="_blank">ASP
Documentation Tool™</a>, a utility I wrote to automate the documentation of web
applications developed using ASP 2.0 or 3.0 and the VBScript and JScript scripting
languages.</p>
<p>When developing applications using Java and Perl, I've always been impressed with the
JavaDoc and PerlDoc documentation utilities these languages support. When producing work
for a client, these utilities take a lot of the hard work out of the mundane (but
critically important) work involved with documenting the project.</p>
<p>Unfortunately there is no such standard documentation utility for ASP, and having not
found a suitable commercial offering, I decided to write my own documentation utility for
ASP. Since I often work on projects inherited from other developers, such a utility would
be able to give a useful overview of the project without having to manually look through
the ASP code. The utility would also (hopefully!) create much of the low level
documentation required when handing over work to clients, saving valuable development
time.</p>
<font face="Verdana">
<p align="center"><a href="images/ASP_Documentation_ToolConfigurator_Large_ScreenGrab.png"><img
src="images/ASP_Documentation_ToolConfigurator_Small_ScreenGrab.png"
alt="The ASP Documentation Tool use a graphical user interface to edit the ASP Documentation Tool's configuration options"
border="1" width="311" height="274"></a> <br>
</font>Figure 1. The ASP Documentation Tool™'s GUI. Click image for full sized
version.<font face="Verdana"></p>
</font>
<h2>Features</h2>
<p>The ASP Documentation Tool™ scans all the files of a web project, and outputs a
report based on what it finds within the files. The report contains a list of the
following:
<ul>
<li>A summary of the project.</li>
<li>Pages within the site (.asp, .asa and .inc - other file types may be added if required).</li>
<li>Full source code for each page, with optional syntax highlighting.</li>
<li>A list of VBScript functions in the site, showing where they are defined and used.</li>
<li>A list of VBScript subroutines in the site, showing where they are defined and used.</li>
<li>A list of JScript functions in the site, showing where they are defined and used.</li>
<li>A list of client-side JavaScript functions in the site, showing where they are defined.</li>
<li>A list of ActiveX objects, showing where they are instantiated.</li>
<li>A list of VBScript constants.</li>
<li>A list of HTML Forms and Form elements.</li>
<li>A list of Request.QueryString, Request.Form and Request.ServerVariables used.</li>
<li>A list of email addresses used in the site</li>
<li>A list of ASP Application and Session variables used.</li>
<li>Details of SQL Server 2000 user tables and stored procedures in database(s) associated
with the project.</li>
<li>Details of Microsoft Access tables and queries in database(s) associated with the
project.</li>
</ul>
<p>The report is produced in standard HTML [<a
href="http://www.winnershtriangle.com/w/SampleWeb_Documentation/default.htm"
target="_blank">view sample</a>], with an option to export the report in Microsoft's HTML
Help [<a
href="http://www.winnershtriangle.com/w/SampleWeb_Documentation/SampleWeb.chm"
target="_blank">view sample</a>] and plain text format [<a
href="http://www.winnershtriangle.com/w/SampleWeb_Documentation/SampleWeb.txt"
target="_blank">view sample</a>]. The HTML output can be viewed in any web browser on any
operating system. By contrast, the HTML Help format is restricted to machines running
Microsoft Windows. HTML Help does, however, have some useful advantages over the standard
HTML output:
<ul>
<li>The documentation is stored as a single .chm file, making it easier to redistribute.</li>
<li>The documentation contains a useful table of contents showing an overview of the site.</li>
<li>There is an index as well as a search facility.</li>
<li>The search facility also allows full searching of the source code of each page in the
documented website.</li>
</ul>
<p align="center"><img src="images/SampleWeb_HTML_Help_SmallScreenshot.png" width="381"
height="255"
alt="The HTML Help report compiled by the ASP Documentation Tool™ allows easy searching of the project documentation, including the ASP source code"><br>
Figure 2. The HTML Help report compiled by the ASP Documentation Tool™ allows easy
searching of the project documentation, including the ASP source code.</p>
<h2>System Requirements</h2>
<p>The ASP Documentation Tool™ is written in Perl 5, but has been compiled into a
Windows executable file that can be used on any machine without requiring Perl. </p>
<p>If you want the ASP Documentation Tool™ to create a report in HTML Help format
then you will need to download and install the HTML Help Workshop. This is a <a
href="http://www.microsoft.com/downloads/release.asp?releaseid=33071" target="_blank">free
download</a> from Microsoft.com. It is strongly recommended that you install the HTML Help
Workshop to the default location, which is <em>C:\Program Files\HTML Help Workshop</em>.
If the HTML Help Workshop is installed elsewhere then the ASP Documentation Tool™
will need to be modified to change the value of the variable called "<em>HTMLHelpProg</em>".</p>
<h2>Configuring and Running the ASP Documentation Tool™</h2>
<p>The ASP Documentation Tool™ is installed using a standard Windows installation
routine. There is a graphical user interface - The <i>ASP Documentation Tool™
Configurator</i> - for configuring documentation jobs. </p>
<p>The ASP Documentation Tool™ executable file must be supplied with several command
line options which control the behaviour of the script and the appearance of the output
report. There are just two mandatory command line options, which are used to specify the
input folder (i.e. the folder containing the ASP files that are to be documented) and the
output folder (i.e. where the report should be placed).</p>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td><strong>Option</strong></td>
<td><strong>What it does</strong></td>
<td nowrap><strong>Example</strong></td>
</tr>
<tr>
<td>--i</td>
<td>Input folder containing the website's files. Use a vertical bar to specify more than
one input folder (useful if your includes are in a separate location).</td>
<td nowrap>"C:\inetpub\wwwroot\mywebsite", or<br>
"C:\Inetpub\wwwroot\SampleWeb|C:\Inetpub\wwwroot\includes"</td>
</tr>
<tr>
<td>--o</td>
<td>Output folder where the report should be placed</td>
<td nowrap>"D:\reports\mywebsite"</td>
</tr>
</table>
<p>So the following command when typed in the folder in which the ASPDocumentationTool.exe
resides would document the web project in C:\inetpub\wwwroot\mywebsite and output the
report in the folder D:\reports\mywebsite:</p>
<p>ASPDocumentationTool.exe --i="C:\inetpub\wwwroot\mywebsite"
--o="D:\reports\mywebsite"</p>
<p>Note that the script will overwrite a previous report in that folder.</p>
<p>The following command line options are optional:</p>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td nowrap><strong>Option</strong></td>
<td><strong>What it does</strong></td>
<td nowrap><strong>Example</strong></td>
</tr>
<tr>
<td nowrap>--v</td>
<td>Verbose mode outputs script status to console.</td>
<td nowrap>0 or 1</td>
</tr>
<tr>
<td nowrap>--cs</td>
<td>Specifies whether the source code of ASP pages and SQL stored procedures should by
color coded and syntax highlighted.</td>
<td nowrap>0 or 1</td>
</tr>
<tr>
<td nowrap>--h</td>
<td>Whether entities in the source code should be hyperlinked.</td>
<td nowrap>0 or 1</td>
</tr>
<tr>
<td nowrap>--c</td>
<td>Whether entities in the source code should be color coded.</td>
<td nowrap>0 or 1</td>
</tr>
<tr>
<td nowrap>--l</td>
<td>Whether the source code pages should display line numbers. 1 = numbering, 0 = no line
numbering. Numbering is on by default. This is a useful option if you want to use the ASP
Documentation Tool™ to create syntax highlighted ASP for publication purposes (like I
do on my own ASPAlliance site!) </td>
<td nowrap>0 or 1</td>
</tr>
<tr>
<td nowrap>--txt</td>
<td>Whether the report should be exported as plain text format (using the filename
"projectname".txt).</td>
<td nowrap>0 or 1</td>
</tr>
<tr>
<td nowrap>--dsn</td>
<td>Connection string allowing script to access a SQL Server 2000 database. At the very
least this should contain the name of an ODBC data source, together with a SQL Server
username and password.</td>
<td nowrap>"DSN=Northwind;UID=webuser;PWD=Htf674HHs"</td>
</tr>
<tr>
<td nowrap>--db</td>
<td>name of database to document. Use a vertical bar to specify more than one database.</td>
<td nowrap>"Northwind", or<br>
"Pubs|Northwind"</td>
</tr>
<tr>
<td nowrap>--hh</td>
<td>Whether the output should be compiled in HTML Help format.</td>
<td nowrap>0 or 1</td>
</tr>
<tr>
<td nowrap>--project</td>
<td>Specifies a name for the project.</td>
<td nowrap>"SampleWeb"</td>
</tr>
</table>
<p>As an example, the ASP Documentation Tool™ could be called from the command line
using:</p>
<p>ASPDocumentationTool.exe --i="C:\inetpub\wwwroot\mywebsite"
--o="D:\reports\mywebsite" --cs=1 --v=0 --hh=1 --project="SampleWeb"</p>
<p>Don't forget that it is possible to run the ASP Documentation Tool™ on Windows
machines from .bat scripts, which can of course be scheduled using the AT command or the
Windows Task Scheduler.</p>
<p>The ASP Documentation Tool™ reports are created in standard HTML, which can be
subsequently edited using any HTML editor. The HTML Help format output may also be edited
by using Microsoft's HTML Help Workshop - the HTML Help Workshop project file is created
in the output folder along with the rest of the report, and it has a <em>.hhp</em> file
extension.</p>
<p align="center"><img src="images/HTML_Help_Workshop_SmallScreenshot.png" width="381"
height="256"
alt="Microsoft's HTML Help Workshop can be used to modify the HTML Help report"><br>
Figure 3. Microsoft's HTML Help Workshop can be used to modify the HTML Help report.</p>
<p>The ASP Documentation Tool™ creates a log file in plain text format [<a
href="http://www.winnershtriangle.com/w/SampleWeb_Documentation/SampleWeb.log.txt"
target="_blank">view sample</a>]. </p>
<h2>Obtaining the ASP Documentation Tool™</h2>
<p>See <a href="#Downloads">downloads section</a> below</p>
<p>The evaluation version is fully functional, but has a few limitations, including:
<ul>
<li>There is no support for ASP written in JScript.</li>
<li>There is no facility for documenting SQL Server or Access databases.</li>
<li>There is no facility for exporting the documentation in HTML Help format.</li>
<li>Line numbering of the source code files is mandatory.</li>
<li>There is no text output option.</li>
<li>HTML Forms are not shown in the report.</li>
<li>VBScript subroutines are not shown in the report.</li>
<li>Application Variables are not shown in the report.</li>
<li>There is no access to product updates.</li>
<li>Pop-up window on all source code pages.</li>
<li>This version can only be used for evaluation purposes.</li>
</ul>
<p>The full version of the ASP Documentation Tool™ is available for <a
href="http://www.winnershtriangle.com/w/Products.ASPDocumentationTool.Purchase.asp"
target="_blank">online purchase from RegSoft from just $49.99</a>. Purchasing the ASP
Documentation Tool™ allows you to download the current version, and all subsequent
versions released up to six months from the date of purchase.</p>
<h2>Comments/Suggestions?</h2>
<p>I've released the ASP Documentation Tool™ in the hope that other users may find it
useful! If you would like new features added, then don't hesitate to contact me - most
user requests are incorporated into future releases! </p>
<h2><a name="Downloads"></a>Downloads</h2>
<ul>
<li><a
href="http://www.brettb.com/redirector.asp?URL=http://authors.aspalliance.com/brettb/downloads/ASPDocumentationTool_Evaluation_Version.zip"
title="Download the ASP Documentation Tool™ Evaluation Version">Download
the ASP Documentation Tool™ Evaluation Version</a> (3.5 Mb ZIP file).</li>
</ul>
<ul>
<li><a href="http://www.winnershtriangle.com/w/Products.ASPDocumentationTool.Purchase.asp"
target="_blank">Purchase the ASP Documentation Tool™ Full Version</a> ($49.99).</li>
</ul>
<h2>Further reading</h2>
<ul>
<li><a href="ASPDocumentationTool_Practical_Uses.asp"
title="Practical uses of the ASP Documentation Tool™">Practical uses of the ASP
Documentation Tool™</a>.</li>
</ul>
<ul>
<li><a href="ASPDocumentationSystems.asp" title="ASP Documentation Systems">ASP
Documentation Systems</a>.</li>
</ul>
<!--end article-->
<h2>Useful Development Tools</h2>
<div align="left">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="100%" valign="top"><a
href="http://www.winnershtriangle.com/w/Products.ASPDocumentationTool.asp" target="_blank" title="ASP Documentation Tool™"><strong>ASP
Documentation Tool™</strong></a></td>
</tr>
<tr>
<td width="100%" valign="top">Automatically creates developer documentation for ASP 2.0
and 3.0 web applications written in VBScript and JScript. Documentation for Microsoft
Access, SQL Server 7/2000 databases and Visual Basic 6.0 components associated with the
web application can also be incorporated into the reports. Documentation is created in
HTML, HTML Help and plain text formats.</td>
</tr>
<tr>
<td width="100%" valign="top">
<a
href="http://www.winnershtriangle.com/w/SampleWeb_Documentation/SampleWeb.chm"><img
src="images/Icon_CHM.gif" width="16" height="16" alt="View Sample Output (HTML Help format)"
border="0" align="absmiddle"></a> <a
href="http://www.winnershtriangle.com/w/SampleWeb_Documentation/SampleWeb.chm" title="View Sample Output (HTML Help format)">View Sample
Output</a> (HTML Help format).<br>
<a
href="http://www.winnershtriangle.com/w/SampleWeb_Documentation/Default.htm"><img
src="images/Icon_HTML.gif" width="16" height="16" alt="View Sample Output (HTML Format)"
align="absmiddle" border="0"></a> <a
href="http://www.winnershtriangle.com/w/SampleWeb_Documentation/Default.htm"
target="_blank" title="View Sample Output (HTML Format)">View Sample Output</a> (HTML Format).<br>
<a
href="http://www.brettb.com/redirector.asp?URL=downloads/ASPDocumentationTool_Evaluation_Version.zip"><img
src="images/Icon_Download.gif" width="18" height="20" alt="Download Trial Version"
border="0" align="absmiddle"></a> <a
href="http://www.brettb.com/redirector.asp?URL=downloads/ASPDocumentationTool_Evaluation_Version.zip" title="Download Trial Version">Download
Trial Version</a> (5.2Mb ZIP file).</td>
</tr>
</table>
<br>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="100%" valign="top"><a
href="http://www.winnershtriangle.com/w/Products.IndexServerCompanion.asp" target="_blank" title="Index Server Companion"><strong>Index Server Companion</strong></a></td>
</tr>
<tr>
<td width="100%" valign="top">
The Index Server Companion is a Windows application that extends the functionality of Microsoft Index Server so that it is able to index content from remote websites and also from ODBC databases. As such it can be used as a low cost alternative to Site Server 3.0 Search.
</td>
</tr>
<tr>
<td width="100%" valign="top">
<a
href="http://www.brettb.com/redirector.asp?URL=downloads/IndexServerCompanionDocumentation.zip"><img
src="images/Icon_CHM.gif" width="16" height="16" alt="View Product Documentation"
border="0" align="absmiddle"></a> <a
href="http://www.brettb.com/redirector.asp?URL=downloads/IndexServerCompanionDocumentation.zip" title="View Product Documentation">View Product
Documentation</a> (119K ZIP file).<br>
<a
href="http://www.winnershtriangle.com/w/Products.IndexServerCompanion.SampleSearch.asp"><img
src="images/Icon_HTML.gif" width="16" height="16" alt="Try Sample Search Facility"
align="absmiddle" border="0"></a> <a
href="http://www.winnershtriangle.com/w/Products.IndexServerCompanion.SampleSearch.asp"
target="_blank" title="View Sample Search Facility">Try Sample Search Facility</a>.<br>
<a
href="http://www.brettb.com/redirector.asp?URL=downloads/IndexServerCompanion_EvaluationVersion.zip"><img
src="images/Icon_Download.gif" width="18" height="20" alt="Download Trial Version"
border="0" align="absmiddle"></a> <a
href="http://www.brettb.com/redirector.asp?URL=downloads/IndexServerCompanion_EvaluationVersion.zip" title="Download Trial Version">Download
Trial Version</a> (1.7Mb ZIP file).</td>
</tr>
</table>
<br>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="100%" valign="top"><a
href="http://www.winnershtriangle.com/w/Products.ASPNETDocumentationTool.asp" target="_blank" title="ASP.NET Documentation Tool"><strong>ASP.NET Documentation Tool</strong></a></td>
</tr>
<tr>
<td width="100%" valign="top">Automatically creates developer documentation for ASP.NET web applications written in C# or VB.NET.
Documentation for SQL Server 7/2000 databases and C#/VB.NET components associated with the
web application can also be incorporated into the reports. Documentation is created in
HTML, HTML Help and plain text formats.</td>
</tr>
<tr>
<td width="100%" valign="top">
<a href="http://www.winnershtriangle.com/w/ASP.NETDocToolSamples/SampleWeb.NET/SampleWeb.NET.chm"><img
src="images/Icon_CHM.gif" width="16" height="16" alt="View Sample Output (HTML Help format)"
border="0" align="absmiddle"></a> <a
href="http://www.winnershtriangle.com/w/ASP.NETDocToolSamples/SampleWeb.NET/SampleWeb.NET.chm" title="View Sample Output (HTML Help format)">View Sample
Output</a> (HTML Help format).<br>
<a
href="http://www.winnershtriangle.com/w/ASP.NETDocToolSamples/SampleWeb.NET/Default.htm"><img
src="images/Icon_HTML.gif" width="16" height="16" alt="View Sample Output (HTML Format)"
align="absmiddle" border="0"></a> <a
href="http://www.winnershtriangle.com/w/ASP.NETDocToolSamples/SampleWeb.NET/Default.htm"
target="_blank" title="View Sample Output (HTML Format)">View Sample Output</a> (HTML Format).<br>
<a
href="http://www.brettb.com/redirector.asp?URL=downloads/ASP.NETDocumentationTool_1.0.zip"><img
src="images/Icon_Download.gif" width="18" height="20" alt="Download Trial Version"
border="0" align="absmiddle"></a> <a
href="http://www.brettb.com/redirector.asp?URL=downloads/ASP.NETDocumentationTool_1.0.zip" title="Download Trial Version">Download
Trial Version</a> (727K ZIP file).</td>
</tr>
</table>
<br>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="100%" valign="top"><a
href="http://www.winnershtriangle.com/w/Products.SQLDocumentationTool.asp" target="_blank" title="SQL Documentation Tool"><strong>SQL
Documentation Tool</strong></a></td>
</tr>
<tr>
<td width="100%" valign="top">The SQL Documentation Tool creates technical documentation for Microsoft SQL Server 7.0 and 2000 databases. Technical documentation is created in HTML and HTML Help formats. The HTML Help format documentation is fully searchable and cross referenced. The SQL Documentation Tool documents SQL Server Tables, Views, Stored Procedures, Triggers and Table Relationships.</td>
</tr>
<tr>
<td width="100%" valign="top">
<a
href="http://www.winnershtriangle.com/w/SQLDocumentationTool/Reports/Test_Project/Test_Project.chm"><img
src="images/Icon_CHM.gif" width="16" height="16" alt="View Sample Output (HTML Help format)"
border="0" align="absmiddle"></a> <a
href="http://www.winnershtriangle.com/w/SQLDocumentationTool/Reports/Test_Project/Test_Project.chm" title="View Sample Output (HTML Help format)">View Sample
Output</a> (HTML Help format).<br>
<a
href="http://www.winnershtriangle.com/w/SQLDocumentationTool/Reports/Test_Project/Default.htm"><img
src="images/Icon_HTML.gif" width="16" height="16" alt="View Sample Output (HTML Format)"
align="absmiddle" border="0"></a> <a
href="http://www.winnershtriangle.com/w/SQLDocumentationTool/Reports/Test_Project/Default.htm"
target="_blank" title="View Sample Output (HTML Format)">View Sample Output</a> (HTML Format).<br>
<a
href="http://www.brettb.com/redirector.asp?URL=downloads/SQLDocumentationToolTrial.zip"><img
src="images/Icon_Download.gif" width="18" height="20" alt="Download Trial Version"
border="0" align="absmiddle"></a> <a
href="http://www.brettb.com/redirector.asp?URL=downloads/SQLDocumentationToolTrial.zip" title="Download Trial Version">Download
Trial Version</a> (10.3Mb ZIP file).</td>
</tr>
</table>
<br>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="100%" valign="top"><a
href="http://www.winnershtriangle.com/w/Products.TheWebsiteUtility.asp" target="_blank" title="The Website Utility"><strong>The Website Utility</strong></a></td>
</tr>
<tr>
<td width="100%" valign="top">The Website Utility examines websites for errors and
areas that need to be optimised for search engines by using a built in web crawling engine.
Errors checked for include broken or moved hyperlinks, missing page titles and missing meta tags.
It also generates HTML for use in creating website site maps (table of contents pages - like <a href="TableOfContents.asp" title="Example Table of Contents">this one</a>), and is
able to create both client-side <a href="http://www.winnershtriangle.com/w/Products.TheWebsiteUtility.JavaScriptSearchEngine.asp" title="JavaScript Search Engine">JavaScript Search Engines</a> and server-side <a href="http://www.winnershtriangle.com/w/Products.TheWebsiteUtility.ASPSearchEngine.asp" title="JavaScript Search Engine">ASP Search Engines</a> for a website.</td>
</tr>
<tr>
<td width="100%" valign="top">
<a
href="http://www.winnershtriangle.com/w/TheWebsiteUtility/Reports/ASPAlliance/default.htm"><img
src="images/Icon_HTML.gif" width="16" height="16" alt="View Sample Output (HTML Format)"
align="absmiddle" border="0"></a> <a
href="http://www.winnershtriangle.com/w/TheWebsiteUtility/Reports/ASPAlliance/default.htm"
target="_blank" title="View Sample Output (HTML Format)">View Sample Output</a> (HTML Format).<br>
<a
href="http://www.brettb.com/redirector.asp?URL=downloads/TheWebsiteUtilityTrial.zip"><img
src="images/Icon_Download.gif" width="18" height="20" alt="Download Trial Version"
border="0" align="absmiddle"></a> <a
href="http://www.brettb.com/redirector.asp?URL=downloads/TheWebsiteUtilityTrial.zip" title="Download Trial Version">Download
Trial Version</a> (3Mb ZIP file).</td>
</tr>
</table>
<br>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="100%" valign="top"><a
href="http://www.regnow.com/softsell/nph-softsell.cgi?item=8452-18&affiliate=44172" target="_blank" title="Text Workbench"><strong>Text Workbench</strong></a></td>
</tr>
<tr>
<td width="100%" valign="top">Text Workbench is a file search and replacement utility for text files and Microsoft Office documents. Make rapid file replacements on multiple files and folders full of files. Advanced replacement options include regular expressions support. It even works on remote file systems via FTP. A Regular Expression Laboratory allows advanced pattern matching and replacement expressions to be built and tested. This great utility will make your everyday development tasks much easier!
</td>
</tr>
<tr>
<td width="100%" valign="top">
<a
href="http://www.regnow.com/trialware/download/Download_TxtWrBSetup.exe?item=8452-18&affiliate=44172"><img
src="images/Icon_Download.gif" width="18" height="20" alt="Download Trial Version of Text Workbench"
border="0" align="absmiddle"></a> <a
href="http://www.regnow.com/trialware/download/Download_TxtWrBSetup.exe?item=8452-18&affiliate=44172" title="Download Trial Version of Text Workbench">Download
Trial Version</a> (3Mb ZIP file; you have the option to either install directly from this link or save the file for later installation).</td>
</tr>
</table>
</div>
<h2>Author details</h2>
<p><p><a href="http://www.brettb.com/" title="View Brett's personal website">Brett Burridge</a>
spent two years working in the <a href="http://www.essex.ac.uk/"
title="University of Essex">University of Essex</a> Computing Service, before moving to <a
href="http://www.intapps.com/" title="The Internet Applications Group">The Internet
Applications Group</a> in the Autumn of 1999, where he developed e-Business applications for a range of
corporate clients and dot-com start ups.</P>
<P>Brett is presently employed as an Internet developer and technical writer
through his own company,
<a href="http://www.winnershtriangle.com/w/Default.asp" title="Winnersh Triangle Web Solutions Limited" target="_blank">Winnersh Triangle Web Solutions Limited</a>.
The company produces a number of
innovative products, including the popular
<a href="http://www.winnershtriangle.com/w/Products.ASPDocumentationTool.asp" target="_blank" title="ASP Documentation Tool™ - creates project documentation for ASP 2.0 and 3.0 websites written in VBScript and JScript, and also SQL Server 2000 databases">ASP Documentation Tool™</a>, the <a href="http://www.winnershtriangle.com/w/Products.IndexServerCompanion.asp" target="_blank" title="Index Server Companion - extends the functionality of Index Server to allow indexing of content from remote websites and ODBC databases">Index Server Companion</a>, the <a href="http://www.winnershtriangle.com/w/Products.ASPNETDocumentationTool.asp" target="_blank" title="ASP.NET Documentation Tool - creates documentation for ASP.NET web applications written in VB.NET and C#">ASP.NET Documentation Tool</a>, the <a href="http://www.winnershtriangle.com/w/Products.SQLServerDocumentationTool.asp" target="_blank" title="SQL Server Documentation Tool - Documents Microsoft SQL Server Databases">SQL Server Documentation Tool</a> and <a href="http://www.winnershtriangle.com/w/Products.TheWebsiteUtility.asp" target="_blank" title="The Website Utility">The Website Utility</a>.
The company is also available for <a href="http://www.winnershtriangle.com/w/Services.Main.asp" target="_blank" title="web application design and development">web application design and development</a> at reasonable rates, primarily using
<a href="http://www.winnershtriangle.com/w/Services.Microsoft.asp" target="_blank" title="Development using Microsoft technologies such as ASP, ASP.NET, Visual Basic, SQL Server">Microsoft technologies</a> (ASP, ASP.NET, Visual Basic, SQL Server) but also using <a href="http://www.winnershtriangle.com/w/Services.OpenSource.asp" target="_blank" title="Open source development using technologies such as PHP, MySQL and Perl">open source</a>
technologies such as PHP, MySQL and Perl. Specialist services include development
of <a href="http://www.winnershtriangle.com/w/Services.IndexServer.asp" target="_blank" title="Development of search solutions using Microsoft's Index Server and Site Server 3.0 Search">search solutions</a> using Microsoft's Index Server and Site Server 3.0 Search.
</P>
<P>
As well as the ASPAlliance, Brett has written articles for <a href="http://www.ariadne.ac.uk/issue33/nt-explorer/" title="Read Brett's most recent article for Ariadne.ac.uk" target="_blank">Ariadne.ac.uk</a>
and <a href="http://www.asptoday.com/content.asp?id=1435" target="_blank" title="Read Brett's first ASPToday article">ASPToday</a>, and has contributed recipes to the <a href="http://www.amazon.com/exec/obidos/ASIN/0672325241/brettbcom" target="_blank" title="ASP.NET Developer's Cookbook">ASP.NET Developer's Cookbook</a>.
<small><a href="Links.asp" style="color: rgb(252,253,253);">links</a></small>
</P>
<p>
Outside web development, Brett is interested in digital photography (here's my <a href="http://www.brettb.com/gallery.asp" target="_blank" title="My digital photo gallery">photo gallery</a>), <a href="http://www.brettb.com/MyTropicalFishtank.asp" target="_blank" title="My Tropical Fish!">tropical fishkeeping</a>
and collecting contemporary works of art by artists such as <a href="http://www.brettb.com/Doug_Hyde_Gallery.asp" title="My Doug Hyde Limited Edition Sculptures and Prints" target="_blank">Doug Hyde</a>.
</p>
<p>Contact Brett by emailing <script language="JavaScript"><!--
document.write('<a title="Email Brett" href="mailto:' + 'brett' + '@asp' + 'alliance.com">brett' + '@' + 'aspalliance.com</a>');
// --></script></p>
<p align="center">
<a href="http://www.winnershtriangle.com/w/Products.IndexServerCompanion.asp?FROM=http://authors.aspalliance.com/brettb/ASPDocumentationTool.asp" target="_blank"><IMG SRC="images/IndexServerCompanion_468x60_2.gif" width="468" height="60" alt="Index Server Companion - allows Index Server to index content from remote websites and ODBC databases!!!" border="0"></a>
</p>
</p>
<h2>Article history</h2>
<p>"An ASP Documentation Tool™" published on ASPAlliance.com on 02 June
2002, last revised 22 May 2003.</p>
<p><a title="Back to the ASP Kitchen" href="Default.asp">ASP Kitchen</a>: <a
href="ClassicASPArticles.asp">Classic ASP Articles</a>: An ASP Documentation Tool™</p>
</td>
</td>
<td valign="top" align="center" bgcolor="#CCCCCC" style="BORDER-LEFT: rgb(102,102,102) 1px solid;"> <script type="text/javascript"><!--
google_ad_client = "pub-7044749527879330";
google_ad_width = 120;
google_ad_height = 600;
google_ad_format = "120x600_as";
google_ad_channel ="5708954406";
google_color_border = "0000C0";
google_color_bg = "FFFFFF";
google_color_link = "E60000";
google_color_url = "0000FF";
google_color_text = "000000";
google_ad_type = "text_image";
google_alternate_ad_url = "http://authors.aspalliance.com/brettb/NoGoogleAds.asp";
//--></script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
<p align="center">
<a href="http://www.winnershtriangle.com/w/Products.ASPDocumentationTool.asp" target="_blank"><img src="http://authors.aspalliance.com/brettb/images/ASPDocumentationTool_1.gif" alt="Download a Free ASP Documentation Tool Now!"></a>
</p>
<!-- Search Google -->
<center>
<form method="get" action="http://www.google.com/custom" target="google_window">
<table bgcolor="#cccccc">
<tr><td nowrap="nowrap" valign="top" align="left" height="32">
<a href="http://www.google.com/">
<img src="http://www.google.com/logos/Logo_25gry.gif" border="0" alt="Google" align="middle"></img></a>
<br/>
<input type="text" name="q" size="15" maxlength="255" value=""></input>
</td></tr>
<tr><td valign="top" align="left">
<input type="submit" name="sa" value="Search"></input>
<input type="hidden" name="client" value="pub-7044749527879330"></input>
<input type="hidden" name="forid" value="1"></input>
<input type="hidden" name="channel" value="4628523158"></input>
<input type="hidden" name="ie" value="ISO-8859-1"></input>
<input type="hidden" name="oe" value="ISO-8859-1"></input>
<input type="hidden" name="cof" value="GALT:#008000;GL:1;DIV:#336699;VLC:663399;AH:center;BGC:FFFFFF;LBGC:336699;ALC:0000FF;LC:0000FF;T:000000;GFNT:0000FF;GIMP:0000FF;FORID:1;"></input>
<input type="hidden" name="hl" value="en"></input>
</td></tr></table>
</form>
</center>
<!-- Search Google -->
<p align="center">
<a href="http://www.regnow.com/softsell/visitor.cgi?affiliate=44172&action=site&vendor=7522" target="_blank" title="Search Engine Builder - Build a search engine for your website!"><img border="0" src="images/SearchEngineBuilder.gif" alt="Search Engine Builder - Build a search engine for your website!"></a>
</p>
</td>
</tr>
<tr><td bgcolor="#CC0000" colspan="2" style="BORDER-TOP: rgb(102,102,102) 1px solid;"><small><font color="white">© page content copyright Brett Burridge 1998 - 2004.</font></small></td></tr>
</table>
<!--End ASPAlliance Document Article-->
</body>
</html>