[ECOS] Docbook format in eCos v.2.0

Andrew Lunn andrew.lunn@ascom.ch
Thu May 23 00:28:00 GMT 2002


On Wed, May 22, 2002 at 04:00:10PM +0200, Erik Aagaard Knudsen wrote:
> I wonder why you changed the documentation format in eCos to Docbook? It
> seems pretty complicated for people who just want to read the documentation.
> Do you have any suggestions for making this simple? Tools and how to use
> them (Windows - Unix)? I have tried to use openjade (v1.3), but it doesn't
> seem to work very well.

DocBook is just a markup language, like TeX or HTML etc. You are not
really supposed to read DocBook native. Jade can turn it into other
formats, such as HTML for on line web pages, pdf for distribution on
CDs, or postscript for printing onto paper/books etc. Putting the
DocBook into CVS allows the Open Source community to contribute to the
documentation. 

I like having a local copy of the documentation, running from my web
server. I used to have the CVS checked out directly into my web server
file system. This is not possible now :-(

What would be useful is if RedHat put up the HTML files derived from
the DocBook files in the CVS or a tarball. Then there is no need for
us to get Jade working unless we actually want to write some
documentation.

   Andrew



-- 
Before posting, please read the FAQ: http://sources.redhat.com/fom/ecos
and search the list archive: http://sources.redhat.com/ml/ecos-discuss



More information about the Ecos-discuss mailing list