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

OOC Reference Manual



Eric finally gave his ok to put the current draft of his reference
manual on the ftp server.

The full sources are here:
ftp://cognac.informatik.uni-kl.de/pub/ooc/docs

The HTML version is here:
http://cognac.informatik.uni-kl.de/~oberon1/ooc/OOCref/OOCref_toc.html

-- mva

------------------------------------------------------------------------

OOC Reference Manual
====================

This is the README file for draft (evaluation) version of the OOC
Reference Manual (OOC RM).  The goal of this manual is to provide
complete supporting documentation for the OOC library and OOC
compilers (including oo2c).

The draft status of this manual means that it is a work in progress;
much of the documentation has yet to be written.  You will currently
find a large number of "empty" chapters.  That is, the currently
proposed chapters and chapter outlines are all in place, but many of
them have no content.  These will be filled in as they are written.
Suggestions for additional chapters and sections are always welcome.

Any questions, comments, or suggestions can be sent to:

	Eric Nikitin (enikitin@apk.net)
or	Michael van Acken (acken@informatik.uni-kl.de)

This manual uses the Texinfo documentation system to provide for both
online information and printed output.  This allows the manual to be
presented in a number of formats, which can all be generated from the
same source files.  

The distribution of this manual contains source files (texinfo), as
well as the resulting `info' files (which can be read using the Emacs
Info reader or `info'), HTML files, and postscript files (both
smallbook and A4 formats).

This distribution includes (but is not limited to) the following files:

    README                      This file.

Texinfo source files:

    source/OOCref.texinfo       The "main" Texinfo file, which is used
				to build `info', HTML, and postscipt
				files.  

    source/*.texi               Files which are included in the "main"
				Texinfo file.  These will be
				automatically incorporated when 
				running `makeinfo' and so forth on the
				main file.

'info' files:

    OOCref.info*		A number of `info' files, which may be
				read using the Emacs Info reader (use
				the key sequence `C-u C-h i' to load) 
				or the `info' program.  

HTML files:

    OOCref.html			HTML version of the OOC RM.  

    OOCref_toc.html		HTML table of contents, which allows 
				easy browsing of the OOC RM.  

Postscript files:

    OOCref_smallbook.ps		"Smallbook" postscript format.

    OOCref_A4.ps 		A4 postscript format for printing on 
				A4 paper (i.e., european paper size).