David Crossley wrote:
Gav.... wrote:
Ok, I have started this, created the basic Glossary output plugin,
Now need to configure it.
Great stuff. Thanks Gavin. One thing to bear in mind is that this code
was written against 0.5 of Forrest. There was no plugin infrastructure,
no locationmap, no XML config system, not dispatcher etc. etc.
We can improve on this plugin a great deal. But lets go one step at a time.
David has already addressed many of your questions. I'll just add what I
can.
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?
No this doesn't happen in the plugin
(apart from a simple example). The real data files
go in whatever project that the user creates.
For example the forrest project will use it
in site-author/content/xdocs/**
I expect that is better to allow separate glossary
data files. They can be any filename because the input.xmap
should respond on the Content Aware Pipeline, i.e. the
source-type action responding on the document type declaration
or namespace.
>
The listLocations plugins uses a horrid workaround
to match on the filename. It needs to be fixed to
use the publicIdentifier in the XML instance document.
If I remember correctly the glossary code already uses the sourcetype
action to decide ow to process the file. This means there is not need to
add any code to create individual files for A, B, C etc. Just create the
file "glossary-a.xml", "glossary-b.xml" etc. Link to them as normal and
it will work.
I am doing this in Whiteboard at the moment, is this ok?
Yes, it should be in whiteboard until:
a) it works fully
b) it is documented
c) it has community support
I am not creating samples, I could rename Ross's original Glossary.xml to
something else and use that as a sample ?
Use lowercase filenames.
No, that datafile is Ross' example. I reckon
create a really trivial example data file.
It's OK, at least in the short term, to use the example I have provided.
There are a few definitions from external sources, but the plugin gives
an appropriate credit in all cases.
Say four entries, using very obvious terms, e.g.
HTML = HyperText Markup Language
CSS = Cascading Style Sheets
ASF = Apache Software Foundation
... perhaps use one of those with an example
link to another site.
Ultimately we will want to build a Forrest specific Glossary. So if you
get the time to do this then cool!
Ross
