FAQ Maintainers Mailing List
Re: [faq-maintainers] URL: Header

---------

From: Kent Landfield (kent@faqs.org)
Date: Thu Jan 24 2002 - 11:26:02 CST


Ok, I took a shot at summarizing up what was discussed yesterday and
put it into the format used in the guidelines faq.

If this looks reasonable then it should be a simple cut and paste. If
not, discussion time...

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

        c. URL (OPTIONAL) (RECOMMENDED)
        -------------------------------

        Example:

URL: http://some-site.domain/my_faq.html

        A "URL:" line contains a World Wide Web "address," if you have
        one for your FAQ. (See Section 2.7B for information about HTML
        versions, including some automatically created ones.)

        The URL: header is used to specify a home page for your faq.
        The URL address could be to page on a site you have direct
        access to or it could be to your page on a faq archive such
        as faqs.org. The URL address you list should be a complete
        path to the individual home page for your faq. It should not
        be used to point to a generic home page for a site. For example,

             http://www.somesite.domain/~bob/thefaq.html

        is a good addres to an faq, while

             http://www.somesite.domain
        
        would not be unless the site was dedicated to the faq itself.
 
        It may be useful to list more than one address location for your
        faq. Multiple sites provide redundancy. Additionally, you may
        want to specify multiple ways to access your faq, http, ftp, etc.
        Whatever the reason, it is possible to have multiple URL addresses
        specified. There are two different ways to use the URL: header
        to list multiple locations. You can use multiple URL: headers
        each with a single address or a single URL: header with the
        individual addresses separated by commas.

        An example of multiple URL headers:

URL: http://www.dclj.de
URL: http://de.geocities.com/uweplonus/faq
URL: ftp://rtfm.mit.edu/pub/de/comp-lang-java/faq

        Note: There is a single address listed in each URL: header.

        An example of an individual URL headers with comma separated
        addresses:

URL: http://www.dclj.de, http://de.geocities.com/uweplonus/faq, ftp://rtfm.mit.edu/pub/de/comp-lang-java/faq

       Note: The comma separated addresses must be specified on a
       single line. Continuation lines are not supported at present.

        D. Last-modified, Version, Copyright, Maintainer (all OPTIONAL)
        ----------------------------------------------------------

Last-modified: March 25, 1995
Version: 2.5
Copyright: (c) 1995-1996 Joe Programmer
Maintainer: Joe Programmer <guru@foosys.com> and Cathy Code <code@foosys.com>

        You can have other lines in the auxiliary header, if you
        want. Some common ones are "Last-modified:", "Version:", and
        "Copyright:", which should be self-explanatory. The
        required "From:" header in the main headers (see Section
        1.4A) will usually give the name and email address of the
        maintainer, but if you want to provide more information, or if
        your FAQ is being posted by someone else (see Section 2.8A),
        you may wish to add a "Maintainer:" header.

        Our archive scripts and other software "know" about these
        particular auxiliary headers, and may attempt to handle them
        in special ways. Although it's not specifically required, it
        would be best if you stuck to these exact header names for
        information which fits these categories, rather than using
        arbitary variations on the themes. However, if you have other
        types of information to include, you can create new auxiliary
        headers as you see fit.

        You may put any text you want in these and other unrequired
        headers, in any format you like, as long as the name of the
        header doesn't have any whitespace; use hyphens instead (i.e.,
        "Last-modified: " instead of "Last modified: ").

-- 
Kent Landfield                        Phone: 1-817-545-2502
Email: kent@landfield.com             http://www.landfield.com/
Search the Usenet FAQ Archive at http://www.faqs.org/faqs/
Search the RFC/FYI/STD/BCP Archive at http://www.faqs.org/rfcs/

************************************************************* To unsubscribe send a message to majordomo@faqs.org as

unsubscribe faq-maintainers fill-in-your-email-address-here *************************************************************



[ FAQ Archive | Search FAQ Mail Archive | Authors | Usenet References ]
[ 1993 | 1994 | 1995 | 1996 | 1997 | 1998 | 1999 | 2000
]

---------

faq-admin@faqs.org

© Copyright The Internet FAQ Consortium, 1997-2000
All rights reserved