Return-Path: 
 <dev-return-23466-apmail-forrest-dev-archive=forrest.apache.org@forrest.apache.org>
Delivered-To: apmail-forrest-dev-archive@www.apache.org
Received: (qmail 24555 invoked from network); 8 Apr 2006 23:59:30 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
  by minotaur.apache.org with SMTP; 8 Apr 2006 23:59:30 -0000
Received: (qmail 22643 invoked by uid 500); 8 Apr 2006 23:59:29 -0000
Delivered-To: apmail-forrest-dev-archive@forrest.apache.org
Received: (qmail 22599 invoked by uid 500); 8 Apr 2006 23:59:29 -0000
Mailing-List: contact dev-help@forrest.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:dev-help@forrest.apache.org>
list-unsubscribe: <mailto:dev-unsubscribe@forrest.apache.org>
List-Post: <mailto:dev@forrest.apache.org>
Reply-To: dev@forrest.apache.org
List-Id: <dev.forrest.apache.org>
Delivered-To: mailing list dev@forrest.apache.org
Received: (qmail 22588 invoked by uid 99); 8 Apr 2006 23:59:29 -0000
Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49)
    by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 08 Apr 2006 16:59:28 -0700
X-ASF-Spam-Status: No, hits=0.0 required=10.0
	tests=MSGID_FROM_MTA_HEADER,UNPARSEABLE_RELAY
X-Spam-Check-By: apache.org
Received-SPF: pass (asf.osuosl.org: local policy)
Received: from [203.121.192.7] (HELO mail.e-wire.net.au) (203.121.192.7)
    by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 08 Apr 2006 16:59:27 -0700
Received: from developer (mail.e-wire.net.au [127.0.0.1])
	by mail.e-wire.net.au (8.13.1/8.13.1) with ESMTP id k38NtkAs020048
	for <dev@forrest.apache.org>; Sun, 9 Apr 2006 07:55:46 +0800
Message-Id: <200604082355.k38NtkAs020048@mail.e-wire.net.au>
Received: from 203-121-204-130.e-wire.net.au [203.121.204.130] for
 mail.e-wire.net.au
	(EHLO developer) via SMTP; Sun, 09 Apr 2006 07:55:47 +0800
Reply-To: <brightoncomputers@brightontown.com.au>
From: "Gav...." <brightoncomputers@brightontown.com.au>
To: <dev@forrest.apache.org>
Subject: RE: Glossary
Date: Sun, 9 Apr 2006 07:58:50 +0800
MIME-Version: 1.0
Content-Type: text/plain;
	charset="us-ascii"
Content-Transfer-Encoding: 7bit
X-Mailer: Microsoft Office Outlook, Build 11.0.5510
Thread-Index: AcZbZa0Qpl1Oy6WGSY21jN+jmM8MHAAAW8Eg
X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.2180
In-Reply-To: <44384A53.9000702@apache.org>
X-BitDefender-SpamStamp: 1.1.4
 049000040111ABAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAQ
X-BitDefender-Spam: No (0)
X-Virus-Checked: Checked by ClamAV on apache.org
X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N



> -----Original Message-----
> From: Ross Gardler [mailto:rgardler@apache.org]
> Sent: Sunday, 9 April 2006 7:42 AM
> To: dev@forrest.apache.org
> Subject: Re: Glossary
> 
> Gav.... wrote:
> > I notice I can not add code examples to the Glossary, should I limit the
> > Glossary to descriptions only with links to code examples then?
> 
> In my opinion, a glossary is not intended to be any kind of tutorial or
> example. It should only give a concise definition and a link to more
> complete documentation.

I agree, I am still trying to create that line between description and
example though.

> 
> The problem with allowing too much detail in a glossary is that it then
> becomes "just another place" for documentation to go. The more places we
> have for documentation, the more fragmented that documentation becomes.
> 
> > It would have been nice to have even an inline or one line code snippet.
> 
> I am -0 on allowing code snippets in glossary entries. I would rather
> the effort went into ensuring the main docs were complete and linking to
> them from the glossary.
> 
> Others may disagree.

I do agree. I am looking through
http://marc.theaimsgroup.com/?l=forrest-dev&m=112596689428172&w=2#1 which is
the most upto date complete summary of what is the Dispatcher (still called
Views then).

Trying to describe hooks, the post says :-

forrest:hooks. forrest:hooks is a concept of defining format independent
hooks to structure the output. In xhtml this hooks a transformed into
<span/>s and <div/>s. For example:

"<forrest:hook name="testIdDiv"/>
*or*
<forrest:hook name="testIdDiv" type="div"/>
will be transformed into 
<div name="testIdDiv" />

The same is true for @class attribute for forrest:hooks.
<forrest:hook class="testClassDiv"/>
*or*
<forrest:hook class="testClassDiv" type="div"/>
will be transformed into 
<div class="testClassDiv" />

Another feature is that you can as well output span elements for
forrest:hooks instead of div elements.
<forrest:hook name="testId" type="span"/>
will be transformed into 
<span id="testId" />"

If we take out the example code, we are left with :-

"forrest:hooks. forrest:hooks is a concept of defining format independent
hooks to structure the output. In xhtml this hooks a transformed into
<span/>s and <div/>s.

The same is true for @class attribute for forrest:hooks.

Another feature is that you can as well output span elements for
forrest:hooks instead of div elements."

My summary would something like :-

"forrest:hooks - A hook is structural markup, it can be a <div> block or an
inline <span>."

Without example code, I can not really say too much more about it.

Are short Glossary Entries like this going to be good enough, with links to
further references and code examples?

Gav...

PS - CDATA does allow for code examples in the Glossary Document, so ignore
my original assumption.

> 
> Ross
> 
> 
> --
> No virus found in this incoming message.
> Checked by AVG Free Edition.
> Version: 7.1.385 / Virus Database: 268.4.0/304 - Release Date: 7/04/2006