If you wish to submit something for inclusion in the repository, you
should send mail to doc-comments@tc.cornell.edu with the following
information:

--------------------------------------------------------------------

Network name:		blah.net
 [leave this line out if not a network]
Module name:		blah
 [leave this line out if not a user-written module]
Macro name:		blah
 [leave this line out if network is NOT a macro]
Category:		Transformation
 [leave this line out if NOT a macro or user-written module]
Author:			John Doe, University of Goombah, jxdoe@gumby.goombah.edu
Date last modified:	04/26/93
Other required files:	none
 [none means no other non-standard DX modules or macros are required]
 ELSE
Other required files:	Foobar.net (Rendering macro)
 [use this form if only one other required file]
 ELSE
Other required files:
 Foobar.net (Rendering macro)
 Snafu.net (Transformation macro)
 Snickersnee (Import and Export module)

Program comment in free form.

See also:
 Foo (Transformation macro)
 Bar (Import and Export macro)

--------------------------------------------------------------------

In your submission, this information should also be contained in a
file called README, and in the Comment windows of any DX networks.
To create a comment window, click on Edit in the VPE and type in the
above information in the window that appears.  When finished, click
Apply, then OK.

If you wish, you may include the Author line only in the mail sent
to docx, and not in the README file and network comments.  Users who
download your submission will then not have access to this
information.

Some notes on the above format:

Network name is the filename as net appears on disk.
Module and macro names are the files as they appear in the DX UI
Categories lists. Category is the category the user-author has
assigned either to.

For "Other required files" all non-standard DX dependencies need to
be mentioned.

The free form comment may be as wordy as you wish.  At a minimum,
describe in a sentence or two what the module or macro or network
does. If anything really weird is required or happens, that should
be documented. It is not necessary to tell Joe User that a scalar
input can take a Scalar interactor, for example, but if the
network requires the input field to be 3D and cannot accept 2D fields,
that is worth mentioning (it should have been mentioned also in the
Input description for the macro or module, that is, the notation that
is seen when one double-clicks any module in the UI).

If convenient, short examples can be included right in the Comment.

Comment lines should not contain carriage returns, but should word-wrap
correctly if the user changes the Comment window dimensions. I'm not
sure if there is an upper limit on line length, so occasionally paragraph
separations should be used. This improves readability anyway.

In the mail and README, only a brief version of the program comment
needs to be included; users can use this brief summary to decide
whether or not to download the body of the submission.

See also: lists other files that the browser might like to look at
to either better understand the workings of the macro/network
being documented, or other similar macros that might also be
useful to know about.