Re: FAQ formats (was: Perl HTML conversion script)

---------

Chris Lewis (clewis@ferret.ocunix.on.ca)
Thu, 25 May 1995 01:06:48 -0400


On May 25, 6:31, Frederic Albrecht wrote:
} Subject: FAQ formats (was: Perl HTML conversion script)
}
} On Wed, 24 May 1995, Chris Lewis wrote:
}
} > RFC 1153. RFC 1630 describes URL/URI, _not_ digest format.
}
} Ah, hum, well it was late... And I misread my index, sorry 'bout that :)
}
} >
} > } I don't believe there's much of a standard format out there.
} >
} > I think you might want to consult:
} >
} > Subject: FAQs: A Suggested Minimal Digest Format
} >
} > ftp://rtfm.mit.edu/pub/usenet/news.answers/faqs/minimal-digest-format
}
} I did read this, I even considered using if, but I have foud very few
} FAQs actually using the format and I didn't find it very easy to parse
} without a browsing tool. So in the end I dropped it in favour of a
} regular text format.

Most newsreaders cope with the format. If you're using a descendent of
rn, try ^G. Gnus, tin, and others can do it too. The FAQ does, I think,
a pretty good explanation how how this interacts with undigestifiers,
Fine's converters and so on.

You don't have to follow it _exactly_, if you read and understand what the
minimal requirements for working with the newsreaders and Fine's converter
are.

} > } > * Do people really use it, and are any other programs readily able to read
} > } > this format?
} > }
} > } Not that I know of, I use it because it makes it easy to move whole
} > } sections around and because it can sort sections alphabetically.
} >
} > Most newsreaders "do" RFC1153, or something conformant with the subset
} > described in the FAQ.
}
} I think the question refered to the Emacs outline format, not to the
} digest format...
}
} Does anyone here use digest ? (should I be using it ?)

Fully RFC1153-compliant digest is _ugly_. And almost nobody uses it for
FAQs. A somewhat larger group of people use something roughly conformant
with my FAQ. I do with my 11 FAQs ;-) And I've had lots of complements
on them - both for being simple and cleanly laid out, and for how well
they get converted by Fine's converter.

I may be biased, but, unless you're assuming that your entire audience is
using MIME or HTML capable newsreaders, I think the minimal format given
is the best bang for the buck. Fine for ASCII, fine for HTML-conversion,
compatible with dozens of newsreaders and add-on undigestifiers. It
ain't the prettiest, but it seems to do the job best.

-- 
Chris Lewis: _Una confibula non sat est_
Phone: Canada 613 832-0541
Latest psroff: FTP://ftp.uunet.ca/distrib/chris_lewis/psroff3.0pl17/*
Latest hp2pbm: FTP://ftp.uunet.ca/distrib/chris_lewis/hp2pbm/*


[ Usenet Hypertext FAQ Archive | Search Mail Archive | Authors | Usenet ]
[ 1993 | 1994 | 1995 | 1996 | 1997 ]

---------

faq-admin@landfield.com

© Copyright The Landfield Group, 1997
All rights reserved