lotus



previous page: 2.4) Unacceptable content of posts (alt.sources.mac)
  
page up: alt-sources-mac FAQ
  
next page: 3.2) Small posts, snippets, cross-posts from other newsgroups (alt.sources.mac)

3.1) General format for all posts (alt.sources.mac)




Description

This article is from the alt-sources-mac FAQ, by Mark Pilgrim (f8dy@netaxs.com) with numerous contributions by others.

3.1) General format for all posts (alt.sources.mac)

Choose a good subject line for your posting that accurately describes what
it contains. The alt.sources.mac archive site generates its indices of the
newsgroup from the subject lines of the postings in it, so try to make sure
that there are relevant keywords in your subject that people can search for
when looking for your source code later. For source code archives spread
over several posts (see <3.3> below), the subject lines should include not
only the archive name, type, and platform, but also the part number:
Ghost 1.0 (word game, THINK C, part 0 of 10)
Ghost 1.0 (part 1 of 10)
...
Ghost 1.0 (part 10 of 10)

Put a Followup-To: header line in your posting which directs followups
somewhere other than alt.sources.mac. This is especially important if you
cross-post your alt.sources.mac posting from some other newsgroup, because
people will often respond to the posting in that newsgroup without realizing
it was cross-posted to alt.sources.mac.

At the top of your posting, separated from the main header of the posting
by a blank line, include "Archive-name:" and "Submitted-by:" lines:
Archive-name: ghost-10.hqx
Submitted-by: f8dy@netaxs.com

The "name" on the first line should be a short one-word string that can serve
as a "tag" for the package. If your post is a complete program with a unique
name, you can just use the name of the program as the archive name. If you
are posting a patch to a previously posted bit of source code, you would do
something like "name/patchN", where N is the number of the patch. If you post
source code in multiple parts, do "name/part1", "name/part2", etc. The second
line should contain a return mail address for you.

This informational header (note that it is an auxiliary header, in the body of
the posting, NOT part of the main message header) is used by some automatic
archiving software to maintain alt.sources.mac archives automatically. There
are other useful fields you may want to put in the auxiliary header; if you
are curious, see the documentation for the "rkive" program in the
comp.sources.misc archives to find out what they are.

Other than the informational header, each post should include the following
additional information about the content of the post: the type of code, a
brief description of the code, the language of the code, and (if necessary)
the specific programming environment the code was written in (e.g. THINK C
vs. MPW C, QuickBASIC vs. Visual BASIC). Answer all these questions early
in the post; people should not have to search through the entire package
just to figure out what it is.

For large posts (more than a few pages), this information should constitute
the entire first post (part 0). See <3.3> below for details.

 

Continue to:















TOP
previous page: 2.4) Unacceptable content of posts (alt.sources.mac)
  
page up: alt-sources-mac FAQ
  
next page: 3.2) Small posts, snippets, cross-posts from other newsgroups (alt.sources.mac)