Search the FAQ Archives

3 - A - B - C - D - E - F - G - H - I - J - K - L - M
N - O - P - Q - R - S - T - U - V - W - X - Y - Z
faqs.org - Internet FAQ Archives

FAQs: A Suggested Minimal Digest Format
Section - 6. What are External Meta References, and What is Their Format?

( Single Page )
[ Usenet FAQs | Web FAQs | Documents | RFC Index | Houses ]


Top Document: FAQs: A Suggested Minimal Digest Format
Previous Document: 5. What is the Table of Contents Format?
Next Document: 7. Where Do I need to Look for Other Information?

Many of the more sophisticated viewers can "jump" from one FAQ to the
next, retrieve data via FTP, or send email simply by "pointing at"
properly formatted "tags" in your FAQ.  This FAQ recommends "URL"
("Universal Resource Locator") format tags.  See Section 7 for a
reference.

If your FAQ refers to a FTP-able file, use this format:

	ftp://<inet>/<str>/<str>

Where "<inet>" is the Internet domain name of the server, and the rest
of the "<str>/<str>" is the file name.  If you want to refer to a directory,
leave a trailing "/".

This string can be anywhere in the document, inline with text or whatever.

Similarly, for html (hypertext markup language)-compatible documents,
use http://<inet>/<str>/<str>

For clarity, it's best to surround the URL with angle brackets to make
it easier to parse.  This FAQ uses this convention, ie:

   <ftp://ftp.uunet.ca/distrib/chris_lewis/hp2pbm/>

One difficulty with URLs is that they're often quite long.  Do not
break them in the middle, or they won't work.  It is suggested that
if the URL is too long to fit, start a new line with the URL.  Even
if it does look rather ugly, it's better than not working, or wrapping
beyond the 80th column.



Top Document: FAQs: A Suggested Minimal Digest Format
Previous Document: 5. What is the Table of Contents Format?
Next Document: 7. Where Do I need to Look for Other Information?

Single Page

[ Usenet FAQs | Web FAQs | Documents | RFC Index ]

Send corrections/additions to the FAQ Maintainer:
digfaq@ferret.ocunix.on.ca (Digest FAQ commentary reception)





Last Update March 27 2014 @ 02:11 PM