Phase I: Initial GlishDoc implementation

Version 1.9 Build 803

News	FAQ
Search	Home

Next: Phase II: Initial Use of DocBook Up: Implementation Plan Previous: Implementation Plan

Adopt and/or create a DTD for encoding tool descriptions that will be extracted from the source code. Define necessary GlishDoc-style tags for documenting tool source code.
Implement an initial version of the GlishDoc document extractor in Glish. (It is expected that a Glish implementation will be easier for a typical AIPS++ developer to maintain than one based on, say, Perl. It also allows the possibility for further integration of the documentation extraction into the AIPS++ system in the future.)
Develop (or adapt) style sheets to convert XML tool descriptions into currently supported .help and _meta.g files. Install wrapper script that applies style sheet transformations to XML descriptions. (Augment the EMACS Glish mode to add keyboard macros for inserting commonly used GlishDoc markup.)
Create an AIPS++ note describing how to use GlishDoc tags to mark up in-lined documentation and how to use associated tools to extract the documentation and convert it to currently support forms.
Encourage developers to try in-lining documenation. Evaluate current state of framework for ease-of-use, robustness, adaptability to the AIPS++ system, and effects on the quality of documentation and software process. Adjust plan for later phases accordingly.

Next: Phase II: Initial Use of DocBook Up: Implementation Plan Previous: Implementation Plan Contents