[ic] Pee-Poor Documentation Rant

Jim Balcom interchange-users@interchange.redhat.com
Mon Jan 14 21:03:00 2002


On Mon, 14 Jan 2002, Kevin Walsh wrote:

KW>>> Same as [file name] except interpolates for all interchange tags and
KW>>> variables. Does NOT do locale translations.
KW>>>
KW>>> Does anyone know what this said????
KW>>>
KW>>It says that it does the same job as the [file] tag, except it does
KW>>more and interpolates any Interchange tags that it finds in the
KW>>file.  It should also act as a prompt for you to find the [file] tag
KW>>documentation.

Bzzzzttt!!! All that you did was shift the words around like the trained
apes did. It's gibberish! Why can't it be in plain English? I've got
insurance policies that are easier to comprehend !

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

I believe that I referenced the [file] tag documentation and what I found.

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

Yes, I found that, and it was somewhat helpful, but it still did not tell me
how to use it.

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

Thanks for playing. I'll find you a consolation prize. That's not the way
that it seems to want to get called.

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

I'm glad to have supplied you with some humor and made you feel good.

-= Jim =-

----------------------------------------------------------------
Jim's Linux-Operated Underground Bomb Shelter

Tagline for Monday, January 14, 2002 at 21:00 PM:
I would jog, but the ice would fall out of my glass.

----------------------------------------------------------------
This Linux System has been up 335 hours

My web page: http://www.idk-enterprises.com
----------------------------------------------------------------