The UDK Documentation Structure

Introducing UDK documentation

This document describes the structure of the UNO Development Kit (UDK) documentation. In general the documentation contains tutorials, specifications, concepts, component specific documentation and generated reference documentation.

The documentation is either completely language independent or programming language specific depending on what is being documented.

There are several different sub directories.

• The directory "common" contains language independent documents.
• The directories "c", "cpp", "java", and "python" contain language specific documentation.

Under each of the above there are the following two directories

• The directory "ref" contains generated documentation.
• The directory "man" contains manually written documentation.

Under the directory "man" there is "images", "tutorial", "spec", "component" and "concept" directories, this helps to organize the documents.

The following directory tree is the current one ( as at 10th Oct 2000) of the UDK documentation to show the structure:

udk/www/common/man/images/
                   concept/
               ref/
        cpp/man/images/
                tutorial/
                spec/
            ref/cppu/
                cppuhelper/
                registry/
                sal/
                stor/
                vos/
        java/man/images
             ref/

There is another project which is very important to the UDK documentation, this is the API project. The API project is where all interfaces are specified and documented. There are often bidirectional links between UDK and API, so here is the structure of the API documentation too.

The API project has a similar structure, but there is currently only the reference tree:

api/www/common/ref/
api/www/common/ref/com/
api/www/common/ref/com/sun/
api/www/common/ref/com/sun/star/
api/www/common/ref/com/sun/star/...

If you link with other projects you must use absolute path names (e.g. "http://api.openoffice.org/...").

Author: Markus Meyer ($Date: 2004/11/13 05:10:53 $)
Copyright 2001 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.