
HOME \| NEWS \| PRODUCTS \| DOWNLOADS \| ORDERING \| UPGRADES \| CONTACT

PRODUCT INFORMATION:
ASP DOCUMENTATION TOOL

What is it?

Features

Screenshots

Detailed Overview

Download: Full Evaluation

System Requirements

Technical Support

Version History

Buy Now

OTHER PRODUCTS

The Website Utility

.NET Documentation Tool

VB 6.0 Documentation Tool

SQL Documentation Tool

JavaScript Banner Ad Rotator

PHP Documentation Tool

Indexing Service Companion

Product Ordering

Special Offers

SERVICES

Articles & Whitepapers

Documentation Portal

Client Success Stories

Sell Our Products

Our Blog

ASP Documentation Tool™ Version History

20 August 2007: 7.5 Release

Changed to the Nullsoft Install System installer which resolves the many issues with the Visual Basic Package & Deployment Wizard.
Major GUI update:

Added a global error handler to catch all errors within the GUI. The errors are displayed in a message box and are also logged to GUI.log within the application's installation folder. Please email us if you see any significant GUI errors being reported!
Evaluation version GUI now automatically loads the sample project.
Trailing slashes are now removed from paths entered through the GUI.
Removed the redundant Add New and Delete buttons from the Databases tab within the GUI.
The GUI's save file window now remembers the name of the file that was loaded.
The GUI's save file window now only displays .bat files in the current folder.
Added "Product Website" menu option to GUI's "Help" menu.
"About" window shows correct product icon.

10 August 2007: 7.4 Release

Added "Alerts Report" to the "Extras Report". This report currently shows the following: pages using the unsupported scripting languages PerlScript and Python, and pages using the Microsoft Script Encoder.

22 July 2007: 7.3 Release

Entities such as functions, subroutines and constants are now shown in case-insensitive alphabetical order.
Stopped single lines with just a single quote from showing in VBScript function comments.

1 July 2007: 7.2 Release

Source code pages now link back to the page details page.
ADO command timeout increased to 2 minutes in database documentation routines.
CDO, MAPI and AmHTML objects now reported in appropriate case.

20 June 2007: 7.1 Release

SQL Server 2005 system table sysdiagrams is now excluded from SQL Server database reports.
SQL Server 2005 system views owned by user 'sys' are now excluded from SQL Server database reports.
The following SQL Server 2005 system stored procedures are no longer documented: 'sp_alterdiagram', 'sp_creatediagram', 'sp_dropdiagram', 'sp_helpdiagramdefinition', 'sp_helpdiagrams', 'sp_renamediagram', 'sp_upgraddiagrams' and 'fn_diagramobjects'.
Email addresses report page now says "In page" rather than "Called from".
Form text area value extraction has been improved.
Help file updated, including the addition of more SQL Server connection strings.
Added FAQ entry in help relating to the KTML browser-based WYSIWYG HTML editor's ktml.js file.
VBScript ASP pages containing client-side JavaScript linked to external URLs are no longer identified as being written in JScript.

22 March 2007: 7.0 Release

Improved logging of the FindMultiLineArgs routine and improved the detection of functions by this routine.
Visual Basic COM object source code is now HTML encoded.
Fix issue whereby database table columns were not being detected if there was a problem extracting details of triggers.

10 December 2006: 6.9 Release

Visual Basic component source code now correctly saved. This corrects a problem introduced with version 6.7.
Guess stored procedure calls option now detects stored procedure calls prefixed with a username, e.g. dbo.FindProducts.

10 December 2006: 6.8 Release

Buy now links added to evaluation version's graphical user interface.
Sample project has been updated.

25 November 2006: 6.7 Release

Modifications made to allow source code files from Apple Macintosh systems to be correctly parsed (useful if you receive files from Mac using web designers!).

10 November 2006: 6.6 Release

The Extras report is now optional - there is a checkbox to toggle the report in the GUI, or it may be turned off using the --e command line switch.
Added new [FINDING FILES] section to log file to show which files have been detected.
Cascading Style Sheets (CSS) are now included in a project's documentation if the project contains CSS files.
Add --e command line option and GUI command to help

20 October 2006: 6.5 Release

ASP Cookie usage is now reported: Request.Coookies and Response.Cookies are both supported.
Client-Side JavaScript Cookie Usage is now shown in the HTML report (this assumes the use of the JavaScript document.cookies statement).

20 September 2006: 6.4 Release

Resolved an issue whereby ASP code within client-side JavaScript was inflating the line count report.
Increased the number of limitations in the evaluation version.
If the output folder does not exist the ASP Documentation Tool will attempt to create it.
Report now shows if a page uses the Option Explicit statement.

10 September 2006: 6.3 Release

There are two new reports available from the Extras section. The Code Comments Report (VBScript) report shows the approximate amount of commented out VBScript code within each ASP file. The Code Comments Report (JScript) report shows the approximate amount of commented out JScript code within each ASP file. These reports can assist with code tidying and rationalisation projects. They can also help identify pages that need commenting.

20 July 2006: 6.2 Release

Improved the detection of server-side redirects.
The SampleWeb sample project has been updated.
The documentation has been revised and updated.

1 July 2006: 6.1 Release

The ASP Documentation Tool now shows where server-side redirection is used. The three types of redirection shown are: Response.Redirect, Server.Transfer and Server.Execute.
SampleWeb sample project has been updated.

30 June 2006: 6.0 Release

Increased the timeout values for the Microsoft Access and SQL Server database documentation routines.

10 June 2006: 5.9 Release

Fixed a minor HTML validation problem in the Session variable details page.
Improved error handling of SQL Server errors in Triggers and Views data extraction routines.
Improved the appearance of the SQL Server log information in the log file.
Updated the Frequently Asked Questions section in the documentation.

10 April 2006: 5.8 Release

Modifications made to allow SQL Server 2005 and SQL Server 2005 Express databases to be documented.

30 March 2006: 5.7 Release

Fixed a minor HTML validation problem in the Application variables, Form and Constants details pages.

20 March 2006: 5.6 Release

The Extras Report now shows underused VBScript functions, subroutines and JScript functions.

28 November 2006: 5.5 Release

There is a new Extras report for additional reporting. This report is accessible from the bottom right hand frame.
There is a new report that shows VBScript functions and subroutines and JScript functions that do not appear to be used anywhere within the web application. As such the report may help with migrating ASP applications to ASP.NET, and assist with code tidying projects. This report is accessible from the Extras report link in the bottom right hand frame.

30 November 2005: 5.4 Release

Subroutine usage correctly shown in source code.
Fixed an issue whereby JavaScript in ASP was preventing correct ASP code detection.

24 April 2005: 5.3 Release

Stored Procedure parameters should now be listed in the order the stored procedure specifies them.
Fixed an issue with the extraction of certain HTML Form textarea fields which froze the documentation process.

14 January 2005: 5.2 Release

The GUI now allows multiple input folders to be more easily specified.
The database documentation configuration parts of the GUI have been replaced with a version that is easier to use.
Fixed an issue with server-side includes detection.
The GUI now reports whether the application is the evaluation, Standard or Premium edition.
The documentation is enhanced and now contains more information about documenting databases.
The download ZIP file contains an alternative installer setup.exe file for those who are having difficulties installing software with Microsoft's standard Visual Basic installer.

12 November 2004: 5.1 Release

The ASP Documentation Tool™ is now available in two versions. The Premium Edition contains the Perl source code of the ASPDocumentationTool.exe file that parses the ASP source code and builds the documentation. The Standard Edition does not contain the source code. All users of previous versions that have non-expired registration codes are eligible to download the Premium Edition.
The ASP Documentation Tool™ now optionally detects most includes in the format .
There is a new Nullable column in the SQL Server tables report to show if a specified column can contain null values.
Additional error handling added to SQL Server database documentation routines.
Fixed an issue with the documentation of stored procedures when more than one SQL Server database is documented in the same project.
Fixed an issue with the HTML Help Compiler location option in the GUI.
Improved parsing of ASP code.
Added the gsp command line option. The option may also be configured using the Guess Stored Procedure Calls In Code option in the GUI.
The SampleWeb SQL Server database and SampleWeb website have been updated.

4 August 2004: 5.0 Release

There is a new Page Report.
Major reworking to support Server-Side Includes:
- The ASP Documentation Tool™ now optionally detects includes in the format  [virtual includes are not yet supported].
- The new Page Report shows which pages are include files, which pages are included in each page, and which pages include a page which is an include file.
- Added the useincludes command line option.
- When the useincludes configuration option is on function calls (VBScript and JScript) subroutine calls (VBScript) and VBScript constant usage takes into account the fact that certain pages will only be able to see entities in the same page or a page accessible via server-side includes. The ASP Documentation Tool™ supports nested server-side includes (i.e. the include file Global.asp may itself include AdditionalFunctionality.asp.) Duplicate function/subroutine/constant names in the project are also taken care of.
- ASP VBScript constant detection has been extensively modified.
- The Graphical User Interface contains a checkbox for includes parsing (on the Miscellaneous tab).
The documentation of functions and subroutine calls with similar names (e.g. GetHost and GetHostByName) has been improved.
Reduced the false detection of ASP VBScript function calls.
Fixed an issue with the detection of ASP VBScript constant usage.

10 July 2004: 4.4 Release

The log file is now more detailed than before.
The line count report is now unaffected by files with zero line length.
The line count report now contains links to each file's source code.
Sample.bat file defines musthave and mustnothave variables.
Detection of email addresses has been improved.
Source code indentation has been improved.
VBScript Classes are now detected. Support for VBScript Classes will be considerably enhanced in a future release.
Changes to the Graphical User Interface:
- Application now exits closes properly when the Window is closed - this should prevent file locking issues with ASPDocumentationTool.exe.
- The HTML Help documentation format configuration options work more smoothly than previously
- Configuration files can now only be saved with a .bat file extension.
- The ASP Documentation Tool™ is now aware of content encoded using Microsoft's Script Encoder. It cannot document code encoded using this utility, but it will no longer attempt to document pages that make use of the Script Encoder. [To find out about the Script Encoder, search the Internet for Microsoft Script Encoder].
There is a Script Encoded file in the SampleWeb sample project.

10 April 2004: 4.3 Release

It is now possible to specific a Cascading Style Sheet (CSS) to format the output HTML with. View documentation samples: [Using Gothic.css], [Using VeryGreen.css], [Using HotPink.css].
Fixed an issue with the display of email addresses, constants and functions in source code.
The ASP Documentation Tool™ now finds Request variables where QueryString or Form is not implicitly assigned, e.g. Request("foo").
Resolved issue with extraction of constants from VBScript source code.
The Triggers SQL Server report now correctly links to the database table associated with the particular trigger.
The ASP Documentation Tool™ summarises the number of lines in each file (broken down into ASP, ASP (VBScript), ASP (JScript) and client-side JavaScript. The report is accessed from the new "Line Count Link" in the bottom right hand frame of the documentation. A tab separated version of this report is also found in the text output report.

10 August 2003: 4.2 Release

Fixed an issue with the detection of certain Session and Application variables.
Added a [DOCUMENTATION GENERATION COMPLETE] section to the log file.
Frequently Asked Questions section of documentation has been updated.
Fixed an incorrect hyperlink in the bottom right hand frame of the HTML version report.
The bottom right hand frame of the HTML version report now contains a link to the HTML Help and text versions of the documentation (if they were created).
The list of pages within the project is now sorted alphabetically regardless of file case.
The log file now contains a summary of the project (e.g. number of functions etc.)
Improved the error handling for the documentation of SQL Server databases.
Changes to the Graphical User Interface:
- Application now has the ability to automatically determine whether or not it is being run in evaluation mode.
- The Mode menu has been removed, since it is no longer required.
- The color code entities and hyperlink entities checkboxes have been changed to radio buttons.
- Fixed an issue whereby the Perl version of the ASP Documentation Tool™ would not always run from the Graphical User Interface.
- There is a new View Logfile button that will display the logfile, and also makes it easier to determine whether the ASP Documentation Tool™ has successfully documented a project.
- There is a warning if the HTML Help Compiler executable file cannot be found. Documentation in HTML Help format will not be created if the compiler cannot be found.

16 May 2003: 4.1 Release

Fixed issue whereby some stored procedure names in ASP pages and VB Class files weren't being detected correctly.
Tooltips on constants hyperlinked in the source code now show which page the constant is defined in.
A number of performance enhancements have been made. For many ASP projects, the ASP Documentation Tool™ is now a minimum of 2-3 times faster at creating documentation. Performance improvements are vastly greater with larger projects. The following are now substantially faster:
- Detection of VBScript constant usage in ASP pages.
- Hyperlinking or color coding of ASP VBScript functions in source code.
- Hyperlinking or color coding of ASP VBScript subroutines in source code.
- Hyperlinking or color coding of ASP JScript functions in source code.
- Hyperlinking or color coding of ASP VBScript constants in source code.
The number of ASP VBScript constants found is now listed in the summary page.
Access database queries starting with a tilde character are no longer displayed in reports.
Stored procedures are now detected in ASP code or VB class code if they are prefixed with "sp_".
Stored procedures are now optionally hyperlinked or color coded in the VB class code.
Stored procedure pages no longer display the parameter headings if the stored procedure does not use any parameters.

10 April 2003: 4.0 Release

The ASP Documentation Tool™ now has a graphical user interface! The ASP Documentation Tool™ Configurator makes it possible to use the ASP Documentation Tool™ without having to write .bat files and use command prompt windows.

For the first time, the ASP Documentation Tool™ has now been compiled into a standalone executable file called ASPDocumentationTool.exe. It retains the same command line options as the Perl script. Perl is not required to use this version. There is no significant performance difference between using ASPDocumentationTool.exe and ASPDocumentationTool.pl.

The ASP Documentation Tool™ and its associated files are now installed using a standard Windows installer.

Extensive modifications have been made to the database structure extraction routines:
- The ASP Documentation Tool™ now documents SQL Server Triggers.
- SQL Server Views now display the SQL associated with that View. Each View is now shown in a separate HTML page.
- The ASP Documentation Tool™ is now able to document most Microsoft Access databases (tested with Access 95, Access 97, Access 2000). Documentation will display Access:
  - Tables,
  - Table columns,
  - Views (i.e. SELECT Queries),
  - Stored Procedures (i.e. Queries that aren't considered Views).
- Additional error handling has been introduced to the SQL Server database documentation routines.
- The routines have been made more efficient.
- Multiple databases can now be documented using different connection strings. To assist with this, there is a new databasetypes command line option.

The SampleWeb SQL Server database used for the sample documentation has been expanded with more tables, views and triggers.

There is a now a SampleProject.mdb sample Access 2000 database.

The musthave, mustnothave, displaydescriptions and htmlhelpprog settings have been made into command line options so that they can be altered without editing the Perl script and can be edited using the ASP Documentation Tool™ Configurator.

The documentation has been extensively updated.

28 February 2003: 3.9 Release

Minor alterations made to Email Address report.

Detection of client-side JavaScript functions has been improved.

Detection of function calls to ASP JScript functions has been improved.

Fixed a slight problem with the HTML Help table of contents display if a documented database does not contain tables or views.

Stored procedure calls are now detected in the source code of VB COM objects (if they are preceeded by the EXEC SQL keyword) - see sp_GetCountExpensiveProducts in the SampleWeb project for an example of this.

30 November 2002: 3.8 Release

The reports no longer displays Views owned by "INFORMATION_SCHEMA".

HTML files produced by the ASP Documentation Tool™ have an additional "nofollow" attribute added to the "robots" Meta tag.

Request.QueryString variables are now included in text output report.

Fixed issue whereby Application variables page reported "No Application variables used" even when they were used.

The "title" attribute for stored procedure hyperlinks in the source code pages now displays the correct label.

There is a new report for email addresses. This displays a list of all the email addresses extracted from the ASP files.

The ASP Documentation Tool™ database documentation facility has been modified so that it works with SQL Server 7.0.

28 November 2002: 3.7 Release

Stored procedure extraction routines no longer fail if the database contains user defined functions.

The ASP Documentation Tool™ now documents SQL Server Views.

SQL Server database documentation routine now puts more information in the log file - this will help detect the cause of database documentation errors.

Single line /* */ comments in stored procedures are now correctly color coded.

18 November 2002: 3.6 Release

Detection of ASP VBScript functions and subroutines has been improved.

Fixed minor issue with HTML report when no ASP JScript functions were found in the project.

HTML forms now sorted alphabetically in reports.

Application variables link not shown in HTML Help report if there are no Application variables in the site.

Detection of Client-side JavaScript functions has been improved.

HTML Forms with names such as <%=formName%> will now appear in the list of forms in the reports.

Extraction of HTML Form Action and Method attributes with ASP tags in them has been improved.

Fixed minor issue with HTML tables in some output pages.

Added links in documentation to the recently released ASP.NET Documentation Tool.

15 October 2002: 3.5 Release

Fixed a few minor issues.

Fixed an issue whereby Application variables were not displayed if there were no Session variables in a site.

Syntax highlighting of ASP and Visual Basic source code slightly modified to prevent keywords being highlighted if present in double quotes.

External JavaScript files (i.e. those with .js file extensions) are now supported.

The detection of a page's scripting language has now been improved. The page's language is now shown at the top of the source code.

A site's default scripting language can now be specified from the command line by using the --defaultlanguage option.

Detection of HTML Form field names and values has been improved.

30 September 2002: 3.4 Release

New in this version is the ability to document the Visual Basic 6.0 source code associated with custom written COM Objects. This makes the ASP Documentation Tool™ a complete documentation system for projects using ASP, SQL Server 2000 and VB COM technologies.

Session and Application variables are no longer case sensitive, so for example Session("UserName") is not treated as a distinct entity from Session("username").

Hyperlinking of ASP JScript functions in the source code now works correctly.

There is now a sample .bat file included within the ZIP archive.

The ZIP archive also includes a sample Visual Basic 6.0 COM Object.

26 September 2002: 3.3 Release

It is now possible for the ASP Documentation Tool™ to extract the comments associated with ASP VBScript functions, if the comments are placed in comments before the function's definition. If you want to see examples of this, most of the functions in the SampleWeb sample project have suitable comments. Note that this feature can be turned off if required.

The ASP Documentation Tool™ now documents the following:
- Request.QueryString variables.
- Request.Form variables.
- Request.ServerVariable variables.

Fixed minor issue with bottom right-hand frame not always showing link to data and pages.

Syntax highlighting of ASP JScript includes more keywords.

Hyperlinking or color coding of Application and Session variables in the source code is more accurate.

ASP VBScript Subroutine and Function calls are detected with greater accuracy.

Hyperlinking or color coding of ASP VBScript Function and Subroutines in the source code is more accurate.

Color coding of include directives is more accurate.

Fixed an issue whereby introduction.html was causing an error with the HTML Help compilation.

17 September 2002: 3.2 Release

Syntax highlighting of ASP keywords has been speeded up substantially, and in some cases the ASP Documentation Tool™ runs up to ten times faster. As a result the ASPKeywords.txt file is no longer required, as ASP keywords are stored within the ASP Documentation Tool™'s saveSyntaxHighlightedSourceCode function.

Syntax highlighting of SQL stored procedures has also been speeded up. The SQLKeywords.txt file is no longer required, as the ASP keywords are stored within the ASP Documentation Tool™'s createDatabaseStoredProcedurePages function.

The ASP Documentation Tool™ now supports JScript as well as VBScript. JScript support within the ASP Documentation Tool™ is as follows:
- Finds JScript functions, and calls to these functions.
- Finds object instantiation using the ActiveXObject keyword.
- Finds usage of Session and Application variables.

Bottom right-hand frame has been tidied up. Clicking on a link will also change the bottom left-hand frame, so for example, clicking on Objects will show the list of Objects.

Entities (e.g. HTML Forms, Objects, Session Variables) no longer appear in the HTML Help format report if there aren't any of the particular entity in the project.

Log file now contains all input parameters.

To improve security, details of the connection string are no longer present in the log file.

Stored procedure calls are now highlighted in the source code if they are preceeded by the EXEC SQL keyword.

Stored procedure pages now show where the stored procedure is called from. Again, the stored procedure call must be preceeded by the EXEC SQL keyword.

Detection of constant values has been improved.

Most commented out client-side JavaScript functions are now ignored.

SampleWeb website has been expanded. It now contains JScript and database connectivity examples to demonstrate the new parsing features of the ASP Documentation Tool™.

It is possible to change the default ASP scripting language for pages.

30 August 2002: 3.1 Release

Added this Version History page to documentation.

All object names are now converted to lower case, with the first letter of each word being converted to upper case. This fixes the issue whereby inconsistent use of case in object names lead to the duplication of object names in the documentation produced by the ASP Documentation Tool™.

Fixed a problem whereby a folder with the same name as an ASP file extension (e.g. /inc or /asp) caused a slight error in the display of the documented site's directory structure.

Added support for multi-line function and subroutine arguments where the function or subroutine definition is split over several lines using the ability of VBScript to spread statements over several lines using an underscore character.

Preliminary work done to create a more object oriented approach to the application.

Fixed an issue that was affecting the display of object names in CreateObject statements.

Functions and Subroutines are now detected even if they are preceded with a Public, Default or Private keyword.

HTML Help output is now able to be saved to folders with spaces in their names.

Line numbering of the source code is now optional.

HTML Forms are now included in the report, including 10 different types of form element.

Client-side JavaScript functions are now included in the report.

ASP Documentation Tool™ now displays how long it took to generate documentation.

The ASP Documentation Tool™ now creates a log file in the output folder with the filename of ProjectName.log. If the ASP Documentation Tool™ does not function as intended then this file should indicate the source of the problem. Note: If you believe that certain lines of your ASP are causing problems, then send them to the author of the ASP Documentation Tool™, as it is almost certain that the issue can be resolved and can serve to make future versions of the application even more accurate when creating documentation.