Instructions for Authors

Our goal for CASA guides is to maintain up-to-date documentation. The documentation should maintain consistent formatting across the tutorials. Cookbook procedures should be written such that they can be extracted as python scripts for use by users or developers (for testing purposes).

Embedded Code

Use the "source" formatting option for codes, and "pre" to illustrate the output of a program. For example:

<source lang="python">
# for CASA
x = 3
y = 2
vis = "OrionBar-Ka.ms"
clean()
</source>

will render as

# for CASA
x = 3
y = 2
vis = "OrionBar-Ka.ms"
clean()

Be sure also to include the command to be executed by user to make the scripts more easily testable by developers.

Testing Scripts

Any cookbook scripts should be tested and verified; the wiki should include a stamp (in MediaWiki, a template) indicating in which version of CASA the script was last tested. Use the script extractor code to generate the script from the wiki page, debug the wiki page, and then stamp it.

Here's an example stamp in MediaWiki's markup language.

{{Checked 3.0.0}}

which yields

Last checked on CASA Version 3.0.0 (r9860).

In MediaWiki markup, double braces indicate a template for commonly used phrases and bits of writeup ("under construction," that sort of thing). Please make new templates as they are needed to stamp pages. A current list of templates is available.

(Also: let Jack Gallimore know if there are any problems with the script extractor. It needs more testing!)