Next Previous Contents

Read Me First

Hartmut Niemann, niemann@cip.e-technik.uni-erlangen.de

$Date: 1998/06/22 08:34:54 $


This note tells you some things you need to know when you start dealing with the GGI documentation. Please read it, it is not long.

A large part of the GGI documentation is maintained using sgml-tools, a set of tools to generate different output formats from one single source file. You have the choice between

The current distribution tree contains only the sgml and text files, others are available from the ftp site (doc directory) or on request from me.

A (hopefully current) browseable html tree can be found at my home page, gzipped tar-files for the different formats can be found there too.

To find out what document covers what, please read the index (which is also autogenerated).

If you find any mistakes in the documentation, please do not change files other than the sgml file. Please change the sgml file and mail me the (unified) diff. You can send me unified diffs from other files as well, but I have to apply them by hand to the sgml source. Changes you make to other files than the sgml master are very likely to be overwritten next time I touch the sgml file. So PLEASE send me unified diffs, and don't commit changes to text files yourself!

If you want to start a new document, take the master file of this document (0README1ST.sgml) as a starting point, and see how easy sgml is. Or write plain ascii text, and I'll gladly sgml-ize it for us.

I am currently using sgml-tools 1.0.6 with some small bug fixes. Some documents need these fixes for correct results. So you might want to download the processed files from the ftp server instead of processing them yourself.

Thank you and happy reading!

Hartmut.


Next Previous Contents