Web Robot View of http://www.brettb.com/ASPDocumentationTool.asp

Page Item Value
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
Description ASP Documentation Tool; ASPDocumentationTool - Creates low level documentation for ASP pages written in VBScript
Keywords asp, vbscript, functions, subroutines, sub, documentation, automatic, creation, creates, administration, project, windows, document, download, sql server, access, microsoft access
Robots Meta Tag  
Page Content   HOME | ABOUT ME | BIOTECHNOLOGY | ARTICLES | TOOLS | GALLERY | CONTACT Search: Go DEVELOPER TOOLS
ASP Doc Tool
ASP.NET Doc Tool
SQL Doc Tool
Index Server Companion
The Website Utility TECHNICAL ARTICLES
ASP
ASP.NET
JavaScript
Transact SQL

PHOTO GALLERIES
Canon EOS 300D Samples
Red Arrows 2004
Living Coasts
Web Page Backgrounds
More Galleries...

NEW STUFF
SQL Color Coder
Canon EOS 300D Samples
The Website Utility
Search Engine Optimisation
Build an ASP Search Engine
My Tropical Fishtank
Savings Other New Stuff...

POPULAR STUFF
Regular Expressions
ASP Documentation Tool
Index Server ASP
JavaScript Ad Rotator

LINKS
Business Website
ASPAlliance Articles

Home Developer Tools

ASP Documentation Tool A number of programming languages have well defined documentation schemes that make it straightforward to generate low level documentation. Examples are Java's JavaDoc (see sample output ) and Perl's PerlDoc. Unfortunately there is no such system for ASP, so creating low level documentation for an ASP application is usually an afterthought.

If you have ever left documentation to the very last moment, or have inherited a web application from another development team, then you may find the ASP Documentation Tool useful. The ASP Documentation Tool is an application that creates developer documentation for ASP 2.0 and 3.0 pages written in VBScript and JScript. While not a replacement for professionally produced technical documentation, it greatly assists in obtaining an overview of a web application.

An evaluation version of the ASP Documentation Tool is available for download . The full version is available for online purchase at just $49.99 from Winnersh Triangle Web Solutions Limited .

An ASP.NET Documentation Tool is also available. This creates project documentation for ASP.NET web applications written in VB.NET and C#.

Screenshots


Click image for full sized version


Click image for full sized version

Sample ASP Documentation The output from the script is created in standard HTML format, a sample report of which is shown in the image below:

This report is available from the following link: SampleWeb Documentation . ASP Documentation Tool generated documentation for the SampleWeb website. Each report contains a number of items. The top left frame contains a list of pages contained in the website. Clicking on the link next to each page name will display the source code of that page. In order to improve readability, the source code may be optionally syntax highlighted and colour coded. The frame also contains a link to the documentation for the database(s) associated with the project.

The bottom left hand frame contains a list of ASP VBScript and JScript functions, ASP VBScript subroutines, client-side JavaScript functions, component object calls, Application variables, Session variables, Email addresses, HTML Forms, Request.Form, Request.QueryString, Request.ServerVariables and constants. Clicking on a ASP function or subroutine name will show where the function or subroutine is situated, together with a list of places from which the function or subroutine is called.

Finally, the top right hand frame contains the main report details, with the bottom right hand frame containing links to the different items of the report. The ASP Documentation Tool also has the option to save the report in HTML Help format [ sample ] and plain text format [ sample ]. Using the ASP Documentation Tool The evaluation version of the ASP Documentation Tool is available as a download .

The ASP Documentation Tool started off as a Perl script, but it has now been converted to a Windows executable. The ASPDocumentation.exe executable file is run from the command line, using a number of command line options. As an example, the script could be called from the command line using:

ASPDocumentationTool.exe --i= C:\inetpub\wwwroot\mywebsite --o= D:\reports\mywebsite --c=1 --h=1 --v=0

The ASP Documentation Tool also contains a graphical user interface for creating the appropriate command line options.

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.

Downloads The evaluation version of the ASP Documentation Tool and sample web files are available using the link below: ASPDocumentationTool_Evaluation_Version.zip (3.56Mb ZIP file). ASP Documentation Tool , documentation and sample files. The ASP Documentation Tool 3.1 Evaluation Version has been downloaded 19799 times since 04 April 2002.

If you want to purchase the commercial version, you may do so from this purchase page . An ASP.NET Documentation Tool is also available. This creates project documentation for ASP.NET web applications written in VB.NET and C#. Legal Issues Copyright (C) 2002, 2003, 2004 Winnersh Triangle Web Solutions Limited . All Rights Reserved. This software is provided as is'' without warranty of any kind. The ASP Documentation Tool is not free software, and as such it may not be freely distributed without the permission of the author.

Useful Development Tools ASP Documentation Tool 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. View Sample Output (HTML Help format).
View Sample Output (HTML Format).
Download Trial Version (5.2Mb ZIP file).
ASP.NET Documentation Tool 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. View Sample Output (HTML Help format).
View Sample Output (HTML Format).
Download Trial Version (2.9Mb ZIP file).
SQL Documentation Tool 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. View Sample Output (HTML Help format).
View Sample Output (HTML Format).
Download Trial Version (10.3Mb ZIP file).
Index Server Companion 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. View Product Documentation (119K ZIP file).
Try Sample Search Facility .
Download Trial Version (1.7Mb ZIP file).
The Website Utility 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 this one ), and is able to create both client-side JavaScript Search Engines and server-side ASP Search Engines for a website. View Sample Output (HTML Help format).
View Sample Output (HTML Format).
Download Trial Version (3Mb ZIP file). Site Map

All content is © 1995 - 2006 Brett Burridge

Image Alt Tags Brettb.Com
Microsoft Certified Professional
The ASP Documentation Tool use a graphical user interface to edit the ASP Documentation Tool's configuration options
The ASP Documentation Tool use a graphical user interface to edit the ASP Documentation Tool's configuration options
ASP Documentation Tool Sample Report
Running the ASP Documentation Tool from the Windows 2000 Command Line
View Sample Output (HTML Help format)
View Sample Output (HTML Format)
Download Trial Version
View Sample Output (HTML Help format)
View Sample Output (HTML Format)
Download Trial Version
View Sample Output (HTML Help format)
View Sample Output (HTML Format)
Download Trial Version
View Product Documentation
Try Sample Search Facility
Download Trial Version
View Sample Output (HTML Help format)
View Sample Output (HTML Format)
Download Trial Version
Internal Links http://www.brettb.com/redirector.asp (13 links in this page) [ Robot View of this URL ]
http://www.brettb.com/ASPDocumentationTool.asp (4 links in this page) [ Robot View of this URL ]
http://www.brettb.com/DeveloperTools.asp (3 links in this page) [ Robot View of this URL ]
http://www.brettb.com/Default.asp (3 links in this page) [ Robot View of this URL ]
http://www.brettb.com/TheWebsiteUtility.asp (2 links in this page) [ Robot View of this URL ]
http://www.brettb.com/SearchingIndexServerWithASP.asp [ Robot View of this URL ]
http://www.brettb.com/technicalwriting.asp [ Robot View of this URL ]
http://www.brettb.com/JavaScriptArticles.asp [ Robot View of this URL ]
http://www.brettb.com/Website_Search_Engine_Optimisation.asp [ Robot View of this URL ]
http://www.brettb.com/SearchResults.asp [ Robot View of this URL ]
http://www.brettb.com/js_banner_ad_rotator.asp [ Robot View of this URL ]
http://www.brettb.com/web.asp [ Robot View of this URL ]
http://www.brettb.com/CanonEOS300D_Gallery1.asp [ Robot View of this URL ]
http://www.brettb.com/BuildingAnASPSearchEngine.asp [ Robot View of this URL ]
http://www.brettb.com/backgrounds.asp [ Robot View of this URL ]
http://www.brettb.com/VBScriptRegularExpressions.asp [ Robot View of this URL ]
http://www.brettb.com/toc.asp [ Robot View of this URL ]
http://www.brettb.com/ASP.NETArticles.asp [ Robot View of this URL ]
http://www.brettb.com/TransactSQLColorCoder.asp [ Robot View of this URL ]
http://www.brettb.com/Investments_ISAs.asp [ Robot View of this URL ]
http://www.brettb.com/CanonEOS300D_Gallery3.asp [ Robot View of this URL ]
http://www.brettb.com/ASPWatchArticles.asp [ Robot View of this URL ]
http://www.brettb.com/Red_Arrows_2004.asp [ Robot View of this URL ]
http://www.brettb.com/BannerAdRotator_JavaDocs/index.html [ Robot View of this URL ]
http://www.brettb.com/Living_Coasts_Photos.asp [ Robot View of this URL ]
http://www.brettb.com/SQL_Help.asp [ Robot View of this URL ]
http://www.brettb.com/contact.asp [ Robot View of this URL ]
http://www.brettb.com/Biotechnology.asp [ Robot View of this URL ]
http://www.brettb.com/MyTropicalFishtank.asp [ Robot View of this URL ]
http://www.brettb.com/ASPNetDocumentationTool.asp [ Robot View of this URL ]
http://www.brettb.com/gallery.asp [ Robot View of this URL ]
http://www.brettb.com/what's_new.asp [ Robot View of this URL ]
http://www.brettb.com/IndexServerCompanion.asp [ Robot View of this URL ]
http://www.brettb.com/ASPAlliance/SampleWeb_Documentation/default.htm [ Robot View of this URL ]
http://www.brettb.com/ASPAlliance/SampleWeb_Documentation/SampleWeb.txt [ Robot View of this URL ]
http://www.brettb.com/Gallery.asp [ Robot View of this URL ]

Reporting Main Page

Report generated by The Website Utility 2.8