forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Crossley <cross...@apache.org>
Subject Re: svn commit: r392105 - /forrest/trunk/whiteboard/plugins/org.apache.forrest.plugin.input.glossary/src/documentation/content/xdocs/glossary.xml
Date Fri, 07 Apr 2006 02:30:02 GMT
Ross Gardler 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.

Yes definitely. That is why i was careful to add this
workaround.

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

That was my workaround because i could not get the @cite
to work. The generated html had links that went nowhere.

Now that i look more carefully at your example site,
i understand more. It seems that it is somehow magically
linked to a citations document. Great, however we don't
yet have the Citations plugin at Forrest. FOR-756

Also i was getting xml validation errors, e.g.
"An element with the identifier "W3C-CSS" must appear in the document."
Same with your example document below.

> 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)".

Hmm, i have the acronym stuff working now.
Don't know what the problem was.

-David

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

Mime
View raw message