| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <HTML> |
| <head> |
| <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1" /> |
| <TITLE>The UDK Documentation Structure</TITLE> |
| <META NAME="GENERATOR" CONTENT="StarOffice/5.2 (Win32)" /> |
| <META NAME="CLASSIFICATION" CONTENT="Using the UDK with the MS Developer Studio 6.0" /> |
| <META NAME="KEYWORDS" CONTENT="UNO,UDKMS Developer Studio 6.0" /> |
| </head> |
| <body LINK="#444488" VLINK="#444488" BGCOLOR="#eeeeff"><A NAME="__Top__"></A> |
| <TABLE WIDTH=100% BORDER=0 CELLPADDING=4 CELLSPACING=0 bgcolor=#666699> |
| <tr> |
| <td> |
| <H1 ALIGN=center STYLE="margin-top: 0.2cm; margin-bottom: 0.2cm; text-decoration: none"> |
| <FONT COLOR="#ffffff"><FONT SIZE=6> |
| The UDK Documentation Structure</FONT></FONT></H1> |
| </td> |
| <td> |
| <A HREF="http://www.openoffice.org/"> |
| <IMG SRC="images/open_office_org_logo.gif" NAME="Grafik1" ALT="OpenOffice" ALIGN=right WIDTH=109 HEIGHT=54 BORDER=0></A> |
| </td> |
| </TR> |
| </TABLE> |
| <br/> |
| <TABLE WIDTH=100% BORDER=0 CELLPADDING=4 CELLSPACING=0> |
| <TR> |
| <TD WIDTH=100% BGCOLOR="#666699"> |
| <h3 style="margin-top: 0.2cm; margin-bottom: 0.2cm; text-decoration: none"> |
| <font COLOR="#ffffff" SIZE=4>Introducing UDK documentation</font></h3> |
| </td> |
| </tr> |
| <tr> |
| <td> |
| <P>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.</p> |
| <p>The documentation is either completely language independent or programming |
| language specific depending on what is being documented.</p> |
| |
| <p>There are several different sub directories.</p> |
| <ul> |
| <li>The directory "common" contains language independent documents.</li> |
| <li>The directories "c", "cpp", "java", and "python" contain language specific |
| documentation.</li> |
| </ul> |
| |
| <p>Under each of the above there are the following two directories</p> |
| <ul> |
| <li>The directory "ref" contains generated documentation.</li> |
| <li>The directory "man" contains manually written documentation.</li> |
| </ul> |
| |
| <P>Under the directory "man" there is "images", "tutorial", "spec", "component" |
| and "concept" directories, this helps to organize the documents.</p> |
| |
| <P>The following directory tree is the current one ( as at 10th Oct 2000) of |
| the UDK documentation to show the structure:</P> |
| |
| <PRE> |
| udk/www/common/man/images/ |
| concept/ |
| ref/ |
| cpp/man/images/ |
| tutorial/ |
| spec/ |
| ref/cppu/ |
| cppuhelper/ |
| registry/ |
| sal/ |
| stor/ |
| vos/ |
| java/man/images |
| ref/ |
| </PRE> |
| |
| <P>There is another project which is very important to the UDK documentation, |
| this is the <A HREF="http://api.openoffice.org">API</A> 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.</p> |
| |
| <p>The API project has a similar structure, but there is currently only |
| the reference tree:</P> |
| |
| <PRE> |
| 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/... |
| </PRE> |
| |
| <P>If you link with other projects you must use absolute path names |
| (e.g. "http://api.openoffice.org/...").</p> |
| |
| </TD> |
| </TR> |
| <TR> |
| <TD BGCOLOR="#666699"> |
| <P ALIGN=left><FONT COLOR="#ffffff"> |
| Author: <A HREF="mailto:markus.meyer@germany.sun.com"><FONT COLOR="#ffffff">Markus Meyer</FONT></A> ($Date: 2004/11/13 05:10:53 $)<br/> |
| <I>Copyright 2001 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.</I></FONT> |
| </P> |
| </TD> |
| </TR> |
| </TABLE> |
| </body> |
| </html> |
