Forum OpenACS Q&A: Best markup language? DocBook, Scribe, Wiki, HTML, LaTex, or etc.
Posted by Andrew Piskorski on 10/04/05 11:42 PM
Well, just how bad is DocBook? I've never attempted to use it, so I am genuinely curious. Malte and others who have, can you give us a rough idea please: How much time did it take you to come up to speed on DocBook, and once you were there, how pleasant and efficient was using DocBook compared to other markup tools?
As far as markup languages that can emit multiple output formats (HTML, PDF, man pages, etc.) go, has anyone used Scribe? It sounds very powerful.
Also, how do all these Wiki syntaxes compare to simply using straight good-old HTML? Or LaTeX, for that matter? In other words, what is the win with using one of the various specialized (but rather ad-hoc?) Wiki syntaxes?
Posted by Malte Sussdorff on 10/05/05 07:43 AM
Getting up to speed on docbook took me half a day for being good enough to write OpenACS documentation. Then it took me again half a day to figure out how to use the provided scripts to generate HTML out of the docbook file. So it is not a problem of the Docbook format. It is more a problem of the steps involved which will scare the casual user from editing documentation.
- Download the documentation source code
- Use a decent editor for docbook (I used emacs) to edit the documentation. Make sure you keep up the markup
- Generate the HTML out of it
- CVS commit both files to the repository
- Make sure you are on the correct branch. Commit again
- Write an email to Joel to update the documentation on openacs.org
- Realize Joel is busy, login to openacs.org and do the update yourself (This steps used to work for OCT members, now this is restricted to even less people).
- Login to openacs.org/wiki/documentation
- Edit the documentation
- Reflect in glory about your excellent work