Re: FAQ formatting

---------

Jim Taylor (JHTaylor@videodiscovery.com)
Wed, 29 Jan 1997 13:34:24 -0800


[I was wondering why this list generates such huge volumes of
responses on seemingly minor topics. Then it dawned on me -- we're
FAQ writers. We love to pontificate!]

>>> Kent Landfield <kent@landfield.com> 01/29/97 12:49pm >>>

>And a pet peeve of mine... If they see a need to read offline, cryptic
>HTML commands in the ASCII version simply confuses the reader. Not
everyone
>knows what an HREF is. But since you said HTML master document, I
assume
>you are not planning on the raw HTML appearing in the text version.

I'm not sure what you mean by "cryptic HTML commands," but if you
mean URLS, I'm afraid I have to disagree.

I don't think an ASCII version of a FAQ should have hundreds of URLs
scattered all over it, but I do think that the most important ones should be
included (and should show up in the form <http://some.url.com>, since
the brackets allow smart systems [like Internet Config] to recognize and
parse the URL).

If someone is reading the FAQ offline, they still might want to see a few
URLs. And if someone is sitting in front of a browser with a printed copy,
they should be able to type in the URLs.

If you maintain the FAQ in HTML format and include the URLs in the form
<a href="http://some.url.com">&lt;http://some.url.com&gt;</a>, then you
kill three birds with one stone: the URL is clickable in the HTML version,
the URL is visible in a printed copy of the HTML version, and the URL is
included in the ASCII version (when links are stripped out).

______________________________________________
Jim "The Frog" Taylor, Director of Information Technology
<mailto:jhtaylor@videodiscovery.com>
Videodiscovery, Inc. - Multimedia Education for Science and Math
Seattle, WA, 206-285-5400 <http://www.videodiscovery.com/vdyweb>



[ 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