URL: Header

---------

Kent Landfield (kent@landfield.com)
Tue, 4 Feb 1997 15:25:59 -0600 (CST)


Hi all,

Time to change gears a bit. I've had the following questions asked a couple
times the last few days so I'm posting this in hopes it helps.

- What is the URL: header used for and why should I use it ?
- What is it's syntax ?
- What are you doing with the URL header on your archive ?

------------------------------

Subject: What is the URL: header used for and why should I use it ?

The URL: Auxiliary header is normally used if you have an HTML version
of your FAQ and would like to refer to it. However, there is no reason
to limit it solely to an HTML version of your FAQ. This header can be
used to point at the most recent copy of your FAQ whether you have it
as a web page, an ftpable text file or some other format.

The major benefit of using the Auxiliary URL: header is that it alerts
the reader to the existence of the document's homepage or the location
of the most current copy very early in the FAQ. So if people are reading
an ASCII copy, reading the FAQ off-line from a CDROM or a paper copy,
they will immediately know where to get the most current copy.

A secondary benefit is that some archive sites use (or will use) the
information you specify in the URL: header to provide their readers
with more direct access to your most current information.

------------------------------

Subject: URL Auxiliary Header syntax:

Simply insert your URL: header in the "Auxiliary Headers" section of
your FAQ. This is the same section of your document where the
Archive-name: header appears.

The following examples are all valid formats. The URL: header can
contain any valid URL reference.

URL: http://www.some.where/your-faq-home-page
URL: ftp://ftp.some.where/your-faq-home-page.txt

URL: <http://www.some.where/your-faq-home-page>
URL: <URL:http://www.some.where/your-faq-home-page>

While the last two examples are valid, the additional characters are
really unnecessary since they add little to the understanding and
usage of the URL: header.

------------------------------

Subject: What are you doing with the URL header on your archive ?

The URL header is used in two different ways on the
http://www.landfield.com/faqs/ archive.

First, the reference in the actual FAQ is linked so the reader
can simply click on it while they are accessing your FAQ here
and get to your FAQ's homepage.

Second, the information in the URL Auxiliary header is used when
index files are generated on the archive. If you specify the URL
for your document's homepage in an Auxiliary URL: header it will be
included automatically and available from within the index files.
This way the reader knows they can always go to the most current copy.

------------------------------

Subject: How many FAQs are using the URL: header today ?

Of the 3120+ FAQs in the Hypertext archive today, 816 of them are
using the URL header.

-------------------------------

FWIW...

---
Kent Landfield                        Phone: 1-817-545-2502             
The Landfield Group                   FAX:   1-817-545-7650             
Email: kent@landfield.com             http://www.landfield.com/
Please send comp.sources.misc related mail to kent@uunet.uu.net.


[ 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