diff options
| -rw-r--r-- | odk/docs/install.html | 120 | ||||
| -rw-r--r-- | odk/index.html | 75 |
2 files changed, 126 insertions, 69 deletions
diff --git a/odk/docs/install.html b/odk/docs/install.html index 94db92d6f613..4cb42c138f23 100644 --- a/odk/docs/install.html +++ b/odk/docs/install.html @@ -60,41 +60,51 @@ </tr> <tr> <td colspan="4"> - <p>The [PRODUCTNAME] SDK comes with a set of development tools, base libraries and jar files which - can be used to develop Java/C++ components, to embed [PRODUCTNAME] application in your own programs - or to use the API (scripting or remote control the office). For a complete working - environment we have some additional requirements. + <p>The [PRODUCTNAME] SDK comes with a set of development tools, base libraries and jar files + which can be used to develop Java/C++ components, to embed [PRODUCTNAME] application in + your own programs or to use the API (scripting or remote control the office). For a + complete working environment we have some additional requirements. </p> <dl> - <dt><b>StarOffice™ or OpenOffice.org installation</b> - <dd>The SDK works on top of an existing office installation and uses the same libraries as the office. + <dt><b>StarOffice™ 6.0 PP2 or OpenOffice.org 1.0.2 installation</b> + <dd>The SDK works on top of an existing office installation and uses the same libraries as + the office installation. <dt><b>JDK (1.3.1_02 or higher)</b> - <dd>A JDK is necessary for developing Java components or applications. An appropriate Java SDK can be - found on <a target="_blank" href="http://java.sun.com/products">http://java.sun.com/products</a>. + <dd>A JDK is necessary for developing Java components or applications. An appropriate Java + SDK can be found on <a target="_blank" href="http://java.sun.com/products"> + http://java.sun.com/products</a>. <dt><b>C++ compiler</b> <dd>A C++ compler is necessary for developing C++ components or applications. UNO depends on a compiler dependent language binding so that we use the appropriate compiler where a language binsing exists:<br> Solaris, Sun WorkShop 6 update 1 C++ 5.2 2000/09/11<br> Linux, GNU C++ compiler, gcc version 3.0.1<br> - Windows, Microsoft C++ Compiler, Microsoft Developer Studio 6.0 (cl, version 12.00.8168)<br> + Windows, Microsoft C++ Compiler, Microsoft Developer Studio 6.0 (cl, version 12.00.8168) <dt><b>GNU make (3.79.1 or higher)</b> <dd>GNU make is used to build the examples of the SDK. GNU make is available from <a target="_blank" href="http://www.gnu.org">http://www.gnu.org</a>, it can be ftped via <a target="_blank" href="ftp://ftp.gnu.org/gnu/make">ftp://ftp.gnu.org/gnu/make</a><br> NOTE: Windows user can find an executable of gnu make under - <a href="http://www.nextgeneration.dk/gnu/make.zip">http://www.nextgeneration.dk/gnu/make.zip</a>. - It is not recommendable to use the Cygwin make because it don't work. + <a target="_blank" href="http://www.nextgeneration.dk/gnu/make.zip"> + http://www.nextgeneration.dk/gnu/make.zip</a>. It is not recommendable to use the Cygwin + make because it don't work. + <dt><b>STLPORT (4.5.3)</b> + <dd>Some examples uses the STL, if you want to test this exmaples you have to install + a vesion of the STLPORT library on your machine. The STLPORT library is available from + <a target="_blank" href="http://www.stlport.org">http://www.stlport.org</a>. </dl> - <p>The SDK provides a configure script (Unix and WindowsNT) that asks for relevant directories (SDK, StarOffice, GNU make, Java, C++, and ANT). After - completing the configure script a new script will be created (WindowsNT and UNIX) to set the necessary environment variables for using the SDK and the required - tools. + <p>The SDK provides a configure script (Unix and WindowsNT/2000/XP) that asks for relevant + directories (SDK, StarOffice, GNU make, Java, C++, STLPORT and ANT). After completing the + configure script a new script will be created (WindowsNT//2000/XP and UNIX) to set the + necessary environment variables for using the SDK and the required tools. </p> <ul> - <li><a href="../configure">configure</a> - <li><a href="../configureWindowsNT.bat">configureWindowsNT.bat</a> + <li><a href="../configure">configure</a> -> for Unix + <li><a href="../configureWindowsNT.bat">configureWindowsNT.bat</a> -> for + WindowsNT/2000/XP </ul> - <p>Other versions of the operating system Windows should use the batch program setsdkenv_windows.bat . + <p>Other versions of the operating system Windows should use the batch program + <SDK_HOME>setsdkenv_windows.bat directly and adopt it to their local environment. </p> <ul> <li><a href="../setsdkenv_windows.bat">setsdkenv_windows.bat</a> @@ -127,6 +137,10 @@ <td widht=65%>path to GNU make</td> </tr> <tr> + <td widht=35%><b>STLPORT_HOME</b></td> + <td widht=65%>path to the STLPORT installation directory</td> + </tr> + <tr> <td widht=35%><b>SDK_AUTO_DEPLOYMENT</b></td> <td widht=65%>if this variable is set, the component examples will be automatically deployed into the Office installation referenced by OFFICE_HOME. See also ((reference deployment mechanism)). @@ -137,6 +151,7 @@ environment variables by yourself. The script sets the following environment variables. </p> <p><b>Environment variables for UNIX</b></p> + <p>Solaris</p> <p> <table width="100%" border=1 cellpadding=4 cellspacing=0> <tr> @@ -148,24 +163,25 @@ </tr> <tr> <td widht=35%>LD_LIBRARY_PATH</td> - <td widht=65%><b>=<i>$LD_LIBRARY_PATH/$OFFICE_PROGRAM_PATH:$SDK_HOM/solsparc/lib</i></b><br> - The LD_LIBRARY_PATH will be set or will be extended by the office program path and the platform - dependent lib directory for some additional libraries. + <td widht=65%><b>=<i>$OFFICE_PROGRAM_PATH:$SDK_HOME/solsparc/lib:$STLPORT_HOME/lib: + $LD_LIBRARY_PATH</i></b><br> + The LD_LIBRARY_PATH will be set or will be extended by the office program path, + the platform dependent lib directory for some additional libraries and the + <STLPORT_HOME>/lib directory (optional). </td> </tr> <tr> <td widht=35%>PATH</td> - <td widht=65%><b>=<i>$PATH:$SDK_HOME/solsparc/bin:$SDK_MAKE:$SDK_CPP_HOME:$SDK_JAVA_HOME/bin</i></b><br> - The PATH variable will be extended by the pathes for the SDK development tools, the compiler, - the JDK, GNU make. + <td widht=65%><b>=<i>$SDK_HOME/solsparc/bin:$SDK_MAKE:$SDK_CPP_HOME:$SDK_JAVA_HOME/bin: + $PATH</i></b><br> + The PATH variable will be extended by the pathes for the SDK development tools, + the compiler, the JDK and GNU make. </td> </tr> </table> </p> - <p><b>Environment variables for Windows</b></p> - <p> Additionally to setting these environment varibales the script calls the "vcvar32.bat" batch file - which is provided by the Microsoft Develper Studio to set the necessary environment varibales for - the compiler. + <p>Linux</p> + <p> <table width="100%" border=1 cellpadding=4 cellspacing=0> <tr> <td widht=35%>OFFICE_PROGRAM_PATH</td> @@ -175,24 +191,56 @@ pleace comment this variable out in the script.</td> </tr> <tr> + <td widht=35%>LD_LIBRARY_PATH</td> + <td widht=65%><b>=<i>$OFFICE_PROGRAM_PATH:$SDK_HOM/linux/lib:$STLPORT_HOME/lib: + $LD_LIBRARY_PATH</i></b><br> + The LD_LIBRARY_PATH will be set or will be extended by the office program path, + the platform dependent lib directory for some additional libraries and the + <STLPORT_HOME>/lib directory (optional). + </td> + </tr> + <tr> + <td widht=35%>PATH</td> + <td widht=65%><b>=<i>$SDK_HOME/linux/bin:$SDK_MAKE:$SDK_CPP_HOME:$SDK_JAVA_HOME/bin: + $PATH</i></b><br> + The PATH variable will be extended by the pathes for the SDK development tools, + the compiler, the JDK and GNU make. + </td> + </tr> + </table> + </p> + <p><b>Environment variables for Windows</b></p> + <p> Additionally to setting these environment varibales the script calls the "vcvar32.bat" + batch file which is provided by the Microsoft Develper Studio to set the necessary + environment varibales for the compiler. + <table width="100%" border=1 cellpadding=4 cellspacing=0> + <tr> + <td widht=35%>OFFICE_PROGRAM_PATH</td> + <td widht=65%><b>=<i>%OFFICE_HOME%\program</i></b><br> + This variable is used to register example components + automatically in your Office installation. If you don't want automatic registration, + pleace comment this variable out in the script.</td> + </tr> + <tr> <td widht=35%>PATH</td> - <td widht=65%><b>=<i>$PATH:$SDK_HOME/solsparc/bin:$SDK_MAKE:$SDK_CPP_HOME:$SDK_JAVA_HOME/bin - :$OFFICE_PROGRAM_PATH</i></b><br> - The PATH variable will be extended by the pathes for the SDK development tools, the compiler, - the JDK, GNU make and the $OFFICE_PROGRAM_PATH. + <td widht=65%><b>=<i>%SDK_HOME%\windows\bin;%SDK_MAKE%;%SDK_CPP_HOME%;%SDK_JAVA_HOME% + \bin;%OFFICE_PROGRAM_PATH%;%STLPORT_HOME%\lib;%PATH%</i></b><br> + The PATH variable will be extended by the pathes for the SDK development tools, + the compiler, the JDK, the STLPORT library, GNU make and the + <OFFICE_PROGRAM_PATH>. </td> </tr> <tr> <td widht=35%>LIB</td> - <td widht=65%><b>=<i>$LIB:$SDK_HOME/windows/lib</i></b><br> - The LIB variable will be extended by the path to the import libraries which are necessary - for winsows. + <td widht=65%><b>=<i>%SDK_HOME%\windows\lib;%STLPORT_HOME\lib;;%LIB%</i></b><br> + The LIB variable will be extended by the path to the import libraries which are + necessary for winsows. </td> </tr> <tr> <td colspan="2">Additionally to setting these environment varibales the script calls the - "vcvar32.bat" batch file which is provided by the Microsoft Develper Studio to set the - necessary environment variables for the compiler.</td> + "vcvar32.bat" batch file which is provided by the Microsoft Develper Studio to set + the necessary environment variables for the compiler.</td> </tr> </table> </p> diff --git a/odk/index.html b/odk/index.html index 25c3fb83e555..ff5f7ab91548 100644 --- a/odk/index.html +++ b/odk/index.html @@ -90,10 +90,12 @@ [PRODUCTNAME], thus covering the two most commonly used programming languages. There will be no limit for office automation in heterogeneous environments. Currently supported platforms of the SDK are Linux, Solaris (sparc), and Windows.</p> - <P>Furthermore the SDK contains reference documentation for the API and a complete developer's - manual, with lots of examples, which shall introduce the API, explain the concepts behind it, - and should make it possible for all users to quickly make their own first steps with the - Office API.</P> + <P>Furthermore the SDK contains <a href="docs/common/ref/com/sun/star/module-ix.html"> + reference</a> documentation for the API and a complete + <a href="docs/Developersguide_intro.html">Developers Guide</a>, with lots of examples, + which shall introduce the API, explain the concepts behind it, and makes it possible for + all users to getting started and make their own first steps with the Office API quickly. + </P> <hr> <table width="100%" border="0" cellpadding="4"> <tr> @@ -104,42 +106,25 @@ <font size="3"><a href="docs/install.html">Installation Guide</a></font> </td> <td width=70%> - An overview of all necessary installation steps (e.g. environment variables) to use this SDK. + An overview of all necessary installation steps (e.g. environment variables) to use + this SDK. </td> </tr> <tr> - <td width=30%> - <font size="3"><a href="docs/DevStudioWizards/wizards.html">Sun ONE Studio 4 Integration</a></font> - </td> - <td width=70%> - An introduction to use the SDK with Sun ONE Studio 4 (formerly Forte for Java) or - NetBeans. The wizards are in a very early preview state and should be replaced in - the near future. - </td> - </tr> - <tr> - <td width=30%> - <font size="3"><a href="docs/tools.html">Development Tools</a></font> - </TD> - <td width=70%> - Overview and a short description of the UNO development tools. - </td> - </tr> - <tr> <td colspan="2"> </td> </tr> <tr> <td width=30%> - <font size="3"><a href="docs/devmanual_preview.html">Developer Documentation</a></font> + <font size="3"><a href="docs/developersguide_intro.html">Developers Guide</a></font> </td> <td width=70%> - Detailed manual, explaining the [PRODUCTNAME] API and the concepts behind it with a - rich set of examples, implemented mainly in Java. + Detailed documentation, explaining the [PRODUCTNAME] API and the concepts behind it + with a rich set of examples, implemented mainly in Java. </td> </tr> <tr> <td width=30%> - <font size="3"><a target="_blank" href="docs/common/ref/com/sun/star/module-ix.html"> + <font size="3"><a href="docs/common/ref/com/sun/star/module-ix.html"> IDL Reference</a></font> </td> <td width=70%> @@ -148,7 +133,7 @@ </tr> <tr> <td width=30%> - <font size="3"><a target="_blank" href="docs/java/ref/index.html">Java UNO Runtime Reference + <font size="3"><a href="docs/java/ref/index.html">Java UNO Runtime Reference </a></font> </td> <td width=70%> @@ -157,11 +142,11 @@ </tr> <tr> <td width=30%> - <font size="3"><a target="_blank" href="docs/cpp/ref/index.html">C++ Reference</a></font> + <font size="3"><a href="docs/cpp/ref/index.html">C++ Reference</a></font> </td> <td width=70%> - Reference documentation of the C++ UNO runtime and a set of C/C++ base and helper functions - and classes to abstract from the system layer. + Reference documentation of the C++ UNO runtime and a set of C/C++ base and helper + functions and classes to abstract from the system layer. </td> </tr> <tr> @@ -169,6 +154,14 @@ </tr> <tr> <td width=30%> + <font size="3"><a href="docs/tools.html">Development Tools</a></font> + </TD> + <td width=70%> + Overview and a short description of the UNO development tools. + </td> + </tr> + <tr> + <td width=30%> <font size="3"><a href="examples/examples.html">Examples</a></font> </td> <td width=70%> @@ -176,8 +169,24 @@ </td> </tr> <tr> + <td colspan="2"> </td> + </tr> + <tr> + <td width=30%> + <font size="3"><a href="docs/DevStudioWizards/wizards.html">Sun ONE Studio 4 Integration</a></font> + </td> + <td width=70%> + An introduction to use the SDK with Sun ONE Studio 4 (formerly Forte for Java) or + NetBeans. The wizards are in a very early preview state and should be replaced in + the near future. + </td> + </tr> + <tr> + <td colspan="2"> </td> + </tr> + <tr> <td width=30%> - <font size="3"><a target="_blank" href="docs/common/spec/xml_format/xml_specification_draft.pdf">XML File Format + <font size="3"><a href="docs/common/spec/xml_format/xml_specification_draft.pdf">XML File Format Specification</a></font> </td> <td width=70%> @@ -186,7 +195,7 @@ </tr> <tr> <td width=30%> - <font size="3"><a target="_blank" href="docs/basic/man/tutorial/tutorial.pdf">[PRODUCTNAME] Basic Programmer's + <font size="3"><a href="docs/basic/man/tutorial/tutorial.pdf">[PRODUCTNAME] Basic Programmer's Tutorial</a></font> </td> <td width=70%> |