Top Categories · Home» » docbkx-maven-plugin. Docbkx Maven Plugin. A Maven plugin for generating HTML from DocBook. documentation you’re trying to generate as it exists in the . We have a bit more complex usage since we use the maven filtering plugin to. xalan xalan docbkx-maven-plugin ${project. version} site generate-html pre-site k docbook-xml runtime ant ant -trax.

Author: Fenrigor Yolkree
Country: Nigeria
Language: English (Spanish)
Genre: Technology
Published (Last): 3 February 2010
Pages: 202
PDF File Size: 17.89 Mb
ePub File Size: 15.26 Mb
ISBN: 620-4-64052-359-9
Downloads: 90070
Price: Free* [*Free Regsitration Required]
Uploader: JoJokazahn

The JavaHelp format combined with its java based framework will allow you to create professional online help systems from your documentations.

So, would it not be awesome if we could refer to the Maven version number from within our DocBook source document?

We have a generatee more complex usage since we use the maven filtering plugin to avoid having to mess with entities and the like. The DocBook plugin at mojo. You still need to add your own msven sense to figure out which output formats make sense with your documents. As no goal is specified nor attached to a phase, you must specify it on the command line like ‘docbkx: The above config runs the plugin in pre-site phase, and will automatically be called when you run mvn site.

Hopefully all of the above ggenerate make you consider using DocBook. The plugin will continue to use target file name, but reserve it for the first chunk of HTML. Leave a Reply Cancel.

The result looks like:. You can use the following command to manually run the plugin for purpose of testing: I think that issue should be clearly kaven with the docbkx-maven-plugin Maven plugin, because in the end it is an incompatability between versions 2.


By using this import: A Maven plugin for generating xhtml5 output from DocBook documents, using version 1. The plugins packaged contain the stylesheets as well.

Maven Docbook for beginners | Vineet Manohar’s blog

The DocBook plugin found at mojo. You will probably find the includes property among the ones you will use most often. Maintaining the dependency by hand would be a lot of work, and there would be severe chance that it would go out whack in no-time.

You should not be required to install additional stuff to your hard disk in order to generate content from your DocBook sources. You are encouraged to work through these examples in the given order.

The only thing that you need to do is add a font tag containing all relevant metadata. The highlightXslthlConfig attribute can be used to configure xslthl to add new highlighters, That is, we must use a namespace in our custom stylesheet to be able to select any docbook element!


There is no target directory created and I do not see any meaningful output on the command line. At least, nothing that pointed me not being a DocBook expert into this direction This sample shows fenerate to skip the plugin execution in an easy way. We are actually quite happy with this approach, especially because we are able to automatically publish the docs in a number of formats, including HTML and PDF.


The maven docbook plugin converts your docbook xml file to user friendly documentation genearte HTML. A Maven plugin for generating fo output from DocBook documents, using version 1.

Docbkx Tools

In this docbmx, we will discuss every feature with an example, showing the relevant configuration code. It does however demonstrate how you could include your own scripts to be executed right before or right after the DocBook to output format transformation. It’s important to understand that we are using the advanced customizing capabilities of DocBook, i.

Post Your Answer Discard By clicking “Post Your Answer”, you acknowledge that you have read our updated terms of serviceprivacy policy and cookie policyand that your continued use of the website is subject generats these policies. The good news is that there is a lot!

In order to use it, add a language attribute to the DocBook element containing your sources, and set it to the language of the sources within that element.

Java, Eclipse, Maven, other tools and me. We are using DocBook for writing technical documentation for all our projects and in-house frameworks. In that case you can simply link this stylesheet to all HTML pages generated by addding the htmlStylesheet property, like shown below.