Getting Started Documentation Glish Learn More Programming Contact Us
Version 1.9 Build 1556
News FAQ
Search Home


next up previous contents
Next: Contents

NOTE 243 - XML-based Documentation for AIPS++

Raymond Plante

16 April 2001

A postscript version of this note is available (290 kB).

Abstract:

This note examines some of the current problems and deficiencies of the AIPS++ documentation and considers how an XML-based approach might be used to address them. I describe an over-all framework based on two key features: the use of the DocBook markup for expository documents and the use of in-line documentation for glish-based tools and functions. This framework will continue to supply users with both HTML and high-quality printable versions of all documentation. I describe the tools needed to support this framework and outline a plan for migrating from our present system. An important goal of this framework is to make it easier for developers to create and maintain high quality documentation that will improve the user experience. It is expected that this note will serve as the basis of one or more formal change proposals aimed at adopting this framework.




next up previous contents
Next: Contents   Contents
Please send questions or comments about AIPS++ to aips2-request@nrao.edu.
Copyright © 1995-2000 Associated Universities Inc., Washington, D.C.

Return to AIPS++ Home Page
2006-10-15