Documentation structure

Jasper Huijsmans jasper at moongroup.com
Fri May 9 00:22:29 CEST 2003


Hi,

I'd like to know what you think about the general documentation
structure I put up here:

http://members.home.nl/jbhuijsmans/xfce4-user-guide/

It splits the documentation into a user guide, which will give an
overview of the desktop, explain general concepts and describe some
common tasks, and separate manuals for each module, which I now have
formatted into one html page.

This is what I currently think is the best way to present our
information. For this to work I think it may be best to install a simple
index file like I have now on the above page to make it easy to find the
documentation. If not all modules are installed, some links will be
dead. Ideally this index would be autogenerated, but that may be added
at a later date.

So, what do you think?

If nobody objects, I would like to implement the above structure and
also install the documents to a new location, like I explained in an
earlier mail: $(datadir)/xfce4/doc/<ll>/, where <ll> is the language
code for translations or 'C' for the main documentation.

Let me know what you think,

	Jasper



More information about the Xfce4-dev mailing list