Here's my  3c:

In Debian and other distributions, package documentation is located in
'/usr/share/doc/<package>/' directory, for Crystal it would be
'/usr/share/doc/fvwm-crystal/'. We can create a function which will generate
menu with all files located there. Depending on the format (text, text.gz) we
can select which application to use for displaying (not just simple "A less",
we can check for other pagers installed in the system).

As for the format, standard Debian documentation is supplied either as text
files (sometimes .gz) in '/usr/share/doc/', or as manual pages, or as the info
documentation, which can be generated from DocBook/SGML. DocBook is also the
preffered way to write the docs in the Linux world, because it can be easily
converted to HTML, PDF, text, man and whatnot.

So, preferably, I would like to include the sources of the documentation in
Crystal repository, and generate them in desired formats using make at the
installation time. We can even make easier for package maintainers to handle
the documentation in various distributions by using above system.

When we will do it this way, creating PDF version will be no problem, and
editing documentation will be a piece of cake.

I just need to learn the basics of SGML... :)

Cheers,
harnir

-- 
+ -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- +
| Maciej Delmanowski  /  http://linux.net.pl/~harnir/  /  GnuPG: 48B03AFE |
+ -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- +

_______________________________________________
fvwm-crystal-users mailing list
[EMAIL PROTECTED]
https://mail.gna.org/listinfo/fvwm-crystal-users

Reply via email to