Subject:
|
Re: [faq FAQ How do I format an entry in the Lugnet FAQ?]
|
Newsgroups:
|
lugnet.faq
|
Date:
|
Wed, 14 Jul 1999 16:20:59 GMT
|
Viewed:
|
4354 times
|
| |
|
|
In lugnet.faq, Jacob Sparre Andersen writes:
> Robert:
>
> [...]
>
> It appears that you were correct, when you wrote that the
> explanation of the FAQ file format is incomprehensible.
>
> I will try to write something easier based on what you wrote
> (and what I think you misunderstood).
Thanks, that would be great. The three parts I think I misunderstood are:
1. The question says "How do I format an entry for the Lugnet FAQ?" so
naturally I assumed the answer would be in the form of a step-by-step how-to.
Instead it's a terse technical statement of the format.
2. The part of the answer which begins with "The answer should be written so
the following document..." is particularly confusing, because it doesn't
explain what's going on. What's really going on is that an automated process of
some kind will be extracting parts of the answer a Lugnet user has submitted
and inserting them into the "following document". You need to explain this in a
simpler way (like I did in my rewrite)
3. The most confusing part of all results from the many "<" and ">" in
the "following document". This results simply from the fact that I am reading
your raw submission as a LUGNET message and there is no formatter present to do
the formatting. As you can see, my rewrite took this implicitly into account,
and in fact my rewrite will no longer be understandable once the automatic
formatter exists because the embedded HTML tags it self-refers to will no
longer be visible to the reader.
So I would actually suggest taking the whole answer and putting it inside <PRE>
and </PRE> markers. That way, you don't have to deal with any of the issues of
whether the answer is being viewed in formatted or unformatted state.
Unfortunately (I think) < and > are still requred inside <PRE> blocks if
they are part of a valid HTML tag.
- Robert Munafo
|
|
Message has 2 Replies:
 | | Re: [faq FAQ How do I format an entry in the Lugnet FAQ?]
|
| Robert Munafo <munafo@gcctech.com> wrote: [snip] (...) [snip, snip; goodbye context] So, there will be but does not currently exist a tool which extracts messages from this newsgroup, checks for actual properly-formatted ones, checks revision, and (...) (25 years ago, 14-Jul-99, to lugnet.faq)
|
Message is in Reply To:
| | Re: [faq FAQ How do I format an entry in the Lugnet FAQ?]
|
| Robert: [...] It appears that you were correct, when you wrote that the explanation of the FAQ file format is incomprehensible. I will try to write something easier based on what you wrote (and what I think you misunderstood). Play well, Jacob (...) (25 years ago, 14-Jul-99, to lugnet.faq)
|
86 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
|
|
|
|
