DocBook vs Apache Forrest
I've spent the last few hours looking at DocBook, and Apache Forrest two XML documentation frameworks. Basically what these two frameworks let you accomplish is seperate your documentation content from your documentation layout, and display format. So you write all your documentation using one XML schema, then apply stylesheets to generate XHTML, PDF, RTF documentation.
We are currently trying to decide which format to use for our Java 1.5 based email server project. So far we are leaning towards DocBook because it seams more mature, and there are more tools for it, but Forrest seams to have a smaller learning curve.
I think Forrest's XML dialect covers 80 percent of the cases, with a much smaller learning curve, but for a large project that also needs to produce print documentation, DocBook merits consideration. The Server Side
DocBook as I mentioned does have lots of tools, though I didn't find any that I tried to be terribly great:
- Conglomerate - this tool looks promising but only works on Unix
- DocBook Template for OpenOffice - Had some trouble using this one creating sections, doesn't support all DocBook features.
- Vex - Vex is an Eclipse plugin that looked promising but I found it kind of hard to use.
- Big list of docbook tools
So we will probably just end up coding the XML by hand which is not that big of a deal, but It would be nice to have a visual tool for this.
One other advantage to DocBook is that there are some books written on the subject:
Anyone out there using either of these documentation frameworks? Experiences, or good tools I missed? Any other good documentation frameworks?
- Upcoming CFML Conferences in April 2017
- CFSummit 2016 Slides
- Securing Legacy CFML - dev.Objective() 2016 Slides
- My CFSummit 2015 Slide Decks
- Adding Chrome Custom Search for CFDocs
- Disable Flash Remoting on ColdFusion Servers
- HackMyCF Adds SSL/TLS Scanner
- IncompatibleClassChangeError after ColdFusion 11 Update 5