Hello,
I just did a major checkin. This is needed for the builder documentation
generation, which is part of the Documentation Project. Here's a little
info about this.
There's a new target in the build.xml called 'documentation.builders'
(it's also called from the main documenation target 'documentation').
With this target documentation will be generated from all the builders
inside the mmbase-config dir. This documentation can be used by
templaters to see which fields can be used in templates,
editwizard-builders can use it, etc.
I've added 2 things to the builder.dtd, a parameter name to the
buildertag and a descriptions/description tag to the field tag. The
first one is needed because there was no buildername inside the
builder.dtd and xslt can't read the filename (which is the buildername).
The description tag can be used to describe each field.
In cvs I've added names to all builders, and descriptions (english and
dutch), but I only added real descriptions to the core builders, the
rest will follow (description is now 'TODO' :) ). Please review the
field-descriptions and change where necessary.
I also added a few files from the docbook stylesheets. These can be used
to create documenation in different languages
(config/default/xslt/common). At the moment only english and dutch are
implemented, but your welcome to create other implementations.
You can switch between different languages by setting the
documentation.builders.language parameter in your build.properties. If
you want to implement another language, you can add a languagecode.xml
to the common dir with all the keys and translations from en.xml and add
the languagecode to l10n.xml.
At the moment there's one known issue, if you try generating
documentation in a language for which not all builders contain
descriptions or names, the resulting docs will contain empty titles,
names, descriptions, etc. I'll fix this in the near future.
On the other hand if no file in <config/default/xslt/common> is
available in the language you've set, it will default to english.
Gerard
- Re: [Documentation] Builder-docs Gerard van Enk
- Re: [Documentation] Builder-docs Kees Jongenburger
- Re: [Documentation] Builder-docs Pierre van Rooden
- Re: [Documentation] Builder-docs Gerard van Enk
- Re: [Documentation] Builder-docs Gerard van Enk
