Re: [Viking-devel] Documentation

[Guilhem B. <gui...@gm...>]

Hi,

I started to add help documentation in viking. You can browse/test my work at
http://repo.or.cz/w/viking/guyou.git?a=shortlog;h=refs/heads/help

Currently, the documentation is written as DocBook because Gnome
provides tools to manage it.
In order to fill the documentation, I partly converted the "User
Manual" page of the wiki via
http://toolserver.org/~magnus/wiki2xml/w2x.php
The result is far from perfect. Many hand rewrite must be done. Some
of them due to w2x tool, others due to wiki page malformed content.
But this is currently a proof-of-concept.


IMHO, it will be definitively impossible to maintain TWO versions of
the user manual. I can imagine two processes:
- keep the User Manual on the wiki and regularly (just before
releasing) convert the content to update the help documentation ;
- remove the wiki page, maintain only the DocBook version, and provide
a HTML version on the viking's site (converted via official DocBook's
XSL stylesheets).

What is YOUR opinion?
As it directly concern contributors involved in the documentation,
this is YOUR decision.
Do you prefer DocBook or MediaWiki?
I really need to know your opinion.

-- 
Guilhem BONNEFILLE
-=- JID: gu...@im... MSN: gui...@ho...
-=- mailto:gui...@gm...
-=- http://nathguil.free.fr/