summaryrefslogtreecommitdiff
path: root/odk/docs
AgeCommit message (Collapse)AuthorFilesLines
2024-05-04tdf#160924: SDK: typo SDK_HOME instead of OO_SDK_HOME for linuxJulien Nabet1-1/+1
Change-Id: I8ec2bc31b19cc6b724a6f7ea3238dda8cf60d4b7 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/167111 Tested-by: Jenkins Reviewed-by: Julien Nabet <serval2412@yahoo.fr>
2024-03-18Add a notice about "published" to the IDL API documentation main pageMike Kaganski1-0/+5
Users don't realize that they may see not only published interfaces there. Seen e.g. on https://ask.libreoffice.org/t/103621 Change-Id: Id93bb12c1871fcfe85b71be01be0995ee2a83ded Reviewed-on: https://gerrit.libreoffice.org/c/core/+/164962 Tested-by: Jenkins Reviewed-by: Mike Kaganski <mike.kaganski@collabora.com>
2024-03-13tdf#160180: bump copyright year to 2024Julien Nabet2-2/+2
Change-Id: I466b8f86e8a53a238ed2ce2d2b053dc519ff8eed Reviewed-on: https://gerrit.libreoffice.org/c/core/+/164794 Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com> Tested-by: Julien Nabet <serval2412@yahoo.fr>
2023-06-29Point to LO DevGuide instead of OOoSamuel Mehrbrodt1-2/+2
Change-Id: Ib8ac0a69491f4cab3fbb1b4ba7ab29e55d3c8350 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/153774 Tested-by: Jenkins Reviewed-by: Samuel Mehrbrodt <samuel.mehrbrodt@allotropia.de>
2023-01-01Bump copyright year to 2023Adolfo Jayme Barrientos2-2/+2
Change-Id: I699112a3e554013bab75b82d1eae00098216c886 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/144893 Tested-by: Jenkins Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
2022-06-10[API CHANGE] Remove deprecated idlc and regmerge from the SDKStephan Bergmann1-143/+1
* Client code must replace uses of idlc and regmerge with uses of unoidl-write, see the changes to odk/examples/ and ure/source/uretext/ in 40f2aee6584eafcf4cd1d95fcf1f775e5435440d "Provide unoidl-write also for the SDK" for examples. * The new types.rdb format is not compatible with LibreOffice < 4.1. Clients generating extensions containing such files are advised to use appropriate LibreOffice-minimal-version elements. * For compatibility with old extensions, reading the legacy types.rdb format is still supported. * The SDK no longer ships an idl/ sub-directory containing the udkap and offapi .idl files (as, unlike idlc, unoidl-write does not need them). odk/config/cfgWin.js had to be adapted to look (somewhat arbitrarily) for an examples/ sub-directory instead of idl/ when checking for "an sdk folder". gb_UnoApi_package_idlfiles became unused and has been removed. * The idlc and regmerge executables have been removed. Module idlc has been removed except for idlc/test/parser/, which is also used by CustomTarget_unoidl/unoidl-write_test, and which may eventually be moved into module unoidl. Module external/ucpp and the corresponding configure options have also been removed. Change-Id: I42a0231699b863b5ebe2bee63bc32c8f79278cc1 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/122363 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2022-04-12odk: update DevGuide wiki links and correct history in footerIlmari Lauhakangas1-5/+3
Change-Id: I95c78d1346d354b755aeecaa1e6c9d789be0b693 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/132905 Tested-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org> Reviewed-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org>
2022-04-12Fix unoidl-read invocationStephan Bergmann1-1/+1
...that had inadvertently been missing from bb64cd2884beb03a2d578ada10abdb3e0df22778 "Add unoidl-read to the SDK" Change-Id: I4003e1dede9c8d6caf036534f4c3d0e59a24da14 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/132903 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2022-04-11Add unoidl-read to the SDKStephan Bergmann2-1/+56
...as a replacement for the legacy regview Change-Id: I1e1eecb45f27422727f28feb19c2479af867bd79 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/132816 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2022-04-11Drop duplicate regmerge/regview itemsStephan Bergmann1-15/+2
...that had been added with 26db47abd059a1482bd03df937314f4645c38ece "CWS-TOOLING: integrate CWS jsc312", probably due to a mis-merge. (The first occurrences had been updated over time, and the second ones not, but lets keep the second ones, properly updated, as that matches the order in which the tools' full descriptions appear further down below.) Change-Id: I725105e926a5761c210c5901e00179ea9a1b6b5e Reviewed-on: https://gerrit.libreoffice.org/c/core/+/132812 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2022-04-11Remove unmotivated horizontal separatorStephan Bergmann1-3/+0
...that had been added with 00bb4bff5cc42f702cb587b47bbdb92b226791ce "INTEGRATION: CWS sdksample", for unclear reasons Change-Id: I2931ecb6f1876d7e99b4706b1fd39f9b8761c68e Reviewed-on: https://gerrit.libreoffice.org/c/core/+/132807 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2022-04-11odk: update DevGuide wiki links after import into TDF wikiIlmari Lauhakangas3-2905/+2910
Change-Id: I5a698250db7e822f8d95ff43d87705df05f91c47 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/132784 Tested-by: Jenkins Reviewed-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org>
2022-04-09Introduce `unoidl-read --summary` modeStephan Bergmann1-1/+1
...as needed by odk/docs/idl/wikilinks.py Change-Id: I6dd096338e9f200679810d33e89c8b9ce18f69f4 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/132752 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2022-02-25Provide unoidl-write also for the SDKStephan Bergmann1-16/+89
...after the new types.rdb format that unoidl-write generates has been used internally since LibreOffice 4.1 in 2013; following up on 6db34b6b33ba8e3b13683efd05df8441b87e9c92 "Directly build UNOIDL .rdb files from .idl files" and its "The legacy tools idlc, regcompare, regmerge, and regview are still contained in the URE or SDK for now." The tools idlc and regmerge are deprecated but still shipped in the SDK for now. The plan is to drop them completely for LO 7.5. odk/examples/ and ure/source/uretest/ are adapted to use unoidl-write instead of idlc and regmerge: * unoidl-write does not use a C preprocessor and the # directives in .idl files, it supports reading a single .idl file (containing an arbitrary number of declarations) or a directory tree where each directory corresponds to a UNOIDL module of the same name and each .idl file contains the declaration of the (non-module) UNOIDL entity of the same name. For some of the odk/examples/, that required moving individual .idl files into sub-directories named after the respective modules. In odk/settings/std.mk, definitinos of IDL and REGMERGE have been replaced with a new UNOIDLWRITE. * unoidl-write always enforces reserved UNOIDL identifier restrictions (see 04af4e4f55f3ef319a78edd4d0109e2e7eba90b6 "[API CHANGE] Fix all bad UNOIDL identifiers across offapi" and 620179240670bd00f60555f1f5c5b0268492f97c "Enforce the UNOIDL identifier scheme") (which idlc only enforced optionally with -cid -we). That required renaming "my_module" in odk/examples/DevelopersGuide/Components/CppComponent/. * The new types.rdb format is not compatibly with LibreOffice < 4.1. Clients generating extensions containing such files are advised to use appropriate LibreOffice-minimal-version elements. Change-Id: I1a248fd96e86ecbf407f829bc100d44bfe7f4e7d Reviewed-on: https://gerrit.libreoffice.org/c/core/+/130533 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2021-01-01Bump copyright year to 2021Adolfo Jayme Barrientos2-2/+2
Change-Id: Icbb000677066127fa67e8c22fb0ab6880acc0169
2021-09-17tdf#143550 - use the term "gluepoints" consistentlyrocso1-1/+1
Change-Id: Id10dc2ef13f54a148a800003cc4bd88ca1a0056f Reviewed-on: https://gerrit.libreoffice.org/c/core/+/122233 Tested-by: Jenkins Reviewed-by: Heiko Tietze <heiko.tietze@documentfoundation.org>
2021-07-01Update documentation for uno executableSamuel Mehrbrodt1-2/+2
After -r parameter was removed with 5a1d51139c580dc64578d36dc1b4a31a4e5e0ef8 Change-Id: I1961f35ea375e7fd7426958275de0809c8fc9e2d Reviewed-on: https://gerrit.libreoffice.org/c/core/+/118087 Tested-by: Jenkins Reviewed-by: Samuel Mehrbrodt <samuel.mehrbrodt@allotropia.de>
2021-01-03Bump copyright year to 2021Adolfo Jayme Barrientos2-2/+2
Change-Id: I3159bfc21a35fc80aef57c7d809d8ea8c62a732e Reviewed-on: https://gerrit.libreoffice.org/c/core/+/108566 Tested-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com> Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
2020-05-06Move all public Java classes to libreoffice.jarSamuel Mehrbrodt1-2/+1
This moves the classes from juh.jar and ridl.jar to libreoffice.jar The goal is to have one single jar (and Java module, will be added later) which developers can include to work with LO. juh.jar and ridl.jar are kept as basically empty jars with libreoffice.jar on its classpath to keep backwards compatibility. This is a continuation of ae855bf48163ff64d94cfc34aff8e37abdb5518d and a preparation to have Java 9 module support. Change-Id: Ifbbfb97f60373d14256e62ae3122913bd17d5bbb Reviewed-on: https://gerrit.libreoffice.org/c/core/+/91930 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2020-02-04tdf#117331 Merge jurt and unoil into ridlSamuel Mehrbrodt1-2/+0
jurt.jar and unoil.jar are kept as effectively empty jars, each with a Class-Path: ridl.jar in their meta-inf/manifest.mf, so that 3rd-party code loading them (with or without also loading ridl.jar) will still have access to their content. Conceptually, the UNOIDL entities in unoil.jar (corresponding to module offapi) are not part of the URE, but are now made available by URE's ridl.jar. This should probably not cause problems in practice. At least for now, we seal exactly those packages in ridl.jar that were originally sealed in jurt.jar. Ideally, all of ridl.jar could be sealed now, but that would be mildly incompatible, as it would prevent 3rd-party code from introducing additional UNOIDL entities in the relevant namespaces (even if that is something we do not want 3rd-party code to do anyway). However, some JunitTest_jurt_* define classes in those sealed packages. In the past they got away with that by using gb_JunitTest_use_jar_classset,*,jurt. Instead they now need to gb_JunitTest_use_jar_classset,*,ridl and drop the gb_JunitTest_use_jar,*,ridl. But the former only makes available the classes that are specified in ridljar/Jar_ridl.mk with gb_Jar_add_sourcefiles, not the UNOIDL entities specified via gb_Jar_add_packagedirs. But the tests need the udkapi UNOIDL entities, so introduce gb_JunitTest_add_classpath to let the tests get them explicitly. (Curiously, JunitTest_jurt_uno and JnitTest_jurt_util use gb_JunitTest_use_jar_classset,*,jurt but don't seem to acutally need it; lets leave that for a follow-up clean up.) As a follow-up clean up, relevant files could be moved from jurt/ to ridljar/. Change-Id: I836f4e7bb47fb41f1306e3f223da90dba988eb9a Co-authored-by: Stephan Bergmann <sbergman@redhat.com> Reviewed-on: https://gerrit.libreoffice.org/c/core/+/84946 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2020-01-17odk: docs: remove the confusing sentence about "user installation"Michael Stahl1-2/+1
Better not mention an undefined term than to leave people guessing what it means. Change-Id: I589475303e215bd12cdc92e0f858d048052b6da6 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/86987 Reviewed-by: Michael Stahl <michael.stahl@cib.de> Tested-by: Michael Stahl <michael.stahl@cib.de>
2020-01-02Bump copyright year to 2020Adolfo Jayme Barrientos2-2/+2
Change-Id: I6fb736591f32907c8977fbac8fbf1dcbaef1bb97 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/86092 Tested-by: Jenkins Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
2019-12-18Fix typoAndrea Gelmini1-1/+1
Change-Id: Ia721484c9c39d62e939bb3f5628c8dcaa89d5603 Reviewed-on: https://gerrit.libreoffice.org/85417 Reviewed-by: Julien Nabet <serval2412@yahoo.fr> Tested-by: Julien Nabet <serval2412@yahoo.fr>
2019-12-18Fix instructions for setting up the SDKStephan Bergmann1-5/+16
(see the mail thread starting at <https://lists.freedesktop.org/archives/libreoffice/2019-December/084013.html> "Beginner's question about installing Libreoffice SDK") Change-Id: Iea0c394ec052587cdf4ba2a6a7ab38f4214ccbf0 Reviewed-on: https://gerrit.libreoffice.org/85374 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2019-12-17Cosmetic documentation fixesStephan Bergmann1-10/+10
consolidate on "Linux", "macOS", "Unix-like systems", "Windows", "Xcode" Change-Id: I448adee41cd557544b9c717ce7663c6fd08a7270 Reviewed-on: https://gerrit.libreoffice.org/85332 Tested-by: Jenkins Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2019-08-11Fixed "OfficeDocument"Matthias Seidel1-1/+1
(cherry picked from commit 856d28801b59d45cf4d32602adc57a08cd618b6d) Change-Id: Ie915588bda5930dc51a1484f20d0bbd9d955ec29 Reviewed-on: https://gerrit.libreoffice.org/77269 Tested-by: Jenkins Reviewed-by: Caolán McNamara <caolanm@redhat.com> Tested-by: Caolán McNamara <caolanm@redhat.com>
2019-07-24Fix typo 'a SDK'Andrea Gelmini1-1/+1
Partial revert of: https://gerrit.libreoffice.org/#/c/76028/4 Change-Id: I94173556f1dff21ff47245f8b632411fc8be1ff6 Reviewed-on: https://gerrit.libreoffice.org/76200 Tested-by: Jenkins Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
2019-05-10an uno -> a unoCaolán McNamara1-2/+2
Change-Id: I538db88f8477dd2d2ad25c372928fec6c11d979d Reviewed-on: https://gerrit.libreoffice.org/72105 Tested-by: Jenkins Reviewed-by: Caolán McNamara <caolanm@redhat.com> Tested-by: Caolán McNamara <caolanm@redhat.com>
2019-05-09par command does not allow n command in its first line(title)Tomoyuki Kubota1-1/+1
Doxygen used to allow this but there was a regression, which is apparently not being fixed: https://github.com/doxygen/doxygen/issues/6304 Change-Id: I7602236522a56c30a2249bd8065796b3c6458704 Reviewed-on: https://gerrit.libreoffice.org/70377 Reviewed-by: Michael Stahl <Michael.Stahl@cib.de> Tested-by: Michael Stahl <Michael.Stahl@cib.de>
2019-01-01Bump copyright year to 2019Adolfo Jayme Barrientos2-2/+2
Change-Id: I0d49ec7db57a0f7d18489dad61e86cbfdf4418cd
2018-09-15SDK: fix image URLs in docsAndras Timar1-52/+52
Change-Id: I2cac00a6da5602e4edbf9f6ca440f3a350e8dea7 Reviewed-on: https://gerrit.libreoffice.org/60540 Reviewed-by: Andras Timar <andras.timar@collabora.com> Tested-by: Andras Timar <andras.timar@collabora.com>
2018-01-01Bump copyright year to 2018Adolfo Jayme Barrientos2-2/+2
Change-Id: Iabd06fbda15d2f83f6ee0cdd37b268910d380476
2017-09-19odk: document what doxygen means by "Protected Member" in IDLMichael Stahl1-0/+9
Interfaces and services that are marked as "optional" in IDL are deliberately tagged as "Protected" by doxygen, while everything else is "Public", so that in the inheritance diagrams dashed lines are drawn for "optional" bases and solid lines for non-optional bases. Unfortunately this also causes doxygen to produce the text "Protected Members", which appears hard to change, so just document it for now. Change-Id: Ice878981bac5bbb7a8a33a10f2b5f68c394e4340
2017-08-17Fix typosAndrea Gelmini1-2/+2
Change-Id: Iaa9c0aea3ea1a239e378bd714ba335f91bb1faf3 Reviewed-on: https://gerrit.libreoffice.org/41194 Reviewed-by: Michael Stahl <mstahl@redhat.com> Tested-by: Michael Stahl <mstahl@redhat.com>
2017-08-17odk: oops, typo "have have"Michael Stahl1-1/+1
Change-Id: I3ab67d22985c8023da9db78ee085db07835aa2bf
2017-08-17tdf#107785 odk: document where to download the SDKMichael Stahl1-2/+22
Change-Id: I56368bc7e75671f170cce2360ac093e43b629e66
2017-07-21migrate to boost::gettextCaolán McNamara1-1/+0
* all .ui files go from <interface> to <interface domain="MODULE"> e.g. vcl * all .src files go away and the english source strings folded into the .hrc as NC_("context", "source string") * ResMgr is dropped in favour of std::locale imbued by boost::locale::generator pointed at matching MODULE .mo files * UIConfig translations are folded into the module .mo, so e.g. UIConfig_cui goes from l10n target to normal one, so the res/lang.zips of UI files go away * translation via Translation::get(hrc-define-key, imbued-std::locale) * python can now be translated with its inbuilt gettext support (we keep the name strings.hrc there to keep finding the .hrc file uniform) so magic numbers can go away there * java and starbasic components can be translated via the pre-existing css.resource.StringResourceWithLocation mechanism * en-US res files go away, their strings are now the .hrc keys in the source code * remaining .res files are replaced by .mo files * in .res/.ui-lang-zip files, the old scheme missing translations of strings results in inserting the english original so something can be found, now the standard fallback of using the english original from the source key is used, so partial translations shrink dramatically in size * extract .hrc strings with hrcex which backs onto xgettext -C --add-comments --keyword=NC_:1c,2 --from-code=UTF-8 --no-wrap * extract .ui strings with uiex which backs onto xgettext --add-comments --no-wrap * qtz for gettext translations is generated at runtime as ascii-ified crc32 of content + "|" + msgid * [API CHANGE] remove deprecated binary .res resouce loader related uno apis com::sun::star::resource::OfficeResourceLoader com::sun::star::resource::XResourceBundleLoader com::sun::star::resource::XResourceBundle when translating strings via uno apis com.sun.star.resource.StringResourceWithLocation can continue to be used Change-Id: Ia2594a2672b7301d9c3421fdf31b6cfe7f3f8d0a
2017-05-02Fix typosMuhammet Kara1-5/+5
Change-Id: Ib6a65c21916d808adfabb1c400937c4ebf12ce2d Reviewed-on: https://gerrit.libreoffice.org/37150 Reviewed-by: Cor Nouws <cor.nouws@documentfoundation.org> Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Julien Nabet <serval2412@yahoo.fr>
2017-02-22Fixed typos, HTML code cleanupMatthias Seidel1-3/+3
(cherry picked from commit b160330c34367bc355031a3850bb2910535049c4) Change-Id: I6fbcf51c1cd3112330cb39c04210a4bd6a4c73f8
2017-01-01Bump copyright year to 2017Adolfo Jayme Barrientos2-2/+2
Change-Id: I26ddcdd7bb9616c0599eec9101603d4be1ea4147
2016-05-23Mention removed options in javamaker and cppumakerSamuel Mehrbrodt1-2/+8
Change-Id: Ibba65c905a3a42053c4f844439a534b84a23089a Reviewed-on: https://gerrit.libreoffice.org/25150 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2016-03-23odk: remove PREDICTABLE_URLS from doxygen configChris Sherlock1-2/+0
Change-Id: Id3125481c6871176c2fd58dee3696482df88e7d3
2016-03-18Revert "odk: Doxygen configuration upgraded"Chris Sherlock1-315/+46
This reverts commit 6aa3e71bdd95b26cc807ae77ba6387fe80298001.
2016-03-18odk: Doxygen configuration upgradedChris Sherlock1-46/+315
Change-Id: I3abc336bad9bd06ed6569ca7a68c032df8e29877
2016-01-08Bump copyright year to 2016Adolfo Jayme Barrientos2-2/+2
Change-Id: Ifbd88aa55d5aa32a7b8dc11d7ac0310d0ef1e5d1
2015-07-03Fix typosAndrea Gelmini1-1/+1
Change-Id: I8e429d1f03aac7c7cdb7ff4b43b3f46d40292510 Reviewed-on: https://gerrit.libreoffice.org/16709 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Samuel Mehrbrodt <s.mehrbrodt@gmail.com> Tested-by: Samuel Mehrbrodt <s.mehrbrodt@gmail.com>
2015-06-16Fix typosAndrea Gelmini1-1/+1
Change-Id: Ieaf67cf597e05dbae5affa153af907fda4462a41 Reviewed-on: https://gerrit.libreoffice.org/16295 Reviewed-by: Michael Stahl <mstahl@redhat.com> Tested-by: Michael Stahl <mstahl@redhat.com>
2015-05-23tdf#91469: convert links in help/about to httpsJulien Nabet2-2/+2
Change-Id: I1274f75a49a999285488e99713782956e2287249 Reviewed-on: https://gerrit.libreoffice.org/15870 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com> Tested-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
2015-01-04odk: use HTML_TIMESTAMP doxygen optionMiklos Vajna2-0/+2
To be consistent with javadoc, see commit ac631f9ebddbc3674f9628d941e81a7ee73c6c66 (odk: use javadoc -notimestamp, so generated docs don't unnecessarily differ after each build, 2012-10-17). Change-Id: Ie52d2ca08a873e663869d60413be7bf8ec1e0b56
2015-01-01Bump copyright year to 2015Andras Timar2-4/+4
Change-Id: I18f2abfeee3b7e440aace632aec1296a1beab1f7
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-25 02:17:59 +0000