Version 1.9 Build 1556

News	FAQ
Search	Home

Next: LaTeX based documents Up: NOTE 215 - AIPS++ Documentation Notes Previous: Contents

Overview

The AIPS++documentation is a combination of standards and tools. The standards are HTML, LaTeX, and AIPS++guidelines. The tools are cxx2html, help2tex, and latex2html, with a dash of shell programming thrown in. All AIPS++documentation is available via a web interface. Most of the user and system documentation and AIPS++Notes and Memos are written using the LaTeX mark up language. Some older documents may be in texinfo which was abandoned in favor of LaTeX. C++ classes are documented in header files using special cxx2html tags.

Cxx2html, help2tex, and latex2html are all perl scripts. A working knowledge of perl is helpful to understand them and essential for debugging.

All documentation source is found in the "code" tree. The make system's docsys target generates and moves postscript/html files into the "docs" tree.

Next: LaTeX based documents Up: NOTE 215 - AIPS++ Documentation Notes Previous: Contents Contents