| <!DOCTYPE html> |
| <html><head> |
| <title>OpenOffice.org Software Development Kit (SDK) Build Guide</title> |
| <meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8"> |
| </head> |
| <body> |
| <h1>OpenOffice.org Software Development Kit (SDK) Build Guide</h1> |
| |
| <p>The OpenOffice.org Software Development Kit (SDK) can be build as a normal code module in the |
| OpenOffice.org build environment. |
| </p> |
| <p>The build process of the SDK is split in two parts: |
| <ol> |
| <li>the main part of the SDK is build in the <b>api/odk</b> module. In this module everything is |
| collected that is part of the SDK. |
| <ul> |
| <li>header files |
| <li>IDL files |
| <li>tools |
| <li>examples |
| <li>some documentation |
| <li>IDL reference documentation is created |
| </ul> |
| The result of this module is a platform specfic (incudes binaries) <b><i>odkcommon.zip></i></b> file |
| in the <b><bin></b> directory of the output tree. And a <b><i>odkexamples.zip></i></b> file |
| in the <b><bin></b> directory of the common output tree. The files are delivered and later on used |
| in <b>instsetoo_native</b> to package the SDK product. |
| </ol> |
| </p> |
| <p>Many parts of the SDK are coming directly from the global output tree (e.g. header files, IDL files, |
| tools). So it is recommended to build the SDK at the end of a normal build. If the SDK should be build |
| on base of an existing <b>solenv</b>, you have at least to checkout the two modules: |
| <ol> |
| <li><b>api/odk</b> |
| <li><b>instsetoo_native</b> |
| </ol> |
| and have to build them in the given order. In <b>instsetoo_native/util</b> you can use <b>dmake sdkoo</b> to |
| trigger a SDK packaging process directly. |
| </p> |
| |
| <h2>Porting the SDK</h2> |
| <p>The SDK comes currently with a simplified build environment for the examples. This build environment |
| is based on gnu make. This allows SDK users to use the examples or to create own solutions based on the |
| SDK without any complex OpenOffice.org build environment. For porting the SDK to a new platform it is |
| necessary to: |
| <ol> |
| <li>check the <b>api/odk/settings/settings.mk</b> file, insert the appropriate extension and adopt it |
| to the requirements of the new platform. |
| <li>to provide a configure/setsdkenv script or to adopt the existing ones in the root of <b>api/odk</b>. |
| </ol> |
| If it is necessary to insert new files, it is necessary to adopt the packaging makefiles (<b>api/pack/...</b> |
| and the check script (<b>api/odk/util/check.pl</b>). The check script provide a first simple content check |
| of the SDK at the end of the build. |
| </p> |
| |
| <hr style="width: 100%; height: 1px;"> |
| <i>Last update: 11-Aug-2008</i> |
| </body> |
| </html> |
| |
