I've moved it to it's own separate module because spring and hibernate
do it that way and it seems cleaner.
So now it's under
/spring-richclient-manual/src/docbook/en
You can build the module spring-richclient-manual with a "mvn clean
install".
There are 3 docbook plugins: mojo's (=sucks), jboss's (= I 've used that
one) and agilejava (= used by spring-osgi).
I haven't tested agilejava's one yet, nor have I used a decent style on
the jboss's one yet, but at least I get some html output :)
Here's the current manual (with exception handling section):
http://users.telenet.be/geoffrey/tmp/spring-richclient/manual/html_single/
I don't have much more time to put into this (as I am gonna put more
time into drools-solver...), but if anyone else wants to continue this
work, there are 2 things I would like to suggest:
- try out the agilejava docbook plugin with the Spring style
- get it to publish on the website ("mvn site-deploy")
This should be pretty trivial, as spring-osgi already does both already:
http://springframework.svn.sourceforge.net/viewvc/springframework/spring-osgi/trunk/docs/pom.xml?view=markup
http://code.google.com/p/docbkx-tools/
Have fun :)
With kind regards,
Geoffrey De Smet
Geoffrey De Smet wrote:
> I've started a reference manual in the docbook format.
> Docbook is the format used by reference manuals of spring, spring-osgi,
> hibernate, seam, drools, ...
>
> It's located under
> /src/docbook/en
> There is currently 1 section (= chapter or subchapter or subsubchapter):
> exception handling.
>
> You can easily copy-paste that file to start a new section.
> To edit a section, I can recommend the WYSI almost WYG editor XML mind
> (the personal edition is free for non-commercial use).
> http://www.xmlmind.com/xmleditor/download.shtml
>
> Learn to use of:
> - the shortcut control-j (add a new element after the current
> - these elements:
> -- para
> -- literal inside a para (= java code inside a para)
> -- emphasis and emphasis-bold
> -- section (sections can be nested)
> -- programlisting (= to show java code or xml)
> -- mediaobject (= to show images)
> - using the top right buttons to select an entire element (such as
> section etc)
>
> Put the images in the same directory as the docbook file.
> When in doubt, take a look at how the spring reference manual is written.
>
> Feed-back, questions, improvements, etc welcome.
> I am still working on using the docbook plugins to output pdf,
> single_html and html.
>
|
