Skip to content

jbossorg/docbook-import-for-confluence

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is plugin used to import DocBook xml into Atlassian Confluence.

For more info and user discussion look this WiKi page.

For changes look changelog.txt file.

License

GNU Lesser General Public License Version 2.1 http://www.gnu.org/licenses/lgpl-2.1-standalone.html

How to install/update

  • Simply use Confluence Add-ons manager to install or update plugin from Atlassian marketplace.
  • Make sure your confluence's Maximal attachment size is configured to enough value for imported zip file
  • Make sure your confluence's http response timeout is enough not to break response when Import button is hit (as it is sync now)

How to use

To import content from DocBook XML into a space, a user must have the 'Space - Export' permission within the space.

  1. Place your DocBook XML files into a zip file. The DocBook XML file containing the root element must be in the top-level directory, not in a sub-directory. The zip file must also contain all relatively referenced resources (e.g. XIncluded XML files, images and entity files) in the correct relative paths as the import process is XInclude aware.
  2. Go to the main page of the Space you want to import content into. You can also go to other page, imported pages are then stored as subpages of this page.
  3. Select Import DocBook from the Tools menu
  4. Use form on this page, follow instructions on this page.

How to develop this plugin

Build is based on Maven 2 build tool, so build is simple. Repository contains files for Eclipse IDE too so it's simple to import it as existing project into Eclipse.

Heart of plugin are XSLT files used to transform part of DocBook xml intended for one page into Confluence WIKI syntax:

  • /src/main/resources/org/jboss/confluence/plugin/docbook_tools/docbookimport/prepareChapterWIKIContent_4_3.xslt
  • /src/main/resources/org/jboss/confluence/plugin/docbook_tools/docbookimport/prepareChapterWIKIContent_5_0.xslt So update these file if you want to change mapping of DocBook xml structures into WIKI syntax.