[ Usenet FAQs | Web FAQs | Documents | RFC Index ]
    Search the FAQ Archives

Single Page

Top Document: FAQs: A Suggested Minimal Digest Format
Previous Document: 2. Table of Contents
Next Document: 4. What's a Section, and How is it Formatted?


3. What Should the Overall FAQ Look Like?


Most FAQs lend themselves to a format like:

	<news headers>
	<news.answers required headers if the FAQ is registered>
	<title and author>
	<section>
	<section>
	<section>
	<section>

While FAQs aren't always lists of questions and answers, they usually
have "sections" of text -- whether they be sets of lists, individual
Q&A's, groups of Q&A, textual sections, whatever.  The digest format
is all about how these sections should be delimited for automatic parsing.

Note that this FAQ doesn't attempt to explain the news headers and
news.answers subheaders.  For this, you should really consult the
FAQs on how to create news.answers postings.  It's worth noting a
few things here.  You should use Expires/Supersedes to manage the
deletion of previous copies of your FAQ.  It is also a very good idea
to use References: lines to link the parts of multi-part FAQs together
so that they remain together with Usenet news readers.



Top Document: FAQs: A Suggested Minimal Digest Format
Previous Document: 2. Table of Contents
Next Document: 4. What's a Section, and How is it Formatted?

Single Page


[ Usenet FAQs | Web FAQs | Documents | RFC Index ]

Send corrections/additions to the FAQ Maintainer:
digfaq@ferret.ocunix.on.ca (Digest FAQ commentary reception)

Last Update October 22 2009 @ 05:24 AM

Some parts © 2009 Advameg, Inc.