Subject:
|
Format of FAQ items
|
Newsgroups:
|
lugnet.faq
|
Date:
|
Fri, 23 Apr 1999 20:20:05 GMT
|
Reply-To:
|
jsproat@geocities+saynotospam+.com
|
Viewed:
|
2591 times
|
| |
|
|
Todd,
I'm geared to start snarfing the RTL Auction & Shipping FAQ, to start giving
form to the LUGNET FAQ. (LUGFAQ? :-) I am torn between two data formats,
though it should be relatively easy to switch from one to the other.
I think that whatever format is used, it should allow multiple Q+A's in a
single file, with the technical possibility of having it all in one file.
Another possible feature would be to allow a master file to explicitly
include a subordinate file during parsing; this would greatly facilitate
separation of other FAQs, such as the LDraw FAQ.
Once I figure out what format to use, I'll post a broilerplate for people to
submit Q+A's (or just Q's) for the FAQ.
Potential format examples follow. (1)
-----------------------------------------------------------------------------
email headers style
plus: more easily by humans
minus: a separate file for each question? - if so, how to sort, how to name?
-----------------------------------------------------------------------------
Category: Auction & Shipping
Subcategory: Awareness
Subject: You mean I can get money for my old LEGO®?
Content-Language: en
Newsgroups: lugnet.market.*
Author: Todd Lehman
FAQ-Date: 19990423
Yes, absolutely -- anything that says LEGO® on it.
[quote snipped]
Sell your old LEGO® and you will be rewarded. But don't sell it to the
first
bloke who offers you $10 for it -- seek out the people who seek what you
have, and both of you are winners.
-----------------------------------------------------------------------------
xml style
plus: tons of entries in same file, implied sort order can be enforced
minus: not as easily read by humans
minus: XML and / or HTML token chars in entry text may need to be escaped
-----------------------------------------------------------------------------
<ENTRY>
<ENTRYHEADER>
<CATEGORY>Auction & Shipping</CATEGORY>
<SUBCATEGORY>Awareness</SUBCATEGORY>
<SUBJECT>You mean I can get money for my old LEGO®?</SUBJECT>
<CONTENT-LANGUAGE>en</CONTENT-LANGUAGE>
<NEWSGROUPS>lugnet.market.*</NEWSGROUPS>
<AUTHOR>Todd Lehman</AUTHOR>
<FAQ-DATE>19990423</FAQ-DATE>
</ENTRYHEADER>
<ENTRYTEXT>
Yes, absolutely -- anything that says LEGO® on it.
[quote snipped]
Sell your old LEGO® and you will be rewarded. But don't sell it to
the first
bloke who offers you $10 for it -- seek out the people who seek what you
have, and both of you are winners.
</ENTRYTEXT>
</ENTRY>
-----------------------------------------------------------------------------
Any feedback on what kind of format you'd prefer on your end would be
great. I have plenty of time this weekend to get cracking. :-,
Cheers,
- jsproat
1. Quote shamelessly hoovered from the rec.toys.lego Auction & Shipping FAQ
by Todd Lehman: http://www.lugnet.com/fibblesnork/lego/guide/auction/
--
Jeremy H. Sproat <jsproat@geocities.com>
http://www.geocities.com/SiliconValley/Horizon/5249/
"I prefer the term para-mental. It keeps me out of the loony bin."
obconspiracy: NASA plots with the Trilateral Commission to divert Sardaukar
to the Himalayas, in order to "get some".
|
|
Message has 2 Replies:
 | | Re: Format of FAQ items
|
| (...) How come? For specifying the ordering? For ease of editing? What about translations? Maintenance? Bookmarking? Grepping? (...) Something analogous to #include in C then? Would that slurp in an entire sub-FAQ? Or only relevant (...) (25 years ago, 23-Apr-99, to lugnet.faq)
| | | Progress so far, and a new header
|
| FAQ crew, I've gathered 23 questions for the FAQ so far (1), and stuffed them into a holding patteren until the header format is closer to being finalized. In the mean time: I feel that we should allow an Originator header, to give credit towards (...) (25 years ago, 28-Apr-99, to lugnet.faq)
|
82 Messages in This Thread:
  
 
- Entire Thread on One Page:
- Nested:
All | Brief | Compact | Dots
Linear:
All | Brief | Compact
|
|
|
|
