Subject:
|
Raw FAQ data format (Was: Format of FAQ items)
|
Newsgroups:
|
lugnet.faq
|
Date:
|
Sat, 24 Apr 1999 11:14:21 GMT
|
Viewed:
|
1951 times
|
| |
| |
Todd Lehman (lehman@javanet.com) and Sproaticus
(jsproat@geocities.com) writes lots of stuff:
Guys!
It sounds like you are mixing the raw data format and the
presentation format.
I'll try to stick to the raw data format here, and list the
ideas I have been able to extract from the discussion.
- Each entry in a separate file.
- Each entry consists of a number of headers followed by
an empty line and the content of the entry.
- The content of the entries should be marked up as a
subset of HTML ("lynx -dump" is a possible tool for
translation to plain text).
- These header entries have been suggested:
Subject [the question]
Category [category (and sub-category?) name]
Content-Language [ISO 639 language code]
Topic-Level [integer, 0 is beginner/easy/simple]
Version: [author and ISO date]
Newsgroups: [comma-separated list of newsgroups
the question could appear in]
(I am sure I have forgotten something here)
- ASCII + HTML entities are allowed in the headers.
Now I have some questions and ideas:
- Should we use ASCII or Latin-1 for the content character
set?
- The content should of cause not be a full HTML document.
I imagine something that fits into this template:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE>%Subject%</TITLE>
<BODY>
<H1>%Subject%</H1>
%Content%
</HTML>
- It would also be useful with a header entry with
translation information:
Translation: [translator, from language, latest
version string from the translated
entry]
Play well,
Jacob
------------------------------------------------------------
-- E-mail: sparre@cats.nbi.dk --
-- Web...: <URL:http://hugin.risoe.dk/JJ_Memorial/FAQ/> --
------------------------------------------------------------
|
|
Message has 2 Replies: | | Re: Raw FAQ data format (Was: Format of FAQ items)
|
| (...) Sounds mostly good. Catch my exceptions down below. (...) Or some other tool; but I agree, a well-defined subset of HTML can and should be used. (...) (Please keep in mind Jacob, that these are nits I'm picking. :-) "Newsgroups" would be more (...) (26 years ago, 24-Apr-99, to lugnet.faq)
| | | Re: Raw FAQ data format (Was: Format of FAQ items)
|
| (...) I'd like to see Latin-1 as the raw data format, with conversions to the presentation formats of: (a) HTML for webpages and (b) Latin-1/ASCII for text documents (i.e. news postings). (...) Is this a choice between (a) 7-bit ASCII with HTML (...) (26 years ago, 25-Apr-99, to lugnet.faq)
|
Message is in Reply To:
| | Re: Format of FAQ items
|
| (...) What about an outline format? I made a cool little utility that displays, in outline format, any sub-tree of the global ng tree...so from any category sub-homepage you can see what's there beneath it -- especially handy for things like loc (...) (26 years ago, 24-Apr-99, to lugnet.faq)
|
82 Messages in This Thread:
- Entire Thread on One Page:
- Nested:
All | Brief | Compact | Dots
Linear:
All | Brief | Compact
This Message and its Replies on One Page:
- Nested:
All | Brief | Compact | Dots
Linear:
All | Brief | Compact
|
|
|
|