%PRODUCTNAME% API Documentation

# %PRODUCTNAME% API Documentation

| %PRODUCTNAME% %PRODUCT_RELEASE% software is a complete, feature-rich office productivity suite that provides, in combination with this SDK, all the essential tools for building and deploying custom solutions that build on, or integrate with, the %PRODUCTNAME% %PRODUCT_RELEASE% suite of products. The SDK is a development kit for %PRODUCTNAME% %PRODUCT_RELEASE%, which eases the development of office components. It provides a set of libraries, binaries, header, and IDL files which have final API's and can only be extended with new functionality. This set of libraries and binaries is the minimum set of functions needed to use system abstraction for base functionality and for using UNO (Universal Network Objects) component technology. The UNO component model is the base of the whole Office API. The SDK provides everything necessary to use the Office API from external programs (e.g. Java, C++) or to extend the Office functionality with new components (e.g. new filter components, CalcAddin functions). It is compatible over several versions because the API remains unaffected and will only be extended with new functions. The SDK provides the basic building blocks for external developers to develop components in any language for which a binding exists. Currently, there are language bindings for %PRODUCTNAME% %PRODUCT_RELEASE% Basic, Java, Python, and different C++ compilers on different platforms, for %PRODUCTNAME% %PRODUCT_RELEASE%, thus covering the 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, x86), and Windows. The SDK also contains reference documentation for the API and a complete Developer's Guide is available online in TDF Wiki, with lots of examples, which introduce the API, explain the concepts behind it, and make it possible for all users to quickly get started with the Office API. |
Content
| Installation Guide | An overview of all necessary installation steps (e.g. environment variables) to use this SDK.
| Developer's Guide | Detailed documentation, explaining the %PRODUCTNAME% %PRODUCT_RELEASE% API and the concepts behind it, with a rich set of examples, implemented mainly in Java. This documentation is online in TDF Wiki.
| IDL Reference | Complete %PRODUCTNAME% %PRODUCT_RELEASE% API reference.
| Java UNO Runtime Reference | Reference documentation of the Java UNO runtime API.
| C++ Reference | 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.
| Development Tools | Overview and a short description of the UNO development tools.
| Examples | A collection of examples in different programming languages (Java, Python, C++, Basic, OLE, CLI).
| Additional Examples | A git repository with additional examples from various contributors: `git clone https://gerrit.libreoffice.org/sdk-examples`
| OASIS Open Document Format for Office Applications (OpenDocument) TC | Link to the OASIS Open Document Format for Office Applications (OpenDocument) Technical Committee where you can find the latest information about the OASIS Open Document XML file format which is the default document format for %PRODUCTNAME% %PRODUCT_RELEASE%.
| OpenOffice.org XML File Format | Specification of the initial OpenOffice.org XML File Format.
| License | The license for the %PRODUCTNAME% %PRODUCT_RELEASE% SDK.