Relay-Version: version B 2.10 5/3/83; site utzoo.UUCP
Path: utzoo!decvax!ucbvax!ucbcad!nike!lll-crg!seismo!plus5!hokey
From: hokey@plus5.UUCP
Newsgroups: mod.std.mumps
Subject: Proposal: First Line Convention
Message-ID: <1106@plus5.UUCP>
Date: Tue, 7-Oct-86 07:40:40 EDT
Article-I.D.: plus5.1106
Posted: Tue Oct  7 07:40:40 1986
Date-Received: Wed, 8-Oct-86 04:22:29 EDT
Sender: hokey@plus5.UUCP
Lines: 45
Approved: hokey@plus5.uucp
Volume-Issue: X11.1/1986.10/mod.std.mumps/5

I propose the following format for the first line of a routine:

	*label* *ls* ; [*owner*] [ ; [ *date* ] [ ; [ *description* ] ] ]

where:

	*label* ::=	the name of the routine

	*owner* ::= [ *contact* ] [ [ *pgm* , ] ... *pgm* ]

	*date* ::=	the date and optionally time of the last modification.
			Possible formats include:
				RFC822: a *date* or *date-time*
				ISO 2014, 3307, and 4031:
				    YYYYMMDDhhmmss-hhmm  or
				    YYYYMMDDhhmmssZ	 (for UCT)

	*description* ::=	A brief description of the routine.  A fifth
				semicolon piece is often used for a copyright
				notice.

	*contact* ::= *route-addr*

			NOTE:	see RFC822 for a description of *route-addr*.
				*quoted-string*s are not permitted.

	*pgm* ::= *name*	

The purpose of the first line is to provide identification of the routine
and a maintenance contact.

The *pgm* list is used to classify the "position" of the routine in the
package/program heirarchy.  *pgm*s are listed from left to right, as most-
to least-significant.

It is expected that other pertinent information, such as Author and Summary
information, be placed in "offline" comments.

Examples:

	MUP ;Costar,Maint,Monitor;19760207;Bring monitor UP
	XM ;<MailMan-Bugs@VA.GOV>VA,MailMan;;MailMan main menu driver;
	XMINI ;VA,MainMan,Init;

Hokey