We have attempted to provide a good set of documetation with DRAMA, but
we admit to sometimes having trouble keeping it up to date. To help in
this, we generate a large amount automatically from source code comments.
Documentation generated this way provides most of the routine and program
Most of the printed documentation is generated from Latex sources through
recent documentention is either HTML or MS Word/Power Point.
Automatically generated documentation is generated using one of three tools
wflman (William Lupton's Manual generation utility).
This tool was generated at the AAO around about 1989 and later developed
further at the Keck Observatory. It generates
documenation from file and function headers into
Latex, Man, RTF and HTML formats. wflman is well suited for
documenting C routines but it no longer being developed.
JAVA's documentation tool - the standard way of generating documentation
for JAVA software. Due to its relationship with JAVA, this seems a good
way of getting high quaility JAVA documentation. Note that DRAMA's JAVA
documentation is NOT generated until the DJAVA library is built (due to
the string relationship with JAVA).
This is a public domain documentation tool which works in a similar way
to javadoc. We find it particularly suitable for C++ documentation,
which is its main use at this point. The AAO will probably move from
wflman to doxygen for all new code.
If you have not already been there, the full set of on line documentation
can be found
here. This includes the current page, C API, C++ API, JAVA API,
Utility Program and TCL command descriptons.
The full DRAMA release includes this set of Web pages, a set of pages
for use with the unix man command and the Latex sources of the
full documentation set.
There is a draft of a book on DRAMA. This is available in
format. Please context me if you need it in another format.
This document is under active development and many parts have not
yet been completed, but it is a good start to programming in DRAMA. The
examples have not yet been sorted out on line, but the examples from the
course mentioned in the following paragraph are similar.
The AAO can give a course on DRAMA.
The examples and handouts from this course are available. The handouts
are in PDF format.
The following Postscript documentation is available for components of DRAMA.
- DRAMA Software Organisation
- This document introduces the Organisation of the DRAMA software and
management of software Versions.
- Guide to Writing Drama Tasks
- This document is an in depth guide to how to write programs using DRAMA.
- The Error Reporting System
- The DRAMA Error Reporting System provides techniques for reporting errors
in a consistent manner. It is independent of any user interface or
- The Dits Specification
- Dits is the software
package which implements the basic tasking structure, allowing
distributed tasks to communicate in a reliable and efficient way.
- The Message Code System
- Implements a portable Message/Error code system allowing distributed tasks
to pass integer error codes between machines and relate those codes to
appropriate text. It is compatible with the VAX/VMS message code system.
- The Self Defining Data System
- SDS is used by DITS to move data between machines of various architectures,
making allowances for the various machine specific ways of storing numbers and
characters. The user may use SDS directly or via the ARG package supplied
as part of SDS. SDS is capable of being using Standalone for storage and
transfer of data between machines of different architecture.
- The Interprocess Message Passing System
- IMP is the underlining message system used by DITS. It provides the fastest
possible techniques for sending messages between processes on the one machine
while also providing an almost transparent interface for sending messages
to tasks on other machines across a network. IMP is not normally used
directly by DRAMA task authors.
- The Generic Instrumentation Task Specification
- This document describes the requirements imposed on AAO instrumentation
tasks and the package used to implement such requirements. It shows how
inheritance techniques can be used in DRAMA. In addition, several utility
routines are specified.
- Guide to Creating Makefiles for Drama programs
- DRAMA uses an
imake based scheme (similar to that used by
X11) to create Makefiles. The technique allows, for example, the one Make
configuration file to be used for
VxWorks based systems. It also allows Make configuration files
to be independent of the location of DRAMA
- DTCL - DRAMA Interface to TCL
- This document describes the DRAMA Interface to TCL and TK (See the book
Tcl and the Tk Toolkit by John K. Ousterhout (Addison-Wesley 1994)).
DTCL provides a way to quickly write
high quality user interfaces to distributed instrumentation systems and
to prototype DRAMA programs.
- DRAMA Utilities Library
- This document describes a number of utility programs and routines which
may be used by DRAMA programs.
- DRAMA C++ interface
- This document described the DRAMA C++ interface.
Click here for the DRAMA home page and
here for the AAO home page.
For more information, contact email@example.com