home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #16 / NN_1992_16.iso / spool / news / answers / 2250 < prev    next >
Encoding:
Text File  |  1992-07-25  |  18.0 KB  |  429 lines

  1. Newsgroups: news.answers
  2. Path: sparky!uunet!usc!snorkelwacker.mit.edu!bloom-picayune.mit.edu!athena.mit.edu!jik
  3. From: jik@athena.mit.edu (Jonathan I. Kamens)
  4. Subject: news.answers submission guidelines
  5. Message-ID: <news-answers-guidelines_712040414@athena.mit.edu>
  6. Followup-To: poster
  7. Sender: news@athena.mit.edu (News system)
  8. Supersedes: <news-answers-guidelines_709448414@athena.mit.edu>
  9. Nntp-Posting-Host: pit-manager.mit.edu
  10. Reply-To: news-answers-request@MIT.Edu (Jonathan I. Kamens)
  11. Organization: Massachusetts Institute of Technology
  12. Date: Sat, 25 Jul 1992 05:00:31 GMT
  13. Approved: news-answers-request@MIT.Edu (Jonathan I. Kamens)
  14. Expires: Mon, 7 Sep 1992 05:00:14 GMT
  15. Lines: 412
  16.  
  17. Archive-name: news-answers/guidelines
  18. Version: $Id: guidelines,v 1.26 1992/07/05 18:03:32 jik Exp $
  19.  
  20.  
  21. In order to submit an FAQ posting to the news.answers newsgroup, you
  22. should first modify your posting to conform to the guidelines given
  23. below, in section I.  Then, you should submit your posting to me using
  24. the instructions given below, in section II.
  25.  
  26.  
  27. I. Submission guidelines
  28.  
  29.  A. Why the guidelines?
  30.  
  31.     There are three main reasons for the guidelines that are listed
  32.     below.
  33.  
  34.   1. Appropriateness
  35.  
  36.      Only periodic informational postings that are intended to be read
  37.      by people belong in news.answers.  The guidelines are meant to
  38.      prevent other types of postings, including discussion of periodic
  39.      informational postings, from appearing in the group.
  40.  
  41.   2. Usefulness to people
  42.  
  43.      The newsgroup should be as useful as possible to the people who
  44.      read it.  Requirements such as effective "Subject:" and
  45.      "Summary:" lines (see below) further this goal.
  46.  
  47.   3. Automatic archiving
  48.  
  49.      One of the main points of news.answers is that it can be archived
  50.      automatically in order to build up a database of periodic
  51.      informational postings.  Requirements such as the "Archive-name:"
  52.      line further that goal.
  53.  
  54.  B. Required header fields
  55.  
  56.     There are two "headers" in a news.answers posting.  The first is
  57.     the normal header that any article posted to the USENET has.  The
  58.     second header, the "auxiliary header," is separated from the first
  59.     by one or more blank lines.  As far as the News software is
  60.     concerned, the auxiliary header is just part of the body of the
  61.     article; however, news.answers requires some information in it.
  62.  
  63.     The requirements for each of the two headers are discussed in
  64.     detail below.  Required headers are marked with "(R)", while
  65.     optional ones are marked with "(O)".
  66.  
  67.   1. The normal header
  68.  
  69.    a. Newsgroups (R)
  70.  
  71.       I need to know exactly what will appear in the Newsgroups line
  72.       of the posting.  Although the order of newsgroups on the line is
  73.       not important from the point of view of the news software, I
  74.       prefer to have news.answers listed last, since it is the least
  75.       "relevant" of the listed newsgroups.
  76.  
  77.       Example:
  78.  
  79.        Newsgroups: comp.sys.foo,news.answers
  80.  
  81.    b. Subject (R)
  82.  
  83.       The subject line of your posting should have some meaning
  84.       outside of its home newsgroup(s).  For example, instead of just
  85.       "FAQ," you might have "<x> FAQ", where "<x>" is the name of the
  86.       newsgroup or the topic being discussed.
  87.  
  88.       Furthermore, important information should appear near the
  89.       beginning of the subject line, so that news readers that display
  90.       article summaries don't cut off the important information.  For
  91.       example, instead of "Frequently Asked Questions about <x>," use
  92.       "<x> Frequently asked Questions."
  93.  
  94.       Example:
  95.  
  96.        Subject: comp.sys.foo Frequently Asked Questions (FAQ)
  97.  
  98.    c. Followup-To (R) and Reply-To (O)
  99.  
  100.       Your posting must have a "Followup-To:" line in the header that
  101.       directs followups to somewhere other than news.answers.  You may
  102.       choose to direct followups back to the home newsgroup of the
  103.       FAQ, or to direct followups to the author of the FAQ, in which
  104.       case "Followup-To: poster" is sufficient.
  105.  
  106.       If you forget the "Followup-To:" and I get mailed followups to
  107.       your FAQ, I'm going to get peeved at you.
  108.  
  109.       Furthermore, your posting must have a valid E-mail reply address
  110.       in the header, either in the "From:" field, or if not in "From:"
  111.       then in "Reply-To:".
  112.  
  113.       Example:
  114.  
  115.        From: guru@foosys.com (Joe R. Programmer)
  116.        Followup-To: comp.sys.foo
  117.        Reply-To: faq-mail@foosys.com (FAQ Comments address)
  118.  
  119.       In this example, "guru" apparently wants mail about the FAQ to
  120.       go to a different address than the rest of his mail.  I've shown
  121.       the "From:" header, because the version of the FAQ that you
  122.       forward to me should show the "From:" header just as it will
  123.       appear when the article is actually posted.
  124.  
  125.    d. Supersedes, Expires, References (O)
  126.  
  127.       It is a good idea to use "Supersedes:" and "Expires:" header
  128.       lines to make sure that each version of your FAQ stays around
  129.       until the next time it is posted.  A useful tool for this is my
  130.       perl FAQ poster.  It is available from pit-manager.mit.edu, via
  131.       anonymous ftp in the file /pub/post_faq.shar, or via mail server
  132.       (send mail to mail-server@pit-manager.mit.edu with "send
  133.       post_faq.shar" in the body).
  134.  
  135.       Furthermore, if you are posting a multi-part FAQ posting or a
  136.       series of related FAQ postings, it is a good idea to add a
  137.       "References:" line to all of the postings except the first one,
  138.       making the contents of that line the Message-ID of the first
  139.       posting in the series.  If you do this, then people who use
  140.       threaded news readers will be able to manipulate the entire
  141.       series as a single thread, including (for example) killing the
  142.       entire thread if they're not interested or saving the entire
  143.       thread to a file with one command.  The perl FAQ poster
  144.       mentioned above supports an option for doing this.
  145.  
  146.       Example:
  147.  
  148.        Expires: Fri, 1 May 1992 00:00:00 GMT
  149.        Supersedes: <foo-faq_701650000@foosys.com>
  150.  
  151.       The date in the "Expires:" header should be far enough into the
  152.       future that a new version of the FAQ will be posted before the
  153.       one you're posting now expires.  I've shown both headers in the
  154.       format my post_faq script would use.  I haven't shown a
  155.       "References:" header, since the example posting I've been
  156.       presenting is not part of a multi-part FAQ; if there were a
  157.       "References:" header, it would contain a Message ID just like
  158.       the "Supersedes:" header.
  159.  
  160.    e. Summary (O)
  161.  
  162.       You are encouraged to put a summary of the contents of your
  163.       article in the Summary field of the header.  Try to describe
  164.       what your FAQ discusses, and aim your description at someone who
  165.       may not actually be directly interested in the topic covered by
  166.       your FAQ.  There have been discussions about using the Summary
  167.       fields of the FAQ postings in news.answers to construct a short
  168.       "catalog" of the information available through news.answers, so
  169.       think of the Summary field as a "catalog entry" for your FAQ.
  170.  
  171.       Note that header fields are allowed to span multiple lines, as
  172.       long as the continuation lines after the first start with
  173.       whitespace (at least one space or tab character).
  174.  
  175.       Example:
  176.  
  177.        Summary: This posting contains a list of Frequently Asked
  178.                Questions (and their answers) about Foo computers.  It
  179.                should be read by anyone who wishes to post to the
  180.                comp.sys.foo newsgroup.
  181.  
  182.   2. The auxiliary header
  183.  
  184.      The auxiliary header looks like the main message header (i.e.
  185.      "Field-name: field-value"), but is separated from the main
  186.      message header by a blank line, as well as followed by a blank
  187.      line separating it from the rest of the body of the message.
  188.  
  189.      The auxiliary header of this posting is:
  190.  
  191.       Archive-name: news-answers-guidelines
  192.       Version: $Id: guidelines,v 1.26 1992/07/05 18:03:32 jik Exp $
  193.  
  194.    a. Archive-name (R)
  195.  
  196.       In order to be cross-posted in news.answers, your posting must
  197.       include an auxiliary archival header with an "Archive-name:"
  198.       field.
  199.  
  200.       The archive name should be a short (14 characters or less, if at
  201.       all possible, and if not, then each component of the name should
  202.       be unique in the first 14 characters), one-word (hyphens
  203.       allowed) tag identifying the FAQ.  For example, the
  204.       comp.unix.questions FAQ is "unix-faq" (which means that the
  205.       auxiliary header contains "Archive-name: unix-faq").  Multi-part
  206.       FAQs should be named "name/part1", "name/part2", etc.  If you
  207.       post a diff for your FAQ, it should be named "name/diff".  If
  208.       you post diffs for a multi-part FAQ, they should be named
  209.       "name/diff1", "name/diff2", etc.  If you post a diff to a
  210.       one-part posting, then the original FAQ should be named
  211.       "name/part1" (although you can use a name besides "part1" if you
  212.       think there is a more appropriate tag to identify the posting)
  213.       and the diff should be named "name/diff".  Avoid periods in the
  214.       archive name, because some operating systems choke on them; if
  215.       you must have word separators, use hyphens rather than periods.
  216.  
  217.       Please pick the archive name that you would like to use for your
  218.       posting, and include the "Archive-name:" line with that archive
  219.       name in it, when submitting to news.answers.  If there is some
  220.       problem with it, or if I would like to suggest an alternate
  221.       name, I will let you know.
  222.  
  223.       Example:
  224.  
  225.        Archive-name: foo-faq
  226.  
  227.    b. Last-modified, Version (O)
  228.  
  229.       You can have other fields in the auxiliary header, if you want.
  230.       Two common ones are "Last-modified:" and "Version:".
  231.  
  232.       Example:
  233.  
  234.        Last-modified: 1992/03/25
  235.        Version: 2.5
  236.  
  237.   3. Sample FAQ headers
  238.  
  239.      Putting together the examples I've given above, your FAQ's
  240.      headers (or, at least, the ones you submit to me) might look like
  241.      this:
  242.  
  243.      From: guru@foosys.com (Joe R. Programmer)
  244.      Newsgroups: comp.sys.foo,news.answers
  245.      Subject: comp.sys.foo FAQ
  246.      Followup-To: comp.sys.foo
  247.      Reply-To: faq-mail@foosys.com (FAQ Comments address)
  248.      Summary: This posting contains a list of Frequently Asked
  249.              Questions (and their answers) about Foo computers.  It
  250.              should be read by anyone who wishes to post to the
  251.              comp.sys.foo newsgroup.
  252.      Expires: Fri, 1 May 1992 00:00:00 GMT
  253.      Supersedes: <foo-faq_701650000@foosys.com>
  254.  
  255.      Archive-name: foo-faq
  256.      Last-modified: 1992/03/25
  257.      Version: 2.5
  258.  
  259.      Note that the blank line separating the normal header from the
  260.      auxiliary header must be completely blank, i.e., no tabs or
  261.      spaces, and that there must also be one or more completely blank
  262.      lines after the auxiliary header.
  263.  
  264.      Of course, you can include in the posting header any of the other
  265.      standard USENET header fields that have not been discussed here.
  266.  
  267.  C. Mailing lists for FAQ maintainers
  268.  
  269.     Maintainers of FAQs are strongly urged to join the faq-maintainers
  270.     mailing list, which is used for discussion about the news.answers
  271.     newsgroup and the maintenance of USENET FAQs.
  272.  
  273.     If you don't want to be on the discussion list, you may wish to
  274.     join the faq-maintainers-announce list, which will be used only
  275.     for announcements, instead.  Note that subscribers to
  276.     faq-maintainers automatically receive messages sent to
  277.     faq-maintainers-announce.
  278.  
  279.     When submitting your FAQ, make sure to let me know whether or not
  280.     you want to be on one of the lists.
  281.  
  282.  D. List of Periodic Informational Postings
  283.  
  284.     Unless you tell me otherwise, I will add any postings submitted to
  285.     news.answers to the "List of Periodic Informational Postings"
  286.     (LoPIP) articles which appear in news.answers, news.lists, and
  287.     news.announce.newusers.  Therefore, in addition to seeing a copy
  288.     of your posting when you submit it to news.answers, I also need
  289.     you to tell me the frequency at which you intend to post it, since
  290.     the LoPIP posting contains a frequency field for each entry in it.
  291.  
  292.     If you do not have copies of the LoPIP postings and would like to
  293.     get them, to see what they're like or to check if your FAQ is
  294.     already listed, see the instructions at the end of this message.
  295.  
  296.  E. Article approval
  297.  
  298.     Once all of the other issues listed in this posting are resolved,
  299.     you will be given approval to cross-post your FAQ to news.answers.
  300.     You will have to indicate in the header of your posting that such
  301.     approval has been given, or the posting will be mailed to me
  302.     instead of posted.
  303.  
  304.     Note that I am intentionally being somewhat vague about what this
  305.     entails.  When I approve your posting for news.answers, I will
  306.     provide more specific instructions.
  307.  
  308.  
  309. II. Submission instructions
  310.  
  311.     If you have a posting which you wish to submit to news.answers,
  312.     you should first read the guidelines listed above and modify your
  313.     posting to conform to them.  Then, you should submit it by posting
  314.     it to the news.answers newsgroup, assuming that the software on
  315.     the poster's site works properly and will forward the posting to
  316.     the news.answers moderator, or by mailing it to the news.answers
  317.     submission address, news-answers@MIT.Edu.  ONLY SUBMISSIONS SHOULD
  318.     BE MAILED TO THAT ADDRESS.  If there is some commentary or
  319.     explanation that needs to be made, it should be mailed in a
  320.     separate message to news-answers-request@MIT.Edu, which is the
  321.     moderator contact address for any news.answers-related business.
  322.  
  323.     Please submit the FAQ in a form as close as possible to how it
  324.     appears when you post it normally.  This means that you should
  325.     include a complete header, with at the very least the Subject line
  326.     you normally use.  I very much prefer you actually posting the
  327.     message to news.answers as you would post it normally, including
  328.     the cross-posted newsgroups, but omitting the moderation approval
  329.     header line that would cause the article to actually be posted
  330.     rather than mailed to me; this way, I will get to see exactly how
  331.     the article will look when it is actually posted in news.answers.
  332.     Also, if your FAQ does not say somewhere near the top how often it
  333.     is posted, then please let me know the frequency in separate
  334.     E-mail.
  335.  
  336.     Note that if you do not indicate moderator approval in the header
  337.     of your posting, it will NOT be posted to any newsgroup, even if
  338.     you list other newsgroups on the Newsgroups line besides
  339.     news.answers.  Therefore, you CAN and SHOULD place all Newsgroups
  340.     to which you intend to post in the Subject line, in the order you
  341.     intend them to be in when you post.
  342.  
  343.     I will respond, either by agreeing that the FAQ belongs in
  344.     news.answers as-is, by asking you to make minor modifications to
  345.     it in order to make it acceptable, or by rejecting it as
  346.     inappropriate for news.answers.  If you are asked to make
  347.     modifications, please do so and resubmit the posting to me just as
  348.     you did the first time.
  349.  
  350.     Once an FAQ has been approved for news.answers, you will post it
  351.     directly to the group yourself, by indicating in the header of the
  352.     message that it was approved by the news.answers moderator, as
  353.     described above.
  354.  
  355.  
  356. III. If you've submitted before
  357.  
  358.      If you've submitted FAQs to news.answers before, you still have
  359.      to submit any new FAQs to me using the procedure described above,
  360.      i.e., you cannot just post them directly to news.answers.  This
  361.      is also true if you add new parts to a multi-part posting, or if
  362.      you convert a single posting into a multi-part posting.
  363.  
  364.      You should also try to let me know if you change the Newsgroups
  365.      or Subject line of a posting that you are cross-posting to
  366.      news.answers, although this is less important and I probably
  367.      won't have a heart attack if you forget or don't have time.
  368.  
  369.  
  370. IV. This posting
  371.  
  372.     Comments about, suggestions about or corrections to this posting
  373.     are welcomed.  If you would like to ask me to change this posting
  374.     in some way, the method I appreciate most is for you to actually
  375.     make the desired modifications to a copy of the posting, and then
  376.     to send me the modified posting, or a context diff between my
  377.     posted version and your modified version (if you do the latter,
  378.     make sure to include in your mail the "Version:" line from my
  379.     posted version).  Submitting changes in this way makes dealing
  380.     with them easier for me and helps to avoid misunderstandings about
  381.     what you are suggesting.
  382.  
  383.     The following people provided feedback and helped to make this
  384.     posting more readable and useful:
  385.  
  386.      Stan Brown <brown@NCoast.ORG>
  387.      Aydin Edguer <edguer@alpha.CES.CWRU.Edu>
  388.      Tom_Lane@G.GP.CS.CMU.EDU
  389.      Cindy Tittle Moore <tittle@ics.uci.edu> 
  390.      Steven D. Ourada <sourada@iastate.edu>
  391.      Ken Shirriff <shirriff@sprite.Berkeley.EDU>
  392.      Dan Tilque <dant@logos.WR.TEK.COM>
  393.      Bill Wohler <wohler@sap-ag.de>
  394.  
  395.  
  396. V. Getting the "List of Periodic Informational Postings"
  397.  
  398.    There are three "List of Periodic Informational Postings"
  399.    postings:
  400.  
  401.     Subject: List of Periodic Informational Postings, Part I
  402.     Subject: List of Periodic Informational Postings, Part II
  403.     Subject: List of Periodic Informational Postings, Part III
  404.     Newsgroups: news.lists,news.announce.newusers,news.answers
  405.  
  406.    They are available in the indicated USENET newsgroups, or via
  407.    anonymous ftp from pit-manager.mit.edu (18.172.1.27) in the files:
  408.  
  409.     /pub/usenet/news.answers/periodic-postings/part1
  410.     /pub/usenet/news.answers/periodic-postings/part2
  411.     /pub/usenet/news.answers/periodic-postings/part3
  412.  
  413.    They are also available from mail-server@pit-manager.mit.edu by
  414.    sending a mail message containing any or all of:
  415.  
  416.     send usenet/news.answers/periodic-postings/part1
  417.     send usenet/news.answers/periodic-postings/part2
  418.     send usenet/news.answers/periodic-postings/part3
  419.  
  420.    If you want to find out more about the mail server, send a message
  421.    to it containing "help".
  422.  
  423. -- 
  424. Jonathan Kamens                        jik@MIT.Edu
  425. MIT Information Systems/Athena            Moderator, news.answers
  426.     (Send correspondence related to the news.answers newsgroup
  427.     {and ONLY correspondence related to the newsgroup}
  428.          to news-answers-request@MIT.Edu.)
  429.