Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

Supporting Tools and Documents

This section lists the tools (in the more generic sense) and documents that will be needed to support the proposed framework.

• GlishDoc extraction tool. It is expected that this will be the only tool that will have to be developed ``from scratch.''

• Style sheets for validating XML documents and converting them to other formats. It is expected that these would be adapted from existing style sheets that come with Jade or some similar existing package.

• Style sheet application tools. These would be trivial scripts that call an existing program for applying our customized style sheets. In particular, we would have:
  • a GlishDoc validation tool. This would be used by Glish developers to validate the syntax and completeness of their in-lined documentation.

  • a GlishDoc format conversion tool. This would be used by Glish developers to preview their Glish tool documentation in various formats. It would also be used by the AIPS++ make system to convert the documentation into supported formats.

  • DocBook format conversion tool. This would be used by both authors and the AIPS++ make system to convert the documents into the various supported formats. Preferably, this tool would be the same tool used for converting GlishDoc documentation, differing only in the style sheets it uses.

• Lyx, a WYSIWYG editor for creating DocBook documents, adapted for AIPS++ via a pluggable layout class.

• A Note describing how to use GlishDoc tags and tools to document Glish code.

• A Note describing how to create expository documents (e.g. Notes, Gettting Results chapters, etc.) using DocBook and LyX.

• A Style Guide for GlishDoc documentation.