gnumed-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Gnumed-devel] GNUmed docs, again


From: Karsten Hilbert
Subject: [Gnumed-devel] GNUmed docs, again
Date: Sat, 3 Aug 2002 14:26:13 +0200
User-agent: Mutt/1.3.22.1i

Let me propose a general framework on where to put docs how:

client/doc/:
------------

1) user-manual.sgml
 - the parent sgml source for the User's Manual
 - includes several chapter files that also live in this
   directory

2) developer-guide.sgml
 - the same for the Developer's Guide

3) TODO
 - text file with bits and pieces that should go in the docs
 - good for people who want to document something but don't
   want to mess around with the sgml documents for some reason
 - please leave your email address if you put stuff in here

Several sgml files containing chapters (such as
client-installation.sgml, backend-installation.sgml, ...) live
here, too.

Andreas, where should those source files live in the end-users
filesystem ? IMHO they don't belong into
/usr/share/doc/packages/GNUmed/ or do they ?

client/doc/user-manual/:
------------------------
- HTML version of user-manual.sgml
- this may be put in /usr/share/doc/packages/GNUmed/user-manual/
  on end-user machines
- this is what the client loads via gmManual.py

client/doc/developer-guide/:
----------------------------
- well, guess what :-)

Any other/better suggestions ?

Karsten
-- 
GPG key ID E4071346 @ wwwkeys.pgp.net
E167 67FD A291 2BEA 73BD  4537 78B9 A9F9 E407 1346



reply via email to

[Prev in Thread] Current Thread [Next in Thread]