Return-Path: 
 <dev-return-23438-apmail-forrest-dev-archive=forrest.apache.org@forrest.apache.org>
Delivered-To: apmail-forrest-dev-archive@www.apache.org
Received: (qmail 66248 invoked from network); 6 Apr 2006 23:31:05 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
  by minotaur.apache.org with SMTP; 6 Apr 2006 23:31:05 -0000
Received: (qmail 53857 invoked by uid 500); 6 Apr 2006 23:31:04 -0000
Delivered-To: apmail-forrest-dev-archive@forrest.apache.org
Received: (qmail 53797 invoked by uid 500); 6 Apr 2006 23:31:03 -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 53783 invoked by uid 99); 6 Apr 2006 23:31:03 -0000
Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49)
    by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 06 Apr 2006 16:31:03 -0700
X-ASF-Spam-Status: No, hits=0.0 required=10.0
	tests=
X-Spam-Check-By: apache.org
Received-SPF: neutral (asf.osuosl.org: local policy)
Received: from [212.23.3.140] (HELO pythagoras.zen.co.uk) (212.23.3.140)
    by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 06 Apr 2006 16:31:02 -0700
Received: from [82.69.78.226] (helo=[192.168.0.2])
	by pythagoras.zen.co.uk with esmtp (Exim 4.30)
	id 1FRdw0-0006sT-Sk
	for dev@forrest.apache.org; Thu, 06 Apr 2006 23:30:40 +0000
Message-ID: <4435A4A0.9030402@apache.org>
Date: Fri, 07 Apr 2006 00:30:40 +0100
From: Ross Gardler <rgardler@apache.org>
User-Agent: Mozilla Thunderbird 1.0 (Windows/20041206)
X-Accept-Language: en-us, en
MIME-Version: 1.0
To: Forrest Developers List <dev@forrest.apache.org>
Subject: Re: svn commit: r392105 -
 /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.glossary/src/documentation/content/xdocs/glossary.xml
References: <20060406224753.47627.qmail@minotaur.apache.org>
In-Reply-To: <20060406224753.47627.qmail@minotaur.apache.org>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
X-Originating-Pythagoras-IP: [82.69.78.226]
X-Virus-Checked: Checked by ClamAV on apache.org
X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N

crossley@apache.org wrote:
> Author: crossley
> Date: Thu Apr  6 15:47:46 2006
> New Revision: 392105
> 
> URL: http://svn.apache.org/viewcvs?rev=392105&view=rev
> Log:
> Remove examples of acronym and definition/@cite until we know how to use them.

See inline...

> Modified: forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.glossary/src/documentation/content/xdocs/glossary.xml
> URL: http://svn.apache.org/viewcvs/forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.glossary/src/documentation/content/xdocs/glossary.xml?rev=392105&r1=392104&r2=392105&view=diff
> ==============================================================================
> --- forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.glossary/src/documentation/content/xdocs/glossary.xml (original)
> +++ forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.glossary/src/documentation/content/xdocs/glossary.xml Thu Apr  6 15:47:46 2006
> @@ -23,10 +23,11 @@
>      <title>C</title>
>      <item id="CSS">
>        <term>Cascading Style Sheets</term>
> -      <acronym>CSS</acronym>
> -      <definition cite="http://www.w3.org/Style/CSS/">Cascading Style Sheets (CSS)
> +      <definition>Cascading Style Sheets (CSS)
>        is a simple mechanism for adding style (e.g. fonts, colors, spacing) to Web
> -      documents.</definition>

Cite is used to link to an original source for the definition. Each 
glossary term can have multiple definitions, some of which may not be 
our copyright, therefore we need to cite the source.

> +      documents.
> +      Source: <a href="http://www.w3.org/Style/CSS/">W3C</a>.

Putting it in the @cite attribute allows us to do this processing in 
XSLT. We can do clever stuff like "only show defininitions from the w3c".

>      <item id="SVG">
>        <term>Scalable Vector Graphics</term>
> -      <acronym>SVG</acronym>
> -      <definition cite="http://www.w3.org/Graphics/SVG/">SVG is a language for describing
> +      <definition>Scalable Vector Graphics (SVG) is a language for describing
>        two-dimensional graphics and graphical applications in XML.
> +      Source: <a href="http://www.w3.org/Graphics/SVG/">W3C</a>.
>        </definition>

Again, putting the accronym in an attribute allows us to do powerful 
stuff like search for the term associated with this accronym. Why is 
this not an attribute? Because some terms have multiple accronyms

For complete examples, see the glossary.xml file I originally attached 
to the issue. This document is rendered at [1]. You can see that the 
@cite is rendered by the XSLT in almost the same way you have hard coded 
above. The accronyms are also rendered in a similar way to what you ahve 
above, for example "Data Definition Language (DDL)".

Ross

[1] http://www.gardler.org/teaching/glossary.html