Posts Tagged ‘docbook’

Markdown – another format to write document

Tuesday, August 3rd, 2010

imageDuring the git-svn study, I notice there are lots of document in github are in markdown format, and showing in html looks very concise like wiki page.

Wikipedia gives excellent definition for markdown, see http://en.wikipedia.org/wiki/Markdown

Markdown is a lightweight markup language, originally created by John Gruber and Aaron Swartz to help maximum readability and "publishability" of both its input and output forms. The language takes many cues from existing conventions for marking up plain text in email.

Let’s compare it to other my used document format

Compare to M$ Word, it is plain text, easy to write and controlled by version control system, and best of all, it lets me focus on content instead of format

Compare to Wiki, the format is quite similar, and markdown is a file, it means, I can easily put into svn/git and publish in other place, wiki system force in most of time to write online

image Compare to Docbook (http://www.docbook.org/) it is a plain text instead of xml format, it can help me to focus on the contents I am writting and reach to “publishability”, since it is more readability from the source, for docbook, mostly I need to generate html to see what it looks like, or rely on my software like

Compare to apt (http://maven.apache.org/doxia/references/apt-format.html), the format is quite similar, markdown seems more popular and well acceptable by community and it is better for publishability.

And always remind myself, “how to write the information is more important than choosing tools” ;-)

Doxia or docbook for document

Tuesday, May 18th, 2010

Put some efforts to thinking of the improvement on the design documents, and here is some technical thinking, I always try to find efficiency tool (better cool) to fit my purpose.

image Word, Powerpoint, Wiki shall be good documentation format, and today I want to check a bit on doxia and docbook.

The need this time is

  1. it shall be nature to integrate into CI system and publish online in html format, so it can be accessed easily.
  2. it shall be part of version control system, so people can update it more easily and under control, in order to update easiler, it is better in plain text format.
  3. If possible, it shall be generated PDF format easier, so it can be printed as booklet. see example in right (generated from http://www.signgenerator.org/books/dummies/)

Doxia http://maven.apache.org/doxia/index.html is a content generation framework which aims to provide its users with powerful techniques for generating static and dynamic content, it supports APT, FML, xdoc format, and also it can generate books as well.

It is well integrated into maven, so type "mvn site", you can get them all

image docbook http://www.docbook.org/ is more similar with our tagtool SGML format, and it is standard, supported by O’Reilly (http://oreilly.com/oreilly/author/stylesheet.html), see good example from “CI with hudson”, surely you need pay attention or learn the docbook format to write. I downloaded its source from github and complete build the pdf file from scratch, and it works !!

Also  there is a tutorial docbook with eclipse : http://www.vogella.de/articles/DocBook/index.html 

Maybe you worry about how to coordinate on different parts of the book, don’t worry, it can be seperated with different chapters, see example in jboss http://docs.jboss.org/docbook/userguide/html_single/#aop.fig.

I will post the example for both format this week