Skip to content

start:

OpenOffice.org Software Development Kit (SDK) Build Guide

The OpenOffice.org Software Development Kit (SDK) can be build as a normal code module in the OpenOffice.org build environment.

The build process of the SDK is split in two parts:

  1. the main part of the SDK is build in the api/odk module. In this module everything is collected which doesn't contain any product information.
    • header files
    • IDL files
    • tools
    • examples
    • some documentation
    The result of this module is a odkXXX.zip> file in the <bin> directory of the output tree. This file is delivered and is the source of the api/sdk_oo module.
  2. the final product branding and packaging is done in the api/sdk_oo module. In this module all parts containing product information are packed into the SDK and the final package is delivered.
    • Developer's Guide
    • IDL reference documentation is created
    • final branding
    The result of this module is a final OpenOffice.orgXX_SDK.zip file in the <bin> directory of the output tree. This file is delivered in the global output tree or can be used directly from the local tree.

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 solenv, you have at least to checkout the two modules:

  1. api/odk
  2. api/sdk_oo
and have to build them in the given order.

Porting the SDK

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:

  1. check the api/odk/settings/settings.mk file, insert the appropriate extension and adopt it to the requirements of the new platform.
  2. to provide a configure/setsdkenv script or to adopt the existing ones in the root of api/odk.
If it is necessary to insert new files, it is necessary to adopt the packaging makefiles (api/pack/... and the check script (api/odk/util/check.pl). The check script provide a first simple content check of the SDK at the end of the build.

Last update: 25-Sep-2003