[doxia-dev] [jira] Commented: (DOXIA-24) [PATCH] better docbook support through the use of docbook xsl stylesheets

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[doxia-dev] [jira] Commented: (DOXIA-24) [PATCH] better docbook support through the use of docbook xsl stylesheets

JIRA jira@codehaus.org
    [ http://jira.codehaus.org/browse/DOXIA-24?page=comments#action_49554 ]

Lars Trieloff commented on DOXIA-24:
------------------------------------

It is an BSD-like license. From the COPYING notice included in the patch:

Copyright
---------

Copyright (C) 1999, 2000, 2001, 2002 Norman Walsh

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the ``Software''), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

Except as contained in this notice, the names of individuals
credited with contribution to this software shall not be used in
advertising or otherwise to promote the sale, use or other
dealings in this Software without prior written authorization
from the individuals in question.

Any stylesheet derived from this Software that is publically
distributed will be identified with a different name and the
version strings in any derived Software will be changed so that
no possibility of confusion between the derived package and this
Software will exist.

Warranty
--------

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT.  IN NO EVENT SHALL NORMAN WALSH OR ANY OTHER
CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Contacting the Author
---------------------

These stylesheets are maintained by Norman Walsh, <[hidden email]>.

> [PATCH] better docbook support through the use of docbook xsl stylesheets
> -------------------------------------------------------------------------
>
>          Key: DOXIA-24
>          URL: http://jira.codehaus.org/browse/DOXIA-24
>      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:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira