Source Code for http://authors.aspalliance.com/brettb/ASPDocumentationTool_Practical_Uses.asp
<html>
<!--Begin ASPAlliance Document Header-->
<head>
<title>Practical uses of the ASP Documentation Tool</title>
<link type="text/css" rel="stylesheet" href="ASPKitchen.css" />
<meta name="description"
content="The ASP Documentation Tool is a utility for creating technical documentation for web applications written in ASP 2.0 and 3.0 using either the VBScript or JScript scripting languages">
<meta name="keywords"
content="ASP, documenting, document, tool, utility, VBScript, JScript, classic ASP, documentation">
</head>
<!--Begin ASPAlliance Document Article-->
<body topmargin="0" leftmargin="0">
<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>
<table border="0" cellpadding="8" width="100%" cellspacing="0">
<tr>
<td valign="top" align="left"><!--start article--> <p><a title="Back to the ASP Kitchen" href="Default.asp">ASP
Kitchen</a>: <a href="ClassicASPArticles.asp">Classic ASP Articles</a>: Practical uses of
the ASP Documentation Tool</p>
<h1>Practical uses of the ASP Documentation Tool</h1>
<p align="center"><a href="#How to determine which ActiveX objects are used on a site">How
to determine which ActiveX objects are used on a site</a> | <a
href="#Modifying ASP Function or Subroutine parameters">Modifying ASP function or
subroutine parameters</a><br>
<a href="#Tidying up the code">Tidying up the code of a web application</a> | <a
href="#Determining where a particular stored procedure is used">Determining where a
particular stored procedure is used</a><br>
<a href="#My boss">My boss/project manager/client wants technical documentation in Word
format</a> | <a href="#Migrating a site from Classic ASP 2.0 or 3.0 to ASP.NET">Migrating
a site from Classic ASP 2.0 or 3.0 to ASP.NET</a></p>
<h2>Introduction</h2>
<p>This article describes some of the practical uses of the <a
href="ASPDocumentationTool.asp">ASP Documentation Tool</a>. The ASP Documentation Tool is
a utility for creating technical documentation for web applications written in ASP 2.0 and
3.0 using either the VBScript or JScript scripting languages.</p>
<h3>Three different type of report</h3>
<p>The ASP Documentation Tool creates three types of report about an ASP web application: <ol>
<li>The <strong>standard HTML</strong> report can be viewed in any web browser that supports
frames.</li>
<li>The <strong>Microsoft HTML Help</strong> format is the format used by most Windows
applications for their help files.</li>
<li>The <strong>plain text</strong> report can be viewed in any text editor or word
processing application.</li>
</ol>
<table border="0" width="768">
<tr>
<td width="33%"><p align="center"><a
href="http://www.brettb.com/ASPAlliance/SampleWeb_Documentation/default.htm"
target="_blank"><img src="images/ADT_prac_uses_ASPDocumentation_Output_Small_HTML.png"
alt="Screenshot of the standard HTML output report produced by the ASP Documentation Tool"
border="1" width="256" height="193"></a><br>
<strong>Standard HTML report</strong></td>
<td width="33%"><p align="center"><a
href="http://www.brettb.com/ASPAlliance/SampleWeb_Documentation/SampleWeb.chm"><img
src="images/ADT_prac_uses_ASPDocumentation_Output_Small_HTMLHelp.png"
alt="Screenshot of the Microsoft HTML Help output report produced by the ASP Documentation Tool"
border="1" width="256" height="193"></a><br>
<strong>Microsoft's HTML Help report</strong></td>
<td width="34%"><p align="center"><a
href="http://www.brettb.com/ASPAlliance/SampleWeb_Documentation/SampleWeb.txt"
target="_blank"><img src="images/ADT_prac_uses_ASPDocumentation_Output_Small_Text.png"
alt="Screenshot of the plain text output report produced by the ASP Documentation Tool"
border="1" width="256" height="193"></a><br>
<strong>Plain text report</strong></td>
</tr>
</table>
<p>Click on any of the images above to view an example of that report.</p>
<h2><a name="How to determine which ActiveX objects are used on a site"></a>How to
determine which ActiveX objects are used on a site</h2>
<p>ASP web applications commonly make use of ActiveX objects to perform tasks such as
connecting to databases or sending email. When moving websites between web servers, it is
critical to know which objects are used on the site, as it may be necessary to install
these objects on the new web server or to rewrite the code. For example, ASP code that
sends email can use any one of a number of third party objects.</p>
<p>The ASP Documentation Tool looks for the instantiation of ActiveX objects through the
use of the CreateObject and Server.CreateObject functions. The report produced by the ASP
Documentation Tool contains a list of the objects used, and shows where each object is
used in the web application:</p>
<p align="center"><img src="images/ADT_prac_uses_objects.gif"
alt="Screenshot of the HTML Help output produced by the ASP Documentation Tool, showing which ActiveX objects are used in a web application"
width="486" height="366"><br>
<strong>Figure 1. The ASP Documentation Tool shows which ActiveX objects are used in a web
application</strong></p>
<p align="left">The ASP Documentation Tool is able to show the source code of public
Functions and Properties of any custom ActiveX objects written in Visual Basic 6.0. This
is shown in Figure 1 above (the custom ActiveX object is called Samplewebcomobject).</p>
<h3><a name="Modifying ASP Function or Subroutine parameters"></a>Modifying ASP function
or subroutine parameters</h3>
<p>A common task in development is modifying the parameters associated with a particular
function or subroutine. Typically this would be to add additional parameters to the
function and subroutine. This involves two processes: <ol>
<li>Modifying the function or subroutine's parameters.</li>
<li>Changing all the calls to the function or subroutine to reflect the changes made to the
parameters.</li>
</ol>
<p>The ASP Documentation Tool contains a list of all the VBScript functions and
subroutines, and JScript functions. Clicking on a function or subroutine name will show
where the function or subroutine is to be found within the site. There is a also a list of
where in the site the function or subroutine is used. This makes it a straightforward task
to change the function or subroutine's parameters, as well as all of the calls made to the
function or subroutine.</p>
<p align="center"><img src="images/ADT_prac_uses_functions.gif"
alt="Screenshot of the HTML Help output produced by the ASP Documentation Tool, showing how the ASP Documentation Tool makes it straightforward to modify the arguments of a particular ASP function or subroutine"
width="486" height="366"><br>
<strong>Figure 2. The ASP Documentation Tool shows where functions and subroutines are
found, and where they are used</strong></p>
<h2><a name="Tidying up the code"></a>Tidying up the code of a web application</h2>
<p>The ASP Documentation Tool can be useful when tidying up the ASP code of a web
application. For example, it is able to assist with the following: <ul>
<li><em>Rationalisation of duplicate functions and subroutines</em>. The ASP Documentation
Tool lists all of the VBScript functions and subroutines and JScript functions used in the
web application. It is, therefore, straightforward to remove duplicate instances of these
functions and subroutines. Duplicated functions and subroutines could probably be moved to
a global include file.</li>
<li><em>Removal of email addresses used for testing purposes.</em> The ASP
Documentation Tool displays where email addresses are used on a site, so it can be useful
for ensuring that functionality that sends email will send the messages to the correct
recipients.</li>
</ul>
<h2><a name="Determining where a particular stored procedure is used"></a>Determining
where a particular stored procedure is used</h2>
<p>The ASP Documentation Tool is also able to document SQL Server 7 and SQL Server 2000
databases. The resulting documentation for the database is fully integrated with the
documentation of the ASP files within the web application. The documentation includes a
list of stored procedures within the databases documented. Clicking on the name of a
stored procedure will show the details of that procedure. It will also show where in the
ASP code that stored procedure is called from (<em>provided that the name of the stored
procedure has been preceded with the <strong>EXEC</strong> keyword</em>).</p>
<p align="center"><img src="images/ADT_prac_uses_storedprocedures.gif"
alt="Screenshot of the HTML Help output produced by the ASP Documentation Tool, showing how the documentation of a SQL Server 7.0 or SQL Server 2000 database is fully integrated with the documentation of the ASP files associated with the web application"
width="486" height="366"><strong><br>
Figure 3. The ASP Documentation Tool will also document SQL Server 7.0 and SQL Server 2000
databases associated with a web application</strong></p>
<p>Alternatively, it is possible to use the integrated search facility within the HTML
Help report to search for the name of the stored procedure. A list of all the occurrences
of the search query will be displayed. HTML Help report produced by the ASP Documentation
Tool allows all of the source code of the web application to be searched. Because HTML
Help files are compiled, searching them is much faster than using the search facility
within a development package such as Visual InterDev.</p>
<h2><a name="My boss"></a>My boss/project manager/client wants technical documentation in
Word format</h2>
<p>The ASP Documentation Tool is able to create a text report of the ASP web application
and associated SQL Server 7.0 or SQL Server 2000 databases or Microsoft Access databases.
This text report can, therefore, be used as the basis for the technical documentation of a
project. The ASP Documentation Tool's text report contains lists of: <ul>
<li>ASP Pages</li>
<li>ASP VBScript functions</li>
<li>ASP VBScript functions (with arguments)</li>
<li>ASP VBScript subroutines</li>
<li>ASP VBScript subroutines (with arguments)</li>
<li>ASP JScript functions</li>
<li>ASP JScript functions (with arguments)</li>
<li>Client-side JavaScript functions</li>
<li>Client-side JavaScript functions (with arguments)</li>
<li>ActiveX Objects used</li>
<li>Functions within custom Visual Basic 6.0 ActiveX objects</li>
<li>Functions within custom Visual Basic 6.0 ActiveX objects (with arguments)</li>
<li>Application variables used</li>
<li>Session variables used</li>
<li>Request.QueryString variables used</li>
<li>Request.Form variables used</li>
<li>Request.ServerVariables variables used</li>
<li>VBScript Constants</li>
<li>HTML Forms</li>
<li>Email Addresses</li>
<li>Include files</li>
<li>SQL Server 7.0 or SQL Server 2000:<ul>
<li>Tables</li>
<li>Views</li>
<li>Stored Procedures</li>
<li>Triggers</li>
</ul>
</li>
<li>Microsoft Access database:<ul>
<li>Tables</li>
<li>Views (Queries)</li>
<li>Stored Procedures (i.e. Queries that aren't Views)</li>
</ul>
</li>
<li>Composition of ASP each file (i.e. amount of ASP [VBScript], ASP [JScript], client-side
JavaScript and HTML).</li>
</ul>
<p>An <a href="http://www.brettb.com/ASPAlliance/SampleWeb_Documentation/SampleWeb.txt"
target="_blank">ASP Documentation Tool sample text report</a> is available.</p>
<h2><a name="Migrating a site from Classic ASP 2.0 or 3.0 to ASP.NET"></a>Migrating a site
from Classic ASP 2.0 or 3.0 to ASP.NET</h2>
<p>The ASP Documentation Tool can also assist in the migration of web applications from
ASP to ASP.NET. This is a topic that has been covered on the Microsoft website (see <a
href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnaspp/html/aspnetmigrissues.asp"
target="_blank">Migrating to ASP.NET: Key Considerations</a>). The ASP Documentation Tool
can assist the migration process by: <ul>
<li>Listing the ASP pages associated with the web application.</li>
<li>Showing a list of VBScript functions and subroutines that will need to be converted to a
language such as VB.NET</li>
<li>Showing a list of JScript functions.</li>
<li>Showing which pages make use of the ADO objects - these pages could be candidates for
conversion to ADO.NET.</li>
</ul>
<p>Note that a <a href="ASPNETDocumentationTool.asp">ASP.NET Documentation Tool</a> is
also available, should you also wish to document your ASP.NET web applications.</p>
<h2>System Requirements</h2>
<p>The <a href="ASPDocumentationTool.asp">ASP Documentation Tool</a> will run on any
Windows operating system from Windows 95 onwards.</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 free download from
Microsoft.com. At the time of writing the download URL was <a
href="http://www.microsoft.com/downloads/release.asp?releaseid=33071" target="_blank">http://www.microsoft.com/downloads/release.asp?releaseid=33071</a>.</p>
<h2>Availability & Pricing</h2>
<ul>
<li><a
href="http://www.brettb.com/redirector.asp?URL=http://authors.aspalliance.com/brettb/downloads/ASPDocumentationTool_Evaluation_Version.zip">Download
the ASP Documentation Tool trial version, documentation and sample files</a> (3.5 Mb ZIP
file).</li>
</ul>
<p>This trial version is fully functional, but has a few limitations.<ul>
<li><strong><a href="http://www.regsoft.net/purchase.php3?productid=47650">Purchase the full
version of the ASP Documentation Tool</a></strong> ($49.99).</li>
</ul>
<ul>
<li><a href="http://www.winnershtriangle.com/w/Products.SpecialOffers.asp" target="_blank"><strong>Purchase
both the ASP Documentation Tool and the ASP.NET Documentation Tool</strong></a> and make
valuable savings.</li>
</ul>
<h2>Resources</h2>
<ul>
<li><a href="http://www.winnershtriangle.com/w/Products.ASPDocumentationTool.asp">ASP
Documentation Tool website</a>.</li>
</ul>
<ul>
<li>An <a href="http://www.winnershtriangle.com/w/Products.ASPNETDocumentationTool.asp">ASP.NET
Documentation Tool</a> is also available. This creates project documentation for ASP.NET
web applications written in VB.NET and C#.<!--end article--></li>
</ul>
<p><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>
</p>
<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.ASPDocumentationTool.asp?FROM=http://authors.aspalliance.com/brettb/ASPDocumentationTool_Practical_Uses.asp" target="_blank"><IMG SRC="images/ASPDocumentationToolBannerAd.gif" width="468" height="60" alt="Download a free ASP Documentation Tool now!!!" border="0"></a>
</p>
</p>
<h2>Article history</h2>
<p>"Practical uses of the ASP Documentation Tool" published on ASPAlliance.com
on 07 January 2003, revised 17 August 2004.</p>
<p><a title="Back to the ASP Kitchen" href="Default.asp">ASP Kitchen</a>: <a
href="ClassicASPArticles.asp">Classic ASP Articles</a>: Practical uses of the ASP
Documentation Tool</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>