forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gav...." <brightoncomput...@brightontown.com.au>
Subject Glossary Plugin FOR-755 - was RE: [jira] Updated: (FOR-639) define terminology for the various aspects of Dispatcher
Date Sat, 01 Apr 2006 11:34:03 GMT
Hi All,

> -----Original Message-----
> From: David Crossley [mailto:crossley@apache.org]
> Sent: Saturday, 1 April 2006 6:42 AM
> To: dev@forrest.apache.org; brightoncomputers@brightontown.com.au
> Subject: Re: [jira] Updated: (FOR-639) define terminology for the various
> aspects of Dispatcher
> 
> Gav.... wrote:
> > Ok, Paul has also mentioned this so needs sorting, I'll see what I can
> come
> > up with in the next day or two.
> >
> > What we have so far it terms of Dispatcher Docs published:-
> >
> > dispatcher.html
> > howto-structurer-install.html
> > howto-dispatcher-quickstart.html
> > howto-structurer-dsl.html
> > howto-structurer-contracts.html
> >
> > The howto-structurer-install.html is actually describing how to
> > Install the "Dispatcher" so I think should be renamed to avoid
> > Further confusion.
> 
> Yes, i have wondered about that too.
> Today i will 'svn move' the documents,
> amend all the links and references, and
> create .htaccess redirects for the website.
> 
> > The howto-structurer-dsl is out of date and contains incorrect
> > Contract examples. Is there an upto date version of this or
> > Shall I attempt to correct the examples given.
> > 	Also, I would like an example of what is meant by
> > "Domain Specific" in this context  (of -dsl)
> >
> > This FOR is about clarifying and defining terminology used. So do we
> > Want a new page called dispatcher-terminology.html or similar and how
> > Do we want the content presented - in example form, or in a strict
> > Dictionary type arrangement leaving the examples on the howto pages?
> 
> There was a mailing list discussion about this.
> Need to find that.
> 
> One really good idea was to create the new Glossary plugin
> http://issues.apache.org/jira/browse/FOR-755
> and use that.

Ok, I have started this, created the basic Glossary output plugin,
Now need to configure it.

I have questions (never done a plugin before so bear with me) :-

I'm referring to the attachments provided on FOR-755 here -

1. Does glossary.xmap get renamed to and therefore replace output.xmap ?
2.Where do the .dtd and .mod files need to go?
3a. I have put glossary2document.xsl in resources/stylesheets, is this
correct?
3b. And will I need to rename it to glossary-to-document.xsl ? 
3c. If yes to 3b, anything else to change?
4. Glossary.xml is placed in the xdocs directory, this is the main file we
Need to add our Terminology. Looking quickly, its an A-Z arrangement, can we
and should we have a separate A-Z for Dispatcher Terminology, therefore a
separate dispatcher-glossary.xml file, or will ALL Forrest terminology
reside in the same Glossary.xml file?

I am doing this in Whiteboard at the moment, is this ok?
I am not creating samples, I could rename Ross's original Glossary.xml to
something else and use that as a sample ?

Anything else?

Lots of 'Q''s in there, sorry.

1 hour later ...

Ant Test - Build Failed die to could not validate Glossary.xml, I guess
that's because the .dtd and .mod files are in the wrong place.

Gav...

> 
> Failing that, i reckon just use an ordinary document
> with concise definitions that link to examples in
> the other documents.

I have started this also, in fact started in when your idea of
Using the Glossary Plugin came through. Hmm, I wonder which I'll
Finish first :)

> 
> However it gets done is good.
> 
> -David

On it,

Gav...




Mime
View raw message