[ic] Pee-Poor Documentation Rant

[Kevin Walsh]

> I wanted to set up a Quote Of The Day (QOTD) on my main page using a file
> that cron generates from 'fortune'.
>
> ...
>
> I checked section 2.39 of the 'Interchange Tags Reference'
>
> ...
>
> 2.39.2 Description
>
> Same as [file name] except interpolates for all interchange tags and
> variables. Does NOT do locale translations.
>
> Does anyone know what this said????
>
It says that it does the same job as the [file] tag, except it does
more and interpolates any Interchange tags that it finds in the
file.  It should also act as a prompt for you to find the [file] tag
documentation.

>
> I can tell you, that after some experimentation I found that I can use the
> phrase: [include file="pages/qotd"]
>
> and the contents of that file are displayed on my web page.
>
If, after reading the docs you posted above, you had read the [file]
tag documentation, you would have probably found this:

    Description

    Inserts the contents of the named file. The file should normally be
    relative to the catalog directory -- file names beginning with / or
    .. are not allowed if the Interchange server administrator has set
    NoAbsolute to Yes.

So [file name="pages/qotd"], or [file pages/qotd], would be more
efficient for files that don't contain Interchange tags.  Your usage
of the [include] will do, of course.  I would have chosen to put the
qotd file in "tmp" rather than in "pages", but that's just me.

There was a certain irony in you posting a docs rant that I just
couldn't help laugh at.

-- 
   _/   _/  _/_/_/_/  _/    _/  _/_/_/  _/    _/
  _/_/_/   _/_/      _/    _/    _/    _/_/  _/   K e v i n   W a l s h
 _/ _/    _/          _/ _/     _/    _/  _/_/    kevin@cursor.biz
_/   _/  _/_/_/_/      _/    _/_/_/  _/    _/