Subject:
|
[faq FAQ How do I format an entry in the Lugnet FAQ?]
|
Newsgroups:
|
lugnet.faq
|
Date:
|
Tue, 13 Jul 1999 22:35:52 GMT
|
Viewed:
|
4324 times
|
| |
|
|
In lugnet.faq, Jeremy H. Sproat writes:
> Robert Munafo wrote:
> > [...] I had to read through the "format" answer
> > http://www.lugnet.com/news/raw.cgi?lugnet.faq:431
> > three or four times before I could understand [...]
>
> You want to re-write the answer? :-,
Here's my attempt at a more understandable answer:
Subject: How do I format an entry in the Lugnet FAQ?
Content-Language: en
Topic-Level: 1
Revision: Jacob Sparre Andersen, 1999-05-06
Revision: Jeremy Sproat, 1999-05-10
Revision: Robert Munafo, 1999-07-13
Reference: http://www.lugnet.com/news/display.cgi?lugnet.faq:83
Reference: http://www.lugnet.com/faq/?n=180&t=i&v=a
Location: /faq/
<P>If you already have a FAQ answer you want to add to the LUGNET FAQ database,
you first need to add headers like the ones you see above this paragraph, and
then add HTML formatting tags like you see scattered throughout this answer.
LUGNET uses HTML formatting and extra header fields so that it can supply FAQ
information to its web browser users as well as more traditional ASCII FAQ
files to other users.</P>
<P>Add a header first. You can cut and paste a header from another FAQ entry
like this one, but make sure to change everything that needs to be changed!</P>
<P>The following entries are allowed in the header, but not all are
required:</P>
<PRE>
Subject: [the question]
Content-Language: [ISO 639 language code. Use "en" for English
and "en-US" for the USA dialect of English.]
Topic-Level: [integer, 0 is beginner/easy/simple]
Revision: [author, ISO date]
Location: [comma-separated list of Lugnet relative
URI's]
Translated-From: [ISO 639 language code]
Translator: [translator, ISO date]
Originator: [originator, ISO date]
Comment: [will be ignored]
Include: [relative (Unix) file name for another
FAQ entry - only header entries that
not already occur will be included]
Reference: [URL to the source of the answer]
</PRE>
<P>After you have added the header, go through the text. A basic familiarity
with the commonly used HTML tags is useful; if you need help look at other FAQ
answers on LUGNET for examples.</P>
<P>Mark the beginning and end of each paragraph with P and /P.</P>
<P>Mark boldface with B and /B, and italics with I and /I.</P>
<P>Any text that you want to appear in a monospaced font, such as ASCII
formatted tables or ASCII graphics illustrations, should be marked with PRE and
/PRE.</P>
<P>If you want a paragraph to be indented to stand out, you can use BLOCKQUOTE
and /BLOCKQUOTE .</P>
<P>Mark URLs with A HREF and /A. Make sure the URL appears twice, once inside
quotes for the HREF and once as plain text, so the user can view and copy the
URL text if he/she wants to.</P>
<P>Other valid HTML tags include DL and /DL, DT and /DT, DD and /DD, TT and
/TT.</P>
<P>After you have finished formatting your FAQ entry in HTML, save it in a text
file. You should be able to view the file with a web browser and the formatting
should look correct (except that the headers will all be run together into one
paragraph). You might need to put an "HTML" tag at the very beginning of the
file to get the browser to format the text in HTML.</P>
<P>When the formatting looks good, submit your FAQ item to the LUGNET group
lugnet.faq. The message will be automatically processed by a LUGNET computer
program. The LUGNET program creates a FAQ answer database entry by starting
with the following text:</P>
<PRE>
<HTML Lang="%Content-Language%">
<Title>%Subject% - The Lugnet FAQ</Title>
<H1>%Subject%</H1>
%Answer%
</HTML>
</PRE>
<P>It then substituts the string <Code>%Answer%</Code> with all of your
HTML formatted content following the headers, and substitutes
<Code>%Content-Language%</Code> and <Code>%Subject%</Code> with the text you
put in the corresponding headers. For the FAQ answer submission to work, the
result should be a strict subset of valid HTML. </P>
|
|
Message has 2 Replies:
 | | 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)
| | | Re: [faq FAQ How do I format an entry in the Lugnet FAQ?]
|
| (...) Robert, I haven't looked closely yet at the rest of your post, but the above paragraph is only correct if it's in the future. :) That is, there's no program yet that goes and collects things from the group. It might not actually even end up (...) (25 years ago, 14-Jul-99, to lugnet.faq)
|
Message is in Reply To:
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
|
|
|
|
