DocBook import for Confluence

Overview

"DocBook import for Confluence" is plugin for Atlassian Confluence allowing user to import DocBook xml formatted documentation into Confluence Space. It was originally created to import existing DocBook documentation for JBoss open source projects into newly introduced JBoss Community Project Documentation Editor, but we decided to give it to other users free of charge too.

 

See our motivation video.

 

Plugin was designed and tested to import DocBook 4 declared by DOCTYPE style in imported xml file originally. DocBook 5 declared by xml namespace works from version 1.1.0. DocBook compatibility:

Plugin version
DocBook 4
DocBook 5
1.0.2cross-small.pngno_entry-small.png
1.1.0+cross-small.pngcross-small.png

 

In case of problems you may use comments under this article or forum available in this Space, but plugin is not oficially supported.

 

Installation

Plugin is available on Atlassian plugin exchange, so you can install/update plugin directly from Confluence administration's "Plugin" page. Alternativelly you can download it from this page attachments and upload it into your Confluence instance manually.

 

Use

User needs "Space - Export" permission for given Confluence Space to use this plugin.

To import documentation select 'JBoss DocBook Importer' item from the 'Tools' menu (visible only for users with given permission).

All necessary notes/help to use this plugin are available directly on import page, and you may also look here https://docs.jboss.org/author/display/AUTHGUIDE/How+to+import+DocBook+XML.

 

Changelog

1.1.1
- improved handling of EOL - all EOL removed inside text parts
- less escape characters in imported wiki markup

1.1.0
- added support for DocBook 5 declared using xml namespace
- patched images import if one page used same image more times
- added validation for page title existence

1.0.2
- first release with DocBook 4 support

 

Source codes

Source code for this plugin is available under LGPL v.2.1 license in GIT repository https://github.com/jbossorg/docbook-import-for-confluence