maven-doxia-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Lars Trieloff (JIRA)" <>
Subject [jira] Commented: (DOXIA-24) [PATCH] better docbook support through the use of docbook xsl stylesheets
Date Tue, 07 Feb 2006 21:32:47 GMT
    [ ] 

Lars Trieloff commented on DOXIA-24:

Hi Jason, Jose,

from an architectural point of view, i think powerful DocBook support should be a feature
of Doxia as a documentation framework. So I would like to take Jose's code which more full-featured
than mine and create a Doxia module that supports DocBook generation with OLink databases
and so on.

What do you think?

> [PATCH] better docbook support through the use of docbook xsl stylesheets
> -------------------------------------------------------------------------
>          Key: DOXIA-24
>          URL:
>      Project: doxia
>         Type: Improvement

>     Reporter: Lars Trieloff
>  Attachments: docbook-xsl-support.patch
> The current state of DocBook support in Doxia is still unsatisfactory. It is now able
to handle the most important elements, but there is still an important problem left out: handling
of xref-links. This type of links points to another docbook element and is expected to be
replaced with a text describing the element by the processing system. For example an xref
pointing to a chapter would be replaced with the text "Chapter N: 'Title of Chapter N'". Implementing
this functionality using the XML Pull Parser currently used in Doxia is a massive effort because
it leads to duplicating a lot of functionality already available in the DocBook XSL Stylesheets,
the standard solution for processing DocBook XML and involves caching of more or less the
whole DocBook document.
> My proposed solution is simple, elegant, but quite heavyweight: I use the DocBook XSL
Stylesheets (which will be bundled with the doxia.jar) and transform the DocBook input document
into a temporary XHTML document. The stylesheets are driven by a customization layer that
turns off any unnecessary features like autogenerated tables of contents and navigation graphics.
> The temporary XHTML document is processed by the Doxia's XhtmlParser into a DoxiaModel.
The DocBook XSL stylesheets and the XhtmlParser take care of maintaining the section nesting
of the document, so that no important information will be lost.
> If the DocBook DTD changes, no Java programming is neccessary, all you need to do is
updating the enclosed DocBook XSL stylesheets. The system is able to handle all of the DocBook
elements and offers all advanced features of the DocBook XSL stylesheets like autogenerated
texts and so on.
> There is only one major drawback: Parsing the DocBook stylesheets takes an huge amount
of memory, but it is still possible to run maven with the default java heap space.

This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators:
For more information on JIRA, see:

View raw message