This is an automated email from the ASF dual-hosted git repository. jimjag pushed a commit to branch cleaned-up in repository https://gitbox.apache.org/repos/asf/openoffice-org.git
commit 8e46804664d2204302bc08ed4b47e13b92f5d163 Author: Jim Jagielski <[email protected]> AuthorDate: Wed Oct 14 16:37:22 2026 -0400 Update the API pages and archive dead search and tools pages --- .../part2}/content/api/project_tools.html | 0 .../part2}/content/api/searchresults.html | 0 .../part2}/content/api/under_construction.html | 0 .../api/DevelopersGuide/DevelopersGuide.html | 4 +- part2/content/api/Misc/index.html | 7 +- .../api/Projects/NetBeansIntegration/index.html | 4 +- part2/content/api/Projects/OOoBean/index.html | 4 +- part2/content/api/SDK/buildguide.html | 28 +++---- part2/content/api/SDK/example_collection.html | 19 ++--- part2/content/api/SDK/index.html | 30 ++------ part2/content/api/SDK/snippets/index.html | 6 +- .../api/TipsAndTricks/cpp_uno_coding_hints.html | 2 +- part2/content/api/TipsAndTricks/external.html | 14 +--- part2/content/api/TipsAndTricks/index.html | 6 +- part2/content/api/TipsAndTricks/internal.html | 8 +- part2/content/api/common/designgoals.html | 4 +- part2/content/api/faq.html | 42 ++++------ part2/content/api/index.html | 89 +++------------------- part2/content/api/listrules.html | 39 ++++------ part2/content/api/modules.html | 10 --- 20 files changed, 94 insertions(+), 222 deletions(-) diff --git a/part2/content/api/project_tools.html b/archive/part2/content/api/project_tools.html similarity index 100% rename from part2/content/api/project_tools.html rename to archive/part2/content/api/project_tools.html diff --git a/part2/content/api/searchresults.html b/archive/part2/content/api/searchresults.html similarity index 100% rename from part2/content/api/searchresults.html rename to archive/part2/content/api/searchresults.html diff --git a/part2/content/api/under_construction.html b/archive/part2/content/api/under_construction.html similarity index 100% rename from part2/content/api/under_construction.html rename to archive/part2/content/api/under_construction.html diff --git a/part2/content/api/DevelopersGuide/DevelopersGuide.html b/part2/content/api/DevelopersGuide/DevelopersGuide.html index fd45e36593..e69bdf28cd 100644 --- a/part2/content/api/DevelopersGuide/DevelopersGuide.html +++ b/part2/content/api/DevelopersGuide/DevelopersGuide.html @@ -1,5 +1,5 @@ <html><head> -<meta http-equiv="refresh" content="6; URL=http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide";> +<meta http-equiv="refresh" content="6; URL=https://wiki.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide";> <title>Developer's Guide</title> </head> <body> @@ -7,7 +7,7 @@ <h1>The Developer's Guide has moved into the Wiki</h1> <p>The Developer's Guide has moved into the OpenOffice.org wiki. You will be redirected automatically in a few seconds. - If you encounter any problems please click <a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide";>Developer's Guide</a> manually.</p> + If you encounter any problems please click <a href="https://wiki.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide";>Developer's Guide</a> manually.</p> <p>Currently no PDF version is available but we hope that we can provide a new generated version based on the wiki content in the near future. The advantage of the wiki is that the guide will be more uptodate and it can be easier maintained. diff --git a/part2/content/api/Misc/index.html b/part2/content/api/Misc/index.html index fd232c02e6..398c97ec24 100644 --- a/part2/content/api/Misc/index.html +++ b/part2/content/api/Misc/index.html @@ -10,14 +10,13 @@ <p>The following sections are currently available:</p> <ul> -<li><a href="../under_construction.html">Developer Projects</a> - <dd>An overview of ongoing projects and a list of possibilities how you can contribute to our - api.openoffice.org project. +<li><a href="https://wiki.openoffice.org/wiki/API/To-Dos";>Developer Projects</a> + <dd>An overview of ongoing projects and a list of possibilities how you can contribute to the API project. <li><a href="../listrules.html">Mailing List Rules</a> <dd>A brief description of some kind of guidelines for our mailing lists. </ul> <hr style="width: 100%; height: 1px;"> -<i>Last update: 26-Aug-2003</i></body> +<i>Last update: 14-Oct-2026</i></body> </html> diff --git a/part2/content/api/Projects/NetBeansIntegration/index.html b/part2/content/api/Projects/NetBeansIntegration/index.html index 51ce6f862a..944702a16e 100644 --- a/part2/content/api/Projects/NetBeansIntegration/index.html +++ b/part2/content/api/Projects/NetBeansIntegration/index.html @@ -1,5 +1,5 @@ <head> -<meta http-equiv="Refresh" content="5; URL=http://wiki.services.openoffice.org/wiki/OpenOffice_NetBeans_Integration";> +<meta http-equiv="Refresh" content="5; URL=https://wiki.openoffice.org/wiki/OpenOffice_NetBeans_Integration";> </head> <h1>OpenOffice.org API plugin for NetBeans</h1> @@ -7,5 +7,5 @@ <p>OpenOffice.org API plugin for NetBeans ...</p> <p>If this page will not be redirected please use this link to find the plugin homepage -<a href="http://wiki.services.openoffice.org/wiki/OpenOffice_NetBeans_Integration";>OpenOffice.org API plugin for NetBeans</a></p> +<a href="https://wiki.openoffice.org/wiki/OpenOffice_NetBeans_Integration";>OpenOffice.org API plugin for NetBeans</a></p> diff --git a/part2/content/api/Projects/OOoBean/index.html b/part2/content/api/Projects/OOoBean/index.html index fdfa555322..76b0bfef03 100644 --- a/part2/content/api/Projects/OOoBean/index.html +++ b/part2/content/api/Projects/OOoBean/index.html @@ -1,9 +1,9 @@ <head> -<meta http-equiv="Refresh" content="5; URL=http://wiki.services.openoffice.org/wiki/OOoBean";> +<meta http-equiv="Refresh" content="5; URL=https://wiki.openoffice.org/wiki/OOoBean";> </head> <h1>OOoBean Project Homepage</h1> <p>This project is integrated into OpenOffice.org 2.0. More information can be found in the OpenOffice.org wiki.</p> -<p>If this page will not be redirected automatically please use this link <a href="http://wiki.services.openoffice.org/wiki/OOoBean";>OOoBean</a> to find the bean homepage</p> +<p>If this page will not be redirected automatically please use this link <a href="https://wiki.openoffice.org/wiki/OOoBean";>OOoBean</a> to find the bean homepage</p> diff --git a/part2/content/api/SDK/buildguide.html b/part2/content/api/SDK/buildguide.html index 7139d9647a..d36aabd943 100644 --- a/part2/content/api/SDK/buildguide.html +++ b/part2/content/api/SDK/buildguide.html @@ -1,17 +1,17 @@ <!DOCTYPE html> <html><head> -<title>OpenOffice.org Software Development Kit (SDK) Build Guide</title> +<title>Apache OpenOffice 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> +<h1>Apache OpenOffice 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>The Apache OpenOffice Software Development Kit (SDK) can be built as a normal code module in the + Apache OpenOffice 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 +<li>the main part of the SDK is build in the <b>odk</b> module. In this module everything is collected that is part of the SDK. <ul> <li>header files @@ -28,10 +28,10 @@ </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: +tools). So it is recommended to build the SDK at the end of a normal build. If the SDK should be built +on base of an existing <b>solenv</b>, you have at least to check out the two modules: <ol> -<li><b>api/odk</b> +<li><b>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 @@ -41,20 +41,20 @@ trigger a SDK packaging process directly. <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 +SDK without any complex Apache OpenOffice 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 +<li>check the <b>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>. +<li>to provide a configure/setsdkenv script or to adopt the existing ones in the root of <b>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 +If it is necessary to insert new files, it is necessary to adopt the packaging makefiles (<b>odk/pack/...</b> +and the check script (<b>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> +<i>Last update: 14-Oct-2026</i> </body> </html> diff --git a/part2/content/api/SDK/example_collection.html b/part2/content/api/SDK/example_collection.html index 5c05069dfc..f85ef66f39 100644 --- a/part2/content/api/SDK/example_collection.html +++ b/part2/content/api/SDK/example_collection.html @@ -8,22 +8,15 @@ <h1>Example Collection</h1> -<p>The following is a collection of examples additionally to the SDK examples showing the use of the OpenOffice.org API in the different application - areas. Take this as start point searching a solution for your own problems or use cases. You can help us to improve this example collection by - contributing own examples or code snippets. -</p> - -<h2>Complete Code Examples</h2> - -<p>Examples with complete source code which can be compiled or which are embedded into OOo documents, belong into this chapter. +<p>The SDK contains examples showing the use of the Apache OpenOffice API in different application + areas, in Java, C++, C# and VB.NET (CLI), OLE and OpenOffice Basic. Take them as a start point when + searching a solution for your own problems or use cases. </p> <ul> - <li>Java examples - <li>C++ examples - <li>OpenOffice.org Basic examples - <li>OLE examples - <li>Python examples + <li><a href="https://github.com/apache/openoffice/tree/trunk/main/odk/examples";>SDK examples</a> in the source tree + <li><a href="https://wiki.openoffice.org/wiki/API/Samples";>API Samples</a> in the wiki + <li><a href="https://wiki.openoffice.org/wiki/API/Tutorials";>API Tutorials</a> in the wiki </ul> </body> diff --git a/part2/content/api/SDK/index.html b/part2/content/api/SDK/index.html index 2e661b3641..17083da7bc 100644 --- a/part2/content/api/SDK/index.html +++ b/part2/content/api/SDK/index.html @@ -17,9 +17,8 @@ OpenOffice API concepts, the OpenOffice UNO component model and how to use the A of the different application areas. At the close of each chapter, there is at least one example that shows how to use the API. </p> -<p>Interested developers should start using this SDK for their implementations. Feedback is welcome via -email on <a href="mailto:[email protected]";>[email protected]</a>, and bugs should be reported -as an <a href="https://www.openoffice.org/project_issues.html";>IssueZilla</a> task. +<p>Interested developers should start using this SDK for their implementations. Feedback is welcome on the <a href="https://openoffice.apache.org/mailing-lists.html#api-mailing-list-public";>API mailing list</a>, and bugs should be reported +in <a href="https://bz.apache.org/ooo/";>Bugzilla</a>. All requests for enhancement and new features will be collected and go into the planning of future versions of the SDK. </p> @@ -40,36 +39,23 @@ programmability features. <li><a href="../docs/cpp/ref/names/index.html">C/C++</a> and <a href="../docs/java/ref/overview-summary.html">Java</a> UNO reference documentation. <li>development tools -<li>examples in Java, C++, OpenOffice Basic +<li>examples in Java, C++, C#, VB.NET, OLE and OpenOffice Basic <li>minimal build environment for the examples <li>run targets in the makefiles for easy running the examples -<li>use of the new deployment tool to integrate new components or Basic libraries in an existing office +<li>use of the <code>unopkg</code> deployment tool to integrate new components or Basic libraries in an existing office installation. </ul> -<h2>Changes with the OpenOffice.org 3.0 SDK</h2> -<p>The initial plan was to integrate the SDK as an optional part in the office installation directly. In the last -minute we detected a high increase of the build time (packaging) because of the huge amount of files. That was -not accpetable and we changed the initial plan. The SDK is still available as separate download.</p> -<p> Because of this last minute change the installation especially under windows is not perfect. The setup suggests -to install the SDK under the new base layer which is recommneded. Otherwise the configuration works not properly. -This will change in the future.</p> -<p>Anyway the installation differs on the different platforms. On Mac OSX the SDK is completely separated because of -the strcuture with the application bundle. On Windows and the other UNIX platforms the SDK is installed as a sub -directory in the new base layer (introduced in OpenOffice.org 3.0) and is shared between different installations -based on the same base layer.<p> -<ul> -<li>Windows: c:/Program Files/OpenOffice.org/Basis 3.0/sdk -<li> Mac OSX: /<somewhere>/OpenOffice.org3.0_SDK -<li> Linux|Solaris (Unix general): /opt/openoffice.org/basis3.0/sdk. -</ul> +<h2>Installation</h2> +<p>The SDK is a separate download. It is installed into its own directory, separate from the office +installation.</p> <h2>Building the SDK</h2> <p>All people who want to build a SDK from scratch should take account of the <a href="buildguide.html" title="link to the SDK build guide">SDK build guide</a>. <hr style="width: 100%; height: 1px;"> -<i>Last update: 11-Aug-2008</i> +<i>Last update: 14-Oct-2026</i> </body> </html> diff --git a/part2/content/api/SDK/snippets/index.html b/part2/content/api/SDK/snippets/index.html index 6049554ebf..bca0ff3ec1 100644 --- a/part2/content/api/SDK/snippets/index.html +++ b/part2/content/api/SDK/snippets/index.html @@ -6,14 +6,14 @@ <body> <h1>Code Snippets</h1> -<p>This is a collection of code snippets collected mostly from questions and answers from the mailing list [email protected].</p> +<p>This is a collection of code snippets collected mostly from questions and answers from the mailing list [email protected].</p> <h2>Categories</h2> -<p>We have already collected several code snippets and under the <a href="http://codesnippets.services.openoffice.org/"; title="Code Snippet Base">Code Snippet Base</a> you can see the for what the snippets are good for!</p> +<p>The Code Snippet Base that used to host the collected snippets is no longer online.</p> <h2>How to Contribute</h2> -<p>We strongly encourage everybody who asks a question on [email protected] and who gets sufficient answers to summarize the answers either with the <a href="SnippetCreator-20060320.uno.pkg">snippet creator</a> or manually in the following template and send the xml code snippet (<a href="../../Examples/Snippets/CodeSnippet.dtd" title="Codesnippet DTD">DTD for validation</a>) to [email protected]:</p> +<p>We strongly encourage everybody who asks a question on [email protected] and who gets sufficient answers to summarize the answers either with the <a href="SnippetCreator-20060320.uno.pkg">snippet creator</a> or manually in the following template and send the xml code snippet (<a href="../../Examples/Snippets/CodeSnippet.dtd" title="Codesnippet DTD">DTD for validation</a>) to [email protected]:</p> <table width="100%" border="1" cellspacing="0" cellpadding="0"> <tr><td> diff --git a/part2/content/api/TipsAndTricks/cpp_uno_coding_hints.html b/part2/content/api/TipsAndTricks/cpp_uno_coding_hints.html index b79d5ce085..0c6ba56b27 100644 --- a/part2/content/api/TipsAndTricks/cpp_uno_coding_hints.html +++ b/part2/content/api/TipsAndTricks/cpp_uno_coding_hints.html @@ -5,7 +5,7 @@ </head> <body> <div style="border: 1px solid #FF9900; background-color:#FFCC99;"> -This page might be outdated, please reffer to the <a href="http://wiki.openoffice.org/wiki/Cpp_Coding_Standards";>Apache OpenOffice wiki</a> for a more current information. +This page might be outdated, please reffer to the <a href="https://wiki.openoffice.org/wiki/Cpp_Coding_Standards";>Apache OpenOffice wiki</a> for a more current information. </div> <h1>C++ UNO Coding Hints</h1> diff --git a/part2/content/api/TipsAndTricks/external.html b/part2/content/api/TipsAndTricks/external.html index f65f69b4fc..b0bf8af164 100644 --- a/part2/content/api/TipsAndTricks/external.html +++ b/part2/content/api/TipsAndTricks/external.html @@ -11,14 +11,6 @@ <p>We do not necessarily endorse the linked external sites.</p> <ul> -<li><a href="http://web.mit.edu/soffice_v8.0/pdfdoc/staroffice-BASIC.pdf";>StarOffice 8 Programming Guide for Basic</a><br> - This document provides an introduction in StarBasic and the API and provides a - lot of useful hints for migrating from a well known (other) Basic language to - StarBasic/OpenOffice.org Basic. - -<li><a href="http://docs.sun.com/app/docs/coll/1263.1?l=en";>Sun published StarOffice 8 documentation</a><br> - On this site you can find different documents around StarOffice published by Sun. - <li><a href="http://www.pitonyak.org/AndrewMacro.sxw";>Andrew Pitonyak's Macro Collection</a><br> This document provides the great OpenOffice.org Basic macro collection written by Andrew Pitonyak. Thanks to Andrew for this great contribution and his ongoing work on this document. @@ -26,17 +18,13 @@ <li><a href="http://www.darwinwars.com/lunatic/bugs/oo_macros.html";>Andrew Brown's Useful and Instructive macros</a><br> This site provides a collection of useful macros for OpenOffice.org. -<li>OpenOffice Documentation Project<br> - This site provides a lot of useful documentation for OpenOffice.org. - <li><a href="http://ooextras.sourceforge.net/";>OpenOffice Extras</a><br> This site provides a lot of useful stuff (e.g. templates) for OpenOffice.org. <li><a href="http://www.bytebot.net/openoffice/faq.html";>Unofficial FAQ's</a><br> This site provides a lot of frequently asked questions around OpenOffice.org. -<li><a href="http://ooo.ximian.com/hackers-guide.html";>Unofficial OpenOffice Hacker's Guide</a> - This site provides a lot of useful hints and information around OpenOffice.org. + </ul> diff --git a/part2/content/api/TipsAndTricks/index.html b/part2/content/api/TipsAndTricks/index.html index 0620a0ebe8..753c799fda 100644 --- a/part2/content/api/TipsAndTricks/index.html +++ b/part2/content/api/TipsAndTricks/index.html @@ -6,7 +6,7 @@ <body> <h1>Tips and Tricks</h1> -<p>This is a collection of knowledge which you may find useful when working with the OpenOffice.org API and +<p>This is a collection of knowledge which you may find useful when working with the Apache OpenOffice API and the SDK. </p> @@ -15,7 +15,7 @@ <li><a href="../faq.html">Frequently Asked Questions</a> <dd>Questions which have been asked most often. <li><a href="internal.html">Internal OO Spots</a> - <dd>Links to interesting internal OpenOffice.org projects or documents. + <dd>Links to interesting internal Apache OpenOffice projects or documents. <li><a href="external.html">External Resources</a> <dd>Links to resources external to the API project. <li><a href="cpp_uno_coding_hints.html">C++ UNO Coding Hints</a> @@ -23,6 +23,6 @@ </ul> <hr style="width: 100%; height: 1px;"> -<i>Last update: 26-Aug-2003</i></body> +<i>Last update: 14-Oct-2026</i></body> </html> diff --git a/part2/content/api/TipsAndTricks/internal.html b/part2/content/api/TipsAndTricks/internal.html index 3c8d722703..40cb60580c 100644 --- a/part2/content/api/TipsAndTricks/internal.html +++ b/part2/content/api/TipsAndTricks/internal.html @@ -10,15 +10,15 @@ provides additionally useful information.</p> <ul> -<li><a href="https://udk.openoffice.org";>UNO Development Kit Project</a> +<li><a href="https://www.openoffice.org/udk/";>UNO Development Kit Project</a> <dd>This project provides information about UNO as the fundamental base for the OpenOffice API.</dd> -<li><a href="https://framework.openoffice.org/scripting/index.html";>Scripting Project</a> - <dd>This project provides information about the upcoming scripting framework.</dd></li> +<li><a href="https://www.openoffice.org/framework/scripting/index.html";>Scripting Project</a> + <dd>This project provides information about the scripting framework.</dd></li> <li><a href="https://wiki.openoffice.org/wiki/Main_Page";>OpenOffice Wiki</a> <dd>The OpenOffice Wiki provides a lot of useful information for developers and can probably be seen as the most important place for developers.</dd></li> <li><a href="https://extensions.openoffice.org";>Extensions Project</a> <dd>The OpenOffice Extensions project with focus on extensions development and an extensions repository.</dd></li> -<li><a href="https://development.openoffice.org/index.html";>OpenOffice for Developers</a> +<li><a href="https://www.openoffice.org/development/";>OpenOffice for Developers</a> <dd>This provides an useful entrance point for all who are interested in developing for OpenOffice or with the OpenOffice API.</dd></li> <li><a href="https://forum.openoffice.org/";>OpenOffice Community Forum</a> diff --git a/part2/content/api/common/designgoals.html b/part2/content/api/common/designgoals.html index 28dc564f13..90cce54ba0 100644 --- a/part2/content/api/common/designgoals.html +++ b/part2/content/api/common/designgoals.html @@ -8,7 +8,7 @@ <p> This API is version independent, scalable, durable, and reusable. And because -it is implemented using the OpenOffice.org component technology, it is +it is implemented using the Apache OpenOffice component technology, it is programming language independent as well. </p> @@ -22,7 +22,7 @@ this project. <p> Its version independence and durability results from the fact that we limit changes to the API. You can add interfaces, services, and so on to the -OpenOffice.org API. However, other changes are rather limited: +Apache OpenOffice API. However, other changes are rather limited: </p> <ul> diff --git a/part2/content/api/faq.html b/part2/content/api/faq.html index 40dc3befb0..448b0743db 100644 --- a/part2/content/api/faq.html +++ b/part2/content/api/faq.html @@ -7,30 +7,27 @@ <body> -<h2>FAQ on OpenOffice.org API</h2> +<h2>FAQ on Apache OpenOffice API</h2> <ul> -<li><a HREF="#languages">From which languages can I use the OpenOffice.org -API?</a> +<li><a HREF="#languages">From which languages can I use the Apache OpenOffice API?</a> <li><a HREF="#corba-idl">What is the difference between UNO IDL and CORBA?</a> <li><a HREF="#api-spec-size">What's the "size" of the API specification?</a> <li><a HREF="#documentation">How is the documentation of the API done?</a> <li><a HREF="#api-impl-size">What is the "size" of the API implementation?</a> <li><a HREF="#java-examples">Do you have any documentation or examples for Java programmers?</a> -<li><a HREF="#not-implemented">Why are there some interfaces in the OpenOffice.org -API which are not implemented in any OpenOffice.org component?</a> -<li><a HREF="#use-interfaces">How can I find out, if I actually can use a certain interface of the OpenOffice.org -API?</a> +<li><a HREF="#not-implemented">Why are there some interfaces in the Apache OpenOffice API which are not implemented in any Apache OpenOffice component?</a> +<li><a HREF="#use-interfaces">How can I find out, if I actually can use a certain interface of the Apache OpenOffice API?</a> <li><a HREF="#compound-docs">Are there interfaces to build compound documents like Microsoft's OLE?</a> <li><a HREF="#conflict-solving">How is conflict resolved on design issues?</a> -<li><a HREF="#my-role">What is your role, Michael Hönnig?</a> </ul> -<p><a NAME="languages"></a><img SRC="/branding/images/q.gif"> <font COLOR="#003399"><b>From which languages can I use the OpenOffice.org -API?</b></font> +<p><a NAME="languages"></a><img SRC="/branding/images/q.gif"> <font COLOR="#003399"><b>From which languages can I use the Apache OpenOffice API?</b></font> <br><br><table CELLPADDING=0 CELLSPACING=0 BORDER=0><tr><td VALIGN=TOP><img SRC="/branding/images/arrow.gif"></td><td> -OpenOffice.org implements the API with UNO (Universal Network Objects). Currently there are language bindings for Java and C++. You can implement your own language binding, and in fact we are actively looking for a volunteer to create a C language binding. - -<p>Additionally UNO allows control from scripting languages and scripting environments (for example debuggers). Currently StarBASIC (VBA syntax compatible) can call on the API and there is a prototype written for Python integration. +Apache OpenOffice implements the API with UNO (Universal Network Objects). The SDK supports Java and C++. Further language bindings are provided for Python (PyUNO) and for the .NET CLI (C# and VB.NET), and the API can be used from OLE automation clients. OpenOffice Basic (with VBA compatible syntax) can call the API directly. </td></tr></table> <p><img SRC="/branding/images/dotted_line.gif"><img SRC="/branding/images/dotted_line.gif"> @@ -48,13 +45,6 @@ UNO IDL is based on CORBA IDL, but additionally it supports <img src="/branding/images/small_blue_bullet.gif"> a new stereotype "service"<br>(combines interfaces and properties). </ul><br> -And currently it does not support: - -<ul> -<img src="/branding/images/small_blue_bullet.gif"> arrays as defined types<br><br> -<img src="/branding/images/small_blue_bullet.gif"> unions -</ul> - </td></tr></table> <p><img SRC="/branding/images/dotted_line.gif"><img SRC="/branding/images/dotted_line.gif"> @@ -64,7 +54,7 @@ And currently it does not support: <br><br><table CELLPADDING=0 CELLSPACING=0 BORDER=0><tr><td VALIGN=TOP><img SRC="/branding/images/arrow.gif"></td><td> -The API consists of about 2000 files, each specifying one type. A type in this respect can be a service, an interface, a struct, an exception, a constant group, or an enum. These files total in about 6 MB of data. +The API consists of about 4,200 IDL files, each specifying one type. A type in this respect can be a service, an interface, a struct, an exception, a constant group, or an enum. These files total in about 13 MB of data. </td></tr></table> <p><img SRC="/branding/images/dotted_line.gif"><img SRC="/branding/images/dotted_line.gif"> @@ -74,9 +64,9 @@ The API consists of about 2000 files, each specifying one type. A type in this r <br><br><table CELLPADDING=0 CELLSPACING=0 BORDER=0><tr><td VALIGN=TOP><img SRC="/branding/images/arrow.gif"></td><td> -A reference like documentation consists within the IDL files. The syntax of the documentation is based on JavaDoc with a few extensions to mark identifiers. We are currently developing a new generator for this syntax which will generate HTML documents directly from the IDLs. +A reference like documentation consists within the IDL files. The syntax of the documentation is based on JavaDoc with a few extensions to mark identifiers. The HTML reference documents are generated directly from the IDL files. -<p> Our <a href="DevelopersGuide/DevelopersGuide.html">Developers Guide</a> describes the concepts of all components within OpenOffice.org which have +<p> Our <a href="DevelopersGuide/DevelopersGuide.html">Developers Guide</a> describes the concepts of all components within Apache OpenOffice which have an API. It is the best resource to start learning about the API. <p> Additionally we have a <a href="basic/man/tutorial/tutorial.pdf">tutorial</a> for StarBASIC programmers. It explains the basic concepts, shows some UML diagrams of the component structure and has plenty of documented examples of the API usage. @@ -94,7 +84,7 @@ It's hard to impossible to find out. Currently the API implementation is just a wrapper to a core API for the most parts. Only newer components directly implement the API. Thus, there is really not much point in finding out how much code implements the API - and it even makes less sense in the future. - Depending on the perspective, we probably can say: The whole OpenOffice.org + Depending on the perspective, we probably can say: The whole Apache OpenOffice is an implementation of the API, especially because more and more features are using the API of other components for integration. </td> @@ -106,17 +96,17 @@ It's hard to impossible to find out. Currently the API implementation is just <br><br><table CELLPADDING=0 CELLSPACING=0 BORDER=0><tr><td VALIGN=TOP><img SRC="/branding/images/arrow.gif"></td><td> -In the <a HREF="http://udk.OpenOffice.org";>UDK project</a> you can find +In the <a HREF="https://www.openoffice.org/udk/";>UDK project</a> you can find documentation on the language binding for Java. There are some Java examples -in the <a HREF="http://soldc.sun.com/staroffice";>StarOffice SDK</a> which +in the <a HREF="SDK/index.html">SDK</a> which might be helpful for you. <p></p> </td></tr></table> -<p><a NAME="not-implemented"></a><img SRC="/branding/images/q.gif"> <font COLOR="#003399"><b>Why are there some interfaces in the OpenOffice.org -API which are not implemented in any OpenOffice.org component?</b></font> +<p><a NAME="not-implemented"></a><img SRC="/branding/images/q.gif"> <font COLOR="#003399"><b>Why are there some interfaces in the Apache OpenOffice API which are not implemented in any Apache OpenOffice component?</b></font> <br><br><table CELLPADDING=0 CELLSPACING=0 BORDER=0><tr><td VALIGN=TOP><img SRC="/branding/images/arrow.gif"></td><td> -The OpenOffice.org -API is actually more like a specification than an API of a preexisting implementation. Thus there are at several reasons why there are interfaces without any implementation:<p></p> +The Apache OpenOffice API is actually more like a specification than an API of a preexisting implementation. Thus there are at several reasons why there are interfaces without any implementation:<p></p> <ol> <ol> @@ -131,7 +121,7 @@ The OpenOffice.org -API is actually more like a specification than an API of a p <p><img SRC="/branding/images/dotted_line.gif"><img SRC="/branding/images/dotted_line.gif"> -<p><a NAME="use-interfaces"></a><img SRC="/branding/images/q.gif"> <font COLOR="#003399"><b>How can I find out if I can use a certain interface of the OpenOffice.org -API?</b></font> +<p><a NAME="use-interfaces"></a><img SRC="/branding/images/q.gif"> <font COLOR="#003399"><b>How can I find out if I can use a certain interface of the Apache OpenOffice API?</b></font> <br><br><table CELLPADDING=0 CELLSPACING=0 BORDER=0><tr><td VALIGN=TOP><img SRC="/branding/images/arrow.gif"></td><td> @@ -146,7 +136,7 @@ Check for a service which exports this interface, then check for a component whi <br> <br><table CELLPADDING=0 CELLSPACING=0 BORDER=0><tr><td VALIGN=TOP><img SRC="/branding/images/arrow.gif"></td><td> -Within StarOffice API there are no interfaces right now for building compound documents. Our idea is to use the Bonobo model for this purpose. +Yes. The <code>com.sun.star.embed</code> module of the API provides interfaces for embedded objects and compound documents. </td></tr></table> <p><img SRC="/branding/images/dotted_line.gif"><img SRC="/branding/images/dotted_line.gif"> diff --git a/part2/content/api/index.html b/part2/content/api/index.html index 2121ce41be..ec95ea0e38 100644 --- a/part2/content/api/index.html +++ b/part2/content/api/index.html @@ -224,86 +224,21 @@ cellspacing="0"> <table width="100%" id="gethelp" cellspacing="25px" cellpadding="0" summary=""> <tr valign="top"> - <td width="50%"> <!-- SEARCH DOCUMENTATION --> - <div class="section2 showlinks" id="search" > - <img class="icon" src="images/search.png" alt="Search-icon" /> - <div class="sec_header">Search API related resources</div> + <td width="50%"> <!-- API REFERENCE --> + <div class="section2 showlinks" id="reference" > + <img class="icon" src="images/search.png" alt="Reference-icon" /> + <div class="sec_header">API Reference</div> <div class="sec_content"> <ul class="nobullet xsmall"> - <li class="doc_tip" id="searchwiki" onmouseover="showtip(this.id)" onmouseout="hidetip()"> - Complete API Wiki - <!-- Google CSE Search Box Begins --> - <form action="http://api.openoffice.org/searchresults.html"; id="cse-search-box"> - <input type="hidden" name="cx" value="001318689579221500783:whwt15senvu" /> - <input type="hidden" name="cof" value="FORID:11" /> - <input type="text" name="q" size="25" /> - <input type="submit" name="sa" value="Search" /> - </form> - <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en";></script> - <!-- Google CSE Search Box Ends --> - </li> - <li class="doc_tip" id="searchdevguide" onmouseover="showtip(this.id)" onmouseout="hidetip()"> - The Developer's Guide - <!-- Google CSE Search Box Begins --> - <form action="http://api.openoffice.org/searchresults.html"; id="cse-search-box"> - <input type="hidden" name="cx" value="001318689579221500783:mbgkvjjufdy" /> - <input type="hidden" name="cof" value="FORID:11" /> - <input type="text" name="q" size="25" /> - <input type="submit" name="sa" value="Search" /> - </form> - <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en";></script> - <!-- Google CSE Search Box Ends --> - </li> - <li class="doc_tip" id="searchapiref" onmouseover="showtip(this.id)" onmouseout="hidetip()"> - The Office API reference - <!-- Google CSE Search Box Begins --> - <form action="http://api.openoffice.org/searchresults.html"; id="searchbox_001318689579221500783:kq2v0al6wzk"> - <input type="hidden" name="cx" value="001318689579221500783:kq2v0al6wzk" /> - <input type="hidden" name="cof" value="FORID:11" /> - <input type="text" name="q" size="25" /> - <input type="submit" name="sa" value="Search" /> - </form> - <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_001318689579221500783%3Akq2v0al6wzk&lang=en";></script> - <!-- Google CSE Search Box Ends --> - </li> - <li class="doc_tip" id="searchjavaref" onmouseover="showtip(this.id)" onmouseout="hidetip()"> - The Java UNO API reference - <!-- Google CSE Search Box Begins --> - <form action="http://api.openoffice.org/searchresults.html"; id="searchbox_001318689579221500783:moxiakvz5zi"> - <input type="hidden" name="cx" value="001318689579221500783:moxiakvz5zi" /> - <input type="hidden" name="cof" value="FORID:11" /> - <input type="text" name="q" size="25" /> - <input type="submit" name="sa" value="Search" /> - </form> - <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_001318689579221500783%3Amoxiakvz5zi&lang=en";></script> - <!-- Google CSE Search Box Ends --> - </li> - <li class="doc_tip" id="searchcppref" onmouseover="showtip(this.id)" onmouseout="hidetip()"> - The C++ UNO API reference - <!-- Google CSE Search Box Begins --> - <form action="http://api.openoffice.org/searchresults.html"; id="searchbox_001318689579221500783:jpgwm58ssc0"> - <input type="hidden" name="cx" value="001318689579221500783:jpgwm58ssc0" /> - <input type="hidden" name="cof" value="FORID:11" /> - <input type="text" name="q" size="25" /> - <input type="submit" name="sa" value="Search" /> - </form> - <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_001318689579221500783%3Ajpgwm58ssc0&lang=en";></script> - <!-- Google CSE Search Box Ends --> - </li> - <li class="doc_tip" id="searchext" onmouseover="showtip(this.id)" onmouseout="hidetip()"> - Complete Extensions Wiki - <!-- Google CSE Search Box Begins --> - <form action="http://api.openoffice.org/searchresults.html"; id="cse-search-box"> - <input type="hidden" name="cx" value="001318689579221500783:rcmrkgwpppq" /> - <input type="hidden" name="cof" value="FORID:11" /> - <input type="text" name="q" size="25" /> - <input type="submit" name="sa" value="Search" /> - </form> - <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en";></script> - <!-- Google CSE Search Box Ends --> - </li> - <!-- <li class="doc_tip" id="searchproj" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="http://api.openoffice.org/servlets/Search?resultsPerPage=40&scope=project";>Search the project data</a></li> --> + <li class="doc_tip" id="searchapiref" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="docs/common/ref/com/sun/star/module-ix.html">Office API (IDL) reference</a></li> + <li class="doc_tip" id="searchjavaref" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="docs/java/ref/overview-summary.html">Java UNO API reference</a></li> + <li class="doc_tip" id="searchcppref" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="docs/cpp/ref/names/index.html">C++ UNO API reference</a></li> </ul> + <p class="xsmall">The reference pages were generated from an earlier snapshot of the sources and do not cover every + type in the current API, for example <code>accessibility::XAccessibleTextSelection</code> and + <code>awt::XLayoutFlowContainer</code>. The current IDL files are in the source tree: + <a href="https://github.com/apache/openoffice/tree/trunk/main/offapi";>offapi</a> and + <a href="https://github.com/apache/openoffice/tree/trunk/main/udkapi";>udkapi</a>.</p> </div> </div> </td> diff --git a/part2/content/api/listrules.html b/part2/content/api/listrules.html index ecc645d708..b62f43af90 100644 --- a/part2/content/api/listrules.html +++ b/part2/content/api/listrules.html @@ -32,14 +32,14 @@ OOo are now collapsed to the Apache OpenOffice project. [email protected] is always appropriate. -http://udk.openoffice.org +https://www.openoffice.org/udk/ for questions about UNO bridges and language bindings including StarBASIC/OOoBASIC -http://framework.openoffice.org/scripting/ +https://www.openoffice.org/framework/scripting/ for questions about the scripting framework -http://xml.openoffice.org +https://www.openoffice.org/xml/ for questions regarding our XML file formats @@ -53,7 +53,7 @@ Developers Guide. This is a list of volunteers, not a support forum. We like to help you, but we cannot do the footwork for you. An online version of the Developers Guide can be found here: -http://api.openoffice.org/DevelopersGuide/DevelopersGuide.html +https://wiki.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide *** ==================================================================== @@ -71,16 +71,9 @@ By breaking these rules, do not wonder if your question remains unanswered, most likely even unseen due to mail filters. If you have additional data, like a document or a longer source code, -please provide us a link where we can download these. You might upload -such documents to the file area: - -http://api.openoffice.org/servlets/ProjectDownloadList - -As far as I know, everybody can do that, you might need an -OpenOffice.org account. As the responsible project lead, I just have to -approve the files to get published. But keep in mind: the more a -volunteer has to read to grab your question, the lesser the change for -an answer. +please provide us a link where we can download these. But keep in mind: +the more a volunteer has to read to grab your question, the lesser the +change for an answer. *** ==================================================================== @@ -101,7 +94,7 @@ contribute to OOo: If you had a question and it was answered to your satisfaction it would be great if you post a summary in our standardized form: -http://api.openoffice.org/SDK/snippets/index.html +https://www.openoffice.org/api/SDK/snippets/index.html This avoids using up the time of the volunteers to answer the same questions over and over again. Thanks for your contribution! @@ -126,9 +119,9 @@ by personal email. *** -------------------------------------------------------------------- If you are pretty sure that you found a defect in either the -documentation or implementation, please file this issue on OOos IssueZilla: +documentation or implementation, please file this issue in Bugzilla: -https://www.openoffice.org/project_issues.html +https://bz.apache.org/ooo/ Implementation bugs which do not only occur by API usage can be reported directly to the appropriate project (like sw, sd, sc or framework), API @@ -137,7 +130,7 @@ file to the API project. StarBASIC/OOoBASIC issues actually belong to the UDK project. If you choose the wrong project, your issue might be delayed. -Please do not misuse IssueZilla as a support tool. It is not and your +Please do not misuse Bugzilla as a support tool. It is not and your issue will simply be rejected. *** ==================================================================== @@ -157,14 +150,12 @@ There are plenty possibilities of contributions to OOo, even for (-> 4. Support questions) - Contribute your larger API examples to our example collection - (http://api.openoffice.org/SDK/example_collection.html) - -If you want to provide us with source code or documentation, we need a -copyright assignment: + (https://www.openoffice.org/api/SDK/example_collection.html) -http://www.openoffice.org/contributing.html +If you want to provide us with source code or documentation, please read +about the contributor license agreements: -Please read this document to learn about how and why. +https://www.apache.org/licenses/contributor-agreements.html </pre> diff --git a/part2/content/api/modules.html b/part2/content/api/modules.html index a864e6cc1f..790d7e966f 100644 --- a/part2/content/api/modules.html +++ b/part2/content/api/modules.html @@ -41,16 +41,6 @@ These interfaces are written in the IDL language.</td> </tr> - <tr> - <td bgcolor="#f0f0f0" valign="top"><a href= - "https://github.com/apache/openoffice/tree/trunk/main/offuh";><code>offuh</code></a></td> - - <td bgcolor="#f0f0f0" valign="top">Generates UNO headers for - C++. - <br> - For each new code-generating file in one of the API modules, - these makefiles must be updated.</td> - </tr> <tr> <td bgcolor="#f0f0f0" valign="top"><a href=
