Difference between revisions of "API"
(→Code Snippets) |
|||
| Line 33: | Line 33: | ||
<DPL>category=API | <DPL>category=API | ||
category=Effort</DPL> <noinclude>[[Category:API]]</noinclude> | category=Effort</DPL> <noinclude>[[Category:API]]</noinclude> | ||
| − | + | * [[API/Concepts_API_changes|Concepts for incompatible API changes and an API deprecation process]] | |
==Things to be Done== | ==Things to be Done== | ||
* [[API/To-Dos]] - An overview of API To-Dos where you will hopefully find something interesting if you plan to support the API project. | * [[API/To-Dos]] - An overview of API To-Dos where you will hopefully find something interesting if you plan to support the API project. | ||
Revision as of 12:27, 24 April 2009
| Project Lead | Jürgen Schmidt |
| Co-Lead | Steffen Grund |
The OpenOffice.org API Wiki. API stands for Application programming interface.
OpenOffice.org offers a language independent API which allows to program the office in different programming languages (e.g. C++, Java, Python, CLI, StarBasic, ...). It allows to use OpenOffice.org as service provider in other applications, extend it with new functionality or simply customize and control OpenOffice.org.
The API is based on the UNO component technology and that makes it really flexible and makes it possible to use one and the same API from different programming languages, all languages which are supported by UNO.
Contents
API Reference
We try to provide always the latest version of a generated API IDL reference documentation online. You can find it on the api.openoffice.org on left side under IDL reference. Maybe interesting for you are the two links Use' and DevGuide in the top menubar of a single type documentation page.
- Use: links to an overview page where you can find all places where this type is used or referenced in the API and in the Developer's Guide
- DevGuide: links to a sub-section of the documentation page where you can find cross references into the Developer's Guide where this type is described in detail and especially the concepts behind.
Also of interest here are the online available reference documentation of the UNO runtime for C++ and Java.
Supported Languages
Code Snippets, Examples and Tutorials
The idea is to collect small snippets or more complex examples showing different API use cases in different programming languages. Or to collect tutorials explaining things in more detail and step by step. Whereas Tutorials are more intended for beginners the Samples section is intended for more experienced users or simply as reference. Ideally all snippets/examples/tutorials would be available in all supported languages.
This new sections in the wiki should extend the already existing Code Snippet Base. But with the advantage of easier contribution and easier maintenance.
Things in progress - Efforts
- Groovy UNO Extension
- OpenOffice CMake Integration
- OpenOffice Eclipse Integration
- OpenOffice Gradle Integration
- OpenOffice Maven2 Integration
- OpenOffice NetBeans Integration
Things to be Done
- API/To-Dos - An overview of API To-Dos where you will hopefully find something interesting if you plan to support the API project.
FAQ
- API/FAQ - A list of frequently asked questions related to the API
