office-gobmx/odk
Hossein 1305edfbc2 tdf#149256 Ship LibreOfficeKit headers in packages
With LibreOfficeKit (LOK) headers in place, it would be possible to
create C++ applications that can access LibreOffice functionality
without building LibreOffice, only by installing SDK and build tools.

Change-Id: I8efc8ac1cec7b3b89e4d7eb2c8d15afeb595672c
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/134863
Tested-by: Hossein <hossein@libreoffice.org>
Tested-by: Jenkins
Reviewed-by: Hossein <hossein@libreoffice.org>
2024-06-23 19:57:30 +02:00
..
config
docs tdf#160924: SDK: typo SDK_HOME instead of OO_SDK_HOME for linux 2024-05-04 12:16:29 +02:00
examples Fix typo 2024-06-05 14:52:40 +02:00
qa/checkapi
settings odk: don't run compiler -dumpversion for eaach include of settings.mk 2024-05-28 14:10:29 +02:00
source tdf#97448 Add helper script to generate Addons.xcu 2024-04-25 10:58:49 +02:00
util
build-examples_common.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
CppunitTest_odk_checkapi.mk tdf#149256 Ship LibreOfficeKit headers in packages 2024-06-23 19:57:30 +02:00
CustomTarget_allheaders.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
CustomTarget_build-examples.mk tdf#143122 Port Java TerminationTest example to C++ 2024-04-30 15:01:19 +02:00
CustomTarget_build-examples_java.mk tdf#143123 Port Java clipboard examples to Python 2024-06-05 01:45:19 +02:00
CustomTarget_check.mk .NET Bindings: Switch for old windows CLI bindings 2024-06-22 00:11:16 +02:00
CustomTarget_classes.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
CustomTarget_config_win.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
CustomTarget_doxygen.mk use windows doxygen in wsl-as-helper case 2024-05-07 17:08:44 +02:00
CustomTarget_html.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
CustomTarget_javadoc.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
CustomTarget_settings.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
Executable_unoapploader.mk
GeneratedPackage_odk_doxygen.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
GeneratedPackage_odk_javadoc.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
GeneratedPackage_uno_loader_classes.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
index.html tdf#160180: bump copyright year to 2024 2024-03-13 22:55:18 +01:00
index_online.html tdf#160180: bump copyright year to 2024 2024-03-13 22:55:18 +01:00
Makefile
Module_odk.mk .NET Bindings: Switch for old windows CLI bindings 2024-06-22 00:11:16 +02:00
Package_cli.mk
Package_config.mk
Package_config_win.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
Package_docs.mk
Package_examples.mk tdf#143123 Port Java clipboard examples to Python 2024-06-05 01:45:19 +02:00
Package_html.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
Package_odk_headers.mk tdf#149256 Ship LibreOfficeKit headers in packages 2024-06-23 19:57:30 +02:00
Package_odk_headers_generated.mk
Package_scripts.mk tdf#97448 Add helper script to generate Addons.xcu 2024-04-25 10:58:49 +02:00
Package_settings.mk
Package_settings_generated.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
Package_share_readme.mk makefile simplification: replace $(call gb_CustomTarget_get_workdir,foo) 2024-05-03 16:06:14 +02:00
Package_share_readme_generated.mk
README.md odk/README.md: easy way to build examples on Linux and macOS 2024-05-10 07:18:25 +02:00

Office Development Kit (odk)

Office development kit (odk) - implements the first step on the way to the LibreOffice SDK tarball.

Part of the SDK; to build you need to add --enable-odk.

Testing the Examples:

  • The easiest way on Linux and macOS is to run make odk.subsequentcheck

  • The way that also works on Windows is to go to instdir/sdk (don't try directly in odk/)

  • See https://api.libreoffice.org/docs/install.html how to set up the SDK.

    • When asked about it during configuration, tell the SDK to do automatic deployment of the example extensions that get built.
  • In a shell set up for SDK development, build (calling make) and test (following the instructions given at the end of each make invocation) each of the SDK's examples/ sub-directories.

    • An example script to build (though not test) the various examples in batch mode is

      find examples \( -type d -name nativelib -prune \) -o \ \( -name Makefile -a -print -a \( -execdir make \; -o -quit \) \)

      (Note that one of the example extensions asks you to accept an example license on stdin during deployment.)