blob: 2121ce41bea49da5e1b33d4c207fce659769b879 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>
The Apache OpenOffice API Project
</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="version" content="0.1" />
<link type="text/css" rel="stylesheet" href="docooo.css" />
</head>
<body>
<div id="docooo">
<script src="docooo.js" type="text/javascript"> </script>
<script type="text/javascript">
/*<![CDATA[*/
mdesc = new Array();
mdesc['help101'] = "Learn about ways for getting help on using OpenOffice.";
mdesc['contrib101'] = "Learn about how YOU can help improving OpenOffice documentation.";
mdesc['searchall'] = "Search all documentation project resources";
mdesc['l10n'] = "Go to a localized documentation project. These are located outside this project.<br />Select a language and click Ok.";
mdesc['br_userman'] = "<b>User Manuals</b> contain detailed descriptions of how to work with OpenOffice and its modules.";
mdesc['br_ug'] = "<div class='floatimg'><img src='img/pdf.png'></div>The draft version of the <b>User's Guide</b> contains descriptions of how to work with OpenOffice and its modules.";
mdesc['br_howtos'] = "<b>How To's</b> are concise and brief instructions for specific tasks or problems.";
mdesc['br_faqs'] = "<b>Frequently Asked Questions</b> contain questions that can be answered quickly.";
mdesc['br_setupg'] = "<div class='floatimg'><img src='img/pdf.png'></div>The <b>Setup Guide</b> describes the installation and setup procedures for OpenOffice.";
mdesc['br_ooa_gsg'] = "<div class='floatimg'><img src='img/pdf.png'></div>The <b>Getting Started Guide</b> from the OOoAuthors group."
mdesc['br_ooa_wg'] = "<div class='floatimg'><img src='img/pdf.png'></div>The <b>Writer Guide</b> from the OOoAuthors group."
mdesc['br_ooa_ig'] = "<div class='floatimg'><img src='img/pdf.png'></div>The <b>Impress Guide</b> from the OOoAuthors group."
mdesc['br_ooa_dg'] = "<div class='floatimg'><img src='img/pdf.png'></div>The <b>Draw Guide</b> from the OOoAuthors group."
mdesc['br_ooa_mig'] = "<div class='floatimg'><img src='img/pdf.png'></div>The <b>Migration Guide</b> from the OOoAuthors group."
mdesc['wiki_main'] = "The starting page for all API wiki content.";
mdesc['wiki_uno'] = "The starting page for all UNO wiki content.";
mdesc['wiki_ext'] = "The starting page for all Extensions wiki content.";
mdesc['wikifaq'] = "All Frequently Asked Questions from the API Project.";
mdesc['wikibasg'] = "The <b>BASIC Programming Guide</b> giving an introduction of programming macros with OpenOffice BASIC.";
mdesc['wikidevguide'] = "The <b>Developer's Guide</b> giving an introduction of programming with the OpenOffice API.";
mdesc['codesnippets'] = "The <b>Code Snippets Base</b> provides useful code snippets to get started fast.";
mdesc['oosdk'] = "The <b>OpenOffice Software Development Kit (SDK)</b> provides the necessary tools to develop with and for OpenOffice.";
mdesc['apisamples'] = "The <b>API Samples</b> provides useful API examples showing.";
mdesc['apitutorials'] = "The <b>API Tutorials</b> provides detailed step by step explained examples/tutorials showing specific API's or service provider interfaces.";
mdesc['ext_repository'] = "The <b>Extensions</b> repository ...";
mdesc['ooforum'] = "The OpenOffice user forum";
mdesc['br_olh'] = "Sorry, not yet available. Soon to come.";
mdesc['br_devdoc'] = "<div class='floatimg'><img src='img/pdf.png'></div>The <b>Developer's Guide</b> contains information about programming with OpenOffice using its API.";
mdesc['br_samp'] = "<b>Samples &amp; Templates</b> contain many additional template and clipart collections for business and personal use.";
mdesc['br_tut'] = "<b>Tutorials</b> are short documents or media that explain a task or concept using example scenarios.";
mdesc['br_art'] = "<b>Articles and Reviews</b> written by OpenOffice users.";
mdesc['br_oooproj'] = "<b>Other OpenOffice projects</b> provide some information resources, too.";
mdesc['br_3rd'] = "<b>3rd Party Documentation and Resources</b> that reside outside the OpenOffice web site.";
mdesc['br_oofor'] = "<b>3rd Party Forums and Resources</b> that reside outside the OpenOffice web site.";
mdesc['br_archive'] = "Sorry, not yet available. Soon to come.";
mdesc['users'] = "When you are an OpenOffice <b>user</b> and look for help and information, look in this column.";
mdesc['contributors'] = "When you would like to <b>contribute</b> content to OpenOffice documentation, look in this column.";
mdesc['join'] = "Join the API project by filling out this simple form.<br /><b>NO COST, NO OBLIGATIONS!</b>";
mdesc['mailinglists'] = "Subscribe to the project's mailing lists and get engaged in the discussions. We recommend the at least <b>dev</b> list.<br />Browse or search past messages in the archives.";
mdesc['wiki'] = "Go to the Documentation section of the OpenOffice wiki.";
mdesc['dashboard'] = "A list of documentation projects.";
mdesc['wishlist'] = "Add your documentation wish here!";
mdesc['c_userman'] = "Help working on <b>User Manuals</b>";
mdesc['c_howtos'] = "Help working on <b>How To's</b>";
mdesc['c_faqs'] = "Help working on the <b>Frequently Asked Questions</b> lists";
mdesc['c_setupg'] = "Help working on the <b>Setup Guide</b>";
mdesc['c_olh'] = "Help working on the <b>Application Help</b> (or <i>Online Help</i>)";
mdesc['c_devtodo'] = "View open ToDo's in the API project";
mdesc['c_oofor'] = "<b>3rd Party Forums and Resources</b> that reside outside the OpenOffice.org web site.";
mdesc['c_samp'] = "Help working on <b>Samples &amp; Templates</b>";
mdesc['c_tut'] = "Help working on <b>Tutorials</b>";
mdesc['c_issues'] = "View the list of open issues";
mdesc['searchwiki'] = "Searches the complete <b>API Wiki</b> content.<br>If you don't exactly know where to look for your information, select this search.";
mdesc['searchdevguide'] = "Searches the complete <b>Developer's Guide</b> in the Wiki.<br>If you don't exactly know where to start in the Developer's Guide, select this search.";
mdesc['searchext'] = "Searches the complete Extensions Wiki Content.";
mdesc['searchapiref'] = "Searches only the <b>Office API</b> reference (UNOIDL) documentation.";
mdesc['searchjavaref'] = "Searches only the <b>Java UNO Runtime API</b> reference documentation.";
mdesc['searchcppref'] = "Searches only the <b>C++ UNO Runtime API</b> reference documentation.";
mdesc['searchfaq'] = "Searches only the Documentation FAQ lists.";
mdesc['searchman'] = "Searches only the Manuals on the Documentation Wiki. Note, that not all manuals are yet available on the wiki.";
mdesc['searchweb'] = "Searches the content on this Documentation Website.";
mdesc['searchproj'] = "Searches the content of this project, including issues, mailing lists, and forum content.<br>If you are looking for <b>project related information</b>, click here.";
mstyle = new Array();
mstyle['help101'] = "bubbleblue";
mstyle['contrib101'] = "bubblered";
mstyle['searchall'] = "bubbleblue";
mstyle['l10n'] = "bubbleblue";
mstyle['br_ooa_gsg'] = "bubbleblue";
mstyle['br_ooa_wg'] = "bubbleblue";
mstyle['br_ooa_ig'] = "bubbleblue";
mstyle['br_ooa_dg'] = "bubbleblue";
mstyle['br_ooa_mig'] = "bubbleblue";
mstyle['searchfaq'] = "bubbleblue";
mstyle['searchman'] = "bubbleblue";
mstyle['searchwiki'] = "bubbleblue";
mstyle['searchdevguide'] = "bubbleblue";
mstyle['searchext'] = "bubbleblue";
mstyle['searchapiref'] = "bubbleblue";
mstyle['searchjavaref'] = "bubbleblue";
mstyle['searchcppref'] = "bubbleblue";
mstyle['searchweb'] = "bubbleblue";
mstyle['searchproj'] = "bubbleblue";
mstyle['wikifaq'] = "bubbleblue";
mstyle['wiki_main'] = "bubbleblue";
mstyle['wiki_uno'] = "bubbleblue";
mstyle['wiki_ext'] = "bubbleblue";
mstyle['wikibasg'] = "bubbleblue";
mstyle['wikidevguide'] = "bubbleblue";
mstyle['codesnippets'] = "bubbleblue";
mstyle['oosdk'] = "bubbleblue";
mstyle['apisamples'] = "bubbleblue";
mstyle['apitutorials'] = "bubbleblue";
mstyle['ext_repository'] = "bubbleblue";
mstyle['ooforum'] = "bubbleblue";
mstyle['br_userman'] = "bubbleblue";
mstyle['br_ug'] = "bubbleblue";
mstyle['br_howtos'] = "bubbleblue";
mstyle['br_faqs'] = "bubbleblue";
mstyle['br_setupg'] = "bubbleblue";
mstyle['br_olh'] = "bubbleblue";
mstyle['br_devdoc'] = "bubbleblue";
mstyle['br_samp'] = "bubbleblue";
mstyle['br_tut'] = "bubbleblue";
mstyle['br_art'] = "bubbleblue";
mstyle['br_oooproj'] = "bubbleblue";
mstyle['br_3rd'] = "bubbleblue";
mstyle['br_oofor'] = "bubbleblue";
mstyle['br_archive'] = "bubbleblue";
mstyle['users'] = "bubbleblue";
mstyle['contributors'] = "bubblered";
mstyle['join'] = "bubblered";
mstyle['mailinglists'] = "bubblered";
mstyle['wiki'] = "bubblered";
mstyle['dashboard'] = "bubblered";
mstyle['wishlist'] = "bubblered";
mstyle['c_userman'] = "bubblered";
mstyle['c_howtos'] = "bubblered";
mstyle['c_faqs'] = "bubblered";
mstyle['c_setupg'] = "bubblered";
mstyle['c_olh'] = "bubblered";
mstyle['c_devtodo'] = "bubblered";
mstyle['c_oofor'] = "bubblered";
mstyle['c_samp'] = "bubblered";
mstyle['c_tut'] = "bubblered";
mstyle['c_issues'] = "bubblered";
function loadpage() {
document.location.href=element("site").options[element("site").selectedIndex].value;
}
/* ]]> */
</script>
<table class="mylamelayouthelper" border="0" summary="" width="100%" cellpadding="0"
cellspacing="0">
<tr>
<td><h1 class="docheader">The Apache OpenOffice API Project</h1></td></tr>
</table>
<table class="mylamelayouthelper" border="0" summary="">
<tr valign="top">
<td id="toprow">
<div id="charter">
<strong>Welcome to the <a href="https://en.wikipedia.org/wiki/Application_programming_interface" title="link to a wikipedia definition of API">API</a> Project</strong><br/>
<p>The API project provides an entry point in the world of Apache OpenOffice from a developers perspective.</p>
<p>OpenOffice offers a language independent <b>application programming interface</b> (API) which allows to program the office in different programming languages (e.g. C++, Java, Python, CLI, OpenOffice Basic, JavaScript, OLE). It allows to use OpenOffice as service provider in other applications, extend it with new functionality or simply customize and control OpenOffice.</p>
<p>The popularity of the standardized (<a href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office#technical">OASIS</a> and <a href="https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office">ISO/IEC 26300</a>) Open Document Format for Office Applications (OpenDocument) is growing. This also drives the popularity of Apache OpenOffice in general. Corporate users often demand the integration of office productivity into existing workflows and applications. They also often require additional functionality or special customizations of the existing features. And that is one of the main goals of the API project. Provide the possibility to customize or control the office that it fits well in your existing environment or fulfill your special requirements.</p>
</div>
</td>
<td id="rightcolumn" rowspan="2">
<div class="section showlinks" id="contrib" >
<img class="icon" src="images/contribute_small.png" alt="Contrib-icon"/>
<div class="sec_header">Getting Involved</div>
<div class="sec_content">
<ul class="nobullet xsmall">
<li class="doc_tip" id="mailinglists" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="https://openoffice.apache.org/mailing-lists.html#api-mailing-list-public">Join the Mailing List</a></li>
<li class="doc_tip" id="c_devtodo" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="https://wiki.openoffice.org/wiki/API/To-Dos">Developer ToDo's</a></li>
<li class="doc_tip" id="c_issues" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="https://bz.apache.org/ooo/buglist.cgi?component=api&issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&issue_type=TASK&list_id=230730" class="showlink">Open issues</a></li>
</ul>
</div>
</div>
<div class="section showlinks" id="quicklinks" >
<img class="icon" src="images/links.png" alt="Links-icon" />
<div class="sec_header">Quick Links</div>
<div class="sec_content">
<ul class="nobullet xsmall">
<li class="doc_tip" id="wiki_main" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="https://wiki.openoffice.org/wiki/API">API Wiki</a></li>
<li class="doc_tip" id="wiki_uno" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="https://wiki.openoffice.org/wiki/Uno">UNO Wiki</a></li>
<li class="doc_tip" id="wiki_ext" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="https://wiki.openoffice.org/wiki/Extensions">Extensions Wiki</a></li>
<li class="doc_tip" id="ext_repository" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="https://extensions.openoffice.org">Extensions Repository</a></li>
<li class="doc_tip" id="wikidevguide" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="https://wiki.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide">Developer's Guide</a></li>
<li class="doc_tip" id="ooforum" onmouseover="showtip(this.id)" onmouseout="hidetip()"><a href="https://forum.openoffice.org/en/forum/">OO Forum</a></li>
</ul>
</div>
</div>
<div class="section showlinks" id="sdk-box" >
<div class="sec_header">SDK</div>
<map name="sdkmap"><area shape="rect" coords="5,5,85,160" href="SDK/index.html"></map>
<img src="images/sdk.png" alt="SDK logo" align="left" hspace="5" vspace="5" border="0" usemap="#sdkmap">
<div class="sec_content">
There is also a <a href="SDK/index.html">Software Development Kit (SDK)</a> available which is an add-on for an existing OpenOffice. It provides the necessary tools and documentation for programming the OpenOffice APIs and creating your own extensions (UNO components) for OpenOffice. If you are interested in OpenOffice programming, you can <a href="https://openoffice.apache.org/downloads.html">download the SDK</a>.
</div>
</div>
<div id="bubble" style="display:none; top: 0px; left: 0px; width:200px;">
<div id="bubble_inner" class=""></div>
</div>
</td>
</tr>
<tr valign="top">
<td id="leftcolumn">
<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>
<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&amp;scope=project">Search the project data</a></li> -->
</ul>
</div>
</div>
</td>
<td width="50%"><!-- VIEW DOCUMENTATION ONLINE -->
<div class="section2 showlinks" id="browse" >
<img class="icon" src="images/browse.png" alt="Browse-icon" />
<div class="sec_header">Browse API related Documentation Online</div>
<div class="sec_content">
<ul class="nobullet xsmall">
<li class="doc_tip" id="wikibasg" onmouseover="showtip(this.id)" onmouseout="hidetip()">
<a href="https://wiki.openoffice.org/wiki/Documentation/BASIC_Guide" class="wiki">BASIC Programming Guide</a>
</li>
<li class="doc_tip" id="wikidevguide" onmouseover="showtip(this.id)" onmouseout="hidetip()">
<a href="https://wiki.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide" class="wiki">Developer's Guide</a>
</li>
</ul>
</div>
<div class="sec_header">Other Resources</div>
<div class="sec_content">
<ul class="nobullet xsmall">
<li class="doc_tip" id="oosdk" onmouseover="showtip(this.id)" onmouseout="hidetip()">
<a href="./SDK/index.html" title="Code Snippet Base">Software Development Kit (SDK)</a>
</li>
<li class="doc_tip" id="apisamples" onmouseover="showtip(this.id)" onmouseout="hidetip()">
<a href="https://wiki.openoffice.org/wiki/API/Samples" class="wiki">API Samples</a>
</li>
<li class="doc_tip" id="apitutorials" onmouseover="showtip(this.id)" onmouseout="hidetip()">
<a href="https://wiki.openoffice.org/wiki/API/Tutorials" class="wiki">API Tutorials</a>
</li>
</ul>
</div>
</div>
</td>
</tr>
</table>
<p>
</p>
</td>
</tr>
</table>
</div>
</body>
</html>