Apache OpenOffice Wiki - User contributions [en]

Documentation/Building Guide AOO/Building on MacOsX

2014-11-27T08:46:38Z

Hdu: XCode 6 has the same extra requirements as XCode5

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on MacOSX}}
[[Category:MacOSX]][[Category:Documentation]]

__TOC__

= Overview =

Building Apache OpenOffice from source code follows the
platform independent [[Documentation/Building_Guide_AOO| building guide]]
when the build requirements outlined below are fulfilled.

= General build requirements =

Please see the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] page.

= Mac specific requirements for building AOO 4.1 (and newer) =

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.7 (aka Lion) or later
| provided by Apple
|-
| Xcode version 4.5 or later.
| Use the App Store application to get and install it. For Xcode 5 (or newer) some [[#XCODE5|extra steps]] are needed.
You can also [http://developer.apple.com/technology/xcode.html download] it free of charge, but a registration at the [https://connect.apple.com/ Apple Developer Connection] site is required for that.
|-
| MacOSX SDK
| SDKs compatible with OSX 10.7 are automatically provided by installing XCode 4.5 or newer
|-
| gnutar
| OSX<=10.8 contains the tool directly, for OSX>=10.9 some [[#OSX109|extra steps]] are needed.
|-
|}

<div id="XCODE5">
= Requirements for Xcode 5 (or newer) =
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| Xcode commandline tools
| run this command in a terminal
sudo xcode-select --install
|-
| autoconf
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/autoconf/autoconf-2.69.tar.bz2
tar xvjf autoconf-2.69.tar.bz2
pushd autoconf-2.69
./configure --prefix=/usr/local
make
sudo make install
popd
|}

</div>

<div id="OSX109">

= OSX 10.9 (or newer) specific requirements =
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| gnutar
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/tar/tar-1.27.tar.bz2
tar xvjf tar-1.27.tar.bz2
pushd tar-1.27
./configure --prefix=/usr/local
make
sudo make install
sudo ln -s /usr/local/bin/tar /usr/local/bin/gnutar
popd
|}
</div>

Documentation/Building Guide/Building on MacOSX

2014-11-27T08:15:48Z

Hdu: too many building guides...

{{Documentation/Building Guide TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building OpenOffice 3.x or Apache OpenOffice 4.0 on Mac OSX}}
[[Category:MacOSX]]

__TOC__

= Overview =
This document explains how to build older OpenOffice source code on Mac OS X systems.
{{Template:Documentation/Note|<code>$SRC_ROOT</code> will denote the directory in which the source code of Apache OpenOffice is stored.}}
{{Template:Documentation/Tip|You are advised to check the release notes for the release you are building to inform yourself about changes since previous releases.}}

= Requirements =

To build the office on Mac OS X several requirements/prerequisites have to be fulfilled.

== Mandatory Requirements ==
* '''Mac OS X''' version 10.4 (aka Tiger) or later (if using 10.5 aka Leopard, have a look at [[User:Dyrcona/LeopardBuild#flex]]
* '''Mac 10.4 SDK'''
* '''XCode''' version 2.4.1 or any XCode 3. If you want to use a newer version than the one that is shipped with your Mac OS X installation media, you need to register at the [https://connect.apple.com/ Apple Developer Connection] site (free of charge) to be able to [http://developer.apple.com/technology/xcode.html download it]. On Mac OS X 10.6 (Snow Leopard), make sure to install the optional 10.4 SDK with XCode.
* '''dmake''', the build environment depends currently on a special patched version of dmake that you can download and build on demand during configure and bootstrap. Or you can provide a prebuilt version and can specify it during configure.
* '''epm''', the build environment depends currently on a special patched version of epm (easy package manager) that you can download and build on demand during configure and bootstrap. Or you can provide a prebuilt version and can specify it during configure.

{{Template:Documentation/Note|XCode 3 and SDK 10.4 is currently required for building trunk or the releases. Work on supporting XCode>=4 is ongoing.}}

== Optional Requirements ==

=== Prebuilt unowinreg.dll ===

This library is Windows only but will be packed in the Apache OpenOffice SDK to ensure that it is available on all platforms. The library provides some glue code to setup a working UNO environment for UNO client applications connecting to an office and doing some remote automation via API. The library should be stored in ''main/external/unowinreg''. Only necessary for building the SDK.

The library can be downloaded under
* http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll

== Recommended tools ==

* '''ccache'''
If you intend to build Apache OpenOffice several times, you probably can benefit of ccache since it will speed up your future builds. The first time you make a build with ccache you won't notice it, but the next time the build will go up to five times faster.

You can install it using '''[http://www.finkproject.org/ Fink]'''. It is simply named "ccache". For '''[http://www.macports.org/ MacPorts]''' users the package is called "ccache".

If you don't use fink, you can download and build it yourself using the source provided at http://ccache.samba.org/

There are two ways to enable ccache - one is to set environment variables, the other way is to use symlinks.

Using environment variables:
export CC="ccache gcc"
export CXX="ccache g++"

Using the symlink approach:
# create a directory for the links
mkdir ~/bin
# create the symlinks pointing to ccache with the name of the compiler
ln -s /path/to/ccache ~/bin/gcc
ln -s /path/to/ccache ~/bin/g++
ln -s /path/to/ccache ~/bin/cc
ln -s /path/to/ccache ~/bin/c++
# no all you need to enable ccache is to prepend ~/bin to your PATH
$ export PATH=~/bin:$PATH

for both methody, you can add the "export ..." lines to your ~/.profile - that way you don't need to manually set it when building. You can still temporarily disable ccache (export CCACHE_DISABLE=1) in case you don't want to use it.

Since OOo is rather huge, you should increase the cache-size to 1 GB or more
ccache -M 1G

* '''subversion''' version '''1.5.4 or later'''
Since OOo's source code is managed using Subversion currently, you also need the svn client to checkout sources (otherwise you would be bount to source-tarballs that aren't generated that frequently). You can either compile yourself or use the subversion universal binaries from the [http://subversion.tigris.org subversion project] Version 1.5.4 or later is required because of important fixes related to the merge-feature.

== Get the source and prepare to build it ==

=== Get the source from SVN ===

You need about 4.7 GB for a checkout from the svn repository. Building the source requires another 5GB.<br>

* '''check out the latest source from svn'''

svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo

=== One-Time preparation and scripts ===

Apache OpenOffice build environment is configured using the open-source configuration-management package 'autoconf'. So you can do your beloved './configure' command, is now done in the '''main''' source directory.

To save the configure parameters and use them with different milestones it is useful to create your own build script to configure the environment and to trigger the build.

The directory structure when you have checked out the sources from svn looks like:

aoo/
aoo/main
aoo/extras
aoo/test
aoo/ext_libraries
aoo/ext_sources

Move into '''main''' and configure a minimal environment to build your first version of Apache OpenOffice:

cd main

Run the autoconf command to prepare a new configure based on the latest changes in configure.in

autoconf

Run configure

./configure --without-stlport --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 --with-epm-url=http://www.msweet.org/files/project2/epm-3.7-source.tar.gz

This commands prepares a minimal environment to build the office without any category-b enabled external libraries. A pure Apache license compatible version. See also the configure switches ''--with-dmake-path'' and ''--with-epm'' to specify prebuilt versions of dmake or epm.

Finally you should run bootstrap to trigger further preparations and to create platform specific shell script to setup a working build environment. On Mac OS x for example '''MacOSXX86Env.Set.sh''' on a Intel based system.

=== Build environment with enabled category-b dependencies ===

To prepare a build environment that provides more features and make use of further external libraries which are under copyleft but viral licenses you have to explicitly enable this '''category-b''' components.

./configure --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://www.msweet.org/files/project2/epm-3.7-source.tar.gz \
--disable-build-mozilla \
--without-stlport \
--enable-verbose \
'''--enable-category-b'''\
--enable-wiki-publisher

===Example build script to simplify user specific configurations===
As mentioned before to save the configure parameters and use them with different versions it is useful to create your own build script to configure the environment.

Create 'build.sh' (to be written) :

<pre>
#! /bin/bash

echo "### checking for unowinreg.dll ... "
if [ ! -e ./external/unowinreg/unowinreg.dll ]; then
wget -O external/unowinreg/unowinreg.dll http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll
else
echo " unowinreg.dll found"
fi

echo "### checking for moz prebuild libs ... "
if [ ! -e ./moz/zipped/MACOSXGCCIinc.zip ]; then
wget -O ./moz/zipped/MACOSXGCCIinc.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIinc.zip
wget -O ./moz/zipped/MACOSXGCCIlib.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIlib.zip
wget -O ./moz/zipped/MACOSXGCCIruntime.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIruntime.zip
else
echo " moz prebuild libs found"
fi

if [ ! -e ./configure ]; then
echo "### autoconf ..."
autoconf
else
echo "### autoconf ..."
rm ./configure
autoconf
fi

echo "### Configure"
./configure --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 --with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz

#./configure --with-build-version="$(date +"%Y-%m-%d %H:%M:%S (%a, %d %b %Y)") - Rev. $(echo $(svn info) | sed -e 's/^.*Last Changed Rev: //g' -e 's/ .*//g')" \
--disable-build-mozilla \
--enable-verbose --enable- category-b --enable-minimizer --enable-presenter-console --enable-wiki-publisher \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz

./bootstrap
</pre>

Put this script into ~/bin and make sure it is executable :

chmod ug+x ~/bin/build.sh

<b>We used the bash shell in all example, since to our belief users of the C-shell are smart enough to figure out the differences anyway. If you want to dig deeper into the build process, please have a look at the description [http://tools.openoffice.org/build_env.html OpenOffice.org's Build Environment].</b>

== Doing the build ==

After running configure and bootstrap we should have a working build environment and all necessary scripts should have been created. From now on you can use '''MacOSXX86Env.Set.sh''' to prepare a new shell with a working build environment.

=== On Mac Intel ===

source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all

or

build --all -P4

=== On PowerPC ===

source MacOSXPPCEnv.Set.sh
cd instsetoo_native
build --all

or

build --all -P2

=== Comments on above ===

'''TODO TODO TODO ....'''

if you run into trouble with --dlv_switch (see: {{Bug|77360}})

The main purpose of the '''bootstrap''' script is to build (if necessary) the dmake utility used. Dmake once was a unix make-clone made by wticorp but got incorporated into OpenOffice since it was orphaned. For more information about dmake, it's history and manpage have a look here: http://tools.openoffice.org/dmake/index.html

Sourcing MacOSXPPCEnv.Set.sh is very important not only for building but also for '''running''' svdem later on. Here all the Environment-Variables for the Build will be set up. For a detailed description see [[Environment_Variables]]. Please note that on Intel machines, 'MacOSXPPCEnv.Set.sh' should be substituted with 'MacOSXX86Env.Set.sh'.

This Build process takes on my box (Dual 1.8 GHz G5, 1.5GB RAM) roughly 10 hours, and 3 to 6 hours on Mac Intel (3:30h on a 2GHz DualCore INTEL iMac). Be patient.

If you want to see how the progress on that build is you can use two '''build''' options to get a comfortable view:

build ... <see above> ... --html --html_path /Users/$USER/Sites

where $USER is your user name. Then you can load in Firefox (not Safari!) the HTML file '''unxmacxi.pro.build.html''' via the in Mac OS X included Apache web server or diretctly form the directory ''/Users/$USER/Sites/''. This file is automatically being updated and is showing the status of the build and also the time needed since the build started.

If you build on Snow Leopard (aka Mac OS X 10.6): Set DYLD_INSERT_LIBRARIES to point to the correct libsqlite3.dylib:
<pre>
DYLD_INSERT_LIBRARIES=/usr/lib/libsqlite3.dylib
</pre>

== '''Installing, preparing and running OpenOffice.org''' ==

===''' Find the Bundle''' ===

Once the build completed, the final product ( en-US version ) is named : OOo_3.0.0_*_MacOSXIntel_install.dmg ( for version 3.0beta e.g.)

And is located in instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US directory ( replace en-US with your locale )

[[Image:Bundle_Location3.0beta.jpg]]

=== '''Install the new Build''' ===

* double-click on the *.dmg icon
* drag the OpenOffice icon into a folder of your choice

=== '''Run the new Build''' ===

* double click the application icon in that folder

=== '''Screenshots''' ===

Now you can start to work with this [[Aqua_Screenshots | amazing productivity suite]].

== '''Contribute by finding, isolating, debugging or solving issues''' ==

=== '''Isolate a problem''' ===

==== '''Reduce a problem''' ====

* make a problem reproducable
* reduce it to a test case that is as small and simple as possible
* if a problem is specific to a document then please attach it to the issue. A mininal excerpt of the document that still shows the problem is even better.
* a screenshot of is a good idea if it clearly shows the problem

==== '''Using application switches''' ====

Application switches are often valuable for isolating a problem. Most of OpenOffice.org's options can be found its Tools->Options menu.
<br><br>
Some switches are so special that there is no user interface to change them. They are only useful for debugging and isolating a problem, but they are very valuable a that. So a developer might suggest to isolate a problem by setting an environment variable before running the application. E.g. for isolating problems with the menubar a developer might suggest to set the environment variable [[AQUA_NATIVE_MENUS]] to false. This is done by typing these commands into a terminal:
* cd <INSTALL_DIR>/OpenOffice.org/Contents/MacOS
* export AQUA_NATIVE_MENUS=false
* ./soffice.bin

==== '''Provide a call stack for crash problems''' ====

Please note that bugs involving crashes should provide a description of how to reproduce the problem and a callstack.
There are several ways to provide the callstack:
* the preferred method is to use OOo"s builtin [[CrashReporting|crash reporting tool]]
* developers may provide a [[Providing_a_gdb_backtrace | gdb backtrace]] of the problem
* if the above two methods don"t work then please attach a file with the details provided by the AppleCrashReporter

=== '''Check against known issues''' ===

Check the list of [http://www.openoffice.org/issues/buglist.cgi?issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=&short_desc_type=fulltext&long_desc=&long_desc_type=fulltext&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=aqua&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time&Submit+query=Submit+query open issues]

=== '''Report a new issue''' ===

Report [http://qa.openoffice.org/issue_handling/pre_submission.html new issues] after you have [[AquaBuild#Isolate_a_problem | isolated the problem]]

=== '''Debug a problem''' ===

Debugging problems is often easier in an development environment:
<ul>
<li>With XCode: [[MacOSX_Debug_OpenOffice.org_using_XCode]]</li>
<li>With Xemacs: [http://www.mikesicotte.com/2007/02/21/debugging-ooo-with-xemacs-and-gdb Michael Sicotte's blog entry]</li>
</ul>

Please note that XCode still has some problems with the executable named soffice.bin (because of the dot in the name). The issue has been reported to xcode-users list.

== '''Current Work in progress (Aqua specific work only)''' ==

With OOO300 the Aqua port became a mainstream port, so most Aqua issues are handled in regular GSL-Layer childworkspaces instead of dedicated Aqua CWSses. Other CWSses that are purely Aqua specific are being tracked below:

* '''{{CWS|ogltrans4mac|DEV300}}''' : Implement the 3D (OpenGL) transitions in Impress ( see : [[Mac_OS_X_Porting_-_OpenGL_transitions| OpenGL transitions on Mac OS X ]] )

==='''Child WorkSpaces in development''' ===

* '''{{CWS|appleremote03|DEV300}}''' : use the contextual menu in presentation mode with Impress. preliminary step

* '''{{CWS|hotmac|OOO300}}''' : fix memory deallocation problems in exit()

* '''{{CWS|macosxscanner01|DEV300}}''' (planned)

All patches that developers have that need testing or peer review should be added here.

==='''Child WorkSpaces in testing (closed for development)''' ===

*'''{{CWS|macmiscfixes}}''' : misc fixes for mac

*'''{{CWS|maccrashrep}}''' : support crash reporting for OSX builds

*'''{{CWS|quicklookplugin01}}''' : a plugin for the QuickLook system available in MacOSX from versions 10.5 onwards

==='''Child WorkSpaces waiting for integration''' ===

* '''{{CWS|appleremote02|DEV300}}''' : improve the Apple Remote use with Impress (use MEDIA_COMMAND stuff, improve code robustness, and portability )

==='''Child Workspaces integrated into OpenOffice's trunk''' ===

A historical overview of [[Aqua_Integrated_CWS | old Aqua specific ChildWorkspaces]].

== '''Known build issues '''==
*'''Tiger''': no known issues
*'''Leopard''': no known issues
*'''Snow Leopard''': no known issues
*'''Lion''': no known issues
*'''Mountain Lion''': no known issues

<div align="left" style="color:grey; font-size:12px">[[AquaBuild/Some Background | '''Some Background (what is a CWS, EIS) (click me to know more) ''']]</div>

== '''External links''' ==
* [https://issues.apache.org/ooo Apache OpenOffice Issuezilla] : a database of bugs, changes and enhancements
* There are [[MacOSXPortMeetings | regular meetings]] on IRC (archives are [[Previous_Mac_Meeting_logs | available]]).
* Apache OpenOffice has a complicated code base. [[Source_code_directories | Here]] is an overview.
* the official Apache OpenOffice blog is at [https://blogs.apache.org/OOo/]
* [http://www.cocoadev.com Cocoadev] provides great resources to get up to speed in Cocoa development
* Pierre Chatelier's excellent [http://ktd.club.fr/programmation/objective-c.php Objective C for C++ developers] is available in both english and french versions
* Details about OSX's [http://developer.apple.com/cocoa Cocoa API] are available in the XCode documentation

[[Category:Aqua]]
[[Category:Build_System]]

Documentation/Building Guide AOO/Building on MacOsX

2014-10-08T08:27:40Z

Hdu: /* Xcode 5 specific requirements */ fixed link for autoconf tarball

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on MacOSX}}
[[Category:MacOSX]][[Category:Documentation]]

__TOC__

= Overview =

Building Apache OpenOffice from source code follows the
platform independent [[Documentation/Building_Guide_AOO| building guide]]
when the build requirements outlined below are fulfilled.

= General build requirements =

Please see the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] page.

= Mac specific requirements for building AOO 4.1 (and newer) =

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.7 (aka Lion) or later
| provided by Apple
|-
| Xcode version 4.5 or later.
| Use the App Store application to get and install it. If you got Xcode 5.x some [[#XCODE5|extra steps]] are needed.
You can also [http://developer.apple.com/technology/xcode.html download] it free of charge, but a registration at the [https://connect.apple.com/ Apple Developer Connection] site is required for that.
|-
| MacOSX SDK
| SDKs compatible with OSX 10.7 are automatically provided by installing XCode 4.5 or newer
|-
| gnutar
| OSX<=10.8 contains the tool directly, for OSX>=10.9 some [[#OSX109|extra steps]] are needed.
|-
|}

<div id="XCODE5">
= Xcode 5 specific requirements =
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| Xcode commandline tools
| run this command in a terminal
sudo xcode-select --install
|-
| autoconf
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/autoconf/autoconf-2.69.tar.bz2
tar xvjf autoconf-2.69.tar.bz2
pushd autoconf-2.69
./configure --prefix=/usr/local
make
sudo make install
popd
|}

</div>

<div id="OSX109">

= OSX 10.9 (or newer) specific requirements =
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| gnutar
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/tar/tar-1.27.tar.bz2
tar xvjf tar-1.27.tar.bz2
pushd tar-1.27
./configure --prefix=/usr/local
make
sudo make install
sudo ln -s /usr/local/bin/tar /usr/local/bin/gnutar
popd
|}
</div>

Documentation/Building Guide AOO/Building on MacOsX

2014-05-21T13:56:46Z

Hdu: removed obsolete Xcode2/Xcode3 requirements

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on MacOSX}}
[[Category:MacOSX]][[Category:Documentation]]

__TOC__

= Overview =

Building Apache OpenOffice from source code follows the
platform independent [[Documentation/Building_Guide_AOO| building guide]]
when the build requirements outlined below are fulfilled.

= General build requirements =

Please see the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] page.

= Mac specific requirements for building AOO 4.1 (and newer) =

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.7 (aka Lion) or later
| provided by Apple
|-
| Xcode version 4.5 or later.
| Use the App Store application to get and install it. If you got Xcode 5.x some [[#XCODE5|extra steps]] are needed.
You can also [http://developer.apple.com/technology/xcode.html download] it free of charge, but a registration at the [https://connect.apple.com/ Apple Developer Connection] site is required for that.
|-
| MacOSX SDK
| SDKs compatible with OSX 10.7 are automatically provided by installing XCode 4.5 or newer
|-
| gnutar
| OSX<=10.8 contains the tool directly, for OSX>=10.9 some [[#OSX109|extra steps]] are needed.
|-
|}

<div id="XCODE5">
= Xcode 5 specific requirements =
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| Xcode commandline tools
| run this command in a terminal
sudo xcode-select --install
|-
| autoconf
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/tar/autoconf-2.69.tar.bz2
tar xvjf autoconf-2.69.tar.bz2
pushd autoconf-2.69
./configure --prefix=/usr/local
make
sudo make install
popd
|}

</div>

<div id="OSX109">
= OSX 10.9 (or newer) specific requirements =
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| gnutar
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/tar/tar-1.27.tar.bz2
tar xvjf tar-1.27.tar.bz2
pushd tar-1.27
./configure --prefix=/usr/local
make
sudo make install
sudo ln -s /usr/local/bin/tar /usr/local/bin/gnutar
popd
|}
</div>

Documentation/Building Guide AOO/Building on MacOsX

2014-05-14T11:29:00Z

Hdu: xcode5 doesn't contain autoconf anymore

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on MacOSX}}
[[Category:MacOSX]][[Category:Documentation]]

__TOC__

= Overview =

For general information on how to build Apache OpenOffice from source code, see the [[Documentation/Building_Guide_AOO|platform independent page]].

See also this slightly older [[Documentation/Building_Guide/Building_on_MacOSX|building guide]].

= Build requirements =
Additionally to the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] you need

== for building AOO 4.1 and newer ==

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.7 (aka Lion) or later
| provided by Apple
|-
| Xcode version 4.5 or later.
| Use the App Store application to get and install it. If you got Xcode 5.x some [[#XCODE5|extra steps]] are needed.
You can also [http://developer.apple.com/technology/xcode.html download] it free of charge, but a registration at the [https://connect.apple.com/ Apple Developer Connection] site is required for that.
|-
| MacOSX SDK
| SDKs compatible with OSX 10.7 are automatically provided by installing XCode 4.5 or newer
|-
| gnutar
| OSX<=10.8 contains the tool directly, for OSX>=10.9 some [[#OSX109|extra steps]] are needed.
|-
|}

== for building AOO 3.4 and 4.0 ==

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.4 (aka Tiger) or later
| If you are using 10.5 aka Leopard, have a look at [[User:Dyrcona/LeopardBuild#flex]].
|-
|Mac 10.4 SDK
|
|-
|XCode version 2.4.1 or later
|
*For Mac OS X 10.7 (aka Lion), XCode 3.2.6 has be installed.
*If you want to use a newer version than the one that is shipped with your Mac OS X installation media, you need to register at the [https://connect.apple.com/ Apple Developer Connection] site (free of charge) to be able to [http://developer.apple.com/technology/xcode.html download it].
*On Mac OS X 10.6 (Snow Leopard), make sure to install the optional 10.4 SDK with XCode.
|}

<div id="XCODE5">
== Extra Requirements for Xcode 5 ==
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| Xcode commandline tools
| run this command in a terminal
sudo xcode-select --install
|-
| autoconf
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/tar/autoconf-2.69.tar.bz2
tar xvjf autoconf-2.69.tar.bz2
pushd autoconf-2.69
./configure --prefix=/usr/local
make
sudo make install
popd
|}

</div>

<div id="OSX109">
== Extra Requirements for OSX >= 10.9 ==
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| gnutar
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/tar/tar-1.27.tar.bz2
tar xvjf tar-1.27.tar.bz2
pushd tar-1.27
./configure --prefix=/usr/local
make
sudo make install
sudo ln -s /usr/local/bin/tar /usr/local/bin/gnutar
popd
|}
</div>

{{Template:Documentation/Note|Java: On systems < Mac OS X 10.7 Apache OpenOffice does not build yet using Java SDK 1.6.0. If you didn't configure Mac OS X for a 1.6, you don't need to do anything - the default (1.5) is OK. To change the default Java version go to Applications/Utilities/Java and modify accordingly}}

Documentation/Building Guide AOO/Building on MacOsX

2014-05-14T08:09:29Z

Hdu: minor rephrasing

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on MacOSX}}
[[Category:MacOSX]][[Category:Documentation]]

__TOC__

= Overview =

For general information on how to build Apache OpenOffice from source code, see the [[Documentation/Building_Guide_AOO|platform independent page]].

See also this slightly older [[Documentation/Building_Guide/Building_on_MacOSX|building guide]].

= Build requirements =
Additionally to the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] you need

== for building AOO 4.1 and newer ==

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.7 (aka Lion) or later
| provided by Apple
|-
| Xcode version 4.5 or later.
| Use the App Store application to get and install it. If you got Xcode 5.x some [[#XCODE5|extra steps]] are needed.
You can also [http://developer.apple.com/technology/xcode.html download] it free of charge, but a registration at the [https://connect.apple.com/ Apple Developer Connection] site is required for that.
|-
| MacOSX SDK
| SDKs compatible with OSX 10.7 are automatically provided by installing XCode 4.5 or newer
|-
| gnutar
| OSX<=10.8 contains the tool directly, for OSX>=10.9 some [[#OSX109|extra steps]] are needed.
|-
|}

== for building AOO 3.4 and 4.0 ==

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.4 (aka Tiger) or later
| If you are using 10.5 aka Leopard, have a look at [[User:Dyrcona/LeopardBuild#flex]].
|-
|Mac 10.4 SDK
|
|-
|XCode version 2.4.1 or later
|
*For Mac OS X 10.7 (aka Lion), XCode 3.2.6 has be installed.
*If you want to use a newer version than the one that is shipped with your Mac OS X installation media, you need to register at the [https://connect.apple.com/ Apple Developer Connection] site (free of charge) to be able to [http://developer.apple.com/technology/xcode.html download it].
*On Mac OS X 10.6 (Snow Leopard), make sure to install the optional 10.4 SDK with XCode.
|}

<div id="XCODE5">
== Extra Requirements for Xcode 5 ==
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| Xcode commandline tools
| run this command in a terminal
sudo xcode-select --install
|}
</div>

<div id="OSX109">
== Extra Requirements for OSX >= 10.9 ==
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| gnutar
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/tar/tar-1.27.tar.bz2
tar xvjf tar-1.27.tar.bz2
pushd tar-1.27
./configure --prefix=/usr/local
make
sudo make install
sudo ln -s /usr/local/bin/tar /usr/local/bin/gnutar
popd
|}
</div>

{{Template:Documentation/Note|Java: On systems < Mac OS X 10.7 Apache OpenOffice does not build yet using Java SDK 1.6.0. If you didn't configure Mac OS X for a 1.6, you don't need to do anything - the default (1.5) is OK. To change the default Java version go to Applications/Utilities/Java and modify accordingly}}

Documentation/Building Guide AOO/Building on MacOsX

2014-05-14T08:07:40Z

Hdu: minor cleanup

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on MacOSX}}
[[Category:MacOSX]][[Category:Documentation]]

__TOC__

= Overview =

For general information on how to build Apache OpenOffice from source code, see the [[Documentation/Building_Guide_AOO|platform independent page]].

See also this slightly older [[Documentation/Building_Guide/Building_on_MacOSX|building guide]].

= Build requirements =
Additionally to the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] you need

== for building AOO 4.1 and newer ==

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.7 (aka Lion) or later
| provided by Apple
|-
| Xcode version 4.5 or later.
| Use the App Store application to get and install it. If you got Xcode 5.x some [[#XCODE5|extra steps]] are needed.
You can also [http://developer.apple.com/technology/xcode.html download] it free of charge, but a registration at the [https://connect.apple.com/ Apple Developer Connection] site is required for that.
|-
| MacOSX SDK
| SDKs compatible with OSX 10.7 are automatically provided by installing XCode 4.5 or newer
|-
| gnutar
| is include in OSX<=10.8, for OSX>=10.9 some [[#OSX109|extra steps]] are needed.
|-
|}

== for building AOO 3.4 and 4.0 ==

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.4 (aka Tiger) or later
| If you are using 10.5 aka Leopard, have a look at [[User:Dyrcona/LeopardBuild#flex]].
|-
|Mac 10.4 SDK
|
|-
|XCode version 2.4.1 or later
|
*For Mac OS X 10.7 (aka Lion), XCode 3.2.6 has be installed.
*If you want to use a newer version than the one that is shipped with your Mac OS X installation media, you need to register at the [https://connect.apple.com/ Apple Developer Connection] site (free of charge) to be able to [http://developer.apple.com/technology/xcode.html download it].
*On Mac OS X 10.6 (Snow Leopard), make sure to install the optional 10.4 SDK with XCode.
|}

<div id="XCODE5">
== Extra Requirements for Xcode 5 ==
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| Xcode commandline tools
| run this command in a terminal
sudo xcode-select --install
|}
</div>

<div id="OSX109">
== Extra Requirements for OSX >= 10.9 ==
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| gnutar
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/tar/tar-1.27.tar.bz2
tar xvjf tar-1.27.tar.bz2
pushd tar-1.27
./configure --prefix=/usr/local
make
sudo make install
sudo ln -s /usr/local/bin/tar /usr/local/bin/gnutar
popd
|}
</div>

{{Template:Documentation/Note|Java: On systems < Mac OS X 10.7 Apache OpenOffice does not build yet using Java SDK 1.6.0. If you didn't configure Mac OS X for a 1.6, you don't need to do anything - the default (1.5) is OK. To change the default Java version go to Applications/Utilities/Java and modify accordingly}}

Documentation/Building Guide AOO/Building on MacOsX

2014-05-14T08:04:33Z

Hdu: gnutar is no longer installed in OSX>=10.9

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on MacOSX}}
[[Category:MacOSX]][[Category:Documentation]]

__TOC__

= Overview =

For general information on how to build Apache OpenOffice from source code, see the [[Documentation/Building_Guide_AOO|platform independent page]].

See also this slightly older [[Documentation/Building_Guide/Building_on_MacOSX|building guide]].

= Build requirements =
Additionally to the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] you need

== for building AOO 4.1 and newer ==

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.7 (aka Lion) or later
| provided by Apple
|-
| Xcode version 4.5 or later.
| Use the App Store application to get and install it. If you got Xcode 5.x some [[#XCODE5|extra steps]] are needed.
You can also [http://developer.apple.com/technology/xcode.html download] it free of charge, but a registration at the [https://connect.apple.com/ Apple Developer Connection] site is required for that.
|-
| MacOSX SDK
| SDKs compatible with OSX 10.7 are automatically provided by installing XCode 4.5 or newer
|-
| gnutar
| is include in OSX<=10.8, for OSX>=10.9 some [[#OSX109|extra steps]] are needed.
|-
|}

== for building AOO 3.4 and 4.0 ==

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.4 (aka Tiger) or later
| If you are using 10.5 aka Leopard, have a look at [[User:Dyrcona/LeopardBuild#flex]].
|-
|Mac 10.4 SDK
|
|-
|XCode version 2.4.1 or later
|
*For Mac OS X 10.7 (aka Lion), XCode 3.2.6 has be installed.
*If you want to use a newer version than the one that is shipped with your Mac OS X installation media, you need to register at the [https://connect.apple.com/ Apple Developer Connection] site (free of charge) to be able to [http://developer.apple.com/technology/xcode.html download it].
*On Mac OS X 10.6 (Snow Leopard), make sure to install the optional 10.4 SDK with XCode.
|}

<div id="XCODE5">
== Extra Requirements for Xcode 5 ==
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| Install the commandline tools
| run this command in a terminal
sudo xcode-select --install
|}
</div>

<div id="OSX109">
== Extra Requirements for OSX >= 10.9 ==
{| class="prettytable" border="1" width="100%"
|-
! style="width: 20%"|What
! Where to get / Remarks
|-
| Get gnutar
| Run these commands in a terminal
curl -OL http://ftpmirror.gnu.org/tar/tar-1.27.tar.bz2
tar xvjf tar-1.27.tar.bz2
cd tar-1.27
./configure --prefix=/usr/local
make
sudo make install
sudo ln -s /usr/local/bin/tar /usr/local/bin/gnutar
|}
</div>

{{Template:Documentation/Note|Java: On systems < Mac OS X 10.7 Apache OpenOffice does not build yet using Java SDK 1.6.0. If you didn't configure Mac OS X for a 1.6, you don't need to do anything - the default (1.5) is OK. To change the default Java version go to Applications/Utilities/Java and modify accordingly}}

Documentation/Building Guide AOO/Building on MacOsX

2014-05-14T07:50:42Z

Hdu: Xcode5 doesn't directly install the command line tools

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on MacOSX}}
[[Category:MacOSX]][[Category:Documentation]]

__TOC__

= Overview =

For general information on how to build Apache OpenOffice from source code, see the [[Documentation/Building_Guide_AOO|platform independent page]].

See also this slightly older [[Documentation/Building_Guide/Building_on_MacOSX|building guide]].

= Build requirements =
Additionally to the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] you need

== for building AOO 4.1 and newer ==

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.7 (aka Lion) or later
| provided by Apple
|-
| Xcode version 4.5 or later.
| Use the App Store application to get and install it. If you got Xcode 5.x some [[#XCODE5|extra steps]] are needed.
You can also [http://developer.apple.com/technology/xcode.html download] it free of charge, but a registration at the [https://connect.apple.com/ Apple Developer Connection] site is required for thas.
|-
| MacOSX SDK
| SDKs compatible with OSX 10.7 are automatically provided by installing XCode 4.5 or newer
|-
|}

== for building AOO 3.4 and 4.0 ==

{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.4 (aka Tiger) or later
| If you are using 10.5 aka Leopard, have a look at [[User:Dyrcona/LeopardBuild#flex]].
|-
|Mac 10.4 SDK
|
|-
|XCode version 2.4.1 or later
|
*For Mac OS X 10.7 (aka Lion), XCode 3.2.6 has be installed.
*If you want to use a newer version than the one that is shipped with your Mac OS X installation media, you need to register at the [https://connect.apple.com/ Apple Developer Connection] site (free of charge) to be able to [http://developer.apple.com/technology/xcode.html download it].
*On Mac OS X 10.6 (Snow Leopard), make sure to install the optional 10.4 SDK with XCode.
|}

<div id="XCODE5">
== Extra Requirements for Xcode 5 ==
{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|Step
! What to do
|-
| Install the commandline tools
| run this command in a terminal
sudo xcode-select --install
|}

</div>

{{Template:Documentation/Note|Java: On systems < Mac OS X 10.7 Apache OpenOffice does not build yet using Java SDK 1.6.0. If you didn't configure Mac OS X for a 1.6, you don't need to do anything - the default (1.5) is OK. To change the default Java version go to Applications/Utilities/Java and modify accordingly}}

Documentation/Building Guide AOO

2014-05-14T07:33:01Z

Hdu: unxmacci target was never released (unxmacci 32bit Xode4+ clang based build)

{{DISPLAYTITLE:Apache OpenOffice Building Guide}}

= Preface =
This guide will help you to build Apache OpenOffice from its source code. It details the prerequisites and explains how to download the source code, prepare and then run the build. [[Documentation/Building_Guide_AOO/Step_by_step|Step-by-step instructions]] for resolving the pre-requisites of individual platforms and building on them are available.

Here is the short version for the brave and impatient:
* Download the source: <code>svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo</code>
* Configure: <code>cd main/ ; autoconf ; ./configure <some-switches> ; ./bootstrap</code>
* Build: <code>source <platform-dependend-name>.sh ; cd instsetoo_native ; build --all</code>
* Wait for an hour or more (The build can take up to 3 hours.)
* Install office
* Enjoy

The detailed description below gives a broader introduction into the build process and explains for the various steps.

==Status==
This document is loosely based on an older [[Documentation/Building Guide|version]]. I have tried to avoid duplication and to move anything that all platforms have in common to this page. Many details have been removed on purpose because they refer to older version of OpenOffice. However, there are still some things not explained in the necessary detail on this page:
* How to use ccache

{{Documentation/SeeAlso|*[[How_to_build_Symphony%27s_source_code]] }}

= Getting help =
You can get help by searching this wiki or by asking questions on the [http://openoffice.apache.org/mailing-lists.html#development-mailing-list-public developers mailing list].

You can help us improve this guide by pointing out any errors (preferably after finding a solution).
Or don't be shy and edit (and improve) these pages yourself.

= Basics =

In order to build Apache OpenOffice you need a proper environment. This includes
* a command line interpreter, typically bourne shell compatible (sh or bash) inside a terminal. On Windows you will need to install Cygwin to provide it.
* C++ compiler and linker. The exact choice depends on the operating system.
* Perl interpreter and several modules.
* Many tools from the Unix world like make or sed.

See section [[#General_Build_Requirements | General Build Requirements]]
for an exact list of requirements.

= Getting the source =

The source code is available as SVN repository at https://svn.apache.org/repos/asf/openoffice

Check it out with

svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo

More details about how to check out source code from SVN can be found [http://openoffice.apache.org/source.html here].

== Space Requirements ==

The checked out files take up somewhat over 5GB on disk (more than 150000 files in more than 7000 folders and the SVN overhead).

After building this becomes (on Windows7) almost 17GB (more than 406000 files in more than 23000 folders).

You can use git as well. There exists no guide for this, therefore ask on dev@openoffice.apache.org, if you want to use git.

= Organization of the source and output tree =

The source code has five top level directories:
;main/:contains most of the so called modules. Each module typically provides one or more libraries. The source code of the writer application for example can be found in main/sd/.
;test/:contains the new [[QA/test_automation_guide | automated testing framework]]
;ext_libraries/:is the new home of modules that build external libraries (libraries maintained outside of Apache OpenOffice and often outside Apache).
;ext_sources/:contains the tar balls (archives) of external libraries. They are included both for convenience and to make sure that specific versions remain available. Note that the source package of the Apache OpenOffice release does not contain any external tar balls.
;extras/:holds the localization data.

Most tools and scripts that are used for building are located below <code>main/solenv/</code>:
*dmake makefiles in <code>main/solenv/inc/</code>
*gmake makefiles in <code>main/solenv/gbuild/</code>
*executables and perl files in <code>main/solenv/bin/</code>
*perl modules in <code>main/bin/modules/</code>

Libraries and other output files that are shared between modules are stored in <code>main/solver/</code>.

=Building=

==Overview==

Building Apache OpenOffice consists of three steps:
;Configuring/bootstrapping:Detect platform, operating system, compiler, etc. and write the information into a shell script for later use. The developer can turn on or off certain features in this phase.
;Building:Compile the source code, transform other input files, apply localization.
;Packing:Create a set of files, the installation set, that can be installed on the respective operating system. This can be msi/cab files for windows, deb or rpm for Linux, dmg for Mac.

The configure step has to be carried out only once. Building and packing is necessary after every source code change. There are short cuts to avoid parts of these steps (when you know what you are doing.)

The building examples in this wiki document use only command line approaches to building. Depending on your expertise, it may be possible to use an IDE which allows specification of custom build scripts.

== General Build Requirements ==

The general requirements for all platforms are
{| class="prettytable"
|- valign="top"
! Requirement
! Description
! Configure switch
|- valign="top"
| Java JDK
| Java Implementation compatible with [http://java.sun.com/j2se/1.5/ JDK 1.5] or [http://java.sun.com/javase/6/ JDK 1.6]. [http://openjdk.java.net/ OpenJDK] is supported as well.

For Windows [http://www.oracle.com/technetwork/java/javase/downloads/index.html/ JDK 1.7] is recommended.
| --with-jdk-home=
|- valign="top"
| Perl
| Perl 5 - note: for Windows Perl will be installed as part of the cygwin environment.

Also required are the perl packages
Archive::Zip
LWP::UserAgent
XML::Parser
They can be installed from the shell with (you may have to run it with super user/administrator rights)
perl -MCPAN -e shell
If it is executed for the first time then CPAN will ask for configuration. Choose autoconfiguration.
Eventually the CPAN shell appeares accepts commands. Install missing modules with
install <module-name>
Find more details [http://wiki.services.openoffice.org/wiki/CPAN_install here].<sup>5</sup>
|- valign="top"
| CUPS
| cups headers. Provided by a cups-devel package or a libcups2-devel

note: not for Windows
|- valign="top"
| PAM
| PAM support. Provided by a pam-devel package or a libpam-dev

note: not for Windows
|- valign="top"
| Apache Ant
| [http://ant.apache.org/ Ant 1.9 or later] (see note)
| --with-ant-home=
|- valign="top"
| Archiver
| zip and unzip - note: for Windows zip and unzip will be installed as part of the cygwin environment.
|- valign="top"
| gperf
| [http://www.gnu.org/software/gperf/gperf.html gperf] tool - note: for Windows gperf will be installed as part of the cygwin environment.
|- valign="top"
| NSS<sup>1</sup>
| For Windows the Mozilla build tools<sup>2</sup> are needed to build the nss module. They can be obtained [http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/ here].
|- valign="top"
| unowinreg.dll
| [http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll pre-built unowinreg.dll] (see note)
Without this file, configure will try to set up cross-compiling with windows.
note: Not for windows. Required on all non-windows platforms. Download with:
cd $SRC/main && wget -O external/unowinreg/unowinreg.dll http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll
|-
|}

'''Notes:'''
# The nss module ("Network Security Services") provides security services needed for e.g. password protection. NSS can be disabled using the configure switch <tt>--disable-nss-module</tt>.
# NSS is provided by the Mozilla project. Building it on Windows requires the [http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32 MozillaBuild tools]. Get the latest version, install it and use the configure switch <tt>--with-mozilla-build</tt> to tell configure where the tools are installed. For example: <tt>--with-mozilla-build=c:/mozilla-build</tt>
# Please note that CPAN is not able to deal with usernames containing spaces. To work around this fact, when CPAN asks you to specify the CPAN build and cache directory, change the default suggestion to /cpan.
# Apache Ant: Assure a proper ant set-up by downloading and installing ant, in total, from the ant site linked above. If you are a Linux developer, your distro may not have ant setup correctly for building Apache OpenOffice.
# Use <tt>./configure --help</tt> to see all possible configuration options

See also the platform specific requirements for
*[[Documentation/Building_Guide_AOO/Building_on_Windows|Windows]]
*[[Documentation/Building_Guide_AOO/Building_on_Linux|Linux]]
*[[Documentation/Building_Guide_AOO/Building_on_MacOsX|MacOSX]]

==Configuration and bootstrapping==
This is typically done only once after the source code is checked out. Repeat this after changing your mind about options given to configure.

The call to
autoconf
creates the main/configure script from main/configure.in and some other input files.

The set of options/switches given to configure depends on the platform and your choice of features. A typical call starts like this
configure \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://www.msweet.org/files/project2/epm-3.7-source.tar.gz \
It tells configure where to find the source code of external tools dmake and epm.

By default only source code under [http://www.apache.org/legal/3party.html#category-a category A] licenses is compiled and included. Besides the Apache License 2.0 this includes for example BSD and MIT/X11 license. If you want to enable features that rely on third party code under [http://www.apache.org/legal/3party.html#category-b category B] licenses (like MPL, CPL, EPL, etc) then add the option
--enable-category-b

For inclusion of externally hosted dictionary extensions add option
--enable-bundled-dictionaries
Note that dictionaries rely on a category B third party library (hunspell). Therefore <code>--enable-category-b</code> is a prerequisite for <code>--enable-bundled-dictionaries</code>. Dictionaries have a variety of licenses and are bundled without modification: they are not compiled.

The <code>--with-lang</code> option will introduce the build of additional language resources. This switch accepts one or more RFC 1766 language tags as arguments, unfortunately not all languages are supported. Check the <code>[http://svn.apache.org/viewvc/openoffice/trunk/main/solenv/inc/langlist.mk?view=markup solenv/inc/langlist.mk]</code> file for all the currently supported language tags. The environment variable WITH_LANG will then contain the language tags of the additional (en-US will always be build) languages. Example:
--with-lang="de fr"
enables the build of the localized German and French version.

You can run the rat scan while building with option
--with-rat-scan
[[Documentation/Building_Guide_AOO/Rat_Scan|Here]] you can find details.

Finish this step by running
./bootstrap
This will build dmake and epm, download missing source code tar balls of external libraries, and download missing external dictionary extensions.

==Building==
Start by including the environment variables prepared by configure into your current environment with
<tt>source <shell-script-name></tt>
where <shell-script-name> depends on your platform:
{| class="prettytable"
|-
!platform id
!<shell-script-name>
|-
| wntmsci12
| winenv.set.sh
|-
| unxlngi6
| LinuxX86Env.Set.sh
|-
| unxlngx6
| LinuxX86-64Env.Set.sh
|-
| unxmacci
| MacOSXX64Env.Set.sh
|}
Look into main/set_soenv for more platforms. (search for lines <code>$OUTPATH = "<platform>";</code> and the nearby line <code>$outfile = "<shell-script-name>";</code>. Add the suffix <code>.sh</code> for the bash variant.

If you want to build the whole office and the install sets then
cd main/instsetoo_native
build --all
You may want to experiment with the -P options for multi process builds to reduce the build time.
build --all -P<m> -- -P<n>
tells build to use <code>m</code> processes (build up to <code>m</code> modules in parallel) and <code>n</code> threads for each module.

Details about creating installation sets can be found [[Building_installation_packages|here]].

Building Apache OpenOffice uses a custom build command, build.pl, located in /main/solenv/bin.
You may find it helpful to learn more about build options from the [http://www.openoffice.org/tools/tools/build.html Build Documentation]

==Partial Builds==

Building the whole office takes a lot of time. Therefore it may be preferable to build only parts after making changes to the source code.
There are two different types of partial builds:
;Compatible:Can be used only when the code changes do not change exported interfaces. Use with care and only when you know what you are doing.
;Incompatible:Use for code changes that modify exported C++ or IDL interfaces, that modify resources that are used by other modules, or when you are not sure.
:If you are a new developer, you should probably always assume your changes are "incompatible" and follow the instructions for '''Incompatible Build'''.

===Make Systems Used by Apache OpenOffice===

For the following Build sections you should be aware that Apache OpenOffice uses two different '''make''' systems to build its modules.
*The older one is based on dmake
*The other and newer one is based on GNU make. This system is often referred to as gbuild.
When a module contains, among others, a Makefile and a Module_<module>.mk file then it is a gbuild module.

===Compatible Build===

After changing code in module <module> which does not change any exported interfaces do
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build
deliver
|
cd <module>
make -sr
No explicit call to <code>deliver</code> is necessary for gbuild modules.
|}
to compile and deliver the resulting libraries to <code>main/solver/</code>. You may want to erase the output of a previous compilation:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build --from <module> --prepare
or faster (but without the un-deliver)
cd <module>
rm -fr <platform>/
|
cd <module>
make clean
|}

===Incompatible Build===

Modifications that change exported interfaces require not only the module to be rebuild that contains the modified code. All depending modules (dependencies are defined in <code><module>/prj/build.lst</code>) have to be rebuild as well. This is best done from <code>main/instsetoo_native/</code>:
<tt>cd main/instsetoo_native/</tt>
<tt>build --from <incompatible-module> --prepare</tt>
<tt>build --from <incompatible-module></tt>

The second line removes the output of all modules that have to be recompiled. The drawback of this command is that the output of modules which are build via gbuild are not removed. Thus, the following additional command performed after the second one will do the trick:
build --from <incompatible-module> --job="make clean; make clean debug=t" --ignore

===Frequently used options===

In order to add debug information to libraries and executables, add the <code>debug</code> switch to any <code>build</code> or <code>make</code> command:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build debug=t
|
cd <module>
make -sr debug=t
|}
Remember that for the gbuild system you have to use the debug flag also when cleaning a module (otherwise eg the wrong precompiled headers are deleted and are not rebuilt):
make clean debug=t

You can force make to rebuild dependency information by first deleting it with the depend option. It would be rebuilt automatically with the next build:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build depend=t
build
|
cd <module>
make -sr depend=t
make -sr
|}

= [http://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO/Step_by_step Step-by-Step Building Guide for Different Platforms] =
[[Category:Documentation]][[Category:Development]][[Category:Porting]]

Office Open XML/Legacy Implementation

2014-03-25T10:34:30Z

Hdu: update repo links to their post-graduation location

= OOXML Basics =

"Office Open XML" is an XML based file format that has been published as [http://www.ecma-international.org/publications/standards/Ecma-376.htm ECMA-376]. It is used as default file format by Microsoft Office 2007/2010.

There are plans to support this file format in OpenOffice.org for interoperation with Microsoft Office 2007/2010.

There are 3 major types of formats with 2 minor types as important supplement.

* [[WordprocessingML]] - For word processor documents (file extensions may be docx, docm)
* [[SpreadsheetML]] - For spreadsheet documents (file extensions may be xlsx, xlsm)
* [[PresentationML]] - For presentation documents (file extensions may be pptx, pptm)
* [[DrawingML]] - Used by other markup language to represent graphics data.
* [[VML]] - A legacy vector markup.

== Packaging Conventions ==
OpenXML document is a package that consists of a flat collection of '''"parts"'''. Each "part" has a case-''insensitive'' part name that consists of a slash (/) delimited sequence of segment names such as "/pres/slides/slide1.xml".

For the most part, the ZIP compression is used to package the parts, in which case the term '''"package"''' refers to the ZIP archive, and the parts refer to the individual files archived within. The part name in this case is the file path within the archive.

Each part also has a '''content type''', and '''/[Content_Types].xml''' provides the content type of each part within the archive.

== Relationships ==
Packages and parts can contains '''explicit relationships''' to other parts as well as to external resources. Every explicit relationship has an ID and a type, and relationship types are named using URIs.

The set of explicit relationships for each package or part is stored in a relationship part whose name (or path) follows a specific convention e.g. the relationship part for a part called '''"/a/b/c.xml"''' is called '''"/a/b/_rels/c.xml.rels"'''. As a special case, the relationship part for the package as a whole is called '''"/_rels/.rels"'''.

= AOO.o Implementation =

Spreadsheet and Presentation import are both in the [[Oox]] module.
Word document import is in the [[WriterFilter]] module.

Some legacy notes:

The initial version of [[Oox]] from the CWS xmlfilter02 has been integrated into SRC680_m243. The continuing [[CWS]] is xmlfilter03 in SRC680. ([http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Fxmlfilter03 view the workspace on EIS])

To fetch the oox code from CVS (using CVSROOT is set properly):

cvs co -r cws_src680_xmlfilter03 -d oox xml/oox

Bonsai is also convenient to follow the changes:

[http://bonsai.go-oo.org/cvsquery.cgi?treeid=default&module=all&branch=cws_src680_xmlfilter03&branchtype=match&dir=xml%2Foox&file=&filetype=match&who=&whotype=match&sortby=Date&hours=2&date=week&mindate=&maxdate=&cvsroot=%2Fhome%2Fooweb%2Fcvsup the changes done in the last 2 weeks]

== Oox ==

There is some code in [[Oox]] module from the [[Xml]] project. To fetch the oox code from SVN:

svn co https://svn.apache.org/repos/asf/openoffice/trunk/main/oox aoo/oox

One important note: we use the term '''fragment''' in the name of our source files to correspond with what the standard calls '''part'''. For instance, the source file that contains class definition that handles the workbook part in [[SpreadsheetML]] is called workbookfragment.cxx. This convention is prevalent across all application types within [[Oox]] module.

== Writerfilter ==

To fetch code from [[Writerfilter]] module from SVN:

svn co https://svn.apache.org/repos/asf/openoffice/trunk/main/writerfilter aoo/writerfilter

== Implementation Generalities ==

The whole [[Oox]] filter makes use of [[FastParser]] service to implement an event driven [[SAX]] parser.

= How to open in OpenOffice.org 3.4 =

* [[Documentation/FAQ/General/OpeningMSO2007Files|Opening Microsoft Office 2007 files]]

= Various Resources =

* [[OpenOffice_filters_using_the_XML_based_file_format|OpenOffice filters using the XML based file format]]
* [http://books.evc-cit.info/ OASIS OpenDocument Essentials]
* http://blogs.sun.com/GullFOSS/entry/office_open_xml_import_filter
* [http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Fxmlfilter03 CWS on EIS]
* [http://www.ecma-international.org/publications/standards/Ecma-376.htm ECMA published standard]
* [http://www.ecma-international.org/news/TC45_current_work/TC45_available_docs.htm Ecma Office Open XML File Formats Standard]
* [http://blogs.msdn.com/brian_jones/archive/2005/06/20/430892.aspx Brian Jones introduction to the Office 12 File Format]

[[Category:Filter]]
[[Category:Office Open XML]]

OpenOffice NetBeans Integration

2014-03-25T10:22:42Z

Hdu: update repo link to their post-graduation location

[[image:OOo-Netbeans-Plugin.png|right]]
= Overview =
The OpenOffice.org API plugin for NetBeans simplifies the development of OpenOffice.org extensions. You can use the OpenOffice.org API to program OpenOffice.org, and automate remote or in process tasks extend OpenOffice.org with completely new functionality. The OpenOffice.org API plugin for NetBeans simplifies accessing and using of the API in new projects and simplifies the task of creating complete OpenOffice.org extension packages (comparable to the NetBeans plugin modules).

= Download and Installation =
Download the latest version from within NetBeans by clicking on Tools - Plugins. You can find the plugin in the "Available Plugins" section as "OpenOffice.org API Plugin". Install it and try it out! The configuration is self explanatory, for detailed information see [[OpenOffice_NetBeans_Integration#Configuration|Configuration]]. The plugin appears automatically in Netbeans 6.5.x, 6.7.x, 6.8 (version 2.0.6) but is not listed for later version (up to 7.1). You can download the [http://people.apache.org/~cmarcum/devtools/org-openoffice-extensions-3.0.0.beta.nbm org-openoffice-extensions-3.0.0.beta.nbm] version for NetBeans 7.2 provided by Carl Marcum. This version is under active development and will be made available in the NetBeans plugin manager list when finished. Until then, remember that it is an '''Beta''' version.

The source is available in the Apache OpenOffice.org source SVN repository in the '''devtools''' tree. The trunk is under development and the tagged 3.0.0.beta will build and run.
<blockquote>[https://svn.apache.org/repos/asf/openoffice/devtools/netbeansintegration/trunk https://svn.apache.org/repos/asf/openoffice/devtools/netbeansintegration/trunk]</blockquote>

= Build and Install from Source =
There is a tagged version of 3.0.0.beta in the SVN repository. To checkout this version using subversion to a directory aoo-netbeans:
<blockquote>
svn co http://svn.apache.org/repos/asf/openoffice/devtools/netbeansintegration/tags/3.0.0.beta aoo-netbeans
</blockquote>

Start Netbeans 7.x then select File -> Open Project and navigate to the aoo-netbeans directory the source was checked out to.<br />
In the projects window RMB on project -> Create NBM. The .nbm file will be located in the build sub-directory of the project.<br />
Select Tools -> Plugins and select Downloaded Tab -> Add and select org-openoffice-extensions.nbm from project build directory then check box and Install.

Setup AOO Installation and SDK Settings below are still valid.

= Features =
Overview of the features included in the current plugin.
== Project Types ==
Click on "File" - "New Project..." and choose category "OpenOffice.org" to open a new project. All project types create working code. Once the project wizard is finished, a working
compilable project is created. It may not do anything, but it can be used
in OpenOffice.org from the beginning.

*'''[[OpenOffice_Simple_UNO_Client_Application_Project_Type|OpenOffice.org Client Application Project Type]]'''
This project type creates an adapted J2SE client application project with additional support of the
simple UNO bootstrap feature. To enable this, some pre-compiled glue code is bundled with the client
application. The result is a portable jar file that bootstraps OpenOffice.org on any supported OS.

*'''[[OpenOffice_Calc_Add-In_Project_Type|OpenOffice.org Calc Add-In Project Type]]'''
This project type creates an adapted J2SE class library project with special support for a UNO
component library and an office extension package. The wizard collects the necessary information for new
Calc built-in functions and abstracts from the underlying UNO technology.

*'''[[General_UNO_Component_Project_Type|General UNO Component Project Type]]'''
This project type creates an adapted J2SE class library project with special support for a
UNO component library and an OpenOffice.org extension package. The wizard collects information about services
and additional optional interfaces which should be implemented. Additional IDL types can also be
defined. A complete code skeleton is generated, with the component helper functions and the default interface methods already implemented.

*'''[[OpenOffice_Add-On_Project_Type|OpenOffice.org Add-On Project Type]]'''
This project type creates an adapted J2SE class library project with special support for a UNO
component library and an OpenOffice.org extension package. The wizard collects the necessary information for an
OpenOffice.org Add-On component and generates an Add-On specific code skeleton.

== File Types ==
Click on "File" - "New File..." and select "OpenOffice.org" as category to create a new file for an OpenOffice.org project. Note, that the OpenOffice.org category is available in all projects, although it only makes sense to use it in one of the projects stated above.
*'''xcu file type'''
Create an empty xcu file type. The files are recognized in NetBeans and
syntax highlighting is supported.

*'''xcs file type'''
Create an empty xcs file type. The files are recognized in NetBeans and
syntax highlighting is supported.

*'''UNO idl file type'''
You can use a file type wizard to create idl files. In the first step, you must select the name location
and UNO type (e.g. Service or Interface). You can add additional
information in the second step. When an interface is created, the second step asks about
the functions that the interface should contain. A complete working idl file is created, and NetBeans provides syntax highlighting. When you choose
to also create an implementation object (only available for service or interface), a Java skeleton file implementing
your new idl file will also be created.

*'''Java UNO Object file type'''
This file wizard creates a Java skeleton file that implements all functions defined in an interface or service idl file. If you choose a service, the Java implementation file will also be
registered in OpenOffice.org when your extension is deployed.

== Create, deploy and debug ==
These are actions that are available in the context menu of an extension project in the "Project"
view.

*'''Debug Extension in Target OpenOffice.org'''
If necessary, "Create OXT" is executed. The resulting OXT file is registered in a temporary user installation of OpenOffice.org, which is located in the build directory of the project. (Cleaning of the project removes the user installation again.) Then OpenOffice.org is started with this user installation. To trigger the registered extension, an appropriate action must be done in OpenOffice.org.
Execution stops at any breakpoints added to the code of the extension and debugging can start from there.

*'''Deploy and Run OpenOffice.org Extension'''
If necessary, "Create OXT" is executed. The resulting OXT file is registered inside the user installation of OpenOffice.org. Then OpenOffice.org is started.

*'''Create OXT'''
If necessary, your code is compiled. The resulting jar file is packed into an OXT file, together with other necessary files such as configuration files, a manifest file, and images. The OXT file is located in the "dist" directory of the project.

*'''Publish Extension on OpenOffice.org Website'''
The starting page for uploading and publishing your extension on api.services.openoffice.org is loaded in your default web browser.

== Miscellaneous ==
*'''External Jars'''
Additional external jars that are used in an extension are automatically copied into the OXT file and added to the extension's classpath. A registered extension in OpenOffice.org can still use the functionality provided there.
The jars can be added to the project as a single jar or as part of a NetBeans library. Note: All the jars from a library will be added to the OXT file, independent from their usage in the extension.

== Specifications ==

Find here links to the specifications of the plugin on the api.openoffice.org page.

[http://specs.openoffice.org/sdk/tools/spec_openoffice-netbeans-integration.odt OpenOffice.org Plugin for NetBeans]

[http://specs.openoffice.org/sdk/tools/spec_openoffice-netbeans-integration-addon-wizard.odt OpenOffice.org Plugin for NetBeans: Add-On Wizard]

[http://specs.openoffice.org/sdk/tools/spec_openoffice-netbeans-integration-calc-addin-wizard.odt OpenOffice.org Plugin for NetBeans: Add-In Wizard]

[http://specs.openoffice.org/sdk/tools/spec_openoffice-netbeans-integration-component-wizard.odt OpenOffice.org Plugin for NetBeans: Component Wizard]

[http://specs.openoffice.org/sdk/tools/spec_openoffice-netbeans-integration-debug-component.odt OpenOffice.org Plugin for NetBeans: Debug Feature]

[http://specs.openoffice.org/sdk/tools/spec_openoffice-netbeans-integration-new-idl-type.odt OpenOffice.org Plugin for NetBeans: IDL type support]

[http://specs.openoffice.org/sdk/tools/spec_openoffice-netbeans-integration-description-xml.odt OpenOffice.org Plugin for NetBeans: Support description.xml]

= Working with the plugin =
The following section describes how you can work with the plugin and describes the requirements because the plugin make use of some external stuff provided by an office and the OpenOffice.org SDK.

== Requirements ==
The plugin works only in combination with OpenOffice.org and an appropriate OpenOffice.org Software Development Kit (SDK). The minimal suggested version is OpenOffice.org 2.0.4. With earlier versions, some features of the plugin will not work.

*'''[http://download.openoffice.org OpenOffice.org]''' or '''[http://www.sun.com/staroffice StarOffice 8]''' or higher versions of both programs
*'''[http://download.openoffice.org/sdk.html OpenOffice.org Software Development Kit (SDK)]'''

Note that the versions of OpenOffice.org and the OpenOffice.org SDK must match for everything to work.

== Configuration ==
Before you can use the new project types you must configure the plugin because it needs an installed OpenOffice.org and OpenOffice.org SDK.

Note:
* As default settings, a standard installation will be found by the plugin - but only if OpenOffice.org together with the SDK are present.
* When you choose the OpenOffice.org installation and an appropriate SDK is found, that SDK is chosen, the "OpenOffice.org SDK Installation" field is then disabled.
* If you change the OpenOffice.org or OpenOffice.org SDK installation, these changes are effective for projects created from now on only.

For changing the office and SDK installation please choose
*'' '''Tools -> Options -> Miscellaneous -> OOo API plugin''' ''
and select a valid OpenOffice.org and OpenOffice.org SDK installation.
<br>[[Image:OpenOffice_Extensions_Plugin_Options.png|center]]<br>
The configuration step automatically installs a new OpenOffice.org library which can be used in other projects to support the OpenOffice.org API. Including this library in your own projects enables context sensitive help and code completion.

Note: on Debian/Ubuntu, the OpenOffice.org installation directory is <code>/usr/lib/openoffice/</code>. For other *nix platforms the location may vary, but you can find the location by inspecting the shell script <code>/usr/bin/ooffice</code> to see where the <code>ooqstart</code> executable is in your installation.

== Working with new Project Types ==
The plugin integrates four new project types under the category '''StarOffice/OpenOffice.org''':
*'''StarOffice/OpenOffice.org Add-On'''
*'''StarOffice/OpenOffice.org Calc Add-Ins'''
*'''StarOffice/OpenOffice.org Client Application'''
*'''StarOffice/OpenOffice.org Component'''

The wizards will collect the necessary information to create the new projects and should follow the NetBeans philosophy. You can simply choose
*'' '''File -> New Project -> OpenOffice.org -> <project_type>''' ''
For more details about the project types please take a look at
*[[OpenOffice_Simple_UNO_Client_Application_Project_Type|OpenOffice.org UNO Client Application Project Type]]
*[[OpenOffice_Calc_Add-In_Project_Type|OpenOffice.org Calc Add-In Project Type]]
*[[General_UNO_Component_Project_Type|OpenOffice.org Component Project Type]]
*[[OpenOffice_Add-On_Project_Type|OpenOffice.org Add-On Project Type]]

== Migrate Projects ==
To migrate projects from an older version of the plugin to a new one is not necessary - the plugin itself will take care of that: build-uno-impl.xml and the project-uno.properties are updated, when updated versions of these files are needed for new features of the updated plugin. Note that build-uno-impl.xml will be overwritten, but project-uno.properties not. In the properties file, only new entries are added, existing ones are kept as they are. The update of the files happens when an old project is opened with a new version of the plugin and for all opened projects when the new plugin is downloaded and installed.

When migrating from one Office version to another (or porting a project across platforms), only a library has to be changed, called "OpenOffice.org <version_number>" (or "StarOffice <version_number>"). Choose '''Tools -> Libraries''' to get an overview of the existing libraries. A library is created when a valid OpenOffice.org and OpenOffice.org SDK is selected in '''Tools -> Options -> Miscellaneous -> OOo API Plugin''' (See [[OpenOffice_NetBeans_Integration#Configuration|Configuration]] for more details).
* To change the library, click right on the project in the '''Project''' window and open the properties. Select '''Libraries''' as category and remove the one that points to the old installation and add the new one.
* When porting the project across platforms, NetBeans notifies that a reference problem exists. The steps for changing the libraries also help in this case.

== Known Problems and Missing Features ==

* Context sensitive help does not work on Linux (Solaris not yet tested), even the javadoc generated Java UNO runtime reference documentation does not work on Linux. Under Windows both work as expected.
* "Red Dot Problem": When you have created a project that supports own idl files (e.g. a Clac AddIn), a "clean" on the project will produce "red dots" that show that imported functionality is missing. The cause for this is the deleted jar file with the idl types that are used in your project. Although this does not seem to be the case, a compile will work and solve the problem. Sometimes the signs appear when "clean and build" is chosen - here the compiled idl files exist, but NetBeans does not recognize that. Open the offending Java file to solve that. Solution: compile idl files in the background and produce a "shadow" jar file in a temp directory that can be used even if the "official" file in the <project_name>/dist folder is deleted.
* With NetBeans versions at least 6.1 there is an update problem regarding NetBeans property sheets and node views: property sheet changes are not reflected in the node view. Seems like the notify mechanism for these updates has changed.

= Releases =

{|cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse; margin-left: 3em; border-color: #333;"
|- style="background-color: #DEDEDE;"
| Release Version || Planned Release Date || Release Date || Planned Features
|- align=center
| 1.0 || 05/08/07 || 05/08/07 || -
|- align=center
| 1.1 || 09/01/07 || 09/18/07 || [[OpenOffice_NetBeans_Integration/Releases/Release_1.1| see 1.1]]
|- align=center
| 1.1.1 || 03/08 || 03/20/08 || [[OpenOffice_NetBeans_Integration/Releases/Release_1.1.x| see 1.1.1]]
|- align=center
| 1.1.2 || 04/08 || 04/30/08 || [[OpenOffice_NetBeans_Integration/Releases/Release_1.1.x| see 1.1.2]]
|- align=center
| 1.1.3 || 06/30/08 || - || [[OpenOffice_NetBeans_Integration/Releases/Release_1.1.x| see 1.1.3]]
|- align=center
| 2.0 || 09/08 || - || [[OpenOffice_NetBeans_Integration/Releases/Release_2.0| see 2.0]]
|- align=center
| 2.0.3 || - || - || bugfixes only
|- align=center
| 2.0.4 || - || - || bugfixes only
|- align=center
| 2.0.5 || - || - || bugfixes only
|- align=center
| 2.0.6 || - || - || bugfixes only
|- align=center
| 2.0.7.alpha || - || - || changes to support NetBeans 6.9, opnly available in the file section of the API project, [http://api.openoffice.org/files/documents/22/4772/org-openoffice-extensions-2.0.7.alpha.nbm org-openoffice-extensions-2.0.7.alpha.nbm]
|}

:   Detailed download statistics can be found [[OpenOffice_NetBeans_Integration/Releases/Download_Statistic| here]] (not up-to-date)

* [[OpenOffice_NetBeans_Integration/Releases/Release_1.2#Current_issues_concerning_NetBeans_6|Issues]] for using the plugin with NetBeans 6.

= Planned Features =
The focus is on creating new wizards for various tasks plus common basic functionality. The main programming language is Java. Support for C++ is also planned and depends on the C++ support in NetBeans which will be available at least for NetBeans 6.0. The planned feature list is not final and more specialized wizards for other service provider interfaces (SPI) are coming in the future.

== New Project Types ==
*'''[[OpenOffice_Scripting_Project_Type|OpenOffice.org Scripting Project Type]]'''<br>This new project type will create an adapted J2SE class library project with special support for OpenOffice.org scripting. It should provide you the possibility to import scripts from OpenOffice.org and open documents, edit, change and build these scripts, debug them and export them back (currently the support is planned for Java scripts only).
*'''[[OpenOffice_SmartTag_Project_Type|OpenOffice.org SmartTag Project Type]]'''<br>This new project type will simplify the development of SmartTags for the OpenOffice.org Writer application.
*'''[[OpenOffice_API_Library_Wrapper_Project_Type|OpenOffice.org API Library API Wrapper Project Type]]'''<br>This new project type should create a ''Library Wrapper Module'' to support simple usage of the OpenOffice.org API in your own projects. It bundles the necessary API jar files from OpenOffice.org in the library and in client applications. This of course is necessary to make use of the OpenOffice.org API in clients running on machines where no OpenOffice.org is installed and where the communication with OpenOffice.org is made over a remote socket connection.

== Common Features ==
*'''Editor for xcu files'''<br>This must be defined in detail but we can think of a special editor for OpenOffice .org configuration files.

= Quality Assurance =

If you find bugs please submit a new [http://api.openoffice.org/issues/enter_bug.cgi?component=sdk&issue_type=DEFECT issue] in the category '''sdk''' and the subcomponent '''netbeans-integration'''

* [[OpenOffice_NetBeans_Integration_QA|Schedule for OpenOffice.org NetBeans Integration QA ]]

= Localization =
* [[OpenOffice_NetBeans_Integration/Localization|Localization Tutorial]]

= Things to be done =
* [[OpenOffice_NetBeans_Integration/To-Dos|ToDo list]]

= Feedback =
We will continuously extend and improve the plugin in the future and your feedback is welcome and highly appreciated. We would like to invite you to discuss it on [mailto:dev@api.openoffice.org dev@api.openoffice.org] (Note: you have to be subscribed on the mailing list).

You can also submit new [http://api.openoffice.org/issues/enter_bug.cgi?component=sdk&issue_type=FEATURE feature] or [http://api.openoffice.org/issues/enter_bug.cgi?component=sdk&issue_type=ENHANCEMENT enhancement] requests in the issue tracker in the category '''sdk''' and the subcomponent '''netbeans-integration'''

[[Category:NetBeans]]
[[Category:API]]
[[Category:Effort]]

Object Inspector

2014-03-25T10:12:04Z

Hdu: update repo link to post-graduation location

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary UNO-Objects.
UNO provides a service-oriented API with abstract service descriptions exporting defined interfaces. The capabilities of a UNO Object do not open up to the developer at design time, mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html XIndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties, there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that a runtime inspection is necessary to determine what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living UNO-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt Inspector.oxt] .

Together with the new package a new toolbar is added from which the object inspector may be started.
The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:

Methods of UNO objects are presented as subnodes below a "Method" node. All methods are listed below this node, no matter what their parental interfaces are.

Properties of UNO objects are presented as subnodes below a "Properties" node.

"Interface" nodes offer a view to all methods by arranging them under their respective interface.

"Service" nodes offer a view to all supported services of a UNO object and their respectively exported interfaces and properties.

Expanding any arbitrary subnode will inspect the UNO object that is represented by the node in the same way as described above.

=== Screenshots ===

[[Image:ObjectInspector.png|600px]]

=== Calling from a Basic Macro ===

The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

=== Sourcecode generation ===

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are code generators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well. See [[ObjectInspectorComparison|Object Inspector Comparison]].

=== IDL help ===
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the IDL files of the respective interface and service descriptions.

== Development ==

=== Source code ===

You will find the Object Inspector source code within the OpenOffice.org Subversion Repository:

svn co svn://svn.apache.org/repos/asf/openoffice/trunk/main/odk/examples/java/Inspector/

The checked in source contains a complete NetBeans project, so that one can immediately start hacking around. Feel free to commit bugfixes and changes or contact cli(at)openoffice.org if you like to take over the project.

=== Known issues ===

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)
* C++ code not properly generated (it was better with previous version). [[Programming_OOoWriter#Going_further_with_Inspector|Read more here]] particularly [[Programming_OOoWriter#Java_Inspector_2| Java Inspector 2]] section.

=== Future Enhancements ===

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refer to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO object also depicts a container that exports interfaces like XIndexAccess.

== See Also ==
* [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0 Object Inspector binary file]
* [[ObjectInspectorComparison|Object Inspector Comparison]]
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [[Extensions_development_basic#Xray_tool|XRay tool description]] in this wiki.
* [http://extensions.services.openoffice.org/project/MRI MRI an Object Inspector] written on Python from the Extension Website.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and AOOBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with AOOWriter
[[Category:API]]
[[Category:Extensions]]

Aw080 documentation

2014-03-25T10:09:37Z

Hdu: update repo link to post-graduation location

[[Category:Development]]
== Branch aw080 ==

This document describes the branch aw080 and changes done there up to now (18th May 2012). The branch (now at Apache under https://svn.apache.org/repos/asf/openoffice/branches/alg/aw080) has a quite long history, I started developing it back at Oracle times. It is intended to move quite some stuff forward to get a better, faster and more stable DrawingLayer.

== Presentation ==

A presentation I held about this can be found here [[Media:ArminVortragIV.odp]]. It contains more or less a condensed (but still big) version of the following pages. At the time of doing the presentation, the diff to the trunk was about 340.000 lines.

== Motivation ==

The branch is following a mixture of goals, all intended to overcome some pretty old limitations of the DrawingLayer in the OpenOffice code. The codebase is now nearly 20 years old and was extended by quite some people. Naturally, these used all their own styles and ideas to do so and had various backgrounds (e.g. knowing about linear algebra or not). Together with the bugfixes done (which is good) sometimes by people not knowing the basic principles of the module (which is not good) quite some non-optimal places were changed and leaded to non-optimal situations. The DrawingLayer itself has to be seen as a big, very central component and can be split at least in three basic parts:

#The DrawingLayer Core which defines the DrawingLayer Model
#The Renderer which is responsible for visualisation of the Model
#The Controller which implements and offers all basic interactions with Drawinglayer objects, including Drag&Drop and others.

There are currently ca. 14 users of Drawinglayer, not only the visible applications but also Dialogs and various others. All these have to be taken care of and being adapted when making changes to DrawingLayer. All in all it's like a gordian knot and it's hard to even find parts to cut out and to replace. The main users are the Draw/Impress application, the DrawingLayer is more or less the basic Application on which these are based.

== Goals ==

The goals fall in different categories:

#Reworks
#Cleanups
#Simplifications
#Restructurings
#Modernizations

It has shown that it is impossible to move the DrawingLayer code forward with just one goal in mind. The dependencies are too huge; often when trying to cleanup one aspect you stumble over something else which is in the way and needs to be changed first; usually this extends to closed circles and thus prevents the changes. The goal for aw080 is to make as view as necessary compromizes to do this, but also to be brave in breaking those dependencies; with each change the first thought should be: How would this look in an ideal Drawinglayer? This gives the necessary global overview to even change things in the right direction without seeing the whole picture. To do so it is necessary to have an ideal picture of the DrawingLayer, something I needed years to develop the needed overview. This alone shows that it's not too well structured.

== Prerequisites ==

The branch is based on work done already, namely CWS (ChildWorkSpace, comparable with a branch) aw033 (very technical docu about it can be found here) and sume successors using the changes. It added Primtives, ViewObjectContacts and lead – together with extensions in VCL – to AntiAliasing. It already cut some places in that gordian knot and prepared the way to continue with aw080. It represents a good in-between break in the renewal of the Drawinglayer. From my overview it should be roughly the 2nd third of needed changes to get it to a future-proof state where using it further will be possible and useful.

== Changes done ==

I will now try to list the changes already done in aw080 and comment them. I will use no special order. This is not easy, it already is made up of 3000 changed files, the diff has 289031 lines (not even the current one, there happened more until today). I will also not be able to list all changes done but will concentrate on the bigger ones which stand for fundamental changes.
I may have roughly added 80% of the changes. For better readability I have splitted them into three categories:

#[[Paradigm changes]]
Changes that deeply influence relationships of objects between each other or principally different handling of model data, relationships of objects or processing of data.
#[[Double precision changes]]
Changes that influence the used number format, mainly changes from unsigned 32-bit to floating point, including usages of Linear Algebra solutions for object transformations.
#[[Other changes]]
Changes that apply to cleanup of old stuff, better readability and/or functionality and speed.

== Things to be done ==

This is definitely work in progress. The changes need to be tested carefully before aw080 can be reintegrated. While the built version already runs stable, a lot of investigations and fixes in not yet working properly mechanisms has to be done before it can be integrated. There will be no further deep and basic paradigm changes (at least I have none planned), but stabilizing and finishing the current changes will still take some work. Also, the overhaul of all SdrObjects is not finished yet. There also needs to be taken care for connector stuff, glue points and other special things which are often forgotten, but need to be taken into account, too.
There are e.g. the export filters to various formats which need to take care of the fact that now objects may be mirrored in X and/or Y. Since the old mechanism was to apply the mirroring to the object geometry this needs to be taken care of.
I will certainly start to provide test builds as soon as the branch is stable enough and stabilization is far enough (short: I see no big problems anymore by just playing around with it). This will be the time where Your help will be deeply needed and welcome! Be prepared, but it will take some more time.
I also got a question already how this will influence DrawingLayer performance. There will not be too many boosts, but quite some due to the changes for broadcasting and the changes for primitive creation.
For questions please use the Apache OpenOffice development list! When more questions arrive, it will be worth to add a Q&A section to this page eventually.

Have fun!
Armin

Symphony

2014-03-24T13:40:13Z

Hdu: replaced link to the incubator repository

IBM announced plan to contribute Symphony code to Apache Software Foundation on July 15, 2011.
The the code is formally ready on 18 Jun 2012.

This page is an introduction of the code contribution and how it can be used.

==Introduction of the code base==

Symphony is quite like OpenOffice with an Java Wrapper. The code contribution doesn't include the Java wrapper which is based on Eclipse. So if you try with the binary build provided below, you will see the property sidebar, but not the MDI view in Symphony.

==Where to get the source code==

The code is now ready at

https://svn.apache.org/repos/asf/openoffice/symphony/trunk

'''IMPORTANT:'''<br />
You still need get some extra source modules from AOO3.4 to make the code base buildable, which includes main/ext_libraries, main/ext_sources. And icu 4.8.1 source can be download from http://download.icu-project.org/files/icu4c/4.8.1/icu4c-4_8_1-src.tgz, then change it's name to af36f635271a239d76d038d6cf8da8df-icu4c-4_8_1-src.tgz and put it in main/ext_sources directory.

==Build guide==

Please follow [http://wiki.services.openoffice.org/wiki/How_to_build_Symphony%27s_source_code this guide] to build Symphony's source code.

==The binary build==

You can build this out yourself by following the build guide. You can also get it from link below.

*[http://people.apache.org/~zhangjf/symphony/build Symphony binary installation package]

Please notice that if you have Apache OpenOffice.org 3.4 installed already, you need uninstall it first. Or you can install it parallel to Apache OpenOffice 3.4 by following guide
*[http://wiki.services.openoffice.org/wiki/Run_OOo_versions_parallel described here]

==Feature Description==
*[[Symphony contribution]]

==FAQ==

'''Q: What is the difference between this build and Symphony?'''

A: Since the java part of Symphony is not contributed. Feature, like MDI, Home page and Embedded browser in Symphony won't be available in this build.
And menu, toolbar, statusbar also have different look&feel from that in Symphony.

The Mail Merge panel in Symhony is implented in Java. It is also updated with related part in OO.o3.x.

'''Q: I can find two kinds of help content in the source code, why?'''

A: The help system of Symphony 3.1 is eclipse based. The Symphony help content can't be consumed by AOO directly. AOO or OO.o help mechanism is used in the code contribution.

OO.o 3.x help content is there to be packaged in the the binary build of the "Symphony code contribution". Symphony 3.1 help content is there for reference of Symphony features.

'''Q: Does this contain everything we get in AOO 3.4? Or what is the difference?'''

A: This is not based on AOO 3.4. Symphony 3.0 was developed based on OO.o3.1. And while it goes some improvments from AOO 3.2, 3.3 and 3.4beta were also integrated. Before it was contributed to ASF, most of changes from AOO 3.4 were also integrated.

[[Category:Documentation]]

Svn practices

2014-03-24T13:37:54Z

Hdu: replaced links to incubator pages

'''This page is under review. This line will be removed after it is done.'''

This page gathered svn practices frequently used by contributors and committers. If you have any advice to this page, please feel free to update it or discuss your idea in ooo-dev mail list.

SVN Client 1.7 is recommanded to use for AOO development. It's strongly recommended use alternative name for svn's subcommand, like co-checkout, ci-commit, up-update, di-diff, and so on.

__TOC__

==Read-only access==
*Grab the whole source code from main trunk

<source lang="bash">
svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo
</source>

*Grab a branch

<source lang="bash">
svn co https://svn.apache.org/repos/asf/openoffice/branches/AOO410 aoo410
</source>

*Grab a specific directory from a branch

<source lang="bash">
svn co https://svn.apache.org/repos/asf/openoffice/branches/AOO410/main/sw sw
</source>

This gets the source code for Writer module (named "sw") from the AOO410 branch

*Get the latest changes into your working copy

Change into the working directory such as aoo or sw for the above case and run
svn update
This command will merge the public changes with the local changes if there are any.

*Update to a specific revision

svn update -r xxxx

*Check changes history

svn log<br />
svn log filename

Also show information about the paths that were changed in each displayed revision.
svn log -v

Show for specific revision.
svn log -r m

*Organize logical changes by changelist
Use cl instead of changelist for convenience.

svn changelist tocload-feature filename1 filename2 ...

*Check changes and create a patch from local changes
When creating patch, combine all your changes into a patch.

The path in patch should at least start in "main" or top directory.

svn diff filename1 filename2 > n.patch

*Create patch from a specific revision:

svn diff -c m > n.patch

*For changes consisting of many revisions n..m use

svn diff -r m:n > n.patch
instead.

*Discard local changes and revert to unmodified state

svn revert

==Write access==
*Apply patch when review other's code change
Make sure current directory is consistent with path in patch, like "main".

svn patch n.patch

Reverse patch:

svn patch --reverse-diff n.patch

*Check changes before committing them

svn status
and / or
svn diff
svn diff --changelist tocload-feature

*Commit your changes
Don't forget to specify the list of files/dirs that are changed to avoid accidentally committing unwanted changes.

svn commit -m "comment" [filenames]
svn commit -m "comment" --changelist tocload-feature

*Committing a patch
Prepare a commit-comment file (e.g. mychangelog.txt) by using the relevant parts of this template:

Patch by:
Suggested by:
Found by:
Review by:
Tested by:

and then commit it by running either
svn commit -F mychangelog.txt [filenames]
svn commit -F mychangelog.txt --changelist tocload-feature

*Update Bugzilla
Update [https://issues.apache.org/ooo/ bugzilla] with revision information for cross reference when you are done with the commit and know the revision numbers.

== Working with a branch ==
There at least two situations that you need to work with a branch.
* If the changes you are about to make are complicated or you want to share them with others during development.

* There are interesting upstream branches created by others. For example, after AOO 3.4 is released, a branch for the AOO 3.4.x micro releases was created.

Instead of doing 'svn commit' both on trunk and the release branch use 'svn merge' if your fix needs to be submitted to both code lines.

There are also other cases in which you don't want to commit in development mainline directly.

*How to create a branch

<source lang="bash">
svn copy https://svn.apache.org/repos/asf/openoffice/trunk \
https://svn.apache.org/repos/asf/openoffice/branches/tocloading \
-m "Creating a private branch for toc loading of word document."
</source>

*Keep a branch in sync
Subversion is aware of the history of your branch and knows when it split away from the mainline. To perform a sync merge, first make sure your working copy of the branch is “clean”—that it has no local modifications reported by 'svn status'. Then simply run:

$ pwd
/home/user/tocloading
$ svn merge ^/ooo/trunk

*Reintegrate a branch
When your new feature is done. It needs to be merged back to mainline. Before do that, sync the brache with mainline and commit your changes. Then

$ svn merge --reintegrate ^/ooo/branches/tocloading

and commit again

*Remove a branch
Once a branch is integrated back it has become useless and can be removed.

$ svn delete ^/ooo/branches/tocloading -m "Remove branch of toc loading"

==Reference==
SVN Basics
http://openoffice.apache.org/svn-basics.html

A guide for new committers:
http://www.apache.org/dev/new-committers-guide.html

Merge Instruction from FreeBSD:
http://wiki.freebsd.org/SubversionPrimer/Merging

SVN book:
http://svnbook.red-bean.com/en/1.7/svn-book.html

SVN Best Practices
http://svn.apache.org/repos/asf/subversion/trunk/doc/user/svn-best-practices.html

[[Category:Documentation]]

Documentation/Building Guide AOO/Building on MacOsX

2014-01-30T13:50:55Z

Hdu: XCode is also available in the App Store

Documentation/Building Guide AOO/Building on MacOsX

2014-01-30T13:09:14Z

Hdu: /* for building AOO 4.1 and newer */ XCode>=4.5 provides SDKs compatible with an OSX 10.7 deployment target

Documentation/Building Guide AOO

2014-01-22T10:57:30Z

Hdu: /* Building */ added unxmacci platform

{{DISPLAYTITLE:Apache OpenOffice Building Guide}}

= Preface =
This guide will help you to build Apache OpenOffice from its source code. It details the prerequisites and explains how to download the source code, prepare and then run the build. [[Documentation/Building_Guide_AOO/Step_by_step|Step-by-step instructions]] for resolving the pre-requisites of individual platforms and building on them are available.

Here is the short version for the brave and impatient:
* Download the source: <code>svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo</code>
* Configure: <code>cd main/ ; autoconf ; ./configure <some-switches> ; ./bootstrap</code>
* Build: <code>source <platform-dependend-name>.sh ; cd instsetoo_native ; build --all</code>
* Wait for an hour or more (The build can take up to 3 hours.)
* Install office
* Enjoy

The detailed description below gives a broader introduction into the build process and explains for the various steps.

==Status==
This document is loosely based on an older [[Documentation/Building Guide|version]]. I have tried to avoid duplication and to move anything that all platforms have in common to this page. Many details have been removed on purpose because they refer to older version of OpenOffice. However, there are still some things not explained in the necessary detail on this page:
* How to use ccache

{{Documentation/SeeAlso|*[[How_to_build_Symphony%27s_source_code]] }}

= Getting help =
You can get help by searching this wiki or by asking questions on the [http://openoffice.apache.org/mailing-lists.html#development-mailing-list-public developers mailing list].

You can help us improve this guide by pointing out any errors (preferably after finding a solution).
Or don't be shy and edit (and improve) these pages yourself.

= Basics =

In order to build Apache OpenOffice you need a proper environment. This includes
* a command line interpreter, typically bourne shell compatible (sh or bash) inside a terminal. On Windows you will need to install Cygwin to provide it.
* C++ compiler and linker. The exact choice depends on the operating system.
* Perl interpreter and several modules.
* Many tools from the Unix world like make or sed.

See section [[#General_Build_Requirements | General Build Requirements]]
for an exact list of requirements.

= Getting the source =

The source code is available as SVN repository at https://svn.apache.org/repos/asf/openoffice

Check it out with

svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo

More details about how to check out source code from SVN can be found [http://openoffice.apache.org/source.html here].

== Space Requirements ==

The checked out files take up somewhat over 5GB on disk (more than 150000 files in more than 7000 folders and the SVN overhead).

After building this becomes (on Windows7) almost 17GB (more than 406000 files in more than 23000 folders).

You can use git as well. There exists no guide for this, therefore ask on dev@openoffice.apache.org, if you want to use git.

= Organization of the source and output tree =

The source code has five top level directories:
;main/:contains most of the so called modules. Each module typically provides one or more libraries. The source code of the writer application for example can be found in main/sd/.
;test/:contains the new [[QA/test_automation_guide | automated testing framework]]
;ext_libraries/:is the new home of modules that build external libraries (libraries maintained outside of Apache OpenOffice and often outside Apache).
;ext_sources/:contains the tar balls (archives) of external libraries. They are included both for convenience and to make sure that specific versions remain available. Note that the source package of the Apache OpenOffice release does not contain any external tar balls.
;extras/:holds the localization data.

Most tools and scripts that are used for building are located below <code>main/solenv/</code>:
*dmake makefiles in <code>main/solenv/inc/</code>
*gmake makefiles in <code>main/solenv/gbuild/</code>
*executables and perl files in <code>main/solenv/bin/</code>
*perl modules in <code>main/bin/modules/</code>

Libraries and other output files that are shared between modules are stored in <code>main/solver/</code>.

=Building=

==Overview==

Building Apache OpenOffice consists of three steps:
;Configuring/bootstrapping:Detect platform, operating system, compiler, etc. and write the information into a shell script for later use. The developer can turn on or off certain features in this phase.
;Building:Compile the source code, transform other input files, apply localization.
;Packing:Create a set of files, the installation set, that can be installed on the respective operating system. This can be msi/cab files for windows, deb or rpm for Linux, dmg for Mac.

The configure step has to be carried out only once. Building and packing is necessary after every source code change. There are short cuts to avoid parts of these steps (when you know what you are doing.)

The building examples in this wiki document use only command line approaches to building. Depending on your expertise, it may be possible to use an IDE which allows specification of custom build scripts.

== General Build Requirements ==

The general requirements for all platforms are
{| class="prettytable"
|- valign="top"
! Requirement
! Description
! Configure switch
|- valign="top"
| Java JDK
| Java Implementation compatible with [http://java.sun.com/j2se/1.5/ JDK 1.5] or [http://java.sun.com/javase/6/ JDK 1.6]. [http://openjdk.java.net/ OpenJDK] is supported as well.

For Windows [http://www.oracle.com/technetwork/java/javase/downloads/index.html/ JDK 1.7] is recommended.
| --with-jdk-home=
|- valign="top"
| Perl
| Perl 5 - note: for Windows Perl will be installed as part of the cygwin environment.

Also required are the perl packages
Archive::Zip
LWP::UserAgent
XML::Parser
They can be installed from the shell with (you may have to run it with super user/administrator rights)
perl -MCPAN -e shell
If it is executed for the first time then CPAN will ask for configuration. Choose autoconfiguration.
Eventually the CPAN shell appeares accepts commands. Install missing modules with
install <module-name>
Find more details [http://wiki.services.openoffice.org/wiki/CPAN_install here].<sup>5</sup>
|- valign="top"
| CUPS
| cups headers. Provided by a cups-devel package or a libcups2-devel

note: not for Windows
|- valign="top"
| PAM
| PAM support. Provided by a pam-devel package or a libpam-dev

note: not for Windows
|- valign="top"
| Apache Ant
| [http://ant.apache.org/ Ant 1.9 or later] (see note)
| --with-ant-home=
|- valign="top"
| Archiver
| zip and unzip - note: for Windows zip and unzip will be installed as part of the cygwin environment.
|- valign="top"
| gperf
| [http://www.gnu.org/software/gperf/gperf.html gperf] tool - note: for Windows gperf will be installed as part of the cygwin environment.
|- valign="top"
| NSS<sup>1</sup>
| For Windows the Mozilla build tools<sup>2</sup> are needed to build the nss module. They can be obtained [http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/ here].
|- valign="top"
| unowinreg.dll
| [http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll pre-built unowinreg.dll] (see note)
Without this file, configure will try to set up cross-compiling with windows.
note: Not for windows. Required on all non-windows platforms. Download with:
cd $SRC/main && wget -O external/unowinreg/unowinreg.dll http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll
|-
|}

'''Notes:'''
# The nss module ("Network Security Services") provides security services needed for e.g. password protection. NSS can be disabled using the configure switch <tt>--disable-nss-module</tt>.
# NSS is provided by the Mozilla project. Building it on Windows requires the [http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32 MozillaBuild tools]. Get the latest version, install it and use the configure switch <tt>--with-mozilla-build</tt> to tell configure where the tools are installed. For example: <tt>--with-mozilla-build=c:/mozilla-build</tt>
# Please note that CPAN is not able to deal with usernames containing spaces. To work around this fact, when CPAN asks you to specify the CPAN build and cache directory, change the default suggestion to /cpan.
# Apache Ant: Assure a proper ant set-up by downloading and installing ant, in total, from the ant site linked above. If you are a Linux developer, your distro may not have ant setup correctly for building Apache OpenOffice.
# Use <tt>./configure --help</tt> to see all possible configuration options

See also the platform specific requirements for
*[[Documentation/Building_Guide_AOO/Building_on_Windows|Windows]]
*[[Documentation/Building_Guide_AOO/Building_on_Linux|Linux]]
*[[Documentation/Building_Guide_AOO/Building_on_MacOsX|MacOSX]]

==Configuration and bootstrapping==
This is typically done only once after the source code is checked out. Repeat this after changing your mind about options given to configure.

The call to
autoconf
creates the main/configure script from main/configure.in and some other input files.

The set of options/switches given to configure depends on the platform and your choice of features. A typical call starts like this
configure \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://www.msweet.org/files/project2/epm-3.7-source.tar.gz \
It tells configure where to find the source code of external tools dmake and epm.

By default only source code under [http://www.apache.org/legal/3party.html#category-a category A] licenses is compiled and included. Besides the Apache License 2.0 this includes for example BSD and MIT/X11 license. If you want to enable features that rely on third party code under [http://www.apache.org/legal/3party.html#category-b category B] licenses (like MPL, CPL, EPL, etc) then add the option
--enable-category-b

For inclusion of externally hosted dictionary extensions add option
--enable-bundled-dictionaries
Note that dictionaries rely on a category B third party library (hunspell). Therefore <code>--enable-category-b</code> is a prerequisite for <code>--enable-bundled-dictionaries</code>. Dictionaries have a variety of licenses and are bundled without modification: they are not compiled.

The <code>--with-lang</code> option will introduce the build of additional language resources. This switch accepts one or more RFC 1766 language tags as arguments, unfortunately not all languages are supported. Check the <code>[http://svn.apache.org/viewvc/openoffice/trunk/main/solenv/inc/langlist.mk?view=markup solenv/inc/langlist.mk]</code> file for all the currently supported language tags. The environment variable WITH_LANG will then contain the language tags of the additional (en-US will always be build) languages. Example:
--with-lang="de fr"
enables the build of the localized German and French version.

You can run the rat scan while building with option
--with-rat-scan
[[Documentation/Building_Guide_AOO/Rat_Scan|Here]] you can find details.

Finish this step by running
./bootstrap
This will build dmake and epm, download missing source code tar balls of external libraries, and download missing external dictionary extensions.

==Building==
Start by including the environment variables prepared by configure into your current environment with
<tt>source <shell-script-name></tt>
where <shell-script-name> depends on your platform:
{| class="prettytable"
|-
!platform id
!<shell-script-name>
|-
| wntmsci12
| winenv.set.sh
|-
| unxlngi6
| LinuxX86Env.Set.sh
|-
| unxlngx6
| LinuxX86-64Env.Set.sh
|-
| unxmacxi
| MacOSXX86Env.Set.sh
|-
| unxmacci
| MacOSXX64Env.Set.sh
|}
Look into main/set_soenv for more platforms. (search for lines <code>$OUTPATH = "<platform>";</code> and the nearby line <code>$outfile = "<shell-script-name>";</code>. Add the suffix <code>.sh</code> for the bash variant.

If you want to build the whole office and the install sets then
cd main/instsetoo_native
build --all
You may want to experiment with the -P options for multi process builds to reduce the build time.
build --all -P<m> -- -P<n>
tells build to use <code>m</code> processes (build up to <code>m</code> modules in parallel) and <code>n</code> threads for each module.

Details about creating installation sets can be found [[Building_installation_packages|here]].

Building Apache OpenOffice uses a custom build command, build.pl, located in /main/solenv/bin.
You may find it helpful to learn more about build options from the [http://www.openoffice.org/tools/tools/build.html Build Documentation]

==Partial Builds==

Building the whole office takes a lot of time. Therefore it may be preferable to build only parts after making changes to the source code.
There are two different types of partial builds:
;Compatible:Can be used only when the code changes do not change exported interfaces. Use with care and only when you know what you are doing.
;Incompatible:Use for code changes that modify exported C++ or IDL interfaces, that modify resources that are used by other modules, or when you are not sure.
:If you are a new developer, you should probably always assume your changes are "incompatible" and follow the instructions for '''Incompatible Build'''.

===Make Systems Used by Apache OpenOffice===

For the following Build sections you should be aware that Apache OpenOffice uses two different '''make''' systems to build its modules.
*The older one is based on dmake
*The other and newer one is based on GNU make. This system is often referred to as gbuild.
When a module contains, among others, a Makefile and a Module_<module>.mk file then it is a gbuild module.

===Compatible Build===

After changing code in module <module> which does not change any exported interfaces do
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build
deliver
|
cd <module>
make -sr
No explicit call to <code>deliver</code> is necessary for gbuild modules.
|}
to compile and deliver the resulting libraries to <code>main/solver/</code>. You may want to erase the output of a previous compilation:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build --from <module> --prepare
or faster (but without the un-deliver)
cd <module>
rm -fr <platform>/
|
cd <module>
make clean
|}

===Incompatible Build===

Modifications that change exported interfaces require not only the module to be rebuild that contains the modified code. All depending modules (dependencies are defined in <code><module>/prj/build.lst</code>) have to be rebuild as well. This is best done from <code>main/instsetoo_native/</code>:
<tt>cd main/instsetoo_native/</tt>
<tt>build --from <incompatible-module> --prepare</tt>
<tt>build --from <incompatible-module></tt>

The second line removes the output of all modules that have to be recompiled. The drawback of this command is that the output of modules which are build via gbuild are not removed. Thus, the following additional command performed after the second one will do the trick:
build --from <incompatible-module> --job="make clean; make clean debug=t" --ignore

===Frequently used options===

In order to add debug information to libraries and executables, add the <code>debug</code> switch to any <code>build</code> or <code>make</code> command:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build debug=t
|
cd <module>
make -sr debug=t
|}
Remember that for the gbuild system you have to use the debug flag also when cleaning a module (otherwise eg the wrong precompiled headers are deleted and are not rebuilt):
make clean debug=t

You can force make to rebuild dependency information by first deleting it with the depend option. It would be rebuilt automatically with the next build:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build depend=t
build
|
cd <module>
make -sr depend=t
make -sr
|}

= [http://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO/Step_by_step Step-by-Step Building Guide for Different Platforms] =
[[Category:Documentation]][[Category:Development]][[Category:Porting]]

Documentation/Building Guide AOO/Building on Windows

2014-01-21T12:01:50Z

Hdu: MSVC2008 with SP1 requirement

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on Windows}}
[[Category:Windows]]

__TOC__

= Overview =

For general information on how to build Apache OpenOffice from source code, see the [[Documentation/Building_Guide_AOO|platform independent page]].

{{Template:Documentation/Windows|This document explains the platform specific details.}}
For building Apache OpenOffice the [http://www.cygwin.com Cygwin environment] is required. Cygwin is a set of programs that run on Windows but emulate a complete Unix command line environment.

As compiler we use Microsoft's Visual C++ 2008 SP1, not the gcc from Cygwin. Therefore Visual Studio Express/Professional (version 2008 or later) can be used for debugging.

To use this document you should be familiar with a bourne command line interpreter (sh or bash), but you need not be a UNIX shell wizard.
{{Template:Documentation/Tip|If you have never used a Unix shell, you might want to take a look at the [http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/index.html shell introduction at TLDP].}}

=Build requirements=

Additionally to the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] you need
{| class="prettytable" border="1" width="100%"
|-
!style="width: 25%"|What
! Where to get
!style="width: 20%"|How to install
|-
| Windows 7 (recommended), Windows Vista, Windows XP
|
|
|-
| Cygwin
| http://www.cygwin.com, '''32bit version''', minimum version: 1.5.10, preferred: current version]

See [[#Setting up Cywin|below]] for setting up cygwin and the required packages.
| (default)
|-
| Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1
| http://www.microsoft.com/en-us/download/details.aspx?id=3138

It brings the Visual Studio 2008 C++ compiler with it.

This is either a DVD image or a net installer. You can either mount the DVD with a suitable tool, burn it do a DVD or use tools like winrar or 7zip to extract files from the ISO file directly. You don't need to install samples or documentation (saves a lot of disk space). It will also install the .NET Framework 3.5 SDK. It might be best to install the Windows SDK into the default directory, and if not that into one without capital letters in the path.
|
|-
| Microsoft Visual C++ 2008 SP1 Redistributable Package (x86)
| vcredist_x86.exe, download found [http://www.microsoft.com/en-us/download/search.aspx?q=Microsoft%20Visual%20C%2b%2b%202008%20Redistributable%20Package&p=0&r=10&t=&s=availabledate~Descending here]
It is just packed as it is into the installation package.

The exact download URL may have changed. In that case you have to search Microsoft's website.
| main/external/vcredist
|-
| Microsoft Visual C++ 2008 SP1 Redistributable Package (x64)
| vcredist_x64.exe, download found [http://www.microsoft.com/en-us/download/search.aspx?q=Microsoft%20Visual%20C%2b%2b%202008%20Redistributable%20Package&p=0&r=10&t=&s=availabledate~Descending here]
It is just packed as it is into the installation package.

The exact download URL may have changed. In that case you have to search Microsoft's website.
| main/external/vcredist
|-
| GDI+ Redistributable
| http://www.microsoft.com/downloads/details.aspx?familyid=6A63AB9C-DF12-4D41-933C-BE590FEAA05A&displaylang=en. Genuine Windows Validation required.
| main/external/gdiplus
|-
| Runtime libraries 10.0
| msvcp100.dll and msvcr100.dll for Java 7 support - see issue [https://issues.apache.org/ooo/show_bug.cgi?id=120979 120979].
Get them from the Microsoft Visual C++ 2010 Redistributable Package (x86) from the Microsoft site - http://www.microsoft.com/en-us/download/search.aspx?q=Microsoft+Visual+C%2b%2b+2010+Redistributable
| main/external/msvcp100
|
|-
| dbghelp.dll
| http://msdn.microsoft.com/en-us/library/windows/desktop/ms679309%28v=vs.85%29.aspx

The exact download URL may have changed. In that case you have to search Microsoft's website.

Search for it on your PC or on the web. E.g., it is part of the Windows Driver Kit.
| main/external/dbghelp
|-
| Windows Driver Kit Version 7.1.0
| http://www.microsoft.com/downloads/details.aspx?id=11800

To enable ATL and ActiveX in the build - it is optional

related configure options are:
--with-atl-include, --with-atl-lib-dir, --with-mfc-include-dir, --with-mfc-lib-dir
|
|-
| Microsoft DirectX SDK
| http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=6812

To enable DirectX in the build - it is optional

related configure option is:
--with-directx-home
|
|-
| Unicode NSIS, version 2.46.5
| http://code.google.com/p/unsis/downloads/detail?name=nsis-2.46.5-Unicode-setup.exe&can=2&q=

If Unicode NSIS is available, a self contained Windows installer is created in addition to the MSI installer files - it is optional
|
|}

When building Apache OpenOffice 3.4.x or 4.0.x you need to provide some additional binaries:
{| class="prettytable" border="1" width="100%"
|-
| Runtime libraries 7.1
| msvcr71.dll for Mozilla libraries. Search for them on the web or on your PC. These files should be named as all lower case. Sometimes when downloaded they are upper case and this will cause 'file not found' errors towards the end of the build))
| main/external/msvcp71
|-
| Runtime libraries 8.0
| msvcp80.dll and msvcr80.dll for Mozilla libraries. Search for them on the web or on your PC.
| main/external/msvcp80
|}

=Remarks=

{{Template:Documentation/Note|OOo uses some Mozilla libraries. Building the corresponding sources is only possible with the VC2003 compiler so you have to use precompiled libraries that require the msvx71 libraries mentioned above. On Windows the Mozilla libraries are needed only for Mozilla address book support. Unfortunately a bug in the module dependencies makes it necessary that the Mozilla libaries are used anyway as otherwise building the module <tt>xmlsecurity</tt> fails.}}

= Setting up Cygwin =

Go to http://www.cygwin.com/ and download and install the current 32bit version.
{{Template:Documentation/Caution|Make sure that you keep the filetype set to “Unix/binary”.}}
{{Template:Documentation/Caution|Make sure that the PATH variable in your cygwin shell does not contain any unquoted blanks and quotes, otherwise configure will not work}}

=== Additional packages for Cygwin to serve the AOO build ===

Cygwin consists of some basic and a lot of optional packages. As building AOO needs some of these optional packages you have to select them in the installer.
Here's a complete list of the required packages:
* Category Archive:
** unzip
** zip
* Category Devel :
** autoconf
** bison
** flex
** gcc-g++
** gperf
** make
** patch
** readline
** subversion (if you want to use svn inside the cygwin shell to checkout and update your working copy of AOO)
* Category Net
** openssh
** openssl
* Category Perl
** perl - see [http://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO#General_Build_Requirements General Build Requirements] for additional Perl modules
* Category Shells
** mintty
* Category Utils
** gnupg
* Category Web
** wget

{{Template:Documentation/Note|The installer will automatically check and download some more packages needed by whose listed here. The whole process takes roughly 20 minutes.}}

=== Breaking links to executable ===

Within the Cygwin Toolkit, some executables might be symlinks: awk.exe and gunzip.exe, tar.exe (in older releases only). This can lead to a break of the build later, and the symlinks should be replaced by copies of the command they link to.

To check this, execute:

ls -l /bin/awk.exe

whether e.g. awk.exe is a symlink. In version 1.5.24-2 awk.exe is a link to gawk.exe. The shell will show this by putting out “awk.exe -> gawk.exe”. In this case gawk.exe must be copied to awk.exe by executing:

cd /bin
rm awk.exe
cp gawk.exe awk.exe

In case you overlook something here or you have a newer Cygwin version with additional symlinks not mentioned here it's not a problem. You will get a helpful error message about an existing link in the configuration step (configure) later. The message will tell you which link you have to remove and you can do it following the advice given above for the awk.exe/gawk.exe pair.

=== Installing additional perl modules in cygwin ===

As explained some perl modules must be installed with CPAN. The necessary command in the cygwin shell is

perl -MCPAN -e shell

If this command is executed the first time CPAN will ask for configuration. Choose autoconfiguration.

{{Template:Documentation/Caution|Please note that CPAN is not able to deal with usernames containing spaces. To work around this fact, when CPAN asks you to specify the ''CPAN build and cache directory'', change the default suggestion to <tt>/cpan</tt>.}}

At the end the CPAN shell appeared and is ready to accept commands for installations. Each module is installed by typing <code>install $MODULENAME</code>. The modules that must be installed are:

* Archive::Zip
* LWP::UserAgent
* XML::Parser (though it seems that this is already installed; doesn't hurt to do it)

CPAN will detect if a selected module depends on other modules and it will offer to download them also. As explained please just confirm this.

{{Template:Documentation/Caution|I got an error message from CPAN somewhat like the following:
<pre>C:\cygwin\bin\perl.exe: *** unable to remap C:\cygwin\bin\cygiconv-2.dll to same
address as parent(0x7C0000) != 0x7D0000</pre>
To fix this, I had to exit the Cygwin shell, run cmd.exe, then type "c:\cygwin\bin\ash.exe" to start the minimal shell, then type <code>/bin/rebaseall</code>. Then CPAN worked when I ran it again.}}

= Configure switches (Windows specific) =

Additionally to the general [[Documentation/Building_Guide_AOO#Configuration_and_bootstrapping|configure switches]] there are several that only have to be used on Windows or have Windows specific values.

Typical values for the compiler and SDK. If default installation paths are used these configure switches are not needed:
--with-frame-home="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v7.0"
--with-psdk-home="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v7.0"
--with-midl-path="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v7.0/Bin"
For DirectX:
--with-directx-home="C:/Program Files (x86)/Microsoft DirectX SDK (June 2010)"
For ATL and ActiveX:
--with-atl-include-dir=/cygdrive/c/WinDDK/7600.16385.1/inc/atl71
--with-atl-lib-dir=/cygdrive/c/WinDDK/7600.16385.1/lib/ATL/i386
--with-mfc-include-dir=/cygdrive/c/WinDDK/7600.16385.1/inc/mfc42
--with-mfc-lib-dir=/cygdrive/c/WinDDK/7600.16385.1/lib/Mfc/i386

And some more:
--enable-pch
--enable-dbgutil

OpenOffice and Eclipse

2014-01-09T08:55:57Z

Hdu: _MSC_VER already predefined

With current versions of Eclipse (4.3) it is possible to create C/C++
projects for OpenOffice modules and use code assist, refactoring,
lookup of definitions and declarations and all the other nice things
that a modern IDE provides.

There are two different approaches to import the OpenOffice source code into
Eclipse:
* The whole repository at once.
:You will need a not-yet-released nightly build of CDT to prevent major memory leaks and still have to increase memory limits for Eclipse.
* Module by module.
:This approach works with vanilla Eclipse. You only import individual modules (say sw/ and sfx/ into your workspace).
:This approach is described below.

==OpenOffice in Eclipse: Some Highlights==

Here are some highlights of developing OpenOffice with Eclipse illustrated with the <code>sfx2</code> module and its <code>sfx2/source/sidebar/AsynchronousCall</code> file.

* Syntax coloring and code formatting
: Both are very customizable (in the 'Preferences' dialog: C/C++->Editor->Syntax Coloring respectively C/C++->Code Style->Formatter)
[[File:AfterStart.png|500px]]
* Switch between .hxx and implementing .cxx
* Follow header inclusion
* Extended tooltips that can display declaration/definition of classes, methods, variables, constants.
[[File:Hover.png|300px|Find out how the constant is defined without leaving the editor]]
* Visualization of whether code enclosed by #ifdef/#endif is active or not
[[File:ifdef.png|300px]]
* Tooltips can be focused => you can explore a class definition without switching your editor to another file.
[[File:MacroExpansion.png|300px|'Simple' macro expansion on hover]] [[File:MacroExpansion2.png|500px|Press F2 to see more details]]
* Find out from where a function or method is called
* Explore the type hierarchy of a class
* Code assist while typing.
* Integration of bugzilla (via Mylyn), don't line how the bugzilla data is presented? Just open an inplace browser to have the same experience as you have now.
* Static code analysis (CODAN)

==Module by Module==
The following describes how to set up Eclipse for the module by module approach.

===Install Eclipse===
Install a current version of Eclipse (http://www.eclipse.org/downloads/).
* Version 4.3 (Kepler) is known to work. Older 4.* versions may also work.
* A version with focus on C/C++ (titled "Eclipse IDE for C/C++ Developers) works best but other versions with the CDT addon installed should work also.

===Prepare a workspace===
Start Eclipse and select or create an empty workspace. The empty workspace is not a
hard requirement but with one Eclipse project per OpenOffice module
you may loose track otherwise. You can freely choose the location of
the workspace, just don't use the OpenOffice source code directory.

===Add module to workspace===
*Open the import wizard via menu <code>File->New->Other</code>.
*In the dialog choose the <code>C/C++ -> Makefile Project with Existing Code</code> wizard.
*In the 'Import Existing Code' wizard
**use the 'Browse...' button to set the 'Existing Code Location' to the top-level directory of a module. This will also set the 'Project Name'.
**Select the correct tool chain for your platform.
:Tool chains for the individual platforms:
:Windows : Microsoft Visual C++
**Close the import wizard via the <code>Finish</code> button to start the module import.

===Setup project properties===
A few changes to the project properties are necessary for the indexer to find all include files and use the correct compiler definitions.
*Open the properties dialog via the menu <code>Project->Properties</code>.
*Activate the <code>C/C++ General->Paths and Symbols</code> page.
*In the 'Languages' list (left center) activate 'GNU C++', (for some reason this name does not change even when you use the MSVC tool chain).
*Click 'Add...' and in the new dialog 'File system...' and browse to <code>main/solver/VERSION/PLATFORM/inc</code>.
*Click 'OK' two times to get back to the properties dialog.
*Repeat the last two steps to add <code>main/solver/VERSION/PLATFORM/inc/offuh</code> for the header created for the UNO IDL files. Note that these includes only exist when the <code>offuh/</code> module has been built.browse to <code>main/solver/VERSION/PLATFORM/inc</code>.
*Go to the 'Symbols' tab page.
*Click 'Add...' and add macro definitions
:Windows: WNT (empty value)
*Click OK to close the dialog.
*Rebuild the index via 'Project->C/C++ Index->Rebuild'. This time the indexer should runs longer because it has to index no only the files in the module but also all include files in <code>solver/</code>

===Using Mylyn for integrating Bugzilla===
Eclipse has a very powerful plugin for integrating bug trackers into the IDE. Bugzilla is supported out of the box. Support for eg. Jira exists also.
Setup for OpenOffice Bugzilla:
* Open the 'Task List' via 'Window->Show View->Task List'. Note that this is not the same view as 'Tasks'.
* If you do this for the first time you will see a 'Connect' link at the bottom of the new view. Click it.
* Otherwise open the 'Task Repositories' view via 'Window->Show View->Other...'
** In the 'Show View' dialog select 'Mylyn->Task Repositories'
** Click on the 'Add Task Repository...' button in the tool bar of the view.

In the 'Add Task Repository...' dialog:
* Choose 'Bugzilla (supports 3.6 and later)'
* Click 'Next >'
* Enter 'https://issues.apache.org/ooo/' ino the 'Server' field.
* Enter 'OpenOffice Bugzilla' or some other descriptive string into the 'Label' field.
* Fill out 'User ID' and 'Password' fields
* (Optional) Check the 'Save Password'
* Click 'Finish' and answer any popups as you like.

Search for tasks in Bugzilla in the 'Task List' view:
* Insert the task id in the search field. Click the now visible link 'Search repository for key or summary...'.
* In the 'Search' dialog:
** Make sure that 'Repository' is set to 'OpenOffice Bugzilla'
** The 'Task Key/ID' field should show the task id you entered earlier.
** Click on 'Search'
* A new editor opens in the editor area with the details about the found bug.
* If you don't like this view, click on the 'Open with Web Browser' button in the toolbar of the editor.
* There seems to be a bug that prevents submitting changes. I get a 'Submit failed:...' error message.
* In the 'Task List' view there is now a new tree view with root node 'Uncategorized'.
** Expand it to see your bug
** A double click on the bug entry opens the Bugzilla editor with that bug.

There exists the concept of 'Context' which defines a set of files for each bug. This is activated by clicking on the 'Activate...' link in the 'Task List' view.

Documentation/Building Guide AOO/Building on MacOsX

2014-01-08T14:45:11Z

Hdu: split build requirements into sub-sections

Documentation/Building Guide AOO/Building on MacOsX

2014-01-08T14:36:42Z

Hdu: /* Build requirements */ for AOO 4.1 and above

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on MacOSX}}
[[Category:MacOSX]][[Category:Documentation]]

__TOC__

= Overview =

For general information on how to build Apache OpenOffice from source code, see the [[Documentation/Building_Guide_AOO|platform independent page]].

See also this slightly older [[Documentation/Building_Guide/Building_on_MacOSX|building guide]].

=Build requirements for AOO 4.1 and newer =

Additionally to the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] you need
{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.7 (aka Lion) or later
|-
| XCode version 4.5 or later
|-
| Mac 10.7 SDK
| Is provided directly by XCode 4.5
|-

=Build requirements for AOO 3.4 and 4.0 =

Additionally to the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] you need
{| class="prettytable" border="1" width="100%"
|-
!style="width: 20%"|What
! Where to get / Remarks
|-
| Mac OS X version 10.4 (aka Tiger) or later
| If you are using 10.5 aka Leopard, have a look at [[User:Dyrcona/LeopardBuild#flex]].
|-
|Mac 10.4 SDK
|
|-
|XCode version 2.4.1 or later
|
*For Mac OS X 10.7 (aka Lion), XCode 3.2.6 has be installed.
*If you want to use a newer version than the one that is shipped with your Mac OS X installation media, you need to register at the [https://connect.apple.com/ Apple Developer Connection] site (free of charge) to be able to [http://developer.apple.com/technology/xcode.html download it].
*On Mac OS X 10.6 (Snow Leopard), make sure to install the optional 10.4 SDK with XCode.
|}

{{Template:Documentation/Note|XCode 4 is currently not tested because of the missing support in XCode and the office dependency to the 10.4 SDK}}

{{Template:Documentation/Note|Java: On systems < Mac OS X 10.7 Apache OpenOffice does not build yet using Java SDK 1.6.0. If you didn't configure Mac OS X for a 1.6, you don't need to do anything - the default (1.5) is OK. To change the default Java version go to Applications/Utilities/Java and modify accordingly}}

Patches to make it build with 1.6 are very welcome. Feel free to submit your patches to the ooo-dev@incubator.apache.org mailing list or file issues.

OpenOffice and Eclipse

2014-01-08T13:36:16Z

Hdu: /* Setup project properties */ _MSC_VER

With current versions of Eclipse (4.3) it is possible to create C/C++
projects for OpenOffice modules and use code assist, refactoring,
lookup of definitions and declarations and all the other nice things
that a modern IDE provides.

There are two different approaches to import the OpenOffice source code into
Eclipse:
* The whole repository at once.
:You will need a not-yet-released nightly build of CDT to prevent major memory leaks and still have to increase memory limits for Eclipse.
* Module by module.
:This approach works with vanilla Eclipse. You only import individual modules (say sw/ and sfx/ into your workspace).
:This approach is described below.

==OpenOffice in Eclipse: Some Highlights==

Here are some highlights of developing OpenOffice with Eclipse illustrated with the <code>sfx2</code> module and its <code>sfx2/source/sidebar/AsynchronousCall</code> file.

* Syntax coloring and code formatting
: Both are very customizable (in the 'Preferences' dialog: C/C++->Editor->Syntax Coloring respectively C/C++->Code Style->Formatter)
[[File:AfterStart.png|500px]]
* Switch between .hxx and implementing .cxx
* Follow header inclusion
* Extended tooltips that can display declaration/definition of classes, methods, variables, constants.
[[File:Hover.png|300px|Find out how the constant is defined without leaving the editor]]
* Visualization of whether code enclosed by #ifdef/#endif is active or not
[[File:ifdef.png|300px]]
* Tooltips can be focused => you can explore a class definition without switching your editor to another file.
[[File:MacroExpansion.png|300px|'Simple' macro expansion on hover]] [[File:MacroExpansion2.png|500px|Press F2 to see more details]]
* Find out from where a function or method is called
* Explore the type hierarchy of a class
* Code assist while typing.
* Integration of bugzilla (via Mylyn), don't line how the bugzilla data is presented? Just open an inplace browser to have the same experience as you have now.
* Static code analysis (CODAN)

==Module by Module==
The following describes how to set up Eclipse for the module by module approach.

===Install Eclipse===
Install a current version of Eclipse (http://www.eclipse.org/downloads/).
* Version 4.3 (Kepler) is known to work. Older 4.* versions may also work.
* A version with focus on C/C++ (titled "Eclipse IDE for C/C++ Developers) works best but other versions with the CDT addon installed should work also.

===Prepare a workspace===
Start Eclipse and select or create an empty workspace. The empty workspace is not a
hard requirement but with one Eclipse project per OpenOffice module
you may loose track otherwise. You can freely choose the location of
the workspace, just don't use the OpenOffice source code directory.

===Add module to workspace===
*Open the import wizard via menu <code>File->New->Other</code>.
*In the dialog choose the <code>C/C++ -> Makefile Project with Existing Code</code> wizard.
*In the 'Import Existing Code' wizard
**use the 'Browse...' button to set the 'Existing Code Location' to the top-level directory of a module. This will also set the 'Project Name'.
**Select the correct tool chain for your platform.
:Tool chains for the individual platforms:
:Windows : Microsoft Visual C++
**Close the import wizard via the <code>Finish</code> button to start the module import.

===Setup project properties===
A few changes to the project properties are necessary for the indexer to find all include files and use the correct compiler definitions.
*Open the properties dialog via the menu <code>Project->Properties</code>.
*Activate the <code>C/C++ General->Paths and Symbols</code> page.
*In the 'Languages' list (left center) activate 'GNU C++', (for some reason this name does not change even when you use the MSVC tool chain).
*Click 'Add...' and in the new dialog 'File system...' and browse to <code>main/solver/VERSION/PLATFORM/inc</code>.
*Click 'OK' two times to get back to the properties dialog.
*Repeat the last two steps to add <code>main/solver/VERSION/PLATFORM/inc/offuh</code> for the header created for the UNO IDL files. Note that these includes only exist when the <code>offuh/</code> module has been built.browse to <code>main/solver/VERSION/PLATFORM/inc</code>.
*Go to the 'Symbols' tab page.
*Click 'Add...' and add macro definitions
:Windows: WNT (empty value) and _MSC_VER=1500
*Click OK to close the dialog.
*Rebuild the index via 'Project->C/C++ Index->Rebuild'. This time the indexer should runs longer because it has to index no only the files in the module but also all include files in <code>solver/</code>

===Using Mylyn for integrating Bugzilla===
Eclipse has a very powerful plugin for integrating bug trackers into the IDE. Bugzilla is supported out of the box. Support for eg. Jira exists also.
Setup for OpenOffice Bugzilla:
* Open the 'Task List' via 'Window->Show View->Task List'. Note that this is not the same view as 'Tasks'.
* If you do this for the first time you will see a 'Connect' link at the bottom of the new view. Click it.
* Otherwise open the 'Task Repositories' view via 'Window->Show View->Other...'
** In the 'Show View' dialog select 'Mylyn->Task Repositories'
** Click on the 'Add Task Repository...' button in the tool bar of the view.

In the 'Add Task Repository...' dialog:
* Choose 'Bugzilla (supports 3.6 and later)'
* Click 'Next >'
* Enter 'https://issues.apache.org/ooo/' ino the 'Server' field.
* Enter 'OpenOffice Bugzilla' or some other descriptive string into the 'Label' field.
* Fill out 'User ID' and 'Password' fields
* (Optional) Check the 'Save Password'
* Click 'Finish' and answer any popups as you like.

Search for tasks in Bugzilla in the 'Task List' view:
* Insert the task id in the search field. Click the now visible link 'Search repository for key or summary...'.
* In the 'Search' dialog:
** Make sure that 'Repository' is set to 'OpenOffice Bugzilla'
** The 'Task Key/ID' field should show the task id you entered earlier.
** Click on 'Search'
* A new editor opens in the editor area with the details about the found bug.
* If you don't like this view, click on the 'Open with Web Browser' button in the toolbar of the editor.
* There seems to be a bug that prevents submitting changes. I get a 'Submit failed:...' error message.
* In the 'Task List' view there is now a new tree view with root node 'Uncategorized'.
** Expand it to see your bug
** A double click on the bug entry opens the Bugzilla editor with that bug.

There exists the concept of 'Context' which defines a set of files for each bug. This is activated by clicking on the 'Activate...' link in the 'Task List' view.

Documentation/Building Guide AOO/Building on Windows

2013-11-22T15:45:09Z

Hdu: old msvc runtime dlls are no longer needed for AOO>=4.1

{{Documentation/Building Guide AOO TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on Windows}}
[[Category:Windows]]

__TOC__

= Overview =

For general information on how to build Apache OpenOffice from source code, see the [[Documentation/Building_Guide_AOO|platform independent page]].

{{Template:Documentation/Windows|This document explains the platform specific details.}}
For building Apache OpenOffice the [http://www.cygwin.com Cygwin environment] is required. Cygwin is a set of programs that run on Windows but emulate a complete Unix command line environment.

As compiler we use Microsoft's Visual C++, not the gcc from Cygwin. Therefore Visual Studio Express can be used for debugging.

To use this document you should be familiar with a bourne command line interpreter (sh or bash), but you need not be a UNIX shell wizard.
{{Template:Documentation/Tip|If you have never used a Unix shell, you might want to take a look at the [http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/index.html shell introduction at TLDP].}}

=Build requirements=

Additionally to the [[Documentation/Building Guide AOO#General_Build_Requirements|general build requirements]] you need
{| class="prettytable" border="1" width="100%"
|-
!style="width: 25%"|What
! Where to get
!style="width: 20%"|How to install
|-
| Windows 7 (recommended), Windows Vista, Windows XP
|
|
|-
| Cygwin
| http://www.cygwin.com, '''32bit version''', minimum version: 1.5.10, preferred: current version]

See [[#Setting up Cywin|below]] for setting up cygwin and the required packages.
| (default)
|-
| Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1
| http://www.microsoft.com/en-us/download/details.aspx?id=3138

It brings the Visual Studio 2008 C++ compiler with it.

This is either a DVD image or a net installer. You can either mount the DVD with a suitable tool, burn it do a DVD or use tools like winrar or 7zip to extract files from the ISO file directly. You don't need to install samples or documentation (saves a lot of disk space). It will also install the .NET Framework 3.5 SDK. It might be best to install the Windows SDK into the default directory, and if not that into one without capital letters in the path.
|
|-
| Microsoft Visual C++ 2008 SP1 Redistributable Package (x86)
| vcredist_x86.exe, download found [http://www.microsoft.com/en-us/download/search.aspx?q=Microsoft%20Visual%20C%2b%2b%202008%20Redistributable%20Package&p=0&r=10&t=&s=availabledate~Descending here]
It is just packed as it is into the installation package.

The exact download URL may have changed. In that case you have to search Microsoft's website.
| main/external/vcredist
|-
| Microsoft Visual C++ 2008 SP1 Redistributable Package (x64)
| vcredist_x64.exe, download found [http://www.microsoft.com/en-us/download/search.aspx?q=Microsoft%20Visual%20C%2b%2b%202008%20Redistributable%20Package&p=0&r=10&t=&s=availabledate~Descending here]
It is just packed as it is into the installation package.

The exact download URL may have changed. In that case you have to search Microsoft's website.
| main/external/vcredist
|-
| GDI+ Redistributable
| http://www.microsoft.com/downloads/details.aspx?familyid=6A63AB9C-DF12-4D41-933C-BE590FEAA05A&displaylang=en. Genuine Windows Validation required.
| main/external/gdiplus
|-
| Runtime libraries 10.0
| msvcp100.dll and msvcr100.dll for Java 7 support - see issue [https://issues.apache.org/ooo/show_bug.cgi?id=120979 120979].
Get them from the Microsoft Visual C++ 2010 Redistributable Package (x86) from the Microsoft site - http://www.microsoft.com/en-us/download/search.aspx?q=Microsoft+Visual+C%2b%2b+2010+Redistributable
| main/external/msvcp100
|
|-
| dbghelp.dll
| http://msdn.microsoft.com/en-us/library/windows/desktop/ms679309%28v=vs.85%29.aspx

The exact download URL may have changed. In that case you have to search Microsoft's website.

Search for it on your PC or on the web. E.g., it is part of the Windows Driver Kit.
| main/external/dbghelp
|-
| Windows Driver Kit Version 7.1.0
| http://www.microsoft.com/downloads/details.aspx?id=11800

To enable ATL and ActiveX in the build - it is optional

related configure options are:
--with-atl-include, --with-atl-lib-dir, --with-mfc-include-dir, --with-mfc-lib-dir
|
|-
| Microsoft DirectX SDK
| http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=6812

To enable DirectX in the build - it is optional

related configure option is:
--with-directx-home
|
|-
| Unicode NSIS, version 2.46.5
| http://code.google.com/p/unsis/downloads/detail?name=nsis-2.46.5-Unicode-setup.exe&can=2&q=

If Unicode NSIS is available, a self contained Windows installer is created in addition to the MSI installer files - it is optional
|
|}

When building Apache OpenOffice 3.4.x or 4.0.x you need to provide some additional binaries:
{| class="prettytable" border="1" width="100%"
|-
| Runtime libraries 7.1
| msvcr71.dll for Mozilla libraries. Search for them on the web or on your PC. These files should be named as all lower case. Sometimes when downloaded they are upper case and this will cause 'file not found' errors towards the end of the build))
| main/external/msvcp71
|-
| Runtime libraries 8.0
| msvcp80.dll and msvcr80.dll for Mozilla libraries. Search for them on the web or on your PC.
| main/external/msvcp80
|}

=Remarks=

{{Template:Documentation/Note|OOo uses some Mozilla libraries. Building the corresponding sources is only possible with the VC2003 compiler so you have to use precompiled libraries that require the msvx71 libraries mentioned above. On Windows the Mozilla libraries are needed only for Mozilla address book support. Unfortunately a bug in the module dependencies makes it necessary that the Mozilla libaries are used anyway as otherwise building the module <tt>xmlsecurity</tt> fails.}}

= Setting up Cygwin =

Go to http://www.cygwin.com/ and download and install the current 32bit version.
{{Template:Documentation/Caution|Make sure that you keep the filetype set to “Unix/binary”.}}
{{Template:Documentation/Caution|Make sure that the PATH variable in your cygwin shell does not contain any unquoted blanks and quotes, otherwise configure will not work}}

=== Additional packages for Cygwin to serve the AOO build ===

Cygwin consists of some basic and a lot of optional packages. As building AOO needs some of these optional packages you have to select them in the installer.
Here's a complete list of the required packages:
* Category Archive:
** unzip
** zip
* Category Devel :
** autoconf
** bison
** flex
** gcc-g++
** gperf
** make
** patch
** readline
** subversion (if you want to use svn inside the cygwin shell to checkout and update your working copy of AOO)
* Category Net
** openssh
** openssl
* Category Perl
** perl - see [http://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO#General_Build_Requirements General Build Requirements] for additional Perl modules
* Category Shells
** mintty
* Category Utils
** gnupg
* Category Web
** wget

{{Template:Documentation/Note|The installer will automatically check and download some more packages needed by whose listed here. The whole process takes roughly 20 minutes.}}

=== Breaking links to executable ===

Within the Cygwin Toolkit, some executables might be symlinks: awk.exe and gunzip.exe, tar.exe (in older releases only). This can lead to a break of the build later, and the symlinks should be replaced by copies of the command they link to.

To check this, execute:

ls -l /bin/awk.exe

whether e.g. awk.exe is a symlink. In version 1.5.24-2 awk.exe is a link to gawk.exe. The shell will show this by putting out “awk.exe -> gawk.exe”. In this case gawk.exe must be copied to awk.exe by executing:

cd /bin
rm awk.exe
cp gawk.exe awk.exe

In case you overlook something here or you have a newer Cygwin version with additional symlinks not mentioned here it's not a problem. You will get a helpful error message about an existing link in the configuration step (configure) later. The message will tell you which link you have to remove and you can do it following the advice given above for the awk.exe/gawk.exe pair.

=== Installing additional perl modules in cygwin ===

As explained some perl modules must be installed with CPAN. The necessary command in the cygwin shell is

perl -MCPAN -e shell

If this command is executed the first time CPAN will ask for configuration. Choose autoconfiguration.

{{Template:Documentation/Caution|Please note that CPAN is not able to deal with usernames containing spaces. To work around this fact, when CPAN asks you to specify the ''CPAN build and cache directory'', change the default suggestion to <tt>/cpan</tt>.}}

At the end the CPAN shell appeared and is ready to accept commands for installations. Each module is installed by typing <code>install $MODULENAME</code>. The modules that must be installed are:

* Archive::Zip
* LWP::UserAgent
* XML::Parser (though it seems that this is already installed; doesn't hurt to do it)

CPAN will detect if a selected module depends on other modules and it will offer to download them also. As explained please just confirm this.

{{Template:Documentation/Caution|I got an error message from CPAN somewhat like the following:
<pre>C:\cygwin\bin\perl.exe: *** unable to remap C:\cygwin\bin\cygiconv-2.dll to same
address as parent(0x7C0000) != 0x7D0000</pre>
To fix this, I had to exit the Cygwin shell, run cmd.exe, then type "c:\cygwin\bin\ash.exe" to start the minimal shell, then type <code>/bin/rebaseall</code>. Then CPAN worked when I ran it again.}}

= Configure switches (Windows specific) =

Additionally to the general [[Documentation/Building_Guide_AOO#Configuration_and_bootstrapping|configure switches]] there are several that only have to be used on Windows or have Windows specific values.

Typical values for the compiler and SDK. If default installation paths are used these configure switches are not needed:
--with-frame-home="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v7.0"
--with-psdk-home="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v7.0"
--with-midl-path="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v7.0/Bin"
For DirectX:
--with-directx-home="C:/Program Files (x86)/Microsoft DirectX SDK (June 2010)"
For ATL and ActiveX:
--with-atl-include-dir=/cygdrive/c/WinDDK/7600.16385.1/inc/atl71
--with-atl-lib-dir=/cygdrive/c/WinDDK/7600.16385.1/lib/ATL/i386
--with-mfc-include-dir=/cygdrive/c/WinDDK/7600.16385.1/inc/mfc42
--with-mfc-lib-dir=/cygdrive/c/WinDDK/7600.16385.1/lib/Mfc/i386

And some more:
--enable-pch
--enable-dbgutil

Build Environment Effort/External source tarballs

2013-11-09T09:11:40Z

Hdu: default TARFILE_LOCATION=ext_sources

{{Build Environment Effort}}
== Integration of external source tarballs in our build process ==

=== General assumptions ===

Most available tarballs can be built (theoretically) by following three steps:

#unpack
#configure
#build

Taking this as the generic way some targets are implemented in our makefiles to ease the integration of external projects.

=== What can be done? ===

With a single dmake you can unpack, patch, configure and build an alien tarball, provided that the according makefile.mk is correct. Each of these steps is skipped when run successfully once. The files in "<module>/<platform>/misc/build" reflect the already done parts and can be deleted to force rerunning a particular step.

Additionally there are some targets for common use actions which can be used with "dmake TARGET":

*create_clean: unpack tarball without modifying it.

*patch: apply the patchfiles from "''PATCH_FILES''" to source tree. The tree is created if not already existing.

*create_patch: a patchfile (named <tarball basename>-newpatch-rename_me +.patch) is created, reflecting all new changes to files from the tarball, done additionally to previous patches. Note that you still have to give that patch a sensible name and add it to PATCH_FILES Additional files have to be set in the variable "ADDITIONAL_FILES" to get into the patch.

=== Where are those tarballs? ===

The tarballs reside outside of the main source code. Setting up a build environment will set an environment variable named TARFILE_LOCATION which is typically set to ''ext_sources''. The tarballs are stored with their checksum as "<md5-checksum>-tarfilename" (see also TARFILE_MD5 in the example).

To initially fill this directory, a script called ''fetch_tarballs.sh'' is called. The only parameter is the list of all required tarfiles for this specific revision, found in the repository root. Thus
<pre>fetch_tarballs.sh external_deps.lst</pre>

checks for the required tarballs and downloads them from the URL given in the first line of this list. This step by default is done in the bootstrap step of setting up an environment.

=== How to get new tarballs upstream? ===

To get new archives to the download directory, please contact the lead of the external project, [mailto://mh@openoffice.org Martin Hollmichel].

Update the file external_deps.lst in the repository root with the file name of the new tarball exactly as it appears in $TARFILE_LOCATION.

=== What's missing? ===

*Dependencies are only between the supported steps or tarball internal.

*<span style="text-decoration: none;">Known feature like "dmake</span> debug" only work in modules that add dmake makefiles to build the external sources.<br>

*switching to a gcc environment on win32 .

*external projects are build as one job. There is no parallelization the build the external project -- this might create a bottleneck for highly parallelized builds, if the external project is big.

=== How to write a makefile.mk for an external tarball ===

This example is taken from the so_berkeley project.

#*************************************************************************

PRJ=.

PRJNAME=so_berkeleydb
TARGET=so_berkeleydb

# --- Settings

.INCLUDE : settings.mk

# --- Files

# Basename of the tarball which is supposed to reside in a direcrory named pointed to by the environment variable TARFILE_LOCATION.
TARFILE_NAME=db-3.2.9

# md5 checksum of the tarball
TARFILE_MD5=d70951c80dabecc2892c919ff5d07172

# Name of the patch file if needed. Used to apply patches to the original tarball needed
# to build (e.g. for win32...).

PATCH_FILES=db-3.2.9.patch

.IF "$(GUI)"=="UNX"

# sometimes it makes sense to call the configure command from a different directory.
CONFIGURE_DIR=out

#relative to CONFIGURE_DIR

# command to configure package and switches. If no "CONFIGURE_ACTION" is supplied
# all other configure variables are ignored.

CONFIGURE_ACTION=..$/dist$/configure

CONFIGURE_FLAGS=--enable-cxx --enable-java --enable-dynamic --enable-shared

# same as with configure.
BUILD_DIR=$(CONFIGURE_DIR)
BUILD_ACTION=make

# copy libraries to the "lib" directory in the local output tree known from own projects.
OUT2LIB=$(BUILD_DIR)$/.libs$/libdb*.so

# same as above. copy to $(BIN)
OUT2BIN=java$/classes$/db.jar

.ENDIF # "$(GUI)"=="UNX"

.IF "$(GUI)"=="WNT"

BUILD_DIR=build_win32

# build a msdev project without GUI.
BUILD_ACTION=msdev Berkeley_DB.dsw /useenv /MAKE "db_buildall - RELEASE" /MAKE "db_java - RELEASE"

OUT2BIN=java$/classes$/db.jar \
$(BUILD_DIR)$/Release$/libdb_java32.dll \
$(BUILD_DIR)$/Release$/libdb32.dll

OUT2LIB= \
$(BUILD_DIR)$/Release$/libdb_java32.lib \
$(BUILD_DIR)$/Release$/libdb32.lib

.ENDIF # "$(GUI)"=="WNT"

# make the created patch contain the new files comments.txt
ADDITIONAL_FILES= build_w32$/comment.txt

OUT2INC= \
$(BUILD_DIR)$/db.h \
include$/db_185.h \
include$/db_cxx.h

OUT2CLASS=java$/classes$/db.jar

# --- Targets

# contains some nessecary variables.
.INCLUDE : set_ext.mk
.INCLUDE : target.mk

# contains the "magic" to create targets out of the set variables.
.INCLUDE : tg_ext.mk

[[Category:Build_System]]

Build Environment Effort/External source tarballs

2013-11-09T09:06:58Z

Hdu: ooo.lst has been renamed to external_deps.lst

{{Build Environment Effort}}
== Integration of external source tarballs in our build process ==

=== General assumptions ===

Most available tarballs can be built (theoretically) by following three steps:

#unpack
#configure
#build

Taking this as the generic way some targets are implemented in our makefiles to ease the integration of external projects.

=== What can be done? ===

With a single dmake you can unpack, patch, configure and build an alien tarball, provided that the according makefile.mk is correct. Each of these steps is skipped when run successfully once. The files in "<module>/<platform>/misc/build" reflect the already done parts and can be deleted to force rerunning a particular step.

Additionally there are some targets for common use actions which can be used with "dmake TARGET":

*create_clean: unpack tarball without modifying it.

*patch: apply the patchfiles from "''PATCH_FILES''" to source tree. The tree is created if not already existing.

*create_patch: a patchfile (named <tarball basename>-newpatch-rename_me +.patch) is created, reflecting all new changes to files from the tarball, done additionally to previous patches. Note that you still have to give that patch a sensible name and add it to PATCH_FILES Additional files have to be set in the variable "ADDITIONAL_FILES" to get into the patch.

=== Where are those tarballs? ===

With the integration of the {{CWS|ause110}} the tarballs no longer reside in the source code repository. Setting up a build environment will set an environment variable named TARFILE_LOCATION. For solving problems with unversioned source archives, files are stored as "<md5-checksum>-tarfilename" (see also TARFILE_MD5 in the example).

To initially fill this directory, a script called ''fetch_tarballs.sh'' is called. The only parameter is the list of all required tarfiles for this specific revision, found in the repository root. Thus
<pre>fetch_tarballs.sh external_deps.lst</pre>

checks for the required tarballs and downloads them from the URL given in the first line of this list. This step by default is done in the bootstrap step of setting up an environment.

=== How to get new tarballs upstream? ===

To get new archives to the download directory, please contact the lead of the external project, [mailto://mh@openoffice.org Martin Hollmichel].

Update the file external_deps.lst in the repository root with the file name of the new tarball exactly as it appears in $TARFILE_LOCATION.

=== What's missing? ===

*Dependencies are only between the supported steps or tarball internal.

*<span style="text-decoration: none;">Known feature like "dmake</span> debug" only work in modules that add dmake makefiles to build the external sources.<br>

*switching to a gcc environment on win32 .

*external projects are build as one job. There is no parallelization the build the external project -- this might create a bottleneck for highly parallelized builds, if the external project is big.

=== How to write a makefile.mk for an external tarball ===

This example is taken from the so_berkeley project.

#*************************************************************************

PRJ=.

PRJNAME=so_berkeleydb
TARGET=so_berkeleydb

# --- Settings

.INCLUDE : settings.mk

# --- Files

# Basename of the tarball which is supposed to reside in a direcrory named pointed to by the environment variable TARFILE_LOCATION.
TARFILE_NAME=db-3.2.9

# md5 checksum of the tarball
TARFILE_MD5=d70951c80dabecc2892c919ff5d07172

# Name of the patch file if needed. Used to apply patches to the original tarball needed
# to build (e.g. for win32...).

PATCH_FILES=db-3.2.9.patch

.IF "$(GUI)"=="UNX"

# sometimes it makes sense to call the configure command from a different directory.
CONFIGURE_DIR=out

#relative to CONFIGURE_DIR

# command to configure package and switches. If no "CONFIGURE_ACTION" is supplied
# all other configure variables are ignored.

CONFIGURE_ACTION=..$/dist$/configure

CONFIGURE_FLAGS=--enable-cxx --enable-java --enable-dynamic --enable-shared

# same as with configure.
BUILD_DIR=$(CONFIGURE_DIR)
BUILD_ACTION=make

# copy libraries to the "lib" directory in the local output tree known from own projects.
OUT2LIB=$(BUILD_DIR)$/.libs$/libdb*.so

# same as above. copy to $(BIN)
OUT2BIN=java$/classes$/db.jar

.ENDIF # "$(GUI)"=="UNX"

.IF "$(GUI)"=="WNT"

BUILD_DIR=build_win32

# build a msdev project without GUI.
BUILD_ACTION=msdev Berkeley_DB.dsw /useenv /MAKE "db_buildall - RELEASE" /MAKE "db_java - RELEASE"

OUT2BIN=java$/classes$/db.jar \
$(BUILD_DIR)$/Release$/libdb_java32.dll \
$(BUILD_DIR)$/Release$/libdb32.dll

OUT2LIB= \
$(BUILD_DIR)$/Release$/libdb_java32.lib \
$(BUILD_DIR)$/Release$/libdb32.lib

.ENDIF # "$(GUI)"=="WNT"

# make the created patch contain the new files comments.txt
ADDITIONAL_FILES= build_w32$/comment.txt

OUT2INC= \
$(BUILD_DIR)$/db.h \
include$/db_185.h \
include$/db_cxx.h

OUT2CLASS=java$/classes$/db.jar

# --- Targets

# contains some nessecary variables.
.INCLUDE : set_ext.mk
.INCLUDE : target.mk

# contains the "magic" to create targets out of the set variables.
.INCLUDE : tg_ext.mk

[[Category:Build_System]]

Documentation/Building Guide AOO

2013-11-08T09:28:38Z

Hdu: the mod module has been removed

{{DISPLAYTITLE:Apache OpenOffice Building Guide}}

= Preface =
This guide will help you to build Apache OpenOffice from its source code. It details the prerequisites and explains how to download the source code, prepare and then run the build. [[Documentation/Building_Guide_AOO/Step_by_step|Step-by-step instructions]] for resolving the pre-requisites of individual platforms and building on them are available.

Here is the short version for the brave and impatient:
* Download the source: <code>svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo</code>
* Configure: <code>cd main/ ; autoconf ; ./configure <some-switches> ; ./bootstrap</code>
* Build: <code>source <platform-dependend-name>.sh ; cd instsetoo_native ; build --all</code>
* Wait for an hour or more (The build can take up to 3 hours.)
* Install office
* Enjoy

The detailed description below gives a broader introduction into the build process and explains for the various steps.

==Status==
This document is loosely based on an older [[Documentation/Building Guide|version]]. I have tried to avoid duplication and to move anything that all platforms have in common to this page. Many details have been removed on purpose because they refer to older version of OpenOffice. However, there are still some things not explained in the necessary detail on this page:
* How to use ccache

{{Documentation/SeeAlso|*[[How_to_build_Symphony%27s_source_code]] }}

= Getting help =
You can get help by searching this wiki or by asking questions on the [http://openoffice.apache.org/mailing-lists.html#development-mailing-list-public developers mailing list].

You can help us improve this guide by pointing out any errors (preferably after finding a solution).
Or don't be shy and edit (and improve) these pages yourself.

= Basics =

In order to build Apache OpenOffice you need a proper environment. This includes
* a command line interpreter, typically bourne shell compatible (sh or bash) inside a terminal. On Windows you will need to install Cygwin to provide it.
* C++ compiler and linker. The exact choice depends on the operating system.
* Perl interpreter and several modules.
* Many tools from the Unix world like make or sed.

See section [[#General_Build_Requirements | General Build Requirements]]
for an exact list of requirements.

= Getting the source =

The source code is available as SVN repository at https://svn.apache.org/repos/asf/openoffice

Check it out with

svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo

More details about how to check out source code from SVN can be found [http://openoffice.apache.org/source.html here].

== Space Requirements ==

The checked out files take up somewhat over 5GB on disk (more than 150000 files in more than 7000 folders and the SVN overhead).

After building this becomes (on Windows7) almost 17GB (more than 406000 files in more than 23000 folders).

You can use git as well. There exists no guide for this, therefore ask on dev@openoffice.apache.org, if you want to use git.

= Organization of the source and output tree =

The source code has five top level directories:
;main/:contains most of the so called modules. Each module typically provides one or more libraries. The source code of the writer application for example can be found in main/sd/.
;test/:contains the new [[QA/test_automation_guide | automated testing framework]]
;ext_libraries/:is the new home of modules that build external libraries (libraries maintained outside of Apache OpenOffice and often outside Apache).
;ext_sources/:contains the tar balls (archives) of external libraries. They are included both for convenience and to make sure that specific versions remain available. Note that the source package of the Apache OpenOffice release does not contain any external tar balls.
;extras/:holds the localization data.

Most tools and scripts that are used for building are located below <code>main/solenv/</code>:
*dmake makefiles in <code>main/solenv/inc/</code>
*gmake makefiles in <code>main/solenv/gbuild/</code>
*executables and perl files in <code>main/solenv/bin/</code>
*perl modules in <code>main/bin/modules/</code>

Libraries and other output files that are shared between modules are stored in <code>main/solver/</code>.

=Building=

==Overview==

Building Apache OpenOffice consists of three steps:
;Configuring/bootstrapping:Detect platform, operating system, compiler, etc. and write the information into a shell script for later use. The developer can turn on or off certain features in this phase.
;Building:Compile the source code, transform other input files, apply localization.
;Packing:Create a set of files, the installation set, that can be installed on the respective operating system. This can be msi/cab files for windows, deb or rpm for Linux, dmg for Mac.

The configure step has to be carried out only once. Building and packing is necessary after every source code change. There are short cuts to avoid parts of these steps (when you know what you are doing.)

The building examples in this wiki document use only command line approaches to building. Depending on your expertise, it may be possible to use an IDE which allows specification of custom build scripts.

== General Build Requirements ==

The general requirements for all platforms are
{| class="prettytable"
|- valign="top"
! Requirement
! Description
! Configure switch
|- valign="top"
| Java JDK
| Java Implementation compatible with [http://java.sun.com/j2se/1.5/ JDK 1.5] or [http://java.sun.com/javase/6/ JDK 1.6]. [http://openjdk.java.net/ OpenJDK] is supported as well.

For Windows [http://www.oracle.com/technetwork/java/javase/downloads/index.html/ JDK 1.7] is recommended.
| --with-jdk-home=
|- valign="top"
| Perl
| Perl 5 - note: for Windows Perl will be installed as part of the cygwin environment.

Also required are the perl packages
Archive::Zip
LWP::UserAgent
XML::Parser
They can be installed from the shell with (you may have to run it with super user/administrator rights)
perl -MCPAN -e shell
If it is executed for the first time then CPAN will ask for configuration. Choose autoconfiguration.
Eventually the CPAN shell appeares accepts commands. Install missing modules with
install <module-name>
Find more details [http://wiki.services.openoffice.org/wiki/CPAN_install here].<sup>5</sup>
|- valign="top"
| CUPS
| cups headers. Provided by a cups-devel package or a libcups2-devel

note: not for Windows
|- valign="top"
| PAM
| PAM support. Provided by a pam-devel package or a libpam-dev

note: not for Windows
|- valign="top"
| Apache Ant
| [http://ant.apache.org/ Ant 1.9 or later] (see note)
| --with-ant-home=
|- valign="top"
| Archiver
| zip and unzip - note: for Windows zip and unzip will be installed as part of the cygwin environment.
|- valign="top"
| gperf
| [http://www.gnu.org/software/gperf/gperf.html gperf] tool - note: for Windows gperf will be installed as part of the cygwin environment.
|- valign="top"
| NSS<sup>1</sup>
| For Windows the Mozilla build tools<sup>2</sup> are needed to build the nss module. They can be obtained [http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/ here].
|-
|}

'''Notes:'''
# The nss module ("Network Security Services") provides security services needed for e.g. password protection. NSS can be disabled using the configure switch <tt>--disable-nss-module</tt>.
# NSS is provided by the Mozilla project. Building it on Windows requires the [http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32 MozillaBuild tools]. Get the latest version, install it and use the configure switch <tt>--with-mozilla-build</tt> to tell configure where the tools are installed. For example: <tt>--with-mozilla-build=c:/mozilla-build</tt>
# Please note that CPAN is not able to deal with usernames containing spaces. To work around this fact, when CPAN asks you to specify the CPAN build and cache directory, change the default suggestion to /cpan.
# Apache Ant: Assure a proper ant set-up by downloading and installing ant, in total, from the ant site linked above. If you are a Linux developer, your distro may not have ant setup correctly for building Apache OpenOffice.
# Use <tt>./configure --help</tt> to see all possible configuration options

See also the platform specific requirements for
*[[Documentation/Building_Guide_AOO/Building_on_Windows|Windows]]
*[[Documentation/Building_Guide_AOO/Building_on_Linux|Linux]]
*[[Documentation/Building_Guide_AOO/Building_on_MacOsX|MacOSX]]

==Configuration and bootstrapping==
This is typically done only once after the source code is checked out. Repeat this after changing your mind about options given to configure.

The call to
autoconf
creates the main/configure script from main/configure.in and some other input files.

The set of options/switches given to configure depends on the platform and your choice of features. A typical call starts like this
configure \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://www.msweet.org/files/project2/epm-3.7-source.tar.gz \
It tells configure where to find the source code of external tools dmake and epm.

By default only source code under [http://www.apache.org/legal/3party.html#category-a category A] licenses is compiled and included. Besides the Apache License 2.0 this includes for example BSD and MIT/X11 license. If you want to enable features that rely on third party code under [http://www.apache.org/legal/3party.html#category-b category B] licenses (like MPL, CPL, EPL, etc) then add the option
--enable-category-b

For inclusion of externally hosted dictionary extensions add option
--enable-bundled-dictionaries
Note that dictionaries rely on a category B third party library (hunspell). Therefore <code>--enable-category-b</code> is a prerequisite for <code>--enable-bundled-dictionaries</code>. Dictionaries have a variety of licenses and are bundled without modification: they are not compiled.

The <code>--with-lang</code> option will introduce the build of additional language resources. This switch accepts one or more RFC 1766 language tags as arguments, unfortunately not all languages are supported. Check the <code>[http://svn.apache.org/viewvc/openoffice/trunk/main/solenv/inc/langlist.mk?view=markup solenv/inc/langlist.mk]</code> file for all the currently supported language tags. The environment variable WITH_LANG will then contain the language tags of the additional (en-US will always be build) languages. Example:
--with-lang="de fr"
enables the build of the localized German and French version.

You can run the rat scan while building with option
--with-rat-scan
[[Documentation/Building_Guide_AOO/Rat_Scan|Here]] you can find details.

Finish this step by running
./bootstrap
This will build dmake and epm, download missing source code tar balls of external libraries, and download missing external dictionary extensions.

==Building==
Start by including the environment variables prepared by configure into your current environment with
<tt>source <shell-script-name></tt>
where <shell-script-name> depends on your platform:
{| class="prettytable"
|-
!platform id
!<shell-script-name>
|-
| wntmsci12
| winenv.set.sh
|-
| unxlngi6
| LinuxX86Env.Set.sh
|-
| unxlngx6
| LinuxX86-64Env.Set.sh
|-
| unxmacxi
| MacOSXX86Env.Set.sh
|}
Look into main/set_soenv for more platforms. (search for lines <code>$OUTPATH = "<platform>";</code> and the nearby line <code>$outfile = "<shell-script-name>";</code>. Add the suffix <code>.sh</code> for the bash variant.

If you want to build the whole office and the install sets then
cd main/instsetoo_native
build --all
You may want to experiment with the -P options for multi process builds to reduce the build time.
build --all -P<m> -- -P<n>
tells build to use <code>m</code> processes (build up to <code>m</code> modules in parallel) and <code>n</code> threads for each module.

Building Apache OpenOffice uses a custom build command, build.pl, located in /main/solenv/bin.
You may it helpful to learn more about build options from the [http://www.openoffice.org/tools/tools/build.html Build Documentation]

==Partial Builds==

Building the whole office takes a lot of time. Therefore it may be preferable to build only parts after making changes to the source code.
There are two different types of partial builds:
;Compatible:Can be used only when the code changes do not change exported interfaces. Use with care and only when you know what you are doing.
;Incompatible:Use for code changes that modify exported C++ or IDL interfaces, that modify resources that are used by other modules, or when you are not sure.
:If you are a new developer, you should probably always assume your changes are "incompatible" and follow the instructions for '''Incompatible Build'''.

===Make Systems Used by Apache OpenOffice===

For the following Build sections you should be aware that Apache OpenOffice uses two different '''make''' systems to build its modules.
*The older one is based on dmake
*The other and newer one is based on GNU make. This system is often referred to as gbuild.
When a module contains, among others, a Makefile and a Module_<module>.mk file then it is a gbuild module.

===Compatible Build===

After changing code in module <module> which does not change any exported interfaces do
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build
deliver
|
cd <module>
make -sr
No explicit call to <code>deliver</code> is necessary for gbuild modules.
|}
to compile and deliver the resulting libraries to <code>main/solver/</code>. You may want to erase the output of a previous compilation:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build --from <module> --prepare
or faster (but without the un-deliver)
cd <module>
rm -fr <platform>/
|
cd <module>
make clean
|}

===Incompatible Build===

Modifications that change exported interfaces require not only the module to be rebuild that contains the modified code. All depending modules (dependencies are defined in <code><module>/prj/build.lst</code>) have to be rebuild as well. This is best done from <code>main/instsetoo_native/</code>:
<tt>cd main/instsetoo_native/</tt>
<tt>build --from <incompatible-module> --prepare</tt>
<tt>build --from <incompatible-module></tt>

The second line removes the output of all modules that have to be recompiled. The drawback of this command is that the output of modules which are build via gbuild are not removed. Thus, the following additional command performed after the second one will do the trick:
build --from <incompatible-module> --job="make clean; make clean debug=t" --ignore

===Frequently used options===

In order to add debug information to libraries and executables, add the <code>debug</code> switch to any <code>build</code> or <code>make</code> command:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build debug=t
|
cd <module>
make -sr debug=t
|}
Remember that for the gbuild system you have to use the debug flag also when cleaning a module (otherwise eg the wrong precompiled headers are deleted and are not rebuilt):
make clean debug=t

You can force make to rebuild dependency information by first deleting it with the depend option. It would be rebuilt automatically with the next build:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build depend=t
build
|
cd <module>
make -sr depend=t
make -sr
|}

= [http://wiki.openoffice.org/wiki/Documentation/Building_Guide_AOO/Step_by_step Step-by-Step Building Guide for Different Platforms] =
[[Category:Documentation]][[Category:Development]][[Category:Porting]]

BUGZILLA/FAQ

2013-11-07T12:06:00Z

Hdu: /* Meaning of bracketed branch names in the summary */ using the branch tag for problems introduced by a branch

This page lists several FAQ how to use the [https://issues.apache.org/ooo/ AOO-BUGZILLA]

== Attachments and Sample Documents ==

=== What are good Sample Documents? ===
Providing a sample document usually helps to reproduce a problem and to test the fix.
Sample documents should be minimal, e.g. if you notice a bug in the upper left corner on page 345 of a 1000 page document then it is advisable to check whether the bug can still be replicated if the other pages are removed. Removing as much content that does not impact the reproducibility of the bug helps everyone who wants to work on that bug report.

=== How to use attached sample documents for multiple Bug Reports ===
If an appropriate document to reproduce the problem or to show the problem (screenshot) already does exist in Bugzilla, please [https://wiki.documentfoundation.org/QA/Bugzilla/FAQ#How_to_use_attached_sample_documents_for_multiple_Bug_Reports cite the document instead of attaching it again]. That saves time, because other users, who might know the existing attachment, do not need to check whether the new attachment contains new information (and only looks similar) or simply is a clone.

== Bug Summary ==
Be as concise as possible in the bug Summary. The more specific a bug summary is the more useful it is for others such as when you report a new bug you will notice that bugzilla tries to find similar bugs that might be of interest. So instead of having a summary "Bug in Writer!!!" please be more specific and write e.g. "Writer prints green text underlines as blue on a Windows GDI printer".

=== Meaning of bracketed branch names in the summary ===
Development often happens in [https://en.wikipedia.org/wiki/Branching_%28revision_control%29 code branches]. Development branches are usually very interesting because they contain important new features or major cleanups. But code in branches is mostly not yet ready for general consumptions and needs to be extensively tested before it can be integrated. When such branches are tested the bugs found are very valuable for everyone working on that branch but of little value for the general public. So if a problem occurs only on a development branch then please use the bracketed branch name in the bug summary to make things as clear as possible. Examples of such tags used were e.g. [sidebar], [ia2], [aw080], etc. If the integration of a code branch into the mainline has introduced problems then adding the branch tag also makes very much sense.

=== Meaning of bracketed pseudo key words in the summary ===
In order to make bug summaries as concise as possible experienced bug reporters used pseudo tags directly in the summary. They are often obsolete nowadays because some bugzilla fields are better suited for marking the kind of bug.

Examples for pseudo tags that were used are:
* '''[Regression]''' Deprecated tag for AOO regression issues. The "regression" keyword should be added to the '''Keywords''' field instead.
* '''[RFE]''' deprecated for ''Request For Enhancement''. Set the '''Issue Type''' selector to ENHANCEMENT instead.
* '''[WW8]''' Bug related to WW8 import filter (for Word.Document.8)

== Bug STATUS ==

=== CONFIRMED ===
==== Should I report new bugs with initial Status CONFIRMED? ====
The CONFIRMED status means that the bug report is clear enough and has sufficient details for another person to replicate the bug on another system.
So the answer is generally '''no'''! Even if you are pretty sure that you found a real bug and added lots of relevant information, generally following the [http://en.wikipedia.org/wiki/Two-man_rule#Other_uses Two Men Rule] results in better reports, what leads to faster bug fixing costing less developer resources. But of course, if you are an experienced bug tester (relevant contribution in more than 100 bugs or similar qualification), you might find good reasons to ignore the Two Men Rule and to select initial Status CONFIRMED

==== When should I change Status from UNCONFIRMED to CONFIRMED? ====
Please do not change to CONFIRMED only because you were able to reproduce reporter's observations. The right moment for CONFIRMED is when [http://www.openoffice.org/qa/issue_handling/basic_rules.html#complete all relevant information] has been gained.
# Report is a [[QA/HowToFileIssue#Principles|Good Bug Report]]
## Check for duplicates has been proceeded?
## Summary is clear and specific enough to distinguish the reported bug from other similar ones
## Sample Document available? Even if it seems to be simple for QA staff to create own sample documents, it saves a lot of time if a sample is attached. and Additionally the sample document can contribute additional relevant information (Localization, Language, Formatting caused by repoerter's very special ''New Document Templates'', ...
# Other selectors with correct contents?
## Relation to Operating System checked?
## Most early OO Version with what the bug has been observed selected (if possible, do your own tests with older versions)
## Appropriate Importance?
## Keywords appropriate?
# All or at least most relevant aspects of the bug are listed in the report

If these conditions are fulfilled you should select CONFIRMED. But of course, it's a matter of consideration, an important CRASH-Regression should be taken by developers as soon as possible, here it would be inappropriate to leave Status UNCONFIRMED because some minor questions are without answer.

== Mixed ==
=== From where can I download latest test versions? ===
You can test latest bug fixes with unstable test builds from [http://ci.apache.org/projects/openoffice/index.html here].

=== How To Crash AOO ===
For some investigations it is necessary to provoke a crash. You can find possibilities how to crash AOO with this [https://issues.apache.org/ooo/buglist.cgi?bug_status=CONFIRMED&bug_status=ACCEPTED&bug_status=REOPENED&f1=days_elapsed&list_id=79579&longdesc=crash&longdesc_type=allwordssubstr&o1=lessthan&query_format=advanced&resolution=---&short_desc=crash&short_desc_type=allwordssubstr&v1=100 Bugzilla query], what shows current crash-bugs.

=== What is the appropriate ''Version'' in Bugzilla Version selector? ===
The most early AOO or OOo version with what the problem has been observed. For ''Regression'' bugs ''Version'' information will help developers to find the code change what causes the problem.

In August 2013 the syntax for '''AOO''' versions in the selector has been changed, the ''AOO'' prefix has been dropped for most AOO versions. For historical reasons (?)[https://issues.apache.org/ooo/report.cgi?x_axis_field=product&y_axis_field=component&z_axis_field=&no_redirect=1&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_id=&bug_id_type=anyexact&votes=&votes_type=greaterthaneq&version=AOO340-dev&version=AOO400-dev&version=AOO410-dev&version=AOO+3.4.0&version=AOO+3.4.1&version=AOO+4.0&version=AOO+4.0.0&emailtype1=substring&email1=&emailtype2=substring&email2=&emailtype3=substring&email3=&chfieldvalue=&chfieldfrom=&chfieldto=Now&j_top=AND&f1=noop&o1=noop&v1=&format=table&action=wrap some Versions] with AOO prefix remained. If you work on such a bug report please always think about switching to a "modern" version.

=== How to connect a Bug report to a Tracking Bug ===
If you want to add a Bug report (like [https://issues.apache.org/ooo/show_bug.cgi?id=122762 Bug 122762]) to a TASK Tracking Bug (like [https://issues.apache.org/ooo/show_bug.cgi?id=122364 Tracking Bug 122364]), the best way is
# Add Bug number to ''Depends on'' field in TASK Tracking Bug
# [https://issues.apache.org/ooo/show_bug.cgi?id=122364#c3 Cite] complete Heading line of "Depends-On-Bug" in a ''Comment'' in the TASK Tracking Bug.
:: So all interested users listed in CC of TASK Tracking Bug will get a summary of the new bug with mail from bugzilla@apache.org and can see immediately what the reported problem is - no need for a detour to the tracking Bug (and several clicks).

=== How to attach screenshots with additional graphic contents ===
If you want to add some graphic contents to a screenshot to make it more comprehensible, you should copy the clipboard contents with the screenshot to a new DRAW document and add emphasis, text ideas, callouts, pointer arrows or whatever in the Draw document. If you save it with 'File -> Properties -> Security - open File Readonly' before aou attach it in the Bug, the document is protected against unintended edits, but can be edited if appropriate by other users.

=== What is the best file type for screenshots? ===
Graphic formats with lossless compression like "PNG" are much more suitable than JPG, because no compression artifacts compound recognition of details.

[[Category:Quality Assurance]]

BUGZILLA/FAQ

2013-11-07T12:00:01Z

Hdu: /* Meaning of bracketed branch names in the summary */ minor rephrasing

This page lists several FAQ how to use the [https://issues.apache.org/ooo/ AOO-BUGZILLA]

== Attachments and Sample Documents ==

=== What are good Sample Documents? ===
Providing a sample document usually helps to reproduce a problem and to test the fix.
Sample documents should be minimal, e.g. if you notice a bug in the upper left corner on page 345 of a 1000 page document then it is advisable to check whether the bug can still be replicated if the other pages are removed. Removing as much content that does not impact the reproducibility of the bug helps everyone who wants to work on that bug report.

=== How to use attached sample documents for multiple Bug Reports ===
If an appropriate document to reproduce the problem or to show the problem (screenshot) already does exist in Bugzilla, please [https://wiki.documentfoundation.org/QA/Bugzilla/FAQ#How_to_use_attached_sample_documents_for_multiple_Bug_Reports cite the document instead of attaching it again]. That saves time, because other users, who might know the existing attachment, do not need to check whether the new attachment contains new information (and only looks similar) or simply is a clone.

== Bug Summary ==
Be as concise as possible in the bug Summary. The more specific a bug summary is the more useful it is for others such as when you report a new bug you will notice that bugzilla tries to find similar bugs that might be of interest. So instead of having a summary "Bug in Writer!!!" please be more specific and write e.g. "Writer prints green text underlines as blue on a Windows GDI printer".

=== Meaning of bracketed branch names in the summary ===
Development often happens in [https://en.wikipedia.org/wiki/Branching_%28revision_control%29 code branches]. Development branches are usually very interesting because they contain important new features or major cleanups. But code in branches is mostly not yet ready for general consumptions and needs to be extensively tested before it can be integrated. When such branches are tested the bugs found are very valuable for everyone working on that branch but of little value for the general public. So if a problem occurs only on a development branch then please use the bracketed branch name in the bug summary to make things as clear as possible. Examples of such tags used were e.g. [sidebar], [ia2], [aw080], etc.

=== Meaning of bracketed pseudo key words in the summary ===
In order to make bug summaries as concise as possible experienced bug reporters used pseudo tags directly in the summary. They are often obsolete nowadays because some bugzilla fields are better suited for marking the kind of bug.

Examples for pseudo tags that were used are:
* '''[Regression]''' Deprecated tag for AOO regression issues. The "regression" keyword should be added to the '''Keywords''' field instead.
* '''[RFE]''' deprecated for ''Request For Enhancement''. Set the '''Issue Type''' selector to ENHANCEMENT instead.
* '''[WW8]''' Bug related to WW8 import filter (for Word.Document.8)

== Bug STATUS ==

=== CONFIRMED ===
==== Should I report new bugs with initial Status CONFIRMED? ====
The CONFIRMED status means that the bug report is clear enough and has sufficient details for another person to replicate the bug on another system.
So the answer is generally '''no'''! Even if you are pretty sure that you found a real bug and added lots of relevant information, generally following the [http://en.wikipedia.org/wiki/Two-man_rule#Other_uses Two Men Rule] results in better reports, what leads to faster bug fixing costing less developer resources. But of course, if you are an experienced bug tester (relevant contribution in more than 100 bugs or similar qualification), you might find good reasons to ignore the Two Men Rule and to select initial Status CONFIRMED

==== When should I change Status from UNCONFIRMED to CONFIRMED? ====
Please do not change to CONFIRMED only because you were able to reproduce reporter's observations. The right moment for CONFIRMED is when [http://www.openoffice.org/qa/issue_handling/basic_rules.html#complete all relevant information] has been gained.
# Report is a [[QA/HowToFileIssue#Principles|Good Bug Report]]
## Check for duplicates has been proceeded?
## Summary is clear and specific enough to distinguish the reported bug from other similar ones
## Sample Document available? Even if it seems to be simple for QA staff to create own sample documents, it saves a lot of time if a sample is attached. and Additionally the sample document can contribute additional relevant information (Localization, Language, Formatting caused by repoerter's very special ''New Document Templates'', ...
# Other selectors with correct contents?
## Relation to Operating System checked?
## Most early OO Version with what the bug has been observed selected (if possible, do your own tests with older versions)
## Appropriate Importance?
## Keywords appropriate?
# All or at least most relevant aspects of the bug are listed in the report

If these conditions are fulfilled you should select CONFIRMED. But of course, it's a matter of consideration, an important CRASH-Regression should be taken by developers as soon as possible, here it would be inappropriate to leave Status UNCONFIRMED because some minor questions are without answer.

== Mixed ==
=== From where can I download latest test versions? ===
You can test latest bug fixes with unstable test builds from [http://ci.apache.org/projects/openoffice/index.html here].

=== How To Crash AOO ===
For some investigations it is necessary to provoke a crash. You can find possibilities how to crash AOO with this [https://issues.apache.org/ooo/buglist.cgi?bug_status=CONFIRMED&bug_status=ACCEPTED&bug_status=REOPENED&f1=days_elapsed&list_id=79579&longdesc=crash&longdesc_type=allwordssubstr&o1=lessthan&query_format=advanced&resolution=---&short_desc=crash&short_desc_type=allwordssubstr&v1=100 Bugzilla query], what shows current crash-bugs.

=== What is the appropriate ''Version'' in Bugzilla Version selector? ===
The most early AOO or OOo version with what the problem has been observed. For ''Regression'' bugs ''Version'' information will help developers to find the code change what causes the problem.

In August 2013 the syntax for '''AOO''' versions in the selector has been changed, the ''AOO'' prefix has been dropped for most AOO versions. For historical reasons (?)[https://issues.apache.org/ooo/report.cgi?x_axis_field=product&y_axis_field=component&z_axis_field=&no_redirect=1&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_id=&bug_id_type=anyexact&votes=&votes_type=greaterthaneq&version=AOO340-dev&version=AOO400-dev&version=AOO410-dev&version=AOO+3.4.0&version=AOO+3.4.1&version=AOO+4.0&version=AOO+4.0.0&emailtype1=substring&email1=&emailtype2=substring&email2=&emailtype3=substring&email3=&chfieldvalue=&chfieldfrom=&chfieldto=Now&j_top=AND&f1=noop&o1=noop&v1=&format=table&action=wrap some Versions] with AOO prefix remained. If you work on such a bug report please always think about switching to a "modern" version.

=== How to connect a Bug report to a Tracking Bug ===
If you want to add a Bug report (like [https://issues.apache.org/ooo/show_bug.cgi?id=122762 Bug 122762]) to a TASK Tracking Bug (like [https://issues.apache.org/ooo/show_bug.cgi?id=122364 Tracking Bug 122364]), the best way is
# Add Bug number to ''Depends on'' field in TASK Tracking Bug
# [https://issues.apache.org/ooo/show_bug.cgi?id=122364#c3 Cite] complete Heading line of "Depends-On-Bug" in a ''Comment'' in the TASK Tracking Bug.
:: So all interested users listed in CC of TASK Tracking Bug will get a summary of the new bug with mail from bugzilla@apache.org and can see immediately what the reported problem is - no need for a detour to the tracking Bug (and several clicks).

=== How to attach screenshots with additional graphic contents ===
If you want to add some graphic contents to a screenshot to make it more comprehensible, you should copy the clipboard contents with the screenshot to a new DRAW document and add emphasis, text ideas, callouts, pointer arrows or whatever in the Draw document. If you save it with 'File -> Properties -> Security - open File Readonly' before aou attach it in the Bug, the document is protected against unintended edits, but can be edited if appropriate by other users.

=== What is the best file type for screenshots? ===
Graphic formats with lossless compression like "PNG" are much more suitable than JPG, because no compression artifacts compound recognition of details.

[[Category:Quality Assurance]]

BUGZILLA/FAQ

2013-11-07T10:10:00Z

Hdu: minor cleanup, remove deprecated tags from TOC

This page lists several FAQ how to use the [https://issues.apache.org/ooo/ AOO-BUGZILLA]

== Attachments and Sample Documents ==

=== What are good Sample Documents? ===
Providing a sample document usually helps to reproduce a problem and to test the fix.
Sample documents should be minimal, e.g. if you notice a bug in the upper left corner on page 345 of a 1000 page document then it is advisable to check whether the bug can still be replicated if the other pages are removed. Removing as much content that does not impact the reproducibility of the bug helps everyone who wants to work on that bug report.

=== How to use attached sample documents for multiple Bug Reports ===
If an appropriate document to reproduce the problem or to show the problem (screenshot) already does exist in Bugzilla, please [https://wiki.documentfoundation.org/QA/Bugzilla/FAQ#How_to_use_attached_sample_documents_for_multiple_Bug_Reports cite the document instead of attaching it again]. That saves time, because other users, who might know the existing attachment, do not need to check whether the new attachment contains new information (and only looks similar) or simply is a clone.

== Bug Summary ==
Be as concise as possible in the bug Summary. The more specific a bug summary is the more useful it is for others such as when you report a new bug you will notice that bugzilla tries to find similar bugs that might be of interest. So instead of having a summary "Bug in Writer!!!" please be more specific and write e.g. "Writer prints green text underlines as blue on a Windows GDI printer".

=== Meaning of bracketed branch names in the summary ===
Development often happens in [https://en.wikipedia.org/wiki/Branching_%28revision_control%29 code branches]. Development branches are usually very interesting because they contain important new features or major cleanups. But that code is often not yet ready for general consumptions and needs to be extensively tested before it can be integrated. When such branches are tested the bugs found are not of interest to general users but are very interesting for everyone working on that branch.

So it has become customary to add the bracketed branch name to the bug summary to make it clear that a problem only happens on a development branch. Such development branches are e.g. [sidebar], [ia2], [aw080], etc.

=== Meaning of bracketed pseudo key words in the summary ===
In order to make bug summaries as concise as possible experienced bug reporters used pseudo tags directly in the summary. They are often obsolete nowadays because some bugzilla fields are better suited for marking the kind of bug.

Examples for pseudo tags that were used are:
* '''[Regression]''' Deprecated tag for AOO regression issues. The "regression" keyword should be added to the '''Keywords''' field instead.
* '''[RFE]''' deprecated for ''Request For Enhancement''. Set the '''Issue Type''' selector to ENHANCEMENT instead.
* '''[WW8]''' Bug related to WW8 import filter (for Word.Document.8)

== Bug STATUS ==

=== CONFIRMED ===
==== Should I report new bugs with initial Status CONFIRMED? ====
The CONFIRMED status means that the bug report is clear enough and has sufficient details for another person to replicate the bug on another system.
So the answer is generally '''no'''! Even if you are pretty sure that you found a real bug and added lots of relevant information, generally following the [http://en.wikipedia.org/wiki/Two-man_rule#Other_uses Two Men Rule] results in better reports, what leads to faster bug fixing costing less developer resources. But of course, if you are an experienced bug tester (relevant contribution in more than 100 bugs or similar qualification), you might find good reasons to ignore the Two Men Rule and to select initial Status CONFIRMED

==== When should I change Status from UNCONFIRMED to CONFIRMED? ====
Please do not change to CONFIRMED only because you were able to reproduce reporter's observations. The right moment for CONFIRMED is when [http://www.openoffice.org/qa/issue_handling/basic_rules.html#complete all relevant information] has been gained.
# Report is a [[QA/HowToFileIssue#Principles|Good Bug Report]]
## Check for duplicates has been proceeded?
## Summary is clear and specific enough to distinguish the reported bug from other similar ones
## Sample Document available? Even if it seems to be simple for QA staff to create own sample documents, it saves a lot of time if a sample is attached. and Additionally the sample document can contribute additional relevant information (Localization, Language, Formatting caused by repoerter's very special ''New Document Templates'', ...
# Other selectors with correct contents?
## Relation to Operating System checked?
## Most early OO Version with what the bug has been observed selected (if possible, do your own tests with older versions)
## Appropriate Importance?
## Keywords appropriate?
# All or at least most relevant aspects of the bug are listed in the report

If these conditions are fulfilled you should select CONFIRMED. But of course, it's a matter of consideration, an important CRASH-Regression should be taken by developers as soon as possible, here it would be inappropriate to leave Status UNCONFIRMED because some minor questions are without answer.

== Mixed ==
=== From where can I download latest test versions? ===
You can test latest bug fixes with unstable test builds from [http://ci.apache.org/projects/openoffice/index.html here].

=== How To Crash AOO ===
For some investigations it is necessary to provoke a crash. You can find possibilities how to crash AOO with this [https://issues.apache.org/ooo/buglist.cgi?bug_status=CONFIRMED&bug_status=ACCEPTED&bug_status=REOPENED&f1=days_elapsed&list_id=79579&longdesc=crash&longdesc_type=allwordssubstr&o1=lessthan&query_format=advanced&resolution=---&short_desc=crash&short_desc_type=allwordssubstr&v1=100 Bugzilla query], what shows current crash-bugs.

=== What is the appropriate ''Version'' in Bugzilla Version selector? ===
The most early AOO or OOo version with what the problem has been observed. For ''Regression'' bugs ''Version'' information will help developers to find the code change what causes the problem.

In August 2013 the syntax for '''AOO''' versions in the selector has been changed, the ''AOO'' prefix has been dropped for most AOO versions. For historical reasons (?)[https://issues.apache.org/ooo/report.cgi?x_axis_field=product&y_axis_field=component&z_axis_field=&no_redirect=1&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_id=&bug_id_type=anyexact&votes=&votes_type=greaterthaneq&version=AOO340-dev&version=AOO400-dev&version=AOO410-dev&version=AOO+3.4.0&version=AOO+3.4.1&version=AOO+4.0&version=AOO+4.0.0&emailtype1=substring&email1=&emailtype2=substring&email2=&emailtype3=substring&email3=&chfieldvalue=&chfieldfrom=&chfieldto=Now&j_top=AND&f1=noop&o1=noop&v1=&format=table&action=wrap some Versions] with AOO prefix remained. If you work on such a bug report please always think about switching to a "modern" version.

=== How to connect a Bug report to a Tracking Bug ===
If you want to add a Bug report (like [https://issues.apache.org/ooo/show_bug.cgi?id=122762 Bug 122762]) to a TASK Tracking Bug (like [https://issues.apache.org/ooo/show_bug.cgi?id=122364 Tracking Bug 122364]), the best way is
# Add Bug number to ''Depends on'' field in TASK Tracking Bug
# [https://issues.apache.org/ooo/show_bug.cgi?id=122364#c3 Cite] complete Heading line of "Depends-On-Bug" in a ''Comment'' in the TASK Tracking Bug.
:: So all interested users listed in CC of TASK Tracking Bug will get a summary of the new bug with mail from bugzilla@apache.org and can see immediately what the reported problem is - no need for a detour to the tracking Bug (and several clicks).

=== How to attach screenshots with additional graphic contents ===
If you want to add some graphic contents to a screenshot to make it more comprehensible, you should copy the clipboard contents with the screenshot to a new DRAW document and add emphasis, text ideas, callouts, pointer arrows or whatever in the Draw document. If you save it with 'File -> Properties -> Security - open File Readonly' before aou attach it in the Bug, the document is protected against unintended edits, but can be edited if appropriate by other users.

=== What is the best file type for screenshots? ===
Graphic formats with lossless compression like "PNG" are much more suitable than JPG, because no compression artifacts compound recognition of details.

[[Category:Quality Assurance]]

BUGZILLA/FAQ

2013-11-07T09:44:40Z

Hdu: bracketed branch names and pseudo tags in issue summaries

This page lists several FAQ how to use the [https://issues.apache.org/ooo/ AOO-BUGZILLA]

== Attachments and Sample Documents ==

=== What are good Sample Documents? ===
Providing a sample document usually helps to reproduce a problem and to test the fix.
Sample documents should be minimal, e.g. if you notice a bug in the upper left corner on page 345 of a 1000 page document then it is advisable to check whether the bug can still be replicated if the other pages are removed. Removing as much content that does not impact the reproducibility of the bug helps everyone who wants to work on that bug report.

=== How to use attached sample documents for multiple Bug Reports ===
If an appropriate document to reproduce the problem or to show the problem (screenshot) already does exist in Bugzilla, please [https://wiki.documentfoundation.org/QA/Bugzilla/FAQ#How_to_use_attached_sample_documents_for_multiple_Bug_Reports cite the document instead of attaching it again]. That saves time, because other users, who might know the existing attachment, do not need to check whether the new attachment contains new information (and only looks similar) or simply is a clone.

== Bug Summary ==
Be as concise as possible in the bug Summary. The more specific a bug summary is the more useful it is for others such as when you report a new bug you will notice that bugzilla tries to find similar bugs that might be of interest. So instead of having a summary "Bug my cousin noticed in Writer!" please be more specific and write e.g. "Writer prints green text underlines as blue on a Windows GDI printer".

=== Meaning of bracketed branch names in the summary ===
Development often happens in [https://en.wikipedia.org/wiki/Branching_%28revision_control%29 code branches]. Development branches are usually very interesting because they contain important new features or major cleanups. But that code is often not yet ready for general consumptions and needs to be extensively tested before it can be integrated. When such branches are tested the bugs founds are not of interest to general users but are very interesting for everyone working on that branch.

So it has become customary to add the bracketed branch name to the bug summary to make it clear that a problem only happens on a development branch. Such development branches are e.g. [sidebar], [ia2], [aw080], etc.

=== Meaning of bracketed pseudo key words in the summary ===
In order to make bug summaries as concise as possible experienced bug reporters used pseudo tags directly in the summary. They are often obsolete nowadays because some bugzilla fields are better suited for marking the kind of bug.

Examples for pseudo tags that were used are:
==== [Regression] ====
Deprecated tag for AOO regression issues. The "regression" keyword should be added to the '''Keywords''' field instead.
==== [RFE] ====
Request For Enhancement: deprecated, please set ''Issue Type'' selector to ENHANCEMENT.
==== [WW8] ====
Bug related to WW8 import filter (for Word.Document.8)

== Bug STATUS ==

=== CONFIRMED ===
==== Should I report new bugs with initial Status CONFIRMED? ====
The CONFIRMED status means that the bug report is clear enough and has sufficient details for another person to replicate the bug on another system.
So the answer is generally '''no'''! Even if you are pretty sure that you found a real bug and added lots of relevant information, generally following the [http://en.wikipedia.org/wiki/Two-man_rule#Other_uses Two Men Rule] results in better reports, what leads to faster bug fixing costing less developer resources. But of course, if you are an experienced bug tester (relevant contribution in more than 100 bugs or similar qualification), you might find good reasons to ignore the Two Men Rule and to select initial Status CONFIRMED

==== When should I change Status from UNCONFIRMED to CONFIRMED? ====
Please do not change to CONFIRMED only because you were able to reproduce reporter's observations. The right moment for CONFIRMED is when [http://www.openoffice.org/qa/issue_handling/basic_rules.html#complete all relevant information] has been gained.
# Report is a [[QA/HowToFileIssue#Principles|Good Bug Report]]
## Check for duplicates has been proceeded?
## Summary is clear and specific enough to distinguish the reported bug from other similar ones
## Sample Document available? Even if it seems to be simple for QA staff to create own sample documents, it saves a lot of time if a sample is attached. and Additionally the sample document can contribute additional relevant information (Localization, Language, Formatting caused by repoerter's very special ''New Document Templates'', ...
# Other selectors with correct contents?
## Relation to Operating System checked?
## Most early OO Version with what the bug has been observed selected (if possible, do your own tests with older versions)
## Appropriate Importance?
## Keywords appropriate?
# All or at least most relevant aspects of the bug are listed in the report

If these conditions are fulfilled you should select CONFIRMED. But of course, it's a matter of consideration, an important CRASH-Regression should be taken by developers as soon as possible, here it would be inappropriate to leave Status UNCONFIRMED because some minor questions are without answer.

== Mixed ==
=== From where can I download latest test versions? ===
You can test latest bug fixes with unstable test builds from [http://ci.apache.org/projects/openoffice/index.html here].

=== How To Crash AOO ===
For some investigations it is necessary to provoke a crash. You can find possibilities how to crash AOO with this [https://issues.apache.org/ooo/buglist.cgi?bug_status=CONFIRMED&bug_status=ACCEPTED&bug_status=REOPENED&f1=days_elapsed&list_id=79579&longdesc=crash&longdesc_type=allwordssubstr&o1=lessthan&query_format=advanced&resolution=---&short_desc=crash&short_desc_type=allwordssubstr&v1=100 Bugzilla query], what shows current crash-bugs.

=== What is the appropriate ''Version'' in Bugzilla Version selector? ===
The most early AOO or OOo version with what the problem has been observed. For ''Regression'' bugs ''Version'' information will help developers to find the code change what causes the problem.

In August 2013 the syntax for '''AOO''' versions in the selector has been changed, the ''AOO'' prefix has been dropped for most AOO versions. For historical reasons (?)[https://issues.apache.org/ooo/report.cgi?x_axis_field=product&y_axis_field=component&z_axis_field=&no_redirect=1&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_id=&bug_id_type=anyexact&votes=&votes_type=greaterthaneq&version=AOO340-dev&version=AOO400-dev&version=AOO410-dev&version=AOO+3.4.0&version=AOO+3.4.1&version=AOO+4.0&version=AOO+4.0.0&emailtype1=substring&email1=&emailtype2=substring&email2=&emailtype3=substring&email3=&chfieldvalue=&chfieldfrom=&chfieldto=Now&j_top=AND&f1=noop&o1=noop&v1=&format=table&action=wrap some Versions] with AOO prefix remained. If you work on such a bug report please always think about switching to a "modern" version.

=== How to connect a Bug report to a Tracking Bug ===
If you want to add a Bug report (like [https://issues.apache.org/ooo/show_bug.cgi?id=122762 Bug 122762]) to a TASK Tracking Bug (like [https://issues.apache.org/ooo/show_bug.cgi?id=122364 Tracking Bug 122364]), the best way is
# Add Bug number to ''Depends on'' field in TASK Tracking Bug
# [https://issues.apache.org/ooo/show_bug.cgi?id=122364#c3 Cite] complete Heading line of "Depends-On-Bug" in a ''Comment'' in the TASK Tracking Bug.
:: So all interested users listed in CC of TASK Tracking Bug will get a summary of the new bug with mail from bugzilla@apache.org and can see immediately what the reported problem is - no need for a detour to the tracking Bug (and several clicks).

=== How to attach screenshots with additional graphic contents ===
If you want to add some graphic contents to a screenshot to make it more comprehensible, you should copy the clipboard contents with the screenshot to a new DRAW document and add emphasis, text ideas, callouts, pointer arrows or whatever in the Draw document. If you save it with 'File -> Properties -> Security - open File Readonly' before aou attach it in the Bug, the document is protected against unintended edits, but can be edited if appropriate by other users.

=== What is the best file type for screenshots? ===
Graphic formats with lossless compression like "PNG" are much more suitable than JPG, because no compression artifacts compound recognition of details.

[[Category:Quality Assurance]]

BUGZILLA/FAQ

2013-11-07T09:14:01Z

Hdu: concise bug summary (checkpoint save)

This page lists several FAQ how to use the [https://issues.apache.org/ooo/ AOO-BUGZILLA]

== Attachments and Sample Documents ==

=== What are good Sample Documents? ===
Providing a sample document usually helps to reproduce a problem and to test the fix.
Sample documents should be minimal, e.g. if you notice a bug in the upper left corner on page 345 of a 1000 page document then it is advisable to check whether the bug can still be replicated if the other pages are removed. Removing as much content that does not impact the reproducibility of the bug helps everyone who wants to work on that bug report.

=== How to use attached sample documents for multiple Bug Reports ===
If an appropriate document to reproduce the problem or to show the problem (screenshot) already does exist in Bugzilla, please [https://wiki.documentfoundation.org/QA/Bugzilla/FAQ#How_to_use_attached_sample_documents_for_multiple_Bug_Reports cite the document instead of attaching it again]. That saves time, because other users, who might know the existing attachment, do not need to check whether the new attachment contains new information (and only looks similar) or simply is a clone.

== Bug Summary ==
Be as concise as possible in the bug Summary. The more specific a bug summary is the more useful it is for others such as when you report a new bug you will notice that bugzilla tries to find similar bugs that might be of interest. So instead of having a summary "Bug my cousin noticed in Writer!" please be more specific and write e.g. "Writer prints green text underlines as blue on a Windows GDI printer".

=== Meaning of pseudo key words ===
(often in brackets)

==== [sidebar] ====
Related to the new Sidebar feature in AOO 4

==== [cws dba24a] ====
??

==== [ia2] ====
The ''ia2'' AOO code branch is implementing an [http://en.wikipedia.org/wiki/IAccessible2 IAccessible2] native bridge of UNO Accessibility API (UAA) events for Windows, similar to the NX Accessibility and ATK/AT-SPI bridges in place for OSX and Linux. The native bridge replaces the Java JRE implemented Java Accessibility API that requires the Java Access Bridge to connect to UAA events.

==== [PyUNO] ====
??

==== [Presenter Screen] ====
??

==== [Memory Leak] ====
??

==== [Regression] ====
Deprecated tag for AOO performance issues, Key Word should be used.

==== [Automation] ====
??

==== [dba32a] ====
??

==== [postgre sdbc] ====
??

==== [RFE] ====
Request For Enhancement: deprecated, please use ''Issue Type'' selector.

==== [WW8] ====
Bug related to WW8 import filter (for Word.Document.8)

== Bug STATUS ==

=== CONFIRMED ===
==== Should I report new bugs with initial Status CONFIRMED? ====
The CONFIRMED status means that the bug report is clear enough and has sufficient details for another person to replicate the bug on another system.
So the answer is generally '''no'''! Even if you are pretty sure that you found a real bug and added lots of relevant information, generally following the [http://en.wikipedia.org/wiki/Two-man_rule#Other_uses Two Men Rule] results in better reports, what leads to faster bug fixing costing less developer resources. But of course, if you are an experienced bug tester (relevant contribution in more than 100 bugs or similar qualification), you might find good reasons to ignore the Two Men Rule and to select initial Status CONFIRMED

==== When should I change Status from UNCONFIRMED to CONFIRMED? ====
Please do not change to CONFIRMED only because you were able to reproduce reporter's observations. The right moment for CONFIRMED is when [http://www.openoffice.org/qa/issue_handling/basic_rules.html#complete all relevant information] has been gained.
# Report is a [[QA/HowToFileIssue#Principles|Good Bug Report]]
## Check for duplicates has been proceeded?
## Summary is clear and specific enough to distinguish the reported bug from other similar ones
## Sample Document available? Even if it seems to be simple for QA staff to create own sample documents, it saves a lot of time if a sample is attached. and Additionally the sample document can contribute additional relevant information (Localization, Language, Formatting caused by repoerter's very special ''New Document Templates'', ...
# Other selectors with correct contents?
## Relation to Operating System checked?
## Most early OO Version with what the bug has been observed selected (if possible, do your own tests with older versions)
## Appropriate Importance?
## Keywords appropriate?
# All or at least most relevant aspects of the bug are listed in the report

If these conditions are fulfilled you should select CONFIRMED. But of course, it's a matter of consideration, an important CRASH-Regression should be taken by developers as soon as possible, here it would be inappropriate to leave Status UNCONFIRMED because some minor questions are without answer.

== Mixed ==
=== From where can I download latest test versions? ===
You can test latest bug fixes with unstable test builds from [http://ci.apache.org/projects/openoffice/index.html here].

=== How To Crash AOO ===
For some investigations it is necessary to provoke a crash. You can find possibilities how to crash AOO with this [https://issues.apache.org/ooo/buglist.cgi?bug_status=CONFIRMED&bug_status=ACCEPTED&bug_status=REOPENED&f1=days_elapsed&list_id=79579&longdesc=crash&longdesc_type=allwordssubstr&o1=lessthan&query_format=advanced&resolution=---&short_desc=crash&short_desc_type=allwordssubstr&v1=100 Bugzilla query], what shows current crash-bugs.

=== What is the appropriate ''Version'' in Bugzilla Version selector? ===
The most early AOO or OOo version with what the problem has been observed. For ''Regression'' bugs ''Version'' information will help developers to find the code change what causes the problem.

In August 2013 the syntax for '''AOO''' versions in the selector has been changed, the ''AOO'' prefix has been dropped for most AOO versions. For historical reasons (?)[https://issues.apache.org/ooo/report.cgi?x_axis_field=product&y_axis_field=component&z_axis_field=&no_redirect=1&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_id=&bug_id_type=anyexact&votes=&votes_type=greaterthaneq&version=AOO340-dev&version=AOO400-dev&version=AOO410-dev&version=AOO+3.4.0&version=AOO+3.4.1&version=AOO+4.0&version=AOO+4.0.0&emailtype1=substring&email1=&emailtype2=substring&email2=&emailtype3=substring&email3=&chfieldvalue=&chfieldfrom=&chfieldto=Now&j_top=AND&f1=noop&o1=noop&v1=&format=table&action=wrap some Versions] with AOO prefix remained. If you work on such a bug report please always think about switching to a "modern" version.

=== How to connect a Bug report to a Tracking Bug ===
If you want to add a Bug report (like [https://issues.apache.org/ooo/show_bug.cgi?id=122762 Bug 122762]) to a TASK Tracking Bug (like [https://issues.apache.org/ooo/show_bug.cgi?id=122364 Tracking Bug 122364]), the best way is
# Add Bug number to ''Depends on'' field in TASK Tracking Bug
# [https://issues.apache.org/ooo/show_bug.cgi?id=122364#c3 Cite] complete Heading line of "Depends-On-Bug" in a ''Comment'' in the TASK Tracking Bug.
:: So all interested users listed in CC of TASK Tracking Bug will get a summary of the new bug with mail from bugzilla@apache.org and can see immediately what the reported problem is - no need for a detour to the tracking Bug (and several clicks).

=== How to attach screenshots with additional graphic contents ===
If you want to add some graphic contents to a screenshot to make it more comprehensible, you should copy the clipboard contents with the screenshot to a new DRAW document and add emphasis, text ideas, callouts, pointer arrows or whatever in the Draw document. If you save it with 'File -> Properties -> Security - open File Readonly' before aou attach it in the Bug, the document is protected against unintended edits, but can be edited if appropriate by other users.

=== What is the best file type for screenshots? ===
Graphic formats with lossless compression like "PNG" are much more suitable than JPG, because no compression artifacts compound recognition of details.

[[Category:Quality Assurance]]

BUGZILLA/FAQ

2013-11-07T09:03:34Z

Hdu: added "good sample docs" subsection

This page lists several FAQ how to use the [https://issues.apache.org/ooo/ AOO-BUGZILLA]

== Attachments and Sample Documents ==

=== What are good Sample Documents? ===
Providing a sample document usually helps to reproduce a problem and to test the fix.
Sample documents should be minimal, e.g. if you notice a bug in the upper left corner on page 345 of a 1000 page document then it is advisable to check whether the bug can still be replicated if the other pages are removed. Removing as much content that does not impact the reproducibility of the bug helps everyone who wants to work on that bug report.

=== How to use attached sample documents for multiple Bug Reports ===
If an appropriate document to reproduce the problem or to show the problem (screenshot) already does exist in Bugzilla, please [https://wiki.documentfoundation.org/QA/Bugzilla/FAQ#How_to_use_attached_sample_documents_for_multiple_Bug_Reports cite the document instead of attaching it again]. That saves time, because other users, who might know the existing attachment, do not need to check whether the new attachment contains new information (and only looks similar) or simply is a clone.

== Bug Summary ==

=== Meaning of pseudo key words ===
(often in brackets)

==== [sidebar] ====
Related to the new Sidebar feature in AOO 4

==== [cws dba24a] ====
??

==== [ia2] ====
The ''ia2'' AOO code branch is implementing an [http://en.wikipedia.org/wiki/IAccessible2 IAccessible2] native bridge of UNO Accessibility API (UAA) events for Windows, similar to the NX Accessibility and ATK/AT-SPI bridges in place for OSX and Linux. The native bridge replaces the Java JRE implemented Java Accessibility API that requires the Java Access Bridge to connect to UAA events.

==== [PyUNO] ====
??

==== [Presenter Screen] ====
??

==== [Memory Leak] ====
??

==== [Regression] ====
Deprecated tag for AOO performance issues, Key Word should be used.

==== [Automation] ====
??

==== [dba32a] ====
??

==== [postgre sdbc] ====
??

==== [RFE] ====
Request For Enhancement: deprecated, please use ''Issue Type'' selector.

==== [WW8] ====
Bug related to WW8 import filter (for Word.Document.8)

== Bug STATUS ==

=== CONFIRMED ===
==== Should I report new bugs with initial Status CONFIRMED? ====
The CONFIRMED status means that the bug report is clear enough and has sufficient details for another person to replicate the bug on another system.
So the answer is generally '''no'''! Even if you are pretty sure that you found a real bug and added lots of relevant information, generally following the [http://en.wikipedia.org/wiki/Two-man_rule#Other_uses Two Men Rule] results in better reports, what leads to faster bug fixing costing less developer resources. But of course, if you are an experienced bug tester (relevant contribution in more than 100 bugs or similar qualification), you might find good reasons to ignore the Two Men Rule and to select initial Status CONFIRMED

==== When should I change Status from UNCONFIRMED to CONFIRMED? ====
Please do not change to CONFIRMED only because you were able to reproduce reporter's observations. The right moment for CONFIRMED is when [http://www.openoffice.org/qa/issue_handling/basic_rules.html#complete all relevant information] has been gained.
# Report is a [[QA/HowToFileIssue#Principles|Good Bug Report]]
## Check for duplicates has been proceeded?
## Summary is clear and specific enough to distinguish the reported bug from other similar ones
## Sample Document available? Even if it seems to be simple for QA staff to create own sample documents, it saves a lot of time if a sample is attached. and Additionally the sample document can contribute additional relevant information (Localization, Language, Formatting caused by repoerter's very special ''New Document Templates'', ...
# Other selectors with correct contents?
## Relation to Operating System checked?
## Most early OO Version with what the bug has been observed selected (if possible, do your own tests with older versions)
## Appropriate Importance?
## Keywords appropriate?
# All or at least most relevant aspects of the bug are listed in the report

If these conditions are fulfilled you should select CONFIRMED. But of course, it's a matter of consideration, an important CRASH-Regression should be taken by developers as soon as possible, here it would be inappropriate to leave Status UNCONFIRMED because some minor questions are without answer.

== Mixed ==
=== From where can I download latest test versions? ===
You can test latest bug fixes with unstable test builds from [http://ci.apache.org/projects/openoffice/index.html here].

=== How To Crash AOO ===
For some investigations it is necessary to provoke a crash. You can find possibilities how to crash AOO with this [https://issues.apache.org/ooo/buglist.cgi?bug_status=CONFIRMED&bug_status=ACCEPTED&bug_status=REOPENED&f1=days_elapsed&list_id=79579&longdesc=crash&longdesc_type=allwordssubstr&o1=lessthan&query_format=advanced&resolution=---&short_desc=crash&short_desc_type=allwordssubstr&v1=100 Bugzilla query], what shows current crash-bugs.

=== What is the appropriate ''Version'' in Bugzilla Version selector? ===
The most early AOO or OOo version with what the problem has been observed. For ''Regression'' bugs ''Version'' information will help developers to find the code change what causes the problem.

In August 2013 the syntax for '''AOO''' versions in the selector has been changed, the ''AOO'' prefix has been dropped for most AOO versions. For historical reasons (?)[https://issues.apache.org/ooo/report.cgi?x_axis_field=product&y_axis_field=component&z_axis_field=&no_redirect=1&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_id=&bug_id_type=anyexact&votes=&votes_type=greaterthaneq&version=AOO340-dev&version=AOO400-dev&version=AOO410-dev&version=AOO+3.4.0&version=AOO+3.4.1&version=AOO+4.0&version=AOO+4.0.0&emailtype1=substring&email1=&emailtype2=substring&email2=&emailtype3=substring&email3=&chfieldvalue=&chfieldfrom=&chfieldto=Now&j_top=AND&f1=noop&o1=noop&v1=&format=table&action=wrap some Versions] with AOO prefix remained. If you work on such a bug report please always think about switching to a "modern" version.

=== How to connect a Bug report to a Tracking Bug ===
If you want to add a Bug report (like [https://issues.apache.org/ooo/show_bug.cgi?id=122762 Bug 122762]) to a TASK Tracking Bug (like [https://issues.apache.org/ooo/show_bug.cgi?id=122364 Tracking Bug 122364]), the best way is
# Add Bug number to ''Depends on'' field in TASK Tracking Bug
# [https://issues.apache.org/ooo/show_bug.cgi?id=122364#c3 Cite] complete Heading line of "Depends-On-Bug" in a ''Comment'' in the TASK Tracking Bug.
:: So all interested users listed in CC of TASK Tracking Bug will get a summary of the new bug with mail from bugzilla@apache.org and can see immediately what the reported problem is - no need for a detour to the tracking Bug (and several clicks).

=== How to attach screenshots with additional graphic contents ===
If you want to add some graphic contents to a screenshot to make it more comprehensible, you should copy the clipboard contents with the screenshot to a new DRAW document and add emphasis, text ideas, callouts, pointer arrows or whatever in the Draw document. If you save it with 'File -> Properties -> Security - open File Readonly' before aou attach it in the Bug, the document is protected against unintended edits, but can be edited if appropriate by other users.

=== What is the best file type for screenshots? ===
Graphic formats with lossless compression like "PNG" are much more suitable than JPG, because no compression artifacts compound recognition of details.

[[Category:Quality Assurance]]

BUGZILLA/FAQ

2013-11-07T08:48:57Z

Hdu: added info about CONFIRMED status (checkpoint save)

This page lists several FAQ how to use the [https://issues.apache.org/ooo/ AOO-BUGZILLA]

== Attachments and Sample Documents ==

=== How to use attached sample documents for multiple Bug Reports ===
If an appropriate document to reproduce the problem or to show the problem (screenshot) already does exist in Bugzilla, please [https://wiki.documentfoundation.org/QA/Bugzilla/FAQ#How_to_use_attached_sample_documents_for_multiple_Bug_Reports cite the document instead of attaching it again]. That saves time, because other users, who might know the existing attachment, do not need to check whether the new attachment contains new information (and only looks similar) or simply is a clone.

== Bug Summary ==

=== Meaning of pseudo key words ===
(often in brackets)

==== [sidebar] ====
Related to the new Sidebar feature in AOO 4

==== [cws dba24a] ====
??

==== [ia2] ====
The ''ia2'' AOO code branch is implementing an [http://en.wikipedia.org/wiki/IAccessible2 IAccessible2] native bridge of UNO Accessibility API (UAA) events for Windows, similar to the NX Accessibility and ATK/AT-SPI bridges in place for OSX and Linux. The native bridge replaces the Java JRE implemented Java Accessibility API that requires the Java Access Bridge to connect to UAA events.

==== [PyUNO] ====
??

==== [Presenter Screen] ====
??

==== [Memory Leak] ====
??

==== [Regression] ====
Deprecated tag for AOO performance issues, Key Word should be used.

==== [Automation] ====
??

==== [dba32a] ====
??

==== [postgre sdbc] ====
??

==== [RFE] ====
Request For Enhancement: deprecated, please use ''Issue Type'' selector.

==== [WW8] ====
Bug related to WW8 import filter (for Word.Document.8)

== Bug STATUS ==

=== CONFIRMED ===
==== Should I report new bugs with initial Status CONFIRMED? ====
The CONFIRMED status means that the bug report is clear enough and has sufficient details for another person to replicate the bug on another system.
So the answer is generally '''no'''! Even if you are pretty sure that you found a real bug and added lots of relevant information, generally following the [http://en.wikipedia.org/wiki/Two-man_rule#Other_uses Two Men Rule] results in better reports, what leads to faster bug fixing costing less developer resources. But of course, if you are an experienced bug tester (relevant contribution in more than 100 bugs or similar qualification), you might find good reasons to ignore the Two Men Rule and to select initial Status CONFIRMED

==== When should I change Status from UNCONFIRMED to CONFIRMED? ====
Please do not change to CONFIRMED only because you were able to reproduce reporter's observations. The right moment for CONFIRMED is when [http://www.openoffice.org/qa/issue_handling/basic_rules.html#complete all relevant information] has been gained.
# Report is a [[QA/HowToFileIssue#Principles|Good Bug Report]]
## Check for duplicates has been proceeded?
## Summary is clear and specific enough to distinguish the reported bug from other similar ones
## Sample Document available? Even if it seems to be simple for QA staff to create own sample documents, it saves a lot of time if a sample is attached. and Additionally the sample document can contribute additional relevant information (Localization, Language, Formatting caused by repoerter's very special ''New Document Templates'', ...
# Other selectors with correct contents?
## Relation to Operating System checked?
## Most early OO Version with what the bug has been observed selected (if possible, do your own tests with older versions)
## Appropriate Importance?
## Keywords appropriate?
# All or at least most relevant aspects of the bug are listed in the report

If these conditions are fulfilled you should select CONFIRMED. But of course, it's a matter of consideration, an important CRASH-Regression should be taken by developers as soon as possible, here it would be inappropriate to leave Status UNCONFIRMED because some minor questions are without answer.

== Mixed ==
=== From where can I download latest test versions? ===
You can test latest bug fixes with unstable test builds from [http://ci.apache.org/projects/openoffice/index.html here].

=== How To Crash AOO ===
For some investigations it is necessary to provoke a crash. You can find possibilities how to crash AOO with this [https://issues.apache.org/ooo/buglist.cgi?bug_status=CONFIRMED&bug_status=ACCEPTED&bug_status=REOPENED&f1=days_elapsed&list_id=79579&longdesc=crash&longdesc_type=allwordssubstr&o1=lessthan&query_format=advanced&resolution=---&short_desc=crash&short_desc_type=allwordssubstr&v1=100 Bugzilla query], what shows current crash-bugs.

=== What is the appropriate ''Version'' in Bugzilla Version selector? ===
The most early AOO or OOo version with what the problem has been observed. For ''Regression'' bugs ''Version'' information will help developers to find the code change what causes the problem.

In August 2013 the syntax for '''AOO''' versions in the selector has been changed, the ''AOO'' prefix has been dropped for most AOO versions. For historical reasons (?)[https://issues.apache.org/ooo/report.cgi?x_axis_field=product&y_axis_field=component&z_axis_field=&no_redirect=1&query_format=report-table&short_desc_type=allwordssubstr&short_desc=&longdesc_type=allwordssubstr&longdesc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&keywords_type=allwords&keywords=&bug_id=&bug_id_type=anyexact&votes=&votes_type=greaterthaneq&version=AOO340-dev&version=AOO400-dev&version=AOO410-dev&version=AOO+3.4.0&version=AOO+3.4.1&version=AOO+4.0&version=AOO+4.0.0&emailtype1=substring&email1=&emailtype2=substring&email2=&emailtype3=substring&email3=&chfieldvalue=&chfieldfrom=&chfieldto=Now&j_top=AND&f1=noop&o1=noop&v1=&format=table&action=wrap some Versions] with AOO prefix remained. If you work on such a bug report please always think about switching to a "modern" version.

=== How to connect a Bug report to a Tracking Bug ===
If you want to add a Bug report (like [https://issues.apache.org/ooo/show_bug.cgi?id=122762 Bug 122762]) to a TASK Tracking Bug (like [https://issues.apache.org/ooo/show_bug.cgi?id=122364 Tracking Bug 122364]), the best way is
# Add Bug number to ''Depends on'' field in TASK Tracking Bug
# [https://issues.apache.org/ooo/show_bug.cgi?id=122364#c3 Cite] complete Heading line of "Depends-On-Bug" in a ''Comment'' in the TASK Tracking Bug.
:: So all interested users listed in CC of TASK Tracking Bug will get a summary of the new bug with mail from bugzilla@apache.org and can see immediately what the reported problem is - no need for a detour to the tracking Bug (and several clicks).

=== How to attach screenshots with additional graphic contents ===
If you want to add some graphic contents to a screenshot to make it more comprehensible, you should copy the clipboard contents with the screenshot to a new DRAW document and add emphasis, text ideas, callouts, pointer arrows or whatever in the Draw document. If you save it with 'File -> Properties -> Security - open File Readonly' before aou attach it in the Bug, the document is protected against unintended edits, but can be edited if appropriate by other users.

=== What is the best file type for screenshots? ===
Graphic formats with lossless compression like "PNG" are much more suitable than JPG, because no compression artifacts compound recognition of details.

[[Category:Quality Assurance]]

Uno/FAQ

2013-10-08T13:23:04Z

Hdu: fixed minor typo

[[Uno/FAQ zh|中]]

Frequently Asked Questions about Uno, UDK, URE etc. Based on questions and answers posted to the dev@udk.openoffice.org mailing list. Any comments or questions will also be answered there.

==General==
===Hey, the OpenOffice.org component technology is great. How do I contribute?===
Great, you're always welcome. To find some ideas on where to help please browse the [[Uno/To-Dos|open task list]]. If you've got any questions about any of these tasks don't hesitate to ask them. Please post them to the [http://udk.openoffice.org/servlets/SummarizeList?listName=dev dev@udk.openoffice.org] mailing list.

===Does UNO depend on OpenOffice.org?===
In the near future, there will be an Office Development Kit available for download beside the openoffice.org-setup-set. This development kit contains all files (include-files, libraries, tools, etc.) that are necessary to build components. The development kit will also contain samples. These samples are built with makefiles, that only require gnumake (not the whole openoffice.org build environment). These makefiles can be used as a template to integrate the build of your UNO-components into your build environment.

===Is UNO analogous to MS COM?===
Yes, UNO can be seen as an component model completely independent from the office itself. It is in direct competition to COM. You can find a feature list [http://udk.openoffice.org/common/man/uno.html here].

===What is the ODK?===
The Office Development Kit (ODK) extends the UDK with additional documentation, API's (more IDL's), and examples. The UDK is a subset of the ODK. If you want to extend the OpenOffice.org, or write solutions with OpenOffice.org, then the ODK fits your needs. The UDK is a stand alone object model, that can be used without OpenOffice.org. The UDK will be the main target of integration discussions with Gnome and XPCOM, for achieving the long term goal of having only one Open Source Object Model. In the future, it should be possible to write components which depend on the ODK and components which are independent from OpenOffice.org.

The Office Development Kit enables software engineers to develop components for OpenOffice.org without the need of the bulky OpenOffice.org build environment. Thus, the ODK includes the binaries of the base libraries (+ im
port libraries), C++ header files, all idl-files, .jar files, and development tools (code generators, tools to register components, etc.) The ODK, additionally, includes some source examples and makefiles, that only require gnumake and a C++-compiler, you can take the makefiles, as an example, to integrate them into your build environment. The development kit will be provided in the future alongside every OpenOffice.org build and will be available as an separate [http://download.openoffice.org/index.html#sdk download].

===Why didn't you use Java or CORBA as middleware?===
We wanted a middleware which can be used for components with a fine granularity, at least, in-process. If you use different UNO components in the same language than there is no overhead (e.g., in C++ a call is only a virtual method call). Unfortunately, CORBA has no in-process specification of interfaces and structures. The only way to communicate is through the IIOP protocol. The overhead is too high for in-process communication. We wanted to be programming language independent: let UNO be a mediator between different languages like Java, C++, C and other languages, this isn't the goal of CORBA. Another goal of UNO is to be the mediator between different object models like COM/DCOM, CORBA, Java, and XPCOM which does not appear to be a goal of other object models.

===What are the differences between UNO and CORBA?===
UNO does not generate stub code. We did this in the former UNO2 implementation. One problem was, that the generated stub code was quite a heavy load (about 12 MB at former times, even though the API had less types as compared to now!). With UNO3 (the current version), we decided to generically call implementations, without having generated stub code, just by providing bridging code that knows the specific compiler that compiled the implementation. The only thing that is generated for C++, besides the pure virtual classes, are the getCppuType() functions to reflect types. The full type description is read at runtime from a binary storage. This approach has the advantage that on increasing numbers of types, less space is used. To see more the differences between UNO and CORBA, please have a look on the following [http://udk.openoffice.org/common/man/comparison_uno_corba.html comparison].

===What are the differences between UNO IDL and CORBA IDL?===
UNO IDL has:
* inheritance of structures and exceptions
* a stereotype "service" (an abstract class which combines interfaces and properties)
* can assign specific values to enumeration values
* no stereotype array (but ad-hoc sequences)
* no union stereotype

===Can I use OpenOffice.org components as JavaBeans?===
Yes, the OpenOffice.org bean (OOBean) project enables the use of OpenOffice.org components in Java applications. Please visit [[OOoBean]] for information, source code, and binary downloads.

The OOo Bean features
* Embedding OpenOffice.org components into Java application or applets.
* Accessing the whole StarOffice API from Java, to implement your own applications.
The project is just starting, so please be aware there may be bugs, incomplete documentation, install problems, etc. We would like everyone with interest in OpenOffice.org and Java to contribute to this project, or just use the bean in their Java application.

==Development==
===Can you give me some example code?===
====C++ Examples====
{|border="1" cellspacing="0" class="wikitable"
|- style="background:#efefef;"
| Where || What
|-
| [http://www.openoffice.org/source/browse/udk/remotebridges/examples/officeclient.cxx udk/remotebridges/examples/officeclient.cxx] || The example shows how to build up an interprocess bridge to an OpenOffice.org document. There are no differences if you write a component for Windows or Linux.
|-
| [http://www.openoffice.org/source/browse/udk/product/examples/ udk/product/examples/] || More examples.
|}

====HTML Documentation====
{|border="1" cellspacing="0" class="wikitable"
|- style="background:#efefef;"
| Where || What
|-
| http://udk.openoffice.org/cpp/man/tutorial/remotedemo.html || Remote demo tutorial
|-
| http://udk.openoffice.org/cpp/man/component_tutorial.html || Component writing in UNO space
|-
| http://udk.openoffice.org/cpp/man/tutorial/unointro.html || C++ specific guide to UNO
|-
| http://udk.openoffice.org/common/man/concept/unointro.html || Language independent guide to UNO
|}

====Java Examples====
We lack a good document on how to start developing using Java. You have a look at the source directly. There are also some examples in the jurt project, which you can check out using

$ cvs -d :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs co udk/jurt

You'll find some examples in the source code demo-tree:
{|border="1" cellspacing="0" class="wikitable"
|- style="background:#efefef;"
| Where || What
|-
| [http://www.openoffice.org/source/browse/udk/jurt/demo/com/sun/star/demo/TestOffice.java jurt/demo/com/sun/star/demo/TestOffice.java] || Starts up an interprocess bridge and creates several documents in the office.
|-
| [http://www.openoffice.org/source/browse/udk/jurt/demo/com/sun/star/comp/demo/ jurt/demo/com/sun/star/comp/demo/] || Here some sample code can be found on how to setup a JavaComponent. The sample can be registered with an office and thus runs within the same process as the office.
|}

We also suggest having a look at the sun-developer-connection (http://developers.sun.com/), when you click on Download SDK, you can download the StarOffice Programmers Tutorial. It contains some examples on certain API-topics. Please use the [http://api.openoffice.org/servlets/ProjectMailingListList dev@api.openoffice.org] mailing list for asking high level office API questions.

===How do I generate C++ type definitions?===
#. create .idl files describing the interface
#. generate .urd file using unoidl
#. merge the new type(s) into the system registry with regmerge
#. create the C++ types using cppumaker (for Java: use javamaker)
#. for Java: compile the generated interfaces and add them to your CLASSPATH

===What's the purpose of regcomp?===
The unoidl converts the IDL description into a binary type library format; this type information is needed for every IDL type at runtime. The generated output file of unoidl contains only the type information of the specified IDL file. It does not contain the complete type descriptions of all types. So, it is necessary to install the new types in the type library applicat.rdb using regmerge. If somebody has developed a UNO component, he must support/export some administration functions (e.g., component_writeInfo). In the component_writeInfo function the developer gives some information about the supported services and the implementation name. This information is later used by the service manager to instantiate the component. So, if you developed your own component, you must install your component to the runtime. This could be done with regcomp. regcomp reads the component_writeInfo function and does some administration work with that information. For example, all supported services of the component are inserted in a global SERVICES section, which is used by the service manager. In this section a relation between the service name and the implementation name is established. Under the reserved area IMPLEMENTATIONS you'll find the appropriate section for your own component, which is equal to the key defined in the component_writeInfo function. Please have a look at the installed applicat.rdb in your office directory:

<pre>
$ regview applicat.rdb /SERVICES
$ regview applicat.rdb /SERVICES/<service_name>
$ regview applicat.rdb /IMPLEMENTATIONS
$ regview applicat.rdb /IMPLEMENTATIONS/<implementation_name>
</pre>
So regcomp is always needed if you want to install a new component. regmerge is needed to install new types in the type library.

Where is the OpenOffice.org API?

Please visit the http://api.openoffice.org project site.

===How do I test my components?===
If you develop a new component it'll end up in a shared library or dynamic link library (DLL). The DLL will be loaded on demand if the implemented service is requested. To make the component visible and usable in the OpenOffice.org, you'll have to register your service as a external component. To achieve this you'll need to follow these steps:

#. copy your DLL into the .../program directory
#. copy the tool regcomp into the .../program directory. You will find this tool in the UDK module cpputools
#. use the regcomp tool <pre>$ regcomp -register -r applicat.rdb -c foo.dll</pre>
#. If you develop your own interfaces or new types, then you have to register these new types in the UNO type library. For doing that you need the tool regmerge which you find in the UDK module registry. The unoidl tool generated a foo.urd file which contains the new types. You'll find this file in the output directory of your component.
#. use the regmerge tool <pre>$ regmerge applicat.rdb /UCR foo.urd</pre> All type descriptions of IDL types are stored in the registry under the reserved key UCR (UNO core reflection)
#. After registration of the component and the new types you are able to instantiate your service via the service manager.

A very easy and fast way to instantiate a new service is by using basic. Start a new basic script and type in the following code:
<pre>
Sub Main
s = createUnoService("YourServiceName")
msgbox(s.dbg_supportedinterfaces)
End Sub
</pre>
If the instantiation is successful, the message box will show all supported interfaces of the object.

More information can be found in the README files in the directory http://www.openoffice.org/source/browse/udk/product/examples/.

===How many bridges exist?===
Currently there exist 4 bridges: the C++ bridge, the Java bridge, the [http://udk.openoffice.org/common/man/spec/urp.html UNO Remote Protocol (URP) bridge], and the [http://api.openoffice.org/ IIOP bridge].

===When is a bridge involved?===
If you develop your components in C++, remember that for in process calling of components compiled by the same compiler, there is no need to bridge any interface. The component loader recognizes this fact and uses the implemented C++ interface directly. But if you use scripting (e.g., basic) to call a Java component or to do remote UNO to some other process, bridging is indeed involved.

===How do I specify default values for structs?===
It is not possible to specify default values for structs because these defaults cannot be used in other object models (e.g., CORBA). It is also impossible to emulate default values for member variables by modifying the unoidl-generated default constructors for structs. The default constructors set enums to the first enum value, numbers to 0, and the other types use their default constructors. The generated inline default constructor can be found in the .hpp file. The constructor sets the members to known initial values only.

===Hey, my component just dumps core. What's going wrong?===
Since it's hard to tell from a stack trace only, what is going wrong, please send as much information as possible. If you're lucky, you're the writer of the service and you can send the component implementation code and the code which instantiates the object as well. If you are not the component developer then you're forced to contact the component developer.

===Why is it so annoying to write a compiler version dependent C++ bridge?===
The goal behind UNO is to provide the simplest language binding for the UNO component writer and user, the least amount of generated code, and a maximum of execution speed. With the current technique, the goals are reached. For example, in C++ there is no call overhead, because a C++ to C++ call is only a virtual method call. There is no compile time code generation, it is done by the bridge on the fly. The UNO C++ language binding is smarter than all other (CORBA, COM) bindings. On the other hand, writing a C++ bridge is a hard thing to do, but this has to be done only once for each compiler, operating system, and processor. There are simpler ways to achieve language bindings, but they aren't better ways. A bridge from cpp to uno is very compiler and abi dependent, and at first glance, it seems that it isn't portable at all. But it must be noted that the bridge code is pretty similar for most compilers. The main differences are the generated vtables, performing C++ virtual calls, and handling exceptions.

===How do I implement a C++ bridge for a RISC CPU?===
On RISC machines parameters to functions are passed in registers, whereas, the C++ bridge code manipulates a stack between the C++ layout and the required uno layout. For an example of how this is solved, please see the sunpro5 solaris sparc bridge. Registers are pushed right to stack (extending non-register parameters on the stack [if more than 6]).

===Which PropertyValue should I use when loading an existing document?===
A document is always opened through a loader with an empty property argument
<source lang="oobas">
PropertyValue [] szEmptyArgs = new PropertyValue [0];
String doc = "private:factory/swriter";
aDoc = oCLoader.loadComponentFromURL(doc, "_blank", 0, szEmptyArgs );
</source>
Using these arguments, you can force OpenOffice.org to use a certain filter, open the document read-only, and set a password for password protected documents. The csv-filter for spreadsheet documents has some additional options which are the same as the pick list from the UI,the options are stored in the soffice.ini/sofficerc.

===How do I open an existing document and then save it into HTML format?===
Here's some sample code for that:
<source lang="oobas">
PropertyValue [] mypv = new PropertyValue[1];
mypv[0] = new PropertyValue();
mypv[0].Name = new String("FilterName");
mypv[0].Value = new String("scalc: Text - txt");
mypv[0].Handle = -1;
mypv[0].State = PropertyState.DEFAULT_VALUE;
aStore.storeAsURL(doc, mypv); //aStore is a XStorable object, and doc is url string
</source>

===How do I save a OpenOffice.org document as XML?===
Here's some sample code for that:
<source lang="oobas">
sub SaveXML
dim mProps(0) as new com.sun.star.beans.PropertyValue
mProps(0).Name = "FilterName"
'This works with 614
mProps(0).Value = "swriter: StarOffice XML (Writer)"
oDesk = createUNOService("com.sun.star.frame.Desktop")
'For some reason, ActiveComponent no longer works:
oComponent = oDesk.CurrentComponent()
oComponent.storeAsUrl("file:///C|/Tmp/startemp.xml",_
mProps())
end sub
</source>

===Should I always use queryInterface?===
You don't need to call queryInterface directly. A more comfortable way is to use a special reference constructor for this. Instead of
<source lang="cpp">
::com::sun::star::uno::Any x = xI->queryInterface(
::getCppuType((const ::com::sun::star::uno::Reference<
::com::sun::star::i18n::XTransliteration>*)0));
x >>= transRef;
</source>

you should use:
<pre>
transRef = Reference< XTransliteration >( xI, UNO_QUERY );
</pre>

===What does cannot dump type 'com/star/uno/RuntimeException' mean?===
First, make sure that you followed the FAQ entry [[Uno/FAQ#How_do_I_generate_C.2B.2B_type_definitions.3F|'How do I generate C++ type definitions?']]. That means: you created a .idl file that "describes" or "defines" the component. You use the unoidl tool to compile the idl file. Run the cppumaker on the resulting .urd file. The cppumaker generates a C++ representation for idl types and it works on a type library which is generated by the unoidl. If you followed these steps and get the error: cppumaker ERROR: cannot dump type 'com/star/uno/RuntimeException', you must integrate your new type into the system type library because the type information is needed at runtime and also for generating the C++ code. For doing that, the easiest way is to merge your 'XXX.urd' files into the system type library. The system type library is called applicat.rdb and can be found in the program directory. To merge the type library, you must use the tool regmerge which you should find in the build environment. All type information in the applicat.rdb are saved under a reserved area 'UCR'. You must merge your own types also in this reserved area. Using regmerge:
$ regmerge applicat.rdb /UCR yourtypes.urd
There exists another nice tool to view the contents of a registry file (= type library):
$ regview applicat.rdb /UCR/com/sun/star/uno
This shows all types of the module com.sun.star.uno or
$ regview applicat.rdb /UCR/com/sun/star/uno/XInterface
shows the type information of com.sun.star.uno.XInterface

Additional info about generating code: The cppumaker needs all type information because the cppumaker generates the specified type and all the dependencies. The depent types will be generated recursively, so that you get all the necessary C++ type declarations you need to build your component.

After the regmerge the applicat.rdb contains all types, the ones that comes with Openoffice.org and your new one. Note the regmerge command only modifies the first file, the others are opened read only.

You should now check with regview, that the regmerge really worked and that it now contains your new type. For example:
$ regview applicat.rdb /UCR/com/sun/star/uno/RuntimeException
should give output about the normal RuntimeException.
$ regview applicat.rdb /UCR/your/new/types
should give output about your new type (of course replace your/new/types with the module and typename of the new type in idl).

Then the following command should generate C++ headers below your current working directory:
$ cppumaker -O. -Tyour/new/types -BUCR applicat.rdb
If this doesn't work, at least the following command should work:
$ cppumaker -O. -Tcom/sun/star/uno/RuntimeException -BUCR applicat.rdb

===What does symbol "component_getImplementationEnvironment" could not be found mean?===
If you try to register your DLL with regcomp like this:
$ regcomp -register -r applicat.rdb -c foo.dll
and get the following error:
register component "foo.dll" in registry "applicat.rdb" failed!
ERROR: component could not be registered: symbol "component_getImplementationEnvironment"
could not be found in "foo.dll"
Make sure that you defined the function outside any classes in a .cxx file like this:
<pre>
extern "C"
void SAL_CALL component_getImplementationEnvironment(
const sal_Char ** ppEnvTypeName,
uno_Environment ** ppEnv )
{
*ppEnvTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME;
}
</pre>
If you are not using a module definition file (DEF file), then you can use a SAL_DLLEXPORT macro in front of your function definition, which expands to __declspec(dllexport). On Win32 platforms check your exports using
$ dumpbin /EXPORTS foo.dll
If this still doesn't work while registering your DLL, make sure that your path is correct and that all libraries foo.dll is linked against are accessible via your path. On Win32 platforms you can use a tool which is delivered with Developer Studio 6. It's called depend and shows library imports and missing libraries (marked red). If this still doesn't help you should debug the function writeRegistryInfo() of the shared library component loader. The loader is located in the CVS module stoc which checks out the directory oo/udk/stoc. Inside the stoc directory the loader is built in the directory source/loader. The built library is called cpld.dll.

===What if regcomp does not find your C++ service===
If you are testing C++ library registration of your Calc.XlsxExport
service with regcomp like this:
<source lang=cpp>
SAL_DLLPUBLIC_EXPORT sal_Bool SAL_CALL component_writeInfo (void*, void* key)
{
OSL_TRACE ("%s: Xlsx HELLO", __PRETTY_FUNCTION__);
</source>
but
$ regcomp -register -r foo.rdb -c unxlngx6.pro/lib/libscfilt.so
register component 'unxlngx6.pro/lib/libscfiltlx.so' in registry 'foe.rdb' succesful!
fails to print HELLO and
$ regview foo.rdb | grep Xlsx
fails to print something like
/ com.sun.star.comp.Calc.XlsxExport
Data = 0 = "com.sun.star.comp.Calc.XlsxExport"
you can assume safely assume that component_writeInfo is not found.

Make sure to add these functions to the util/NAME.map file, eg
when adding the first UNO service to calc's scfilt library, do
<source lang=bash>
--- sc/util/scfilt.map
+++ sc/util/scfilt.map
@@ -1,6 +1,9 @@
SCFILT_1_0 {
global:
ScFilterCreate;
+ component_getImplementationEnvironment;
+ component_writeInfo;
+ component_getFactory;
local:
*;
};
</source>

and that you tell scp2 the library is a UNO library, in the case of scfilt, do
<source lang=bash>
--- scp2/source/calc/file_calc.scp
+++ scp2/source/calc/file_calc.scp
@@ -49,7 +49,7 @@ STD_UNO_LIB_FILE_PATCH( gid_File_Lib_Sc, sc)

STD_LIB_FILE_PATCH( gid_File_Lib_Scui, scui)

-STD_LIB_FILE( gid_File_Lib_Scfilt, scfilt)
+STD_UNO_LIB_FILE( gid_File_Lib_Scfilt, scfilt)

STD_UNO_LIB_FILE( gid_File_Lib_Scd, scd)
</source>

===How do I unmerge what I added to type library with regmerge?===
regmerge overwrites existing keys. However, a tool to delete existing keys would be nice to have, but there currently is none.

===Where do I find service descriptions in the type library?===
Service descriptions are not stored in the type library because reflective information about services aren't needed at runtime. A service description exists only for modeling purposes.

You can start the IDL compiler with a special option ( -C ) to generate a type library including service descriptions and comments, it is not used in a normal office build, as it approximately doubles the file size.

===How do I create a unique uik number?===
Some people do it by just copying an existing one and modifying it a little. This is, of course, disapproved of, but it works for now. We currently don't have our own tool, but you can use the guidgen.exe that comes with the Microsoft compiler.

However, the guides are currently not used. They are there for historical reasons (the former UNO component model needed it) and we left it in for a future bridge, maybe UNO-COM, which would require unique identifiers.
How can I configure the office to be started in listening mode ?
There are two ways.
#. Start the office with an additional parameter :<pre>soffice -accept=socket,host=0,port=2002;urp;StarOffice.ServiceManager</pre>(Please ensure to quote the ; on a Unix shell).
#. Place the same string without '-accept=' into a configuration file. You can edit the file <pre><office-install>/share/config/registry/instance/org/openoffice/Setup.xml</pre>and replace the tag<pre><ooSetupConnectionURL cfg:type="string"/></pre>with <pre><ooSetupConnectionURL cfg:type="string">socket,host=0,port=2002;urp;StarOffice.ServiceManager</ooSetupConnectionURL></pre>

Note that this change has effect on the whole network installation, which can easily become a very serious security problem. Please also note, that using the host=0 phrase will make the office listen on every network interface, in case you only want to script your office from the same machine, it is definitely better, more secure, to replace the 0 with localhost.

If you want to configure remote connect only for a certain user (in a network installation), you need to do the modification into the user dependent configuration directory in Setup.xml, above.

===How do I start the TestOffice.java?===
As parameters, please use, for example: uno:socket,host=localhost,port=2002;urp;StarOffice.NamingService

===How do I remotely connect to an OpenOffice.org running on a different machine?===
When connecting to an OpenOffice.org you supply an Uno URL, which allows to locate a named Uno object in a different process. A Uno URL consists of four parts:
* The constant string "uno".
* A connection specification with optional parameters as key/value pairs.
* A protocol specification with optional parameters as key/value pairs.
* The name of the object to be located.

Those four parts are concatenated to a string
uno:[connection],params;[protocol],params;[objectname]

An example Uno URL looks like:
uno:socket,host=localhost,port=2002;urp;StarOffice.ServiceManager

For more information about Uno URLs please consult http://udk.openoffice.org/common/man/spec/uno-url.html

A string similar to the uno-url is used to configure the accepting process, for instance the office. . You can start the office with
soffice "-accept=socket,host=0,port=2002;urp;"
Note that this string is not specified as strong as the uno-url and other programs may define there own format (e.g. the uno tool coming with the ODK expects a different format). One speciality of the socket connection part is, that you can use "host=0", which means accept on every network interface available on the current machine including localhost. The "host=0" part cannot be used for connecting to a resource.

Additionally, you don't need to specify the object name, as the office either way exports multiple objects (StarOffice.NamingService, StarOffice.ServiceManager and [new] StarOffice.ComponentContext).

===What's the purpose of the UnoUrlResolver?===
The UnoUrlResolver gets a remote object for a service name specified in an uno-url, especially a StarOffice.ServiceManager. Then, you use the the service managers XNamingService interface in order to retrieve the service manager 'registeredObject' via getRegisteredObject in order to be able to queryInterface() for a XMultiServiceFactory. Remember, that the remote OpenOffice.org process has fulfilled its startup phase before the naming service reference is returned. This is necessary to guarantee the availability of all services. As you can see, the naming service is only a container for the service manager. This is done for flexibility reasons, because future versions may export more objects than only the service manager. Understand the uno-url as an entry point into another process; after that, everything else should be handled via normal UNO calls. Perhaps future versions also will remove the naming service's ability to remove and add objects, which obviously doesn't make any sense for remote processes.
How can I be event notified when a remote bridge is being disposed?

A XComponent notifies its event listeners when it is being disposed. Unfortunately a reference to a UnoUrlResolver object is not sufficient to receive a dispose event notification. You'll need at least a connector and a bridge factory service (see com.sun.star.comp.urlresolver.UnoUrlResolver in the jurt directory for more details) which you can query for a XComponent interface. This queried reference can be used to add a dispose event listener like this:
<pre>
String connection = "socket,host=localhost,port=2002";
String protocol = "urp";
Object connector = _xMultiServiceFactory.createInstance("com.sun.star.connection.Connector");
XConnector connector_xConnector = (XConnector)UnoRuntime.queryInterface(XConnector.class, connector);
XConnection xConnection = connector_xConnector.connect(connection);
xBridge = xBridgeFactory.createBridge(connection + ";" + protocol, protocol, xConnection, null);
XComponent component = (XComponent)UnoRuntime.queryInterface(XComponent.class, component);
component.addEventListener(...);
</pre>

==Documentation==
===How can I check out the UDK WWW documentation?===
The documentation for the UDK project, which can be viewed via http://udk.openoffice.org, can be checked out using the following CVS command
$ cvs -d :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs -z3 co udk/www

If you don't want the generated C++ module reference documents you might want to save these commands into a script or batch file and run it from the command shell:
<pre>
cvs -d :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs -z3 co udk/www/common
cvs -d :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs -z3 co udk/www/cpp/man
cvs -d :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs -z3 co udk/www/java
cvs -d :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs -z3 co udk/www/images
cvs -d :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs -z3 co udk/www/documentation_structure.html
cvs -d :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs -z3 co udk/www/faq.html
cvs -d :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs -z3 co udk/www/index.html
</pre>

===Where can I find more information about the UNO security model?===
Please look at http://udk.openoffice.org/common/man/concept/uno_security.html. The main goal of this draft is to provide a generic API to wrap existing security implementations, this draft is based on Java security and semantics and may change. There are details being discussed, marked in red, for example remote transparency.

===Where can I find more information about the UNO CORBA bridge?===
Bridging UNO and CORBA is no trivial task, as both component models are based on different fundamental concepts. Therefore, we want to write down the ideas about how to deal with these fundamental differences, before beginning implementation. Please look at http://udk.openoffice.org/common/man/concept/uno_corba.html for more information.

This document currently contains only part that we will have to deal with during development of the bridge. The document is supposed to grow rapidly during the next weeks. Any input on UNO CORBA bridge from the community is very welcome, discussions take place on dev@udk.openoffice.org.

The main goal is to get a CORBA-bridge that supports all features necessary to communicate with the GNOME desktop (http://www.gnome.org). The component model used in GNOME is Bonobo, which is built on top of [http://www.gnome.org/projects/ORBit2/ ORBIT], an open source CORBA ORB (Object Request Broker). A CORBA-UNO bridge would allow to script OpenOffice.org with a GNOME scripting language, for example.

The secondary goal is to develop a 'generic' CORBA-UNO-bridge, that allows communication with an arbitrary ORB. This would allow OpenOffice.org to seamlessly integrate into any CORBA environment.

===Where can I find more information about the SOAP-UNO integration?===
Please have a look at http://udk.openoffice.org/common/man/draft/soap.html.

===Where can I find more information about the OpenOffice.org Bonobo integration?===
A brief overview about the project OpenOffice.org - Bonobo Integration can be found at http://whiteboard.openoffice.org/bonobo/. Something about motivation and goals of this project is written there. We have checked in some code into CVS, enabling OpenOffice.org to be a Bonobo server for containers like Nautilus. Everyone is welcome to contribute ideas or code, on how to bring OpenOffice.org and GNOME closer together on the level of component technology.

[[Category:Uno]] [[Category:FAQ]]

Documentation/Building Guide/Building on MacOSX

2013-09-27T09:33:24Z

Hdu: updated configure for AOO40x

{{Documentation/Building Guide TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on Mac OS X}}
[[Category:MacOSX]]

__TOC__

= Overview =
This document explains how to build the Apache OpenOffice source code on Mac OS X systems.
{{Template:Documentation/Note|<code>$SRC_ROOT</code> will denote the directory in which the source code of Apache OpenOffice is stored.}}
{{Template:Documentation/Tip|You are advised to check the release notes for the release you are building to inform yourself about changes since previous releases.}}

= Requirements =

To build the office on Mac OS X several requirements/prerequisites have to be fulfilled.

== Mandatory Requirements ==
* '''Mac OS X''' version 10.4 (aka Tiger) or later (if using 10.5 aka Leopard, have a look at [[User:Dyrcona/LeopardBuild#flex]]
* '''Mac 10.4 SDK'''
* '''XCode''' version 2.4.1 or any XCode 3. If you want to use a newer version than the one that is shipped with your Mac OS X installation media, you need to register at the [https://connect.apple.com/ Apple Developer Connection] site (free of charge) to be able to [http://developer.apple.com/technology/xcode.html download it]. On Mac OS X 10.6 (Snow Leopard), make sure to install the optional 10.4 SDK with XCode.
* '''dmake''', the build environment depends currently on a special patched version of dmake that you can download and build on demand during configure and bootstrap. Or you can provide a prebuilt version and can specify it during configure.
* '''epm''', the build environment depends currently on a special patched version of epm (easy package manager) that you can download and build on demand during configure and bootstrap. Or you can provide a prebuilt version and can specify it during configure.

{{Template:Documentation/Note|XCode 3 and SDK 10.4 is currently required for building trunk or the releases. Work on supporting XCode>=4 is ongoing.}}

== Optional Requirements ==

=== Prebuilt unowinreg.dll ===

This library is Windows only but will be packed in the Apache OpenOffice SDK to ensure that it is available on all platforms. The library provides some glue code to setup a working UNO environment for UNO client applications connecting to an office and doing some remote automation via API. The library should be stored in ''main/external/unowinreg''. Only necessary for building the SDK.

The library can be downloaded under
* http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll

=== Prebuilt Mozilla archives (based on seamonkey1.1.13) ===

To enable macros/macro security (disabled by default for security reasons), you'll have to put the prebuilt archives of mozilla binaries in the ''main/moz/zipped'' directory.

Note: archives are Intel only for now.

'''Archives to be downloaded''' :

* http://tools.openoffice.org/moz_prebuild/OOo3.2/MACOSXGCCIinc.zip
* http://tools.openoffice.org/moz_prebuild/OOo3.2/MACOSXGCCIlib.zip
* http://tools.openoffice.org/moz_prebuild/OOo3.2/MACOSXGCCIruntime.zip

or from

* http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIinc.zip
* http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIlib.zip
* http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIruntime.zip

== Recommended tools ==

* '''ccache'''
If you intend to build Apache OpenOffice several times, you probably can benefit of ccache since it will speed up your future builds. The first time you make a build with ccache you won't notice it, but the next time the build will go up to five times faster.

You can install it using '''[http://www.finkproject.org/ Fink]'''. It is simply named "ccache". For '''[http://www.macports.org/ MacPorts]''' users the package is called "ccache".

If you don't use fink, you can download and build it yourself using the source provided at http://ccache.samba.org/

There are two ways to enable ccache - one is to set environment variables, the other way is to use symlinks.

Using environment variables:
export CC="ccache gcc"
export CXX="ccache g++"

Using the symlink approach:
# create a directory for the links
mkdir ~/bin
# create the symlinks pointing to ccache with the name of the compiler
ln -s /path/to/ccache ~/bin/gcc
ln -s /path/to/ccache ~/bin/g++
ln -s /path/to/ccache ~/bin/cc
ln -s /path/to/ccache ~/bin/c++
# no all you need to enable ccache is to prepend ~/bin to your PATH
$ export PATH=~/bin:$PATH

for both methody, you can add the "export ..." lines to your ~/.profile - that way you don't need to manually set it when building. You can still temporarily disable ccache (export CCACHE_DISABLE=1) in case you don't want to use it.

Since OOo is rather huge, you should increase the cache-size to 1 GB or more
ccache -M 1G

* '''subversion''' version '''1.5.4 or later'''
Since OOo's source code is managed using Subversion currently, you also need the svn client to checkout sources (otherwise you would be bount to source-tarballs that aren't generated that frequently). You can either compile yourself or use the subversion universal binaries from the [http://subversion.tigris.org subversion project] Version 1.5.4 or later is required because of important fixes related to the merge-feature.

== Get the source and prepare to build it ==

=== Get the source from SVN ===

You need about 4.7 GB for a checkout from the svn repository. Building the source requires another 5GB.<br>

* '''check out the latest source from svn'''

svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo

=== One-Time preparation and scripts ===

Apache OpenOffice build environment is configured using the open-source configuration-management package 'autoconf'. So you can do your beloved './configure' command, is now done in the '''main''' source directory.

To save the configure parameters and use them with different milestones it is useful to create your own build script to configure the environment and to trigger the build.

The directory structure when you have checked out the sources from svn looks like:

aoo/
aoo/main
aoo/extras
aoo/test
aoo/ext_libraries
aoo/ext_sources

Move into '''main''' and configure a minimal environment to build your first version of Apache OpenOffice:

cd main

Run the autoconf command to prepare a new configure based on the latest changes in configure.in

autoconf

Run configure

./configure --without-stlport --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 --with-epm-url=http://www.msweet.org/files/project2/epm-3.7-source.tar.gz

This commands prepares a minimal environment to build the office without any category-b enabled external libraries. A pure Apache license compatible version. See also the configure switches ''--with-dmake-path'' and ''--with-epm'' to specify prebuilt versions of dmake or epm.

Finally you should run bootstrap to trigger further preparations and to create platform specific shell script to setup a working build environment. On Mac OS x for example '''MacOSXX86Env.Set.sh''' on a Intel based system.

=== Build environment with enabled category-b dependencies ===

To prepare a build environment that provides more features and make use of further external libraries which are under copyleft but viral licenses you have to explicitly enable this '''category-b''' components.

./configure --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://www.msweet.org/files/project2/epm-3.7-source.tar.gz \
--disable-build-mozilla \
--without-stlport \
--enable-verbose \
'''--enable-category-b'''\
--enable-wiki-publisher

===Example build script to simplify user specific configurations===
As mentioned before to save the configure parameters and use them with different versions it is useful to create your own build script to configure the environment.

Create 'build.sh' (to be written) :

<pre>
#! /bin/bash

echo "### checking for unowinreg.dll ... "
if [ ! -e ./external/unowinreg/unowinreg.dll ]; then
wget -O external/unowinreg/unowinreg.dll http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll
else
echo " unowinreg.dll found"
fi

echo "### checking for moz prebuild libs ... "
if [ ! -e ./moz/zipped/MACOSXGCCIinc.zip ]; then
wget -O ./moz/zipped/MACOSXGCCIinc.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIinc.zip
wget -O ./moz/zipped/MACOSXGCCIlib.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIlib.zip
wget -O ./moz/zipped/MACOSXGCCIruntime.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIruntime.zip
else
echo " moz prebuild libs found"
fi

if [ ! -e ./configure ]; then
echo "### autoconf ..."
autoconf
else
echo "### autoconf ..."
rm ./configure
autoconf
fi

echo "### Configure"
./configure --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 --with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz

#./configure --with-build-version="$(date +"%Y-%m-%d %H:%M:%S (%a, %d %b %Y)") - Rev. $(echo $(svn info) | sed -e 's/^.*Last Changed Rev: //g' -e 's/ .*//g')" \
--disable-build-mozilla \
--enable-verbose --enable- category-b --enable-minimizer --enable-presenter-console --enable-wiki-publisher \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz

./bootstrap
</pre>

Put this script into ~/bin and make sure it is executable :

chmod ug+x ~/bin/build.sh

<b>We used the bash shell in all example, since to our belief users of the C-shell are smart enough to figure out the differences anyway. If you want to dig deeper into the build process, please have a look at the description [http://tools.openoffice.org/build_env.html OpenOffice.org's Build Environment].</b>

== Doing the build ==

After running configure and bootstrap we should have a working build environment and all necessary scripts should have been created. From now on you can use '''MacOSXX86Env.Set.sh''' to prepare a new shell with a working build environment.

=== On Mac Intel ===

source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all

or

build --all -P4

=== On PowerPC ===

source MacOSXPPCEnv.Set.sh
cd instsetoo_native
build --all

or

build --all -P2

=== Comments on above ===

'''TODO TODO TODO ....'''

if you run into trouble with --dlv_switch (see: {{Bug|77360}})

The main purpose of the '''bootstrap''' script is to build (if necessary) the dmake utility used. Dmake once was a unix make-clone made by wticorp but got incorporated into OpenOffice since it was orphaned. For more information about dmake, it's history and manpage have a look here: http://tools.openoffice.org/dmake/index.html

Sourcing MacOSXPPCEnv.Set.sh is very important not only for building but also for '''running''' svdem later on. Here all the Environment-Variables for the Build will be set up. For a detailed description see [[Environment_Variables]]. Please note that on Intel machines, 'MacOSXPPCEnv.Set.sh' should be substituted with 'MacOSXX86Env.Set.sh'.

This Build process takes on my box (Dual 1.8 GHz G5, 1.5GB RAM) roughly 10 hours, and 3 to 6 hours on Mac Intel (3:30h on a 2GHz DualCore INTEL iMac). Be patient.

If you want to see how the progress on that build is you can use two '''build''' options to get a comfortable view:

build ... <see above> ... --html --html_path /Users/$USER/Sites

where $USER is your user name. Then you can load in Firefox (not Safari!) the HTML file '''unxmacxi.pro.build.html''' via the in Mac OS X included Apache web server or diretctly form the directory ''/Users/$USER/Sites/''. This file is automatically being updated and is showing the status of the build and also the time needed since the build started.

If you build on Snow Leopard (aka Mac OS X 10.6): Set DYLD_INSERT_LIBRARIES to point to the correct libsqlite3.dylib:
<pre>
DYLD_INSERT_LIBRARIES=/usr/lib/libsqlite3.dylib
</pre>

== '''Installing, preparing and running OpenOffice.org''' ==

===''' Find the Bundle''' ===

Once the build completed, the final product ( en-US version ) is named : OOo_3.0.0_*_MacOSXIntel_install.dmg ( for version 3.0beta e.g.)

And is located in instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US directory ( replace en-US with your locale )

[[Image:Bundle_Location3.0beta.jpg]]

=== '''Install the new Build''' ===

* double click on the *.dmg icon
* drag the OpenOffice.org icon into a folder of your choice

=== '''Run the new Build''' ===

* double click the application icon in that folder

=== '''Screenshots''' ===

Now you can start to work with this [[Aqua_Screenshots | amazing productivity suite]].

== '''Contribute by finding, isolating, debugging or solving issues''' ==

=== '''Isolate a problem''' ===

==== '''Reduce a problem''' ====

* make a problem reproducable
* reduce it to a test case that is as small and simple as possible
* if a problem is specific to a document then please attach it to the issue. A mininal excerpt of the document that still shows the problem is even better.
* a screenshot of is a good idea if it clearly shows the problem

==== '''Using application switches''' ====

Application switches are often valuable for isolating a problem. Most of OpenOffice.org's options can be found its Tools->Options menu.
<br><br>
Some switches are so special that there is no user interface to change them. They are only useful for debugging and isolating a problem, but they are very valuable a that. So a developer might suggest to isolate a problem by setting an environment variable before running the application. E.g. for isolating problems with the menubar a developer might suggest to set the environment variable [[AQUA_NATIVE_MENUS]] to false. This is done by typing these commands into a terminal:
* cd <INSTALL_DIR>/OpenOffice.org/Contents/MacOS
* export AQUA_NATIVE_MENUS=false
* ./soffice.bin

==== '''Provide a call stack for crash problems''' ====

Please note that bugs involving crashes should provide a description of how to reproduce the problem and a callstack.
There are several ways to provide the callstack:
* the preferred method is to use OOo"s builtin [[CrashReporting|crash reporting tool]]
* developers may provide a [[Providing_a_gdb_backtrace | gdb backtrace]] of the problem
* if the above two methods don"t work then please attach a file with the details provided by the AppleCrashReporter

=== '''Check against known issues''' ===

Check the list of [http://www.openoffice.org/issues/buglist.cgi?issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=&short_desc_type=fulltext&long_desc=&long_desc_type=fulltext&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=aqua&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time&Submit+query=Submit+query open issues]

=== '''Report a new issue''' ===

Report [http://qa.openoffice.org/issue_handling/pre_submission.html new issues] after you have [[AquaBuild#Isolate_a_problem | isolated the problem]]

=== '''Debug a problem''' ===

Debugging problems is often easier in an development environment:
<ul>
<li>With XCode: [[MacOSX_Debug_OpenOffice.org_using_XCode]]</li>
<li>With Xemacs: [http://www.mikesicotte.com/2007/02/21/debugging-ooo-with-xemacs-and-gdb Michael Sicotte's blog entry]</li>
</ul>

Please note that XCode still has some problems with the executable named soffice.bin (because of the dot in the name). The issue has been reported to xcode-users list.

== '''Current Work in progress (Aqua specific work only)''' ==

With OOO300 the Aqua port became a mainstream port, so most Aqua issues are handled in regular GSL-Layer childworkspaces instead of dedicated Aqua CWSses. Other CWSses that are purely Aqua specific are being tracked below:

* '''{{CWS|ogltrans4mac|DEV300}}''' : Implement the 3D (OpenGL) transitions in Impress ( see : [[Mac_OS_X_Porting_-_OpenGL_transitions| OpenGL transitions on Mac OS X ]] )

==='''Child WorkSpaces in development''' ===

* '''{{CWS|appleremote03|DEV300}}''' : use the contextual menu in presentation mode with Impress. preliminary step

* '''{{CWS|hotmac|OOO300}}''' : fix memory deallocation problems in exit()

* '''{{CWS|macosxscanner01|DEV300}}''' (planned)

All patches that developers have that need testing or peer review should be added here.

==='''Child WorkSpaces in testing (closed for development)''' ===

*'''{{CWS|macmiscfixes}}''' : misc fixes for mac

*'''{{CWS|maccrashrep}}''' : support crash reporting for OSX builds

*'''{{CWS|quicklookplugin01}}''' : a plugin for the QuickLook system available in MacOSX from versions 10.5 onwards

==='''Child WorkSpaces waiting for integration''' ===

* '''{{CWS|appleremote02|DEV300}}''' : improve the Apple Remote use with Impress (use MEDIA_COMMAND stuff, improve code robustness, and portability )

==='''Child Workspaces integrated into OpenOffice's trunk''' ===

A historical overview of [[Aqua_Integrated_CWS | old Aqua specific ChildWorkspaces]].

== '''Known build issues '''==
*'''Tiger''': no known issues
*'''Leopard''': no known issues
*'''Snow Leopard''': no known issues
*'''Lion''': no known issues
*'''Mountain Lion''': no known issues

<div align="left" style="color:grey; font-size:12px">[[AquaBuild/Some Background | '''Some Background (what is a CWS, EIS) (click me to know more) ''']]</div>

== '''External links''' ==
* [https://issues.apache.org/ooo Apache OpenOffice Issuezilla] : a database of bugs, changes and enhancements
* There are [[MacOSXPortMeetings | regular meetings]] on IRC (archives are [[Previous_Mac_Meeting_logs | available]]).
* Apache OpenOffice has a complicated code base. [[Source_code_directories | Here]] is an overview.
* the official Apache OpenOffice blog is at [https://blogs.apache.org/OOo/]
* [http://www.cocoadev.com Cocoadev] provides great resources to get up to speed in Cocoa development
* Pierre Chatelier's excellent [http://ktd.club.fr/programmation/objective-c.php Objective C for C++ developers] is available in both english and french versions
* Details about OSX's [http://developer.apple.com/cocoa Cocoa API] are available in the XCode documentation

[[Category:Aqua]]
[[Category:Build_System]]

Documentation/Building Guide/Building on MacOSX

2013-09-27T09:24:01Z

Hdu: /* Mandatory Requirements */

{{Documentation/Building Guide TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on Mac OS X}}
[[Category:MacOSX]]

__TOC__

= Overview =
This document explains how to build the Apache OpenOffice source code on Mac OS X systems.
{{Template:Documentation/Note|<code>$SRC_ROOT</code> will denote the directory in which the source code of Apache OpenOffice is stored.}}
{{Template:Documentation/Tip|You are advised to check the release notes for the release you are building to inform yourself about changes since previous releases.}}

= Requirements =

To build the office on Mac OS X several requirements/prerequisites have to be fulfilled.

== Mandatory Requirements ==
* '''Mac OS X''' version 10.4 (aka Tiger) or later (if using 10.5 aka Leopard, have a look at [[User:Dyrcona/LeopardBuild#flex]]
* '''Mac 10.4 SDK'''
* '''XCode''' version 2.4.1 or any XCode 3. If you want to use a newer version than the one that is shipped with your Mac OS X installation media, you need to register at the [https://connect.apple.com/ Apple Developer Connection] site (free of charge) to be able to [http://developer.apple.com/technology/xcode.html download it]. On Mac OS X 10.6 (Snow Leopard), make sure to install the optional 10.4 SDK with XCode.
* '''dmake''', the build environment depends currently on a special patched version of dmake that you can download and build on demand during configure and bootstrap. Or you can provide a prebuilt version and can specify it during configure.
* '''epm''', the build environment depends currently on a special patched version of epm (easy package manager) that you can download and build on demand during configure and bootstrap. Or you can provide a prebuilt version and can specify it during configure.

{{Template:Documentation/Note|XCode 3 and SDK 10.4 is currently required for building trunk or the releases. Work on supporting XCode>=4 is ongoing.}}

== Optional Requirements ==

=== Prebuilt unowinreg.dll ===

This library is Windows only but will be packed in the Apache OpenOffice SDK to ensure that it is available on all platforms. The library provides some glue code to setup a working UNO environment for UNO client applications connecting to an office and doing some remote automation via API. The library should be stored in ''main/external/unowinreg''. Only necessary for building the SDK.

The library can be downloaded under
* http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll

=== Prebuilt Mozilla archives (based on seamonkey1.1.13) ===

To enable macros/macro security (disabled by default for security reasons), you'll have to put the prebuilt archives of mozilla binaries in the ''main/moz/zipped'' directory.

Note: archives are Intel only for now.

'''Archives to be downloaded''' :

* http://tools.openoffice.org/moz_prebuild/OOo3.2/MACOSXGCCIinc.zip
* http://tools.openoffice.org/moz_prebuild/OOo3.2/MACOSXGCCIlib.zip
* http://tools.openoffice.org/moz_prebuild/OOo3.2/MACOSXGCCIruntime.zip

or from

* http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIinc.zip
* http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIlib.zip
* http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIruntime.zip

== Recommended tools ==

* '''ccache'''
If you intend to build Apache OpenOffice several times, you probably can benefit of ccache since it will speed up your future builds. The first time you make a build with ccache you won't notice it, but the next time the build will go up to five times faster.

You can install it using '''[http://www.finkproject.org/ Fink]'''. It is simply named "ccache". For '''[http://www.macports.org/ MacPorts]''' users the package is called "ccache".

If you don't use fink, you can download and build it yourself using the source provided at http://ccache.samba.org/

There are two ways to enable ccache - one is to set environment variables, the other way is to use symlinks.

Using environment variables:
export CC="ccache gcc"
export CXX="ccache g++"

Using the symlink approach:
# create a directory for the links
mkdir ~/bin
# create the symlinks pointing to ccache with the name of the compiler
ln -s /path/to/ccache ~/bin/gcc
ln -s /path/to/ccache ~/bin/g++
ln -s /path/to/ccache ~/bin/cc
ln -s /path/to/ccache ~/bin/c++
# no all you need to enable ccache is to prepend ~/bin to your PATH
$ export PATH=~/bin:$PATH

for both methody, you can add the "export ..." lines to your ~/.profile - that way you don't need to manually set it when building. You can still temporarily disable ccache (export CCACHE_DISABLE=1) in case you don't want to use it.

Since OOo is rather huge, you should increase the cache-size to 1 GB or more
ccache -M 1G

* '''subversion''' version '''1.5.4 or later'''
Since OOo's source code is managed using Subversion currently, you also need the svn client to checkout sources (otherwise you would be bount to source-tarballs that aren't generated that frequently). You can either compile yourself or use the subversion universal binaries from the [http://subversion.tigris.org subversion project] Version 1.5.4 or later is required because of important fixes related to the merge-feature.

== Get the source and prepare to build it ==

=== Get the source from SVN ===

You need about 4.7 GB for a checkout from the svn repository. Building the source requires another 5GB.<br>

* '''check out the latest source from svn'''

svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo

=== One-Time preparation and scripts ===

Apache OpenOffice build environment is configured using the open-source configuration-management package 'autoconf'. So you can do your beloved './configure' command, is now done in the '''main''' source directory.

To save the configure parameters and use them with different milestones it is useful to create your own build script to configure the environment and to trigger the build.

The directory structure when you have checked out the sources from svn looks like:

aoo/
aoo/main
aoo/extras
aoo/test
aoo/ext_libraries
aoo/ext_sources

Move into '''main''' and configure a minimal environment to build your first version of Apache OpenOffice:

cd main

Run the autoconf command to prepare a new configure based on the latest changes in configure.in

autoconf

Run configure

./configure --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 --with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz

This commands prepares a minimal environment to build the office without any category-b enabled external libraries. A pure Apache license compatible version. See also the configure switches ''--with-dmake-path'' and ''--with-epm'' to specify prebuilt versions of dmake or epm.

Finally you should run bootstrap to trigger further preparations and to create platform specific shell script to setup a working build environment. On Mac OS x for example '''MacOSXX86Env.Set.sh''' on a Intel based system.

=== Build environment with enabled category-b dependencies ===

To prepare a build environment that provides more features and make use of further external libraries which are under copyleft but viral licenses you have to explicitly enable this '''category-b''' components.

./configure --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz \
--disable-build-mozilla \
--enable-verbose \
'''--enable-category-b'''\
--enable-minimizer\
--enable-presenter-console\
--enable-wiki-publisher

===Example build script to simplify user specific configurations===
As mentioned before to save the configure parameters and use them with different versions it is useful to create your own build script to configure the environment.

Create 'build.sh' (to be written) :

<pre>
#! /bin/bash

echo "### checking for unowinreg.dll ... "
if [ ! -e ./external/unowinreg/unowinreg.dll ]; then
wget -O external/unowinreg/unowinreg.dll http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll
else
echo " unowinreg.dll found"
fi

echo "### checking for moz prebuild libs ... "
if [ ! -e ./moz/zipped/MACOSXGCCIinc.zip ]; then
wget -O ./moz/zipped/MACOSXGCCIinc.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIinc.zip
wget -O ./moz/zipped/MACOSXGCCIlib.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIlib.zip
wget -O ./moz/zipped/MACOSXGCCIruntime.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIruntime.zip
else
echo " moz prebuild libs found"
fi

if [ ! -e ./configure ]; then
echo "### autoconf ..."
autoconf
else
echo "### autoconf ..."
rm ./configure
autoconf
fi

echo "### Configure"
./configure --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 --with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz

#./configure --with-build-version="$(date +"%Y-%m-%d %H:%M:%S (%a, %d %b %Y)") - Rev. $(echo $(svn info) | sed -e 's/^.*Last Changed Rev: //g' -e 's/ .*//g')" \
--disable-build-mozilla \
--enable-verbose --enable- category-b --enable-minimizer --enable-presenter-console --enable-wiki-publisher \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz

./bootstrap
</pre>

Put this script into ~/bin and make sure it is executable :

chmod ug+x ~/bin/build.sh

<b>We used the bash shell in all example, since to our belief users of the C-shell are smart enough to figure out the differences anyway. If you want to dig deeper into the build process, please have a look at the description [http://tools.openoffice.org/build_env.html OpenOffice.org's Build Environment].</b>

== Doing the build ==

After running configure and bootstrap we should have a working build environment and all necessary scripts should have been created. From now on you can use '''MacOSXX86Env.Set.sh''' to prepare a new shell with a working build environment.

=== On Mac Intel ===

source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all

or

build --all -P4

=== On PowerPC ===

source MacOSXPPCEnv.Set.sh
cd instsetoo_native
build --all

or

build --all -P2

=== Comments on above ===

'''TODO TODO TODO ....'''

if you run into trouble with --dlv_switch (see: {{Bug|77360}})

The main purpose of the '''bootstrap''' script is to build (if necessary) the dmake utility used. Dmake once was a unix make-clone made by wticorp but got incorporated into OpenOffice since it was orphaned. For more information about dmake, it's history and manpage have a look here: http://tools.openoffice.org/dmake/index.html

Sourcing MacOSXPPCEnv.Set.sh is very important not only for building but also for '''running''' svdem later on. Here all the Environment-Variables for the Build will be set up. For a detailed description see [[Environment_Variables]]. Please note that on Intel machines, 'MacOSXPPCEnv.Set.sh' should be substituted with 'MacOSXX86Env.Set.sh'.

This Build process takes on my box (Dual 1.8 GHz G5, 1.5GB RAM) roughly 10 hours, and 3 to 6 hours on Mac Intel (3:30h on a 2GHz DualCore INTEL iMac). Be patient.

If you want to see how the progress on that build is you can use two '''build''' options to get a comfortable view:

build ... <see above> ... --html --html_path /Users/$USER/Sites

where $USER is your user name. Then you can load in Firefox (not Safari!) the HTML file '''unxmacxi.pro.build.html''' via the in Mac OS X included Apache web server or diretctly form the directory ''/Users/$USER/Sites/''. This file is automatically being updated and is showing the status of the build and also the time needed since the build started.

If you build on Snow Leopard (aka Mac OS X 10.6): Set DYLD_INSERT_LIBRARIES to point to the correct libsqlite3.dylib:
<pre>
DYLD_INSERT_LIBRARIES=/usr/lib/libsqlite3.dylib
</pre>

== '''Installing, preparing and running OpenOffice.org''' ==

===''' Find the Bundle''' ===

Once the build completed, the final product ( en-US version ) is named : OOo_3.0.0_*_MacOSXIntel_install.dmg ( for version 3.0beta e.g.)

And is located in instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US directory ( replace en-US with your locale )

[[Image:Bundle_Location3.0beta.jpg]]

=== '''Install the new Build''' ===

* double click on the *.dmg icon
* drag the OpenOffice.org icon into a folder of your choice

=== '''Run the new Build''' ===

* double click the application icon in that folder

=== '''Screenshots''' ===

Now you can start to work with this [[Aqua_Screenshots | amazing productivity suite]].

== '''Contribute by finding, isolating, debugging or solving issues''' ==

=== '''Isolate a problem''' ===

==== '''Reduce a problem''' ====

* make a problem reproducable
* reduce it to a test case that is as small and simple as possible
* if a problem is specific to a document then please attach it to the issue. A mininal excerpt of the document that still shows the problem is even better.
* a screenshot of is a good idea if it clearly shows the problem

==== '''Using application switches''' ====

Application switches are often valuable for isolating a problem. Most of OpenOffice.org's options can be found its Tools->Options menu.
<br><br>
Some switches are so special that there is no user interface to change them. They are only useful for debugging and isolating a problem, but they are very valuable a that. So a developer might suggest to isolate a problem by setting an environment variable before running the application. E.g. for isolating problems with the menubar a developer might suggest to set the environment variable [[AQUA_NATIVE_MENUS]] to false. This is done by typing these commands into a terminal:
* cd <INSTALL_DIR>/OpenOffice.org/Contents/MacOS
* export AQUA_NATIVE_MENUS=false
* ./soffice.bin

==== '''Provide a call stack for crash problems''' ====

Please note that bugs involving crashes should provide a description of how to reproduce the problem and a callstack.
There are several ways to provide the callstack:
* the preferred method is to use OOo"s builtin [[CrashReporting|crash reporting tool]]
* developers may provide a [[Providing_a_gdb_backtrace | gdb backtrace]] of the problem
* if the above two methods don"t work then please attach a file with the details provided by the AppleCrashReporter

=== '''Check against known issues''' ===

Check the list of [http://www.openoffice.org/issues/buglist.cgi?issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=&short_desc_type=fulltext&long_desc=&long_desc_type=fulltext&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=aqua&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time&Submit+query=Submit+query open issues]

=== '''Report a new issue''' ===

Report [http://qa.openoffice.org/issue_handling/pre_submission.html new issues] after you have [[AquaBuild#Isolate_a_problem | isolated the problem]]

=== '''Debug a problem''' ===

Debugging problems is often easier in an development environment:
<ul>
<li>With XCode: [[MacOSX_Debug_OpenOffice.org_using_XCode]]</li>
<li>With Xemacs: [http://www.mikesicotte.com/2007/02/21/debugging-ooo-with-xemacs-and-gdb Michael Sicotte's blog entry]</li>
</ul>

Please note that XCode still has some problems with the executable named soffice.bin (because of the dot in the name). The issue has been reported to xcode-users list.

== '''Current Work in progress (Aqua specific work only)''' ==

With OOO300 the Aqua port became a mainstream port, so most Aqua issues are handled in regular GSL-Layer childworkspaces instead of dedicated Aqua CWSses. Other CWSses that are purely Aqua specific are being tracked below:

* '''{{CWS|ogltrans4mac|DEV300}}''' : Implement the 3D (OpenGL) transitions in Impress ( see : [[Mac_OS_X_Porting_-_OpenGL_transitions| OpenGL transitions on Mac OS X ]] )

==='''Child WorkSpaces in development''' ===

* '''{{CWS|appleremote03|DEV300}}''' : use the contextual menu in presentation mode with Impress. preliminary step

* '''{{CWS|hotmac|OOO300}}''' : fix memory deallocation problems in exit()

* '''{{CWS|macosxscanner01|DEV300}}''' (planned)

All patches that developers have that need testing or peer review should be added here.

==='''Child WorkSpaces in testing (closed for development)''' ===

*'''{{CWS|macmiscfixes}}''' : misc fixes for mac

*'''{{CWS|maccrashrep}}''' : support crash reporting for OSX builds

*'''{{CWS|quicklookplugin01}}''' : a plugin for the QuickLook system available in MacOSX from versions 10.5 onwards

==='''Child WorkSpaces waiting for integration''' ===

* '''{{CWS|appleremote02|DEV300}}''' : improve the Apple Remote use with Impress (use MEDIA_COMMAND stuff, improve code robustness, and portability )

==='''Child Workspaces integrated into OpenOffice's trunk''' ===

A historical overview of [[Aqua_Integrated_CWS | old Aqua specific ChildWorkspaces]].

== '''Known build issues '''==
*'''Tiger''': no known issues
*'''Leopard''': no known issues
*'''Snow Leopard''': no known issues
*'''Lion''': no known issues
*'''Mountain Lion''': no known issues

<div align="left" style="color:grey; font-size:12px">[[AquaBuild/Some Background | '''Some Background (what is a CWS, EIS) (click me to know more) ''']]</div>

== '''External links''' ==
* [https://issues.apache.org/ooo Apache OpenOffice Issuezilla] : a database of bugs, changes and enhancements
* There are [[MacOSXPortMeetings | regular meetings]] on IRC (archives are [[Previous_Mac_Meeting_logs | available]]).
* Apache OpenOffice has a complicated code base. [[Source_code_directories | Here]] is an overview.
* the official Apache OpenOffice blog is at [https://blogs.apache.org/OOo/]
* [http://www.cocoadev.com Cocoadev] provides great resources to get up to speed in Cocoa development
* Pierre Chatelier's excellent [http://ktd.club.fr/programmation/objective-c.php Objective C for C++ developers] is available in both english and french versions
* Details about OSX's [http://developer.apple.com/cocoa Cocoa API] are available in the XCode documentation

[[Category:Aqua]]
[[Category:Build_System]]

Documentation/Building Guide/Building on MacOSX

2013-09-27T09:20:10Z

Hdu: /* Mandatory Requirements */ XCode4 is not yet supported

{{Documentation/Building Guide TOC
|ShowNextPage=none
|ShowPrevPage=none
}}

{{DISPLAYTITLE:Building on Mac OS X}}
[[Category:MacOSX]]

__TOC__

= Overview =
This document explains how to build the Apache OpenOffice source code on Mac OS X systems.
{{Template:Documentation/Note|<code>$SRC_ROOT</code> will denote the directory in which the source code of Apache OpenOffice is stored.}}
{{Template:Documentation/Tip|You are advised to check the release notes for the release you are building to inform yourself about changes since previous releases.}}

= Requirements =

To build the office on Mac OS X several requirements/prerequisites have to be fulfilled.

== Mandatory Requirements ==
* '''Mac OS X''' version 10.4 (aka Tiger) or later (if using 10.5 aka Leopard, have a look at [[User:Dyrcona/LeopardBuild#flex]]
* '''Mac 10.4 SDK'''
* '''XCode''' version 2.4.1 or any XCode 3. If you want to use a newer version than the one that is shipped with your Mac OS X installation media, you need to register at the [https://connect.apple.com/ Apple Developer Connection] site (free of charge) to be able to [http://developer.apple.com/technology/xcode.html download it]. On Mac OS X 10.6 (Snow Leopard), make sure to install the optional 10.4 SDK with XCode.
* '''dmake''', the build environment depends currently on a special patched version of dmake that you can download and build on demand during configure and bootstrap. Or you can provide a prebuilt version and can specify it during configure.
* '''epm''', the build environment depends currently on a special patched version of epm (easy package manager) that you can download and build on demand during configure and bootstrap. Or you can provide a prebuilt version and can specify it during configure.

{{Template:Documentation/Note|XCode 4 is currently not tested because of the missing support in XCode and the office dependency to the 10.4 SDK}}

{{Template:Documentation/Note|Java: On systems < Mac OS X 10.7 Apache OpenOffice does not build yet using Java SDK 1.6.0. If you didn't configure Mac OS X for a 1.6, you don't need to do anything - the default (1.5) is OK. To change the default Java version go to Applications/Utilities/Java and modify accordingly}}

Of course patches to make it build with 1.6 are very welcome and feel free to submit your patches to the dev@openoffice.apache.org mailing list or file issues.

== Optional Requirements ==

=== Prebuilt unowinreg.dll ===

This library is Windows only but will be packed in the Apache OpenOffice SDK to ensure that it is available on all platforms. The library provides some glue code to setup a working UNO environment for UNO client applications connecting to an office and doing some remote automation via API. The library should be stored in ''main/external/unowinreg''. Only necessary for building the SDK.

The library can be downloaded under
* http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll

=== Prebuilt Mozilla archives (based on seamonkey1.1.13) ===

To enable macros/macro security (disabled by default for security reasons), you'll have to put the prebuilt archives of mozilla binaries in the ''main/moz/zipped'' directory.

Note: archives are Intel only for now.

'''Archives to be downloaded''' :

* http://tools.openoffice.org/moz_prebuild/OOo3.2/MACOSXGCCIinc.zip
* http://tools.openoffice.org/moz_prebuild/OOo3.2/MACOSXGCCIlib.zip
* http://tools.openoffice.org/moz_prebuild/OOo3.2/MACOSXGCCIruntime.zip

or from

* http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIinc.zip
* http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIlib.zip
* http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIruntime.zip

== Recommended tools ==

* '''ccache'''
If you intend to build Apache OpenOffice several times, you probably can benefit of ccache since it will speed up your future builds. The first time you make a build with ccache you won't notice it, but the next time the build will go up to five times faster.

You can install it using '''[http://www.finkproject.org/ Fink]'''. It is simply named "ccache". For '''[http://www.macports.org/ MacPorts]''' users the package is called "ccache".

If you don't use fink, you can download and build it yourself using the source provided at http://ccache.samba.org/

There are two ways to enable ccache - one is to set environment variables, the other way is to use symlinks.

Using environment variables:
export CC="ccache gcc"
export CXX="ccache g++"

Using the symlink approach:
# create a directory for the links
mkdir ~/bin
# create the symlinks pointing to ccache with the name of the compiler
ln -s /path/to/ccache ~/bin/gcc
ln -s /path/to/ccache ~/bin/g++
ln -s /path/to/ccache ~/bin/cc
ln -s /path/to/ccache ~/bin/c++
# no all you need to enable ccache is to prepend ~/bin to your PATH
$ export PATH=~/bin:$PATH

for both methody, you can add the "export ..." lines to your ~/.profile - that way you don't need to manually set it when building. You can still temporarily disable ccache (export CCACHE_DISABLE=1) in case you don't want to use it.

Since OOo is rather huge, you should increase the cache-size to 1 GB or more
ccache -M 1G

* '''subversion''' version '''1.5.4 or later'''
Since OOo's source code is managed using Subversion currently, you also need the svn client to checkout sources (otherwise you would be bount to source-tarballs that aren't generated that frequently). You can either compile yourself or use the subversion universal binaries from the [http://subversion.tigris.org subversion project] Version 1.5.4 or later is required because of important fixes related to the merge-feature.

== Get the source and prepare to build it ==

=== Get the source from SVN ===

You need about 4.7 GB for a checkout from the svn repository. Building the source requires another 5GB.<br>

* '''check out the latest source from svn'''

svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo

=== One-Time preparation and scripts ===

Apache OpenOffice build environment is configured using the open-source configuration-management package 'autoconf'. So you can do your beloved './configure' command, is now done in the '''main''' source directory.

To save the configure parameters and use them with different milestones it is useful to create your own build script to configure the environment and to trigger the build.

The directory structure when you have checked out the sources from svn looks like:

aoo/
aoo/main
aoo/extras
aoo/test
aoo/ext_libraries
aoo/ext_sources

Move into '''main''' and configure a minimal environment to build your first version of Apache OpenOffice:

cd main

Run the autoconf command to prepare a new configure based on the latest changes in configure.in

autoconf

Run configure

./configure --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 --with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz

This commands prepares a minimal environment to build the office without any category-b enabled external libraries. A pure Apache license compatible version. See also the configure switches ''--with-dmake-path'' and ''--with-epm'' to specify prebuilt versions of dmake or epm.

Finally you should run bootstrap to trigger further preparations and to create platform specific shell script to setup a working build environment. On Mac OS x for example '''MacOSXX86Env.Set.sh''' on a Intel based system.

=== Build environment with enabled category-b dependencies ===

To prepare a build environment that provides more features and make use of further external libraries which are under copyleft but viral licenses you have to explicitly enable this '''category-b''' components.

./configure --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz \
--disable-build-mozilla \
--enable-verbose \
'''--enable-category-b'''\
--enable-minimizer\
--enable-presenter-console\
--enable-wiki-publisher

===Example build script to simplify user specific configurations===
As mentioned before to save the configure parameters and use them with different versions it is useful to create your own build script to configure the environment.

Create 'build.sh' (to be written) :

<pre>
#! /bin/bash

echo "### checking for unowinreg.dll ... "
if [ ! -e ./external/unowinreg/unowinreg.dll ]; then
wget -O external/unowinreg/unowinreg.dll http://tools.openoffice.org/unowinreg_prebuild/680/unowinreg.dll
else
echo " unowinreg.dll found"
fi

echo "### checking for moz prebuild libs ... "
if [ ! -e ./moz/zipped/MACOSXGCCIinc.zip ]; then
wget -O ./moz/zipped/MACOSXGCCIinc.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIinc.zip
wget -O ./moz/zipped/MACOSXGCCIlib.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIlib.zip
wget -O ./moz/zipped/MACOSXGCCIruntime.zip http://www.openoffice.org/tools/moz_prebuild/OOo3.2/MACOSXGCCIruntime.zip
else
echo " moz prebuild libs found"
fi

if [ ! -e ./configure ]; then
echo "### autoconf ..."
autoconf
else
echo "### autoconf ..."
rm ./configure
autoconf
fi

echo "### Configure"
./configure --with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 --with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz

#./configure --with-build-version="$(date +"%Y-%m-%d %H:%M:%S (%a, %d %b %Y)") - Rev. $(echo $(svn info) | sed -e 's/^.*Last Changed Rev: //g' -e 's/ .*//g')" \
--disable-build-mozilla \
--enable-verbose --enable- category-b --enable-minimizer --enable-presenter-console --enable-wiki-publisher \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz

./bootstrap
</pre>

Put this script into ~/bin and make sure it is executable :

chmod ug+x ~/bin/build.sh

<b>We used the bash shell in all example, since to our belief users of the C-shell are smart enough to figure out the differences anyway. If you want to dig deeper into the build process, please have a look at the description [http://tools.openoffice.org/build_env.html OpenOffice.org's Build Environment].</b>

== Doing the build ==

After running configure and bootstrap we should have a working build environment and all necessary scripts should have been created. From now on you can use '''MacOSXX86Env.Set.sh''' to prepare a new shell with a working build environment.

=== On Mac Intel ===

source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all

or

build --all -P4

=== On PowerPC ===

source MacOSXPPCEnv.Set.sh
cd instsetoo_native
build --all

or

build --all -P2

=== Comments on above ===

'''TODO TODO TODO ....'''

if you run into trouble with --dlv_switch (see: {{Bug|77360}})

The main purpose of the '''bootstrap''' script is to build (if necessary) the dmake utility used. Dmake once was a unix make-clone made by wticorp but got incorporated into OpenOffice since it was orphaned. For more information about dmake, it's history and manpage have a look here: http://tools.openoffice.org/dmake/index.html

Sourcing MacOSXPPCEnv.Set.sh is very important not only for building but also for '''running''' svdem later on. Here all the Environment-Variables for the Build will be set up. For a detailed description see [[Environment_Variables]]. Please note that on Intel machines, 'MacOSXPPCEnv.Set.sh' should be substituted with 'MacOSXX86Env.Set.sh'.

This Build process takes on my box (Dual 1.8 GHz G5, 1.5GB RAM) roughly 10 hours, and 3 to 6 hours on Mac Intel (3:30h on a 2GHz DualCore INTEL iMac). Be patient.

If you want to see how the progress on that build is you can use two '''build''' options to get a comfortable view:

build ... <see above> ... --html --html_path /Users/$USER/Sites

where $USER is your user name. Then you can load in Firefox (not Safari!) the HTML file '''unxmacxi.pro.build.html''' via the in Mac OS X included Apache web server or diretctly form the directory ''/Users/$USER/Sites/''. This file is automatically being updated and is showing the status of the build and also the time needed since the build started.

If you build on Snow Leopard (aka Mac OS X 10.6): Set DYLD_INSERT_LIBRARIES to point to the correct libsqlite3.dylib:
<pre>
DYLD_INSERT_LIBRARIES=/usr/lib/libsqlite3.dylib
</pre>

== '''Installing, preparing and running OpenOffice.org''' ==

===''' Find the Bundle''' ===

Once the build completed, the final product ( en-US version ) is named : OOo_3.0.0_*_MacOSXIntel_install.dmg ( for version 3.0beta e.g.)

And is located in instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US directory ( replace en-US with your locale )

[[Image:Bundle_Location3.0beta.jpg]]

=== '''Install the new Build''' ===

* double click on the *.dmg icon
* drag the OpenOffice.org icon into a folder of your choice

=== '''Run the new Build''' ===

* double click the application icon in that folder

=== '''Screenshots''' ===

Now you can start to work with this [[Aqua_Screenshots | amazing productivity suite]].

== '''Contribute by finding, isolating, debugging or solving issues''' ==

=== '''Isolate a problem''' ===

==== '''Reduce a problem''' ====

* make a problem reproducable
* reduce it to a test case that is as small and simple as possible
* if a problem is specific to a document then please attach it to the issue. A mininal excerpt of the document that still shows the problem is even better.
* a screenshot of is a good idea if it clearly shows the problem

==== '''Using application switches''' ====

Application switches are often valuable for isolating a problem. Most of OpenOffice.org's options can be found its Tools->Options menu.
<br><br>
Some switches are so special that there is no user interface to change them. They are only useful for debugging and isolating a problem, but they are very valuable a that. So a developer might suggest to isolate a problem by setting an environment variable before running the application. E.g. for isolating problems with the menubar a developer might suggest to set the environment variable [[AQUA_NATIVE_MENUS]] to false. This is done by typing these commands into a terminal:
* cd <INSTALL_DIR>/OpenOffice.org/Contents/MacOS
* export AQUA_NATIVE_MENUS=false
* ./soffice.bin

==== '''Provide a call stack for crash problems''' ====

Please note that bugs involving crashes should provide a description of how to reproduce the problem and a callstack.
There are several ways to provide the callstack:
* the preferred method is to use OOo"s builtin [[CrashReporting|crash reporting tool]]
* developers may provide a [[Providing_a_gdb_backtrace | gdb backtrace]] of the problem
* if the above two methods don"t work then please attach a file with the details provided by the AppleCrashReporter

=== '''Check against known issues''' ===

Check the list of [http://www.openoffice.org/issues/buglist.cgi?issue_status=UNCONFIRMED&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&email1=&emailtype1=exact&emailassigned_to1=1&email2=&emailtype2=exact&emailreporter2=1&issueidtype=include&issue_id=&changedin=&votes=&chfieldfrom=&chfieldto=&chfieldvalue=&short_desc=&short_desc_type=fulltext&long_desc=&long_desc_type=fulltext&issue_file_loc=&issue_file_loc_type=fulltext&status_whiteboard=&status_whiteboard_type=fulltext&keywords=aqua&keywords_type=anytokens&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time&Submit+query=Submit+query open issues]

=== '''Report a new issue''' ===

Report [http://qa.openoffice.org/issue_handling/pre_submission.html new issues] after you have [[AquaBuild#Isolate_a_problem | isolated the problem]]

=== '''Debug a problem''' ===

Debugging problems is often easier in an development environment:
<ul>
<li>With XCode: [[MacOSX_Debug_OpenOffice.org_using_XCode]]</li>
<li>With Xemacs: [http://www.mikesicotte.com/2007/02/21/debugging-ooo-with-xemacs-and-gdb Michael Sicotte's blog entry]</li>
</ul>

Please note that XCode still has some problems with the executable named soffice.bin (because of the dot in the name). The issue has been reported to xcode-users list.

== '''Current Work in progress (Aqua specific work only)''' ==

With OOO300 the Aqua port became a mainstream port, so most Aqua issues are handled in regular GSL-Layer childworkspaces instead of dedicated Aqua CWSses. Other CWSses that are purely Aqua specific are being tracked below:

* '''{{CWS|ogltrans4mac|DEV300}}''' : Implement the 3D (OpenGL) transitions in Impress ( see : [[Mac_OS_X_Porting_-_OpenGL_transitions| OpenGL transitions on Mac OS X ]] )

==='''Child WorkSpaces in development''' ===

* '''{{CWS|appleremote03|DEV300}}''' : use the contextual menu in presentation mode with Impress. preliminary step

* '''{{CWS|hotmac|OOO300}}''' : fix memory deallocation problems in exit()

* '''{{CWS|macosxscanner01|DEV300}}''' (planned)

All patches that developers have that need testing or peer review should be added here.

==='''Child WorkSpaces in testing (closed for development)''' ===

*'''{{CWS|macmiscfixes}}''' : misc fixes for mac

*'''{{CWS|maccrashrep}}''' : support crash reporting for OSX builds

*'''{{CWS|quicklookplugin01}}''' : a plugin for the QuickLook system available in MacOSX from versions 10.5 onwards

==='''Child WorkSpaces waiting for integration''' ===

* '''{{CWS|appleremote02|DEV300}}''' : improve the Apple Remote use with Impress (use MEDIA_COMMAND stuff, improve code robustness, and portability )

==='''Child Workspaces integrated into OpenOffice's trunk''' ===

A historical overview of [[Aqua_Integrated_CWS | old Aqua specific ChildWorkspaces]].

== '''Known build issues '''==
*'''Tiger''': no known issues
*'''Leopard''': no known issues
*'''Snow Leopard''': no known issues
*'''Lion''': no known issues
*'''Mountain Lion''': no known issues

<div align="left" style="color:grey; font-size:12px">[[AquaBuild/Some Background | '''Some Background (what is a CWS, EIS) (click me to know more) ''']]</div>

== '''External links''' ==
* [https://issues.apache.org/ooo Apache OpenOffice Issuezilla] : a database of bugs, changes and enhancements
* There are [[MacOSXPortMeetings | regular meetings]] on IRC (archives are [[Previous_Mac_Meeting_logs | available]]).
* Apache OpenOffice has a complicated code base. [[Source_code_directories | Here]] is an overview.
* the official Apache OpenOffice blog is at [https://blogs.apache.org/OOo/]
* [http://www.cocoadev.com Cocoadev] provides great resources to get up to speed in Cocoa development
* Pierre Chatelier's excellent [http://ktd.club.fr/programmation/objective-c.php Objective C for C++ developers] is available in both english and french versions
* Details about OSX's [http://developer.apple.com/cocoa Cocoa API] are available in the XCode documentation

[[Category:Aqua]]
[[Category:Build_System]]

Python

2013-09-09T09:53:51Z

Hdu: replace OOo with AOO (or OpenOffice)

{{Extensions}}
[[image:Py-uno_128.png|PyUNO Logo]] [[image:Pyuno_logo_a.jpg]]

=== Python and OpenOffice ===
Apache OpenOffice 4 ships with the Python scripting language, version 2.7. OpenOffice.org 3.1 and above shipped with Python version 2.6.1 and older OpenOffice.org releases shipped with Python version 2.3.4. This Python distribution via OpenOffice comes with the [[Uno]] module, which connects the [[API|UNO API]] to the python scripting language. To run this version of Python on Linux, you can go directly to the OpenOffice PATH. And as one would expect with any distribution of Python, AOO-Python can be run from the command line as well.

If you already have a separate Python installation, you can import the uno module (the Python-UNO bridge) to it using [http://forum.openoffice.org/en/forum/viewtopic.php?f=45&t=36370&p=166783 these instructions].

If you already have a different version of Python installed on Windows, you can also access the [[API|UNO API]] using the [http://forum.openoffice.org//en/forum/viewtopic.php?f=45&t=36608&p=167909 COM bridge] instead of the Python bridge. Requires the [http://sourceforge.net/projects/pywin32/ add-on pywin32] module so Python can talk to COM. Note that while the UNO API is uniform, the implementation by the two bridges is slightly different, so the syntax required by each is also sometimes different.

==== Where is the IDE ? ====
OpenOffice's IDE doesn't support Python, so development has to be done from another editor that does. Any volunteer for a binding is welcomed. Here is a nice [http://pythonconquerstheuniverse.wordpress.com/category/the-python-debugger/ blog post] about using [http://www.vim.org VIM] a common Unix/Linux text editor configured in a way that acts like an IDE. Windows users can use [http://www.vim.org/download.php#pc Gvim] and [http://macvim.org/ MacVim] for OSX users.

==== Tips & Tricks ====

Here is some useful information about using python in AOO.

===== Debug output =====

If you launch a python script, any error will silently break the execution, making your extension hard to debug. To change this behaviour, one can change the
'''LogLevel'''
.

Have a look in
''/path/to/aoo/program/'''pythonscript.py'''''
and replace
''LogLevel.use = LogLevel.'''NONE'''''
with
''LogLevel.use = LogLevel.'''DEBUG'''''
.

There are also currently-undocumented environment variables that tell the pyUno bridge to log every call. Set the environment variable
''export PYUNO_LOGLEVEL=ARGS''
. The output may be a little hard to read, but helpful nonetheless.

Note that his applies only to Linux. For Windows, you need some more switches, and the output gets written to files (there is no stdout on windows :-( ).

There are still some error messages that won't appear in these logs; this will improve in the near future (cws pyunofixes4). Once the cws is integrated, I will document these switches on the official pyuno site.

''Thanks to Joerg Budischewski''
.

=== Python specific information for Extension creation ===
To create extensions for python, it is important that you have enough familiarity with the UNO components, as well as with packaging your code for easy distribution through the ''OpenOffice package manager''. Please check the tutorials to learn how to component-ize your code, and how to deploy remote scripting through a service implementation.

To learn to run Python on Windows, visit [[Using Python on Windows| this link]] for more detailed information.

{| align="center" cellspacing="0" cellpadding="0" style="border: 0px solid rgb(134, 194, 230);"
|- valign="top"
| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(134, 194, 230) rgb(134, 194, 230) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">Getting Started</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
*[[Python/Python_Language_Binding|Python Language Binding]]
*[[Python/Python_Loader|Python Loader]]
*[[Using Python on Windows]] - New to Python? Learn how to use python on Windows
*[[Using Python on Linux]] - A must read for an overview on Python and AOO relations
* [[pyUNO bridge]] - Official page of the PyUNO bridge at the [http://udk.openoffice.org/ UDK site] - ([http://www.fatcow.com/edu/mathtex-be/ ''Belorussian translation''])
* [[Python as a macro language]] in OpenOffice.org 2.x - How to use the Python scripting framework
* [[Python/Transfer_from_Basic_to_Python|Transfer from Basic to Python]]
* [http://lucasmanual.com/mywiki/OpenOffice PyUNO Manual] Lukasz created a pyUNO manual. '''new'''
* [[SQLAlquemyPyUNO|SQLAlchemy and PyUNO]] connecting OpenOffice to any database
* [http://www.linuxjournal.com/content/starting-stopping-and-connecting-openoffice-python Starting/Stopping and connecting using Python] From Linux Journal
* Introduction on testing pyUNO programs with [[doctests]]
* Create a [[PythonDialogBox|dialog box]] in PyUNO.
* [[http://codesnippets.services.openoffice.org/Office/Office.ConnectViaPipe.snip Connect to Openoffice] from PyUNO
* [[PyUNO samples]] currently shipping with OpenOffice.org and the explanation.
* Enhanced [http://www.oooforum.org/forum/viewtopic.phtml?p=257496#257496 Capitalized.py] script by ''The gray Cardinal'' at the OpenOffice forum.

| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(134, 194, 230) rgb(134, 194, 230) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">PYUNO Modules</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
*[[Danny's Python Modules]] - Collection guide from DannyB's modules.
*[[PrinttoWriter.py]] - This makes it easy and convenient to print a bunch of text into a Writer document.
*[http://www.oooforum.org/forum/viewtopic.phtml?t=8456 Developing Calc Functions in Python] - Learn how Python can be used to script your spreadsheets
*[http://www.oooforum.org/forum/viewtopic.phtml?p=56037#56037 Generating a Spreadsheet through Python] - Automatically generate new spreadsheets
*[http://www.oooforum.org/forum/viewtopic.phtml?t=9115 Python container components]
*[[PyUNOServer]] - The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc
*[[calcParser]] - calcParser is a small parser using the native SAX utilities within the OpenOffice.org python
*[[OoConfig]] - OoConfig is a Python extension that seeks to provide a configuration editing facility similar to Mozilla's about:config
*[[Bibliographic/Hints and Tips/OOoRISExport.py|OOoRISExport.py]] - Exports the bibliographic database in RIS format. Also [http://bibliographic.openoffice.org/files/documents/124/3078/RISImport.py RISImport.py]
*[[Zotero_Plugin |Zotero Plugin]] - The Zotero plugin provides citation and bibliographic table insertion and editing functions for Writer documents.
*[http://oosheet.hacklab.com.br/ OOSheet] - High level python library to develop spreadsheet macros without the complexity of Uno. Focuses on spreadsheets, but may be useful for other documents.
|}

=== Hacking Around ===
*[[UNO component packaging]] - How to create UNO components as well as the basics of script componentizing
*[http://www.oooforum.org/forum/viewtopic.phtml?p=38234#38234 Python component to parse XML] - Python is great to parse XML, PyUNO is also excellent when working with XML
*[[Example of Service in Python]] - Learn how to run Python as a service, this is useful for remote scripting.
*[http://www.oooforum.org/forum/viewtopic.phtml?p=76972#76972 Modify spreadsheet] - Example of storing and retrieving a custom attribute on a spreadsheet cell.
*A simple [[daemon in Python]] - Learn how to run Python as a daemon
*[[Loook.py]] - a simple Python tool that searches for text strings in OpenOffice.org.
*[[odt2txt.py]] - convert ODF to plain text using python (and convert the txt to html).

=== Python rules OpenOffice (by B. Bois) ===
[[image:python_power_for_OOo.png|Python rules OpenOffice :-)]]

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

Python

2013-09-09T09:48:46Z

Hdu: updated for Apache OpenOffice

{{Extensions}}
[[image:Py-uno_128.png|PyUNO Logo]] [[image:Pyuno_logo_a.jpg]]

=== Python and OpenOffice ===
Apache OpenOffice 4 ships with the Python scripting language, version 2.7. OpenOffice.org 3.1 and above shipped with Python version 2.6.1 and older OpenOffice.org releases shipped with Python version 2.3.4. This Python distribution via OpenOffice comes with the [[Uno]] module, which connects the [[API|UNO API]] to the python scripting language. To run this version of Python on Linux, you can go directly to the OpenOffice PATH. And as one would expect with any distribution of Python, OOo-Python can be run from the command line as well.

If you already have a separate Python installation, you can import the uno module (the Python-UNO bridge) to it using [http://forum.openoffice.org/en/forum/viewtopic.php?f=45&t=36370&p=166783 these instructions].

If you already have a different version of Python installed on Windows, you can also access the [[API|UNO API]] using the [http://forum.openoffice.org//en/forum/viewtopic.php?f=45&t=36608&p=167909 COM bridge] instead of the Python bridge. Requires the [http://sourceforge.net/projects/pywin32/ add-on pywin32] module so Python can talk to COM. Note that while the UNO API is uniform, the implementation by the two bridges is slightly different, so the syntax required by each is also sometimes different.

==== Where is the IDE ? ====
OpenOffice's IDE doesn't support Python, so development has to be done from another editor that does. Any volunteer for a binding is welcomed. Here is a nice [http://pythonconquerstheuniverse.wordpress.com/category/the-python-debugger/ blog post] about using [http://www.vim.org VIM] a common Unix/Linux text editor configured in a way that acts like an IDE. Windows users can use [http://www.vim.org/download.php#pc Gvim] and [http://macvim.org/ MacVim] for OSX users.

==== Tips & Tricks ====

Here is some useful information about using python in OOo.

===== Debug output =====

If you launch a python script, any error will silently break the execution, making your extension hard to debug. To change this behaviour, one can change the
'''LogLevel'''
.

Have a look in
''/path/to/ooo/program/'''pythonscript.py'''''
and replace
''LogLevel.use = LogLevel.'''NONE'''''
with
''LogLevel.use = LogLevel.'''DEBUG'''''
.

There are also currently-undocumented environment variables that tell the pyUno bridge to log every call. Set the environment variable
''export PYUNO_LOGLEVEL=ARGS''
. The output may be a little hard to read, but helpful nonetheless.

Note that his applies only to Linux. For Windows, you need some more switches, and the output gets written to files (there is no stdout on windows :-( ).

There are still some error messages that won't appear in these logs; this will improve in the near future (cws pyunofixes4). Once the cws is integrated, I will document these switches on the official pyuno site.

''Thanks to Joerg Budischewski''
.

=== Python specific information for Extension creation ===
To create extensions for python, it is important that you have enough familiarity with the UNO components, as well as with packaging your code for easy distribution through the ''OpenOffice package manager''. Please check the tutorials to learn how to component-ize your code, and how to deploy remote scripting through a service implementation.

To learn to run Python on Windows, visit [[Using Python on Windows| this link]] for more detailed information.

{| align="center" cellspacing="0" cellpadding="0" style="border: 0px solid rgb(134, 194, 230);"
|- valign="top"
| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(134, 194, 230) rgb(134, 194, 230) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">Getting Started</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
*[[Python/Python_Language_Binding|Python Language Binding]]
*[[Python/Python_Loader|Python Loader]]
*[[Using Python on Windows]] - New to Python? Learn how to use python on Windows
*[[Using Python on Linux]] - A must read for an overview on Python and OOo relations
* [[pyUNO bridge]] - Official page of the PyUNO bridge at the [http://udk.openoffice.org/ UDK site] - ([http://www.fatcow.com/edu/mathtex-be/ ''Belorussian translation''])
* [[Python as a macro language]] in OpenOffice.org 2.x - How to use the Python scripting framework
* [[Python/Transfer_from_Basic_to_Python|Transfer from Basic to Python]]
* [http://lucasmanual.com/mywiki/OpenOffice PyUNO Manual] Lukasz created a pyUNO manual. '''new'''
* [[SQLAlquemyPyUNO|SQLAlchemy and PyUNO]] connecting OpenOffice to any database
* [http://www.linuxjournal.com/content/starting-stopping-and-connecting-openoffice-python Starting/Stopping and connecting using Python] From Linux Journal
* Introduction on testing pyUNO programs with [[doctests]]
* Create a [[PythonDialogBox|dialog box]] in PyUNO.
* [[http://codesnippets.services.openoffice.org/Office/Office.ConnectViaPipe.snip Connect to Openoffice] from PyUNO
* [[PyUNO samples]] currently shipping with OpenOffice.org and the explanation.
* Enhanced [http://www.oooforum.org/forum/viewtopic.phtml?p=257496#257496 Capitalized.py] script by ''The gray Cardinal'' at OOoforum.

| style="width: 35%; padding-right: 15px;" | <div style="border-style: solid solid none; border-color: rgb(134, 194, 230) rgb(134, 194, 230) -moz-use-text-color; border-width: 1px 1px medium; padding: 5px; font-size: 120%; font-weight: bold; background-color: rgb(203, 222, 250);">PYUNO Modules</div> <div style="border: 1px solid rgb(155, 192, 245); padding: 5px 5px 10px;">
*[[Danny's Python Modules]] - Collection guide from DannyB's modules.
*[[PrinttoWriter.py]] - This makes it easy and convenient to print a bunch of text into a Writer document.
*[http://www.oooforum.org/forum/viewtopic.phtml?t=8456 Developing Calc Functions in Python] - Learn how Python can be used to script your spreadsheets
*[http://www.oooforum.org/forum/viewtopic.phtml?p=56037#56037 Generating a Spreadsheet through Python] - Automatically generate new spreadsheets
*[http://www.oooforum.org/forum/viewtopic.phtml?t=9115 Python container components]
*[[PyUNOServer]] - The PyUNOServer is a script that works as an XML server for OpenOffice.org Calc
*[[calcParser]] - calcParser is a small parser using the native SAX utilities within the OpenOffice.org python
*[[OoConfig]] - OoConfig is a Python extension that seeks to provide a configuration editing facility similar to Mozilla's about:config
*[[Bibliographic/Hints and Tips/OOoRISExport.py|OOoRISExport.py]] - Exports the bibliographic database in RIS format. Also [http://bibliographic.openoffice.org/files/documents/124/3078/RISImport.py RISImport.py]
*[[Zotero_Plugin |Zotero Plugin]] - The Zotero plugin provides citation and bibliographic table insertion and editing functions for Writer documents.
*[http://oosheet.hacklab.com.br/ OOSheet] - High level python library to develop spreadsheet macros without the complexity of Uno. Focuses on spreadsheets, but may be useful for other documents.
|}

=== Hacking Around ===
*[[UNO component packaging]] - How to create UNO components as well as the basics of script componentizing
*[http://www.oooforum.org/forum/viewtopic.phtml?p=38234#38234 Python component to parse XML] - Python is great to parse XML, PyUNO is also excellent when working with XML
*[[Example of Service in Python]] - Learn how to run Python as a service, this is useful for remote scripting.
*[http://www.oooforum.org/forum/viewtopic.phtml?p=76972#76972 Modify spreadsheet] - Example of storing and retrieving a custom attribute on a spreadsheet cell.
*A simple [[daemon in Python]] - Learn how to run Python as a daemon
*[[Loook.py]] - a simple Python tool that searches for text strings in OpenOffice.org.
*[[odt2txt.py]] - convert ODF to plain text using python (and convert the txt to html).

=== Python rules OOo (by B. Bois) ===
[[image:python_power_for_OOo.png|Python rules OOo :-)]]

[[Category:Extensions]]
[[Category:Python]]
[[Category:Uno]]

QA/test automation guide

2013-08-28T07:15:40Z

Hdu: /* Run testing */

{{DISPLAYTITLE: Getting Started with Test Automation}}
[[Category: Quality Assurance]]
[[Category: TestAutomation]]

== Introduction ==

Two kind of approaches is supported by Apache OpenOffice.
*GUI Testing: Simulating a common user to perform testing. It depends on a Java library named VCLAuto, which does testing like the old [[VCLTesttool]]. It can easily integrates with JUnit. VCLAuto provides APIs to generate user interface events such as keystrokes and mouse clicks, do GUI actions and get information from the GUI to validate functions.
*UNO API Testing: Use UNO API to verify functions.

== Notice ==
There are some reasons for test failures, so please [[QA/test_env|prepare your testing machine]] before running test.

== Getting the source code ==
Anyone can checkout source code from our Subversion repository. Run the following command.
<source lang="bash">
svn co https://svn.apache.org/repos/asf/openoffice/trunk/test/ test
</source>
If you are not familiar with Subversion, see our [http://openoffice.apache.org/svn-basics.html Subversion Basics] for more information.

== Getting started with Eclipse ==
=== Prerequisites ===
*Eclipse Java IDE: [http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/junor Eclipse Juno(4.2) IDE for Java Developers] or above.<br />
*Apache OpenOffice

=== Setup project ===
'''Step 1.''' Open Eclipse, click menu "File->Import...", and then select "General->Existing Projects into Workspace".<br />
[[File:test_automation_guide_1.png]]<br />
'''Step 2.''' Click next, set "Select root directory" to the source code directory, and then check the following projects.<br />
'''testcommon''': The project includes the common test utilities and low-level implementation to do GUI testing
'''testgui''': The project includes the GUI testing scripts.
'''testuno''': The project includes the UNO API testing scripts.
[[File:test_automation_guide_2.png]]<br />
'''Step 3.''' Click "Finish" to import the projects.

'''Step 4.''' Click menu "Window->Preferences" ("Eclipse->Preferences" on Mac) and then select "Java->Build Path->Classpath Variables" page.<br />
[[File:test_automation_guide_10.png]]<br />
Click "New" to create one new variable "'''openoffice.home'''", and set its value to Apache OpenOffice installation directory.<br />
[[File:test_automation_guide_11.png]]<br />
{{Template:Documentation/Note| '''The default installation directory of Apache OpenOffice'''<br />
Mac OS X: "''/Applications/OpenOffice.org.app/Contents"''<br />
Linux: "''/opt/openoffice.org3''"<br />
Windows: "''C:/Program Files/OpenOffice.org 3''"<br />
Windows 64b: "''C:/Program Files (x86)/OpenOffice.org 3''"
}}
Click "OK" to close "New Variable Entry"dialog. Then click "OK" button of preferences dialog. A message box pops up. Click "Yes".<br />
[[File:test_automation_guide_12.png]]<br />
=== Run testing ===
'''Step 1.''' Select one test class. e.g. testcase.gui.AOOTest, and then click "Run" on the toolbar to start testing. <br />
[[File:test_automation_guide_13.png]]<br />
When testing is finished, JUnit view will show the result.<br />
[[File:test_automation_guide_14.png]]<br />
You also can select one package, click "Run", and then choose "JUnit test" to run all test classes under it.

== Getting started with command line ==

=== Prerequisites ===
*JDK: [http://java.sun.com/j2se/1.5/ JDK 1.5], [http://java.sun.com/javase/6/ JDK 1.6] or above.<br />
*Ant: [http://ant.apache.org/bindownload.cgi Apache Ant 1.8.2] or above.
*JUnit: [https://github.com/KentBeck/junit/downloads JUnit 4.10] or above. For lazy people, if internet is available, it can be automatically installed during testing.

=== Run testing ===
'''As a developer, how to run testing against an OpenOffice built by me?''' <br />
It's easy for developers to run testing after building OpenOffice. One thing you need to do is to make sure you run the commands in the build environment. The script will automatically install your build and then start testing. e.g.
<source lang="bash">
cd main
source MacOSXX86Env.Set.sh
cd ../test && ant
</source>

'''As a normal user, how to run testing against an installed OpenOffice?'''<br />
Firstly compile the project with the command under test module.
<source lang="bash">
ant -Dopenoffice.home="OpenOffice installation directory" compile
</source>
Then start testing with the command "run".
e.g. Run all test classes under package bvt ("Build Verification Testing")
<source lang="bash">
run -Dopenoffice.home="/Applications/OpenOffice.app/Contents" -tp bvt
</source>
e.g. Run the given test classes
<source lang="bash">
run -Dopenoffice.home="/Applications/OpenOffice.app/Contents" -tc bvt.gui.BasicFunctionTest
</source>
On Linux use e.g. -Dopenoffice.home="/opt/openoffice4/program" instead.

''' Where to get the testing result? '''

By default, the testing output is stored in "test/testspace/output***". Open "test/testspace/output/result.html" in your browser to see the testing report.<br />
[[File:test_automation_report.png]]<br />

Special stuff in the output directory.
result.xml: Test result in HTML.
result.html: Test result in XML.
screenshot/: Screenshot pictures when test assert is failed.

== Next ==
Now, all things have been ready for developing new test code. If you are interested, please read [[QA/dev_gui_testing|GUI Testing Development]] and [[QA/dev_api_testing|UNO API Testing Development]] to get more information.

QA/test automation guide

2013-08-27T08:03:16Z

Hdu: /* Run testing */ OpenOffice.org.app has been renamed to OpenOffice.app

{{DISPLAYTITLE: Getting Started with Test Automation}}
[[Category: Quality Assurance]]
[[Category: TestAutomation]]

== Introduction ==

Two kind of approaches is supported by Apache OpenOffice.
*GUI Testing: Simulating a common user to perform testing. It depends on a Java library named VCLAuto, which does testing like the old [[VCLTesttool]]. It can easily integrates with JUnit. VCLAuto provides APIs to generate user interface events such as keystrokes and mouse clicks, do GUI actions and get information from the GUI to validate functions.
*UNO API Testing: Use UNO API to verify functions.

== Notice ==
There are some reasons for test failures, so please [[QA/test_env|prepare your testing machine]] before running test.

== Getting the source code ==
Anyone can checkout source code from our Subversion repository. Run the following command.
<source lang="bash">
svn co https://svn.apache.org/repos/asf/openoffice/trunk/test/ test
</source>
If you are not familiar with Subversion, see our [http://openoffice.apache.org/svn-basics.html Subversion Basics] for more information.

== Getting started with Eclipse ==
=== Prerequisites ===
*Eclipse Java IDE: [http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/junor Eclipse Juno(4.2) IDE for Java Developers] or above.<br />
*Apache OpenOffice

=== Setup project ===
'''Step 1.''' Open Eclipse, click menu "File->Import...", and then select "General->Existing Projects into Workspace".<br />
[[File:test_automation_guide_1.png]]<br />
'''Step 2.''' Click next, set "Select root directory" to the source code directory, and then check the following projects.<br />
'''testcommon''': The project includes the common test utilities and low-level implementation to do GUI testing
'''testgui''': The project includes the GUI testing scripts.
'''testuno''': The project includes the UNO API testing scripts.
[[File:test_automation_guide_2.png]]<br />
'''Step 3.''' Click "Finish" to import the projects.

'''Step 4.''' Click menu "Window->Preferences" ("Eclipse->Preferences" on Mac) and then select "Java->Build Path->Classpath Variables" page.<br />
[[File:test_automation_guide_10.png]]<br />
Click "New" to create one new variable "'''openoffice.home'''", and set its value to Apache OpenOffice installation directory.<br />
[[File:test_automation_guide_11.png]]<br />
{{Template:Documentation/Note| '''The default installation directory of Apache OpenOffice'''<br />
Mac OS X: "''/Applications/OpenOffice.org.app/Contents"''<br />
Linux: "''/opt/openoffice.org3''"<br />
Windows: "''C:/Program Files/OpenOffice.org 3''"<br />
Windows 64b: "''C:/Program Files (x86)/OpenOffice.org 3''"
}}
Click "OK" to close "New Variable Entry"dialog. Then click "OK" button of preferences dialog. A message box pops up. Click "Yes".<br />
[[File:test_automation_guide_12.png]]<br />
=== Run testing ===
'''Step 1.''' Select one test class. e.g. testcase.gui.AOOTest, and then click "Run" on the toolbar to start testing. <br />
[[File:test_automation_guide_13.png]]<br />
When testing is finished, JUnit view will show the result.<br />
[[File:test_automation_guide_14.png]]<br />
You also can select one package, click "Run", and then choose "JUnit test" to run all test classes under it.

== Getting started with command line ==

=== Prerequisites ===
*JDK: [http://java.sun.com/j2se/1.5/ JDK 1.5], [http://java.sun.com/javase/6/ JDK 1.6] or above.<br />
*Ant: [http://ant.apache.org/bindownload.cgi Apache Ant 1.8.2] or above.
*JUnit: [https://github.com/KentBeck/junit/downloads JUnit 4.10] or above. For lazy people, if internet is available, it can be automatically installed during testing.

=== Run testing ===
'''As a developer, how to run testing against an OpenOffice built by me?''' <br />
It's easy for developers to run testing after building OpenOffice. One thing you need to do is to make sure you run the commands in the build environment. The script will automatically install your build and then start testing. e.g.
<source lang="bash">
cd main
source MacOSXX86Env.Set.sh
cd ../test && ant
</source>

'''As a normal user, how to run testing against an installed OpenOffice?'''<br />
Firstly compile the project with the command under test module.
<source lang="bash">
ant -Dopenoffice.home="OpenOffice installation directory" compile
</source>
Then start testing with the command "run".
e.g. Run all test classes under package bvt
<source lang="bash">
run -Dopenoffice.home="/Applications/OpenOffice.app/Contents" -tp bvt
</source>
e.g. Run the given test classes
<source lang="bash">
run -Dopenoffice.home="/Applications/OpenOffice.app/Contents" -tc bvt.gui.BasicFunctionTest
</source>

''' Where to get the testing result? '''

By default, the testing output is stored in "test/testspace/output***". Open "test/testspace/output/result.html" in your browser to see the testing report.<br />
[[File:test_automation_report.png]]<br />

Special stuff in the output directory.
result.xml: Test result in HTML.
result.html: Test result in XML.
screenshot/: Screenshot pictures when test assert is failed.

== Next ==
Now, all things have been ready for developing new test code. If you are interested, please read [[QA/dev_gui_testing|GUI Testing Development]] and [[QA/dev_api_testing|UNO API Testing Development]] to get more information.

Documentation/Building Guide

2013-08-21T12:22:41Z

Hdu: move the pointer to the new page topmost to make this important detail show up in searches instead of "this page is obsolete"

{{Documentation/Building Guide TOC
|ShowPrevPage=none
|ShowNextPage=none
}}
{{DISPLAYTITLE:OpenOffice.org Building Guide}}
__NOTOC__

== Revised Building Guide: for '''Apache OpenOffice''' ==

'''Please Note: An updated version of the building guide, for Apache OpenOffice, can be found [[Documentation/Building_Guide_AOO|here]].'''

Also see additional building information for the release you are building on the
[https://cwiki.apache.org/confluence/display/OOOUSERS/Development+Snapshot+Builds Developer_Snapshot_Builds]
page on the planning wiki.

== Legacy Building Information ==

{{Historical}}

{{Download_Collection|MediaWiki:Books/OpenOffice.org_Building_Guide}}

=== Preface ===
Thank you for choosing to start building OpenOffice.org. It is a very interesting procedure and teaches you a lot about the source code and its structure.

This guide is the great first step if you are interested in modifying the source code, applying patches and fixes, or developing new features.

We hope that this document provides you with the information you need.

=== Getting help ===
If you experience problems on the way, please help us develop this guide!

# First subscribe to our dev mailing list by sending an empty email to dev-subscribe@openoffice.apache.org.
# Wait for a reply, respond to this email with an empty response.
# You get a WELCOME email saying you are now a subscriber.
# Send us a note at dev@openoffice.apache.org with your questions and problems.
# To unsubscribe from the list, send an empty email to dev-unsubscribe@openoffice.apache.org, wait for a reply, respond to this email, you get a GOODBYE email. You have now left the mailing list.

{{PDL1}}
[[Category:Education]][[Category:Development]][[Category:Porting]]

Source Code

2013-07-29T13:31:13Z

Hdu: /* Branches */ remove temporatbranch that is integrated in latest release

See [http://openoffice.apache.org/source.html] for general information about the Apache OpenOffice source code.

==Trunk==

The Apache OpenOffice source code that is currently under development is called trunk.

You can check out the trunk via SVN
svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo
or git
git svn clone https://svn.apache.org/repos/asf/openoffice/trunk aoo

==Branches==

Besides trunk there is a number of branches for development of features that may or may not be integrated into the next release:

URL is <code>https://svn.apache.org/repos/asf/openoffice/branches/<branch name></code>

{| class="prettytable"
|-
! branch name
! description
|-
|[http://svn.apache.org/viewvc/openoffice/branches/gbuild/ gbuild]
|Integration of a set of older child work spaces:
* ause131
* ause130
* writerfilter10
* gnumake4
* sd2gbuild
|-
| [http://svn.apache.org/viewvc/openoffice/branches/AOO400/ AOO400]
| The 4.0.x branch, would be used if we ever need a 4.0.x
|-
| [http://svn.apache.org/viewvc/openoffice/branches/alg/aw080 alg/aw080]
| Long running overhaul of the drawing layer.
|-
| [http://svn.apache.org/viewvc/openoffice/branches/l10n40/ l10n40]
| Branch to test new l10n tools (incl. makefile changes), will be merged back before next release
|-
| [http://svn.apache.org/viewvc/openoffice/branches/rejuvenate01/ rejuvenate01]
| Refresh the platform support (e.g. for Clang, compatibility with C++11, System STL, XCode 4, OSX 64bit, OSX 10.9)
|}

== Tags ==

Each tag marks an important SVN revision. Otherwise tags are similar to branches.

URL is <code>https://svn.apache.org/repos/asf/openoffice/tags/<tag name></code>

{| class="prettytable"
|-
! tag name
! description
|-
|[http://svn.apache.org/viewvc/openoffice/tags/AOO340/ AOO340]
|Release of Apache OpenOffice 3.4.0
|-
|[http://svn.apache.org/viewvc/openoffice/tags/AOO341/ AOO341]
|Release of Apache OpenOffice 3.4.1
|-
|[http://svn.apache.org/viewvc/openoffice/tags/AOO400/ AOO400]
|Release of Apache OpenOffice 4.0.0
|-
|[http://svn.apache.org/viewvc/openoffice/tags/SNAPSHOT SNAPSHOT]
|The latest snapshot. Changing.
|}

Source Code

2013-07-29T13:30:17Z

Hdu: AOO 4.0.0 tag

See [http://openoffice.apache.org/source.html] for general information about the Apache OpenOffice source code.

==Trunk==

The Apache OpenOffice source code that is currently under development is called trunk.

You can check out the trunk via SVN
svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo
or git
git svn clone https://svn.apache.org/repos/asf/openoffice/trunk aoo

==Branches==

Besides trunk there is a number of branches for development of features that may or may not be integrated into the next release:

URL is <code>https://svn.apache.org/repos/asf/openoffice/branches/<branch name></code>

{| class="prettytable"
|-
! branch name
! description
|-
|[http://svn.apache.org/viewvc/openoffice/branches/gbuild/ gbuild]
|Integration of a set of older child work spaces:
* ause131
* ause130
* writerfilter10
* gnumake4
* sd2gbuild
|-
| [http://svn.apache.org/viewvc/openoffice/branches/AOO400/ AOO400]
| The 4.0.x branch, would be used if we ever need a 4.0.x
|-
| [http://svn.apache.org/viewvc/openoffice/branches/alg/aw080 alg/aw080]
| Long running overhaul of the drawing layer.
|-
| [http://svn.apache.org/viewvc/openoffice/branches/writer001/ writer001]
| Already integrated into trunk.
|-
| [http://svn.apache.org/viewvc/openoffice/branches/l10n40/ l10n40]
| Branch to test new l10n tools (incl. makefile changes), will be merged back before next release
|-
| [http://svn.apache.org/viewvc/openoffice/branches/rejuvenate01/ rejuvenate01]
| Refresh the platform support (e.g. for Clang, compatibility with C++11, System STL, XCode 4, OSX 64bit, OSX 10.9)
|}

== Tags ==

Each tag marks an important SVN revision. Otherwise tags are similar to branches.

URL is <code>https://svn.apache.org/repos/asf/openoffice/tags/<tag name></code>

{| class="prettytable"
|-
! tag name
! description
|-
|[http://svn.apache.org/viewvc/openoffice/tags/AOO340/ AOO340]
|Release of Apache OpenOffice 3.4.0
|-
|[http://svn.apache.org/viewvc/openoffice/tags/AOO341/ AOO341]
|Release of Apache OpenOffice 3.4.1
|-
|[http://svn.apache.org/viewvc/openoffice/tags/AOO400/ AOO400]
|Release of Apache OpenOffice 4.0.0
|-
|[http://svn.apache.org/viewvc/openoffice/tags/SNAPSHOT SNAPSHOT]
|The latest snapshot. Changing.
|}

Source Code

2013-07-29T13:28:59Z

Hdu: mention rejuvenate01 branch

See [http://openoffice.apache.org/source.html] for general information about the Apache OpenOffice source code.

==Trunk==

The Apache OpenOffice source code that is currently under development is called trunk.

You can check out the trunk via SVN
svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo
or git
git svn clone https://svn.apache.org/repos/asf/openoffice/trunk aoo

==Branches==

Besides trunk there is a number of branches for development of features that may or may not be integrated into the next release:

URL is <code>https://svn.apache.org/repos/asf/openoffice/branches/<branch name></code>

{| class="prettytable"
|-
! branch name
! description
|-
|[http://svn.apache.org/viewvc/openoffice/branches/gbuild/ gbuild]
|Integration of a set of older child work spaces:
* ause131
* ause130
* writerfilter10
* gnumake4
* sd2gbuild
|-
| [http://svn.apache.org/viewvc/openoffice/branches/AOO400/ AOO400]
| The 4.0.x branch, would be used if we ever need a 4.0.x
|-
| [http://svn.apache.org/viewvc/openoffice/branches/alg/aw080 alg/aw080]
| Long running overhaul of the drawing layer.
|-
| [http://svn.apache.org/viewvc/openoffice/branches/writer001/ writer001]
| Already integrated into trunk.
|-
| [http://svn.apache.org/viewvc/openoffice/branches/l10n40/ l10n40]
| Branch to test new l10n tools (incl. makefile changes), will be merged back before next release
|-
| [http://svn.apache.org/viewvc/openoffice/branches/rejuvenate01/ rejuvenate01]
| Refresh the platform support (e.g. for Clang, compatibility with C++11, System STL, XCode 4, OSX 64bit, OSX 10.9)
|}

== Tags ==

Each tag marks an important SVN revision. Otherwise tags are similar to branches.

URL is <code>https://svn.apache.org/repos/asf/openoffice/tags/<tag name></code>

{| class="prettytable"
|-
! tag name
! description
|-
|[http://svn.apache.org/viewvc/openoffice/tags/AOO340/ AOO340]
|Release of Apache OpenOffice 3.4
|-
|[http://svn.apache.org/viewvc/openoffice/tags/AOO341/ AOO341]
|Release of Apache OpenOffice 3.4.1
|-
|[http://svn.apache.org/viewvc/openoffice/tags/SNAPSHOT SNAPSHOT]
|The latest snapshot. Changing.
|}

Source Code

2013-07-29T13:25:24Z

Hdu: updated for AOO400

See [http://openoffice.apache.org/source.html] for general information about the Apache OpenOffice source code.

==Trunk==

The Apache OpenOffice source code that is currently under development is called trunk.

You can check out the trunk via SVN
svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo
or git
git svn clone https://svn.apache.org/repos/asf/openoffice/trunk aoo

==Branches==

Besides trunk there is a number of branches for development of features that may or may not be integrated into the next release:

URL is <code>https://svn.apache.org/repos/asf/openoffice/branches/<branch name></code>

{| class="prettytable"
|-
! branch name
! description
|-
|[http://svn.apache.org/viewvc/openoffice/branches/gbuild/ gbuild]
|Integration of a set of older child work spaces:
* ause131
* ause130
* writerfilter10
* gnumake4
* sd2gbuild
|-
| [http://svn.apache.org/viewvc/openoffice/branches/AOO400/ AOO400]
| The 4.0.x branch, would be used if we ever need a 4.0.x
|-
| [http://svn.apache.org/viewvc/openoffice/branches/alg/aw080 alg/aw080]
| Long running overhaul of the drawing layer.
|-
| [http://svn.apache.org/viewvc/openoffice/branches/writer001/ writer001]
| Already integrated into trunk.
|-
| [http://svn.apache.org/viewvc/openoffice/branches/l10n40/ l10n40]
| Branch to test new l10n tools (incl. makefile changes), will be merged back before next release
|}

== Tags ==

Each tag marks an important SVN revision. Otherwise tags are similar to branches.

URL is <code>https://svn.apache.org/repos/asf/openoffice/tags/<tag name></code>

{| class="prettytable"
|-
! tag name
! description
|-
|[http://svn.apache.org/viewvc/openoffice/tags/AOO340/ AOO340]
|Release of Apache OpenOffice 3.4
|-
|[http://svn.apache.org/viewvc/openoffice/tags/AOO341/ AOO341]
|Release of Apache OpenOffice 3.4.1
|-
|[http://svn.apache.org/viewvc/openoffice/tags/SNAPSHOT SNAPSHOT]
|The latest snapshot. Changing.
|}

Platform Evolution

2013-07-17T07:43:48Z

Hdu: /* Libraries */ COIN description

OpenOffice has many dependencies on external technologies. If these external dependencies change then OpenOffice needs to adapt.

__TOC__

== Operating Systems ==
* [http://en.wikipedia.org/wiki/Microsoft_Windows Windows]
* [http://en.wikipedia.org/wiki/OS_X Mac OSX]
* [http://en.wikipedia.org/wiki/Linux Linux] / [http://en.wikipedia.org/wiki/Freebsd FreeBSD]
* [http://en.wikipedia.org/wiki/Solaris_%28operating_system%29 Solaris]
* [http://en.wikipedia.org/wiki/Os/2 OS/2]

== Programming Languages ==
* [http://en.wikipedia.org/wiki/C%2B%2B C++]
* [http://en.wikipedia.org/wiki/Java Java]
* [http://en.wikipedia.org/wiki/Perl Perl]
* [http://en.wikipedia.org/wiki/Python_(programming_language) Python]
* [http://en.wikipedia.org/wiki/Javascript JavaScript]
* [http://en.wikipedia.org/wiki/Visual_basic Visual Basic]

== Libraries ==
* [http://en.wikipedia.org/wiki/Standard_Template_Library standard template library]
* [http://en.wikipedia.org/wiki/Boost_%28C%2B%2B_libraries%29 boost]
* libraries for supporting security features
** [https://developer.mozilla.org/en-US/docs/NSS nss] (Network Security Services)
** [http://www.openssl.org openssl] (Secure Socket and Transport Layer)
** [http://www.aleksey.com/xmlsec/ xmlsec] (XML Security Library)
* libraries for supporting internationalization
** [http://www.icu-project.org ICU] (International Components for Unicode)
** [http://hunspell.sourceforge.net hunspell] (Spell Checker)
** hyphen (Hyphenation)
** mythes (Thesaurus)
** [http://graphite.sil.org graphite] (Rendering for Complex Scripts)
* graphics libraries
** [http://www.cairographics.org cairo]
** [http://hci.iwr.uni-heidelberg.de/vigra vigra] (Vision with Generic Algorithms)
* libraries for handling multimedia file formats
** [http://libjpeg.sourceforge.net libjpeg]
** [http://www.libpng.org/pub/png/libpng.html libpng]
** quicktime
** corevideo
** avmedia
* libraries for handling external document formats
** XML (Extensible Markup Language) processing
*** [http://www.xmlsoft.org libxml2] (XML Parser and Toolkit)
*** [http://www.xmlsoft.org/XSLT libxslt] (XSL Transformation)
*** [http://saxon.sourceforge.net saxon] (XSLT and XQuery Processor)
*** [http://expat.sourceforge.net expat] (XML Parser Library)
*** [http://xsltml.sourceforge.net xsltml] (XSLT Math Library)
** RDF (Resource Description Framework) support
*** [http://librdf.org redland] (General RDF support)
*** [http://librdf.org/raptor raptor] (RDF Parser Toolkit)
*** [http://librdf.org/rasqal rasqal] (RDF Query Processor)
* libraries for connectivity
** [http://curl.haxx.se/libcurl/ libcurl] (Multi-Protocol File Transfers)
** [http://code.google.com/p/serf/ serf] (Asynchronous HTTP Client)
** [http://hsqldb.org hsqldb] (HyperSQL Java DataBase)
** [http://www.seamonkey-project.org seamonkey] (for Address Book support)
* libraries for supporting different extension programming languages
** [http://www.python.org python] (Python Language)
** [https://developer.mozilla.org/en-US/docs/Rhino rhino] (for JavaScript)
** [http://www.java.org java] (Java Language)
** [http://tomcat.apache.org tomcat] (Java Application Server)
** [http://www.beanshell.org beanshell] (Java-like Scripting Language)
* other libraries
** [http://www.zlib.net zlib] (Compression Library)
** [https://projects.coin-or.org/CoinMP coinmp] (Common Optimization Interface: Operations Research Solver)
** [http://lucene.apache.org lucene] (Java-based indexing and search technology)
** [http://apr.apache.org apr/apr-util] (Apache Portable Runtime)
** [http://code.google.com/p/ucpp/ ucpp] (Source Preprocessor)
** [http://creadur.apache.org/rat/ Creadur] (Release Audit Tool)

== Standards ==
* the [http://www.opendocumentformat.org/ OpenDocument] standard
* the [http://www.w3.org/XML/ XML] standard
* the [https://en.wikipedia.org/wiki/HTML#Current_variations HTML] standards
* Microsoft binary document formats
* [http://en.wikipedia.org/wiki/Office_Open_XML Microsoft XML] document formats
* [http://www.unicode.org Unicode]
* [http://en.wikipedia.org/wiki/Opentype OpenType]
* Security standards
* [http://www.w3.org/TR/SVG Scalable Vector Graphics]
* [http://en.wikipedia.org/wiki/SQL Structured Query Language]
* [http://en.wikipedia.org/wiki/PostScript PostScript] language
* [http://en.wikipedia.org/wiki/Pdf PDF] format
* [http://en.wikipedia.org/wiki/JPEG JPEG] graphics
* [http://en.wikipedia.org/wiki/Portable_Network_Graphics PNG] graphics
* [http://en.wikipedia.org/wiki/Gif GIF] graphics

Platform Evolution

2013-07-10T08:43:40Z

Hdu: /* Libraries */ ucpp

OpenOffice has many dependencies on external technologies. If these external dependencies change then OpenOffice needs to adapt.

__TOC__

== Operating Systems ==
* [http://en.wikipedia.org/wiki/Microsoft_Windows Windows]
* [http://en.wikipedia.org/wiki/OS_X Mac OSX]
* [http://en.wikipedia.org/wiki/Linux Linux] / [http://en.wikipedia.org/wiki/Freebsd FreeBSD]
* [http://en.wikipedia.org/wiki/Solaris_%28operating_system%29 Solaris]
* [http://en.wikipedia.org/wiki/Os/2 OS/2]

== Programming Languages ==
* [http://en.wikipedia.org/wiki/C%2B%2B C++]
* [http://en.wikipedia.org/wiki/Java Java]
* [http://en.wikipedia.org/wiki/Perl Perl]
* [http://en.wikipedia.org/wiki/Python_(programming_language) Python]
* [http://en.wikipedia.org/wiki/Javascript JavaScript]
* [http://en.wikipedia.org/wiki/Visual_basic Visual Basic]

== Libraries ==
* [http://en.wikipedia.org/wiki/Standard_Template_Library standard template library]
* [http://en.wikipedia.org/wiki/Boost_%28C%2B%2B_libraries%29 boost]
* libraries for supporting security features
** [https://developer.mozilla.org/en-US/docs/NSS nss] (Network Security Services)
** [http://www.openssl.org openssl] (Secure Socket and Transport Layer)
** [http://www.aleksey.com/xmlsec/ xmlsec] (XML Security Library)
* libraries for supporting internationalization
** [http://www.icu-project.org ICU] (International Components for Unicode)
** [http://hunspell.sourceforge.net hunspell] (Spell Checker)
** hyphen (Hyphenation)
** mythes (Thesaurus)
** [http://graphite.sil.org graphite] (Rendering for Complex Scripts)
* graphics libraries
** [http://www.cairographics.org cairo]
** [http://hci.iwr.uni-heidelberg.de/vigra vigra] (Vision with Generic Algorithms)
* libraries for handling multimedia file formats
** [http://libjpeg.sourceforge.net libjpeg]
** [http://www.libpng.org/pub/png/libpng.html libpng]
** quicktime
** corevideo
** avmedia
* libraries for handling external document formats
** XML (Extensible Markup Language) processing
*** [http://www.xmlsoft.org libxml2] (XML Parser and Toolkit)
*** [http://www.xmlsoft.org/XSLT libxslt] (XSL Transformation)
*** [http://saxon.sourceforge.net saxon] (XSLT and XQuery Processor)
*** [http://expat.sourceforge.net expat] (XML Parser Library)
*** [http://xsltml.sourceforge.net xsltml] (XSLT Math Library)
** RDF (Resource Description Framework) support
*** [http://librdf.org redland] (General RDF support)
*** [http://librdf.org/raptor raptor] (RDF Parser Toolkit)
*** [http://librdf.org/rasqal rasqal] (RDF Query Processor)
* libraries for connectivity
** [http://curl.haxx.se/libcurl/ libcurl] (Multi-Protocol File Transfers)
** [http://code.google.com/p/serf/ serf] (Asynchronous HTTP Client)
** [http://hsqldb.org hsqldb] (HyperSQL Java DataBase)
** [http://www.seamonkey-project.org seamonkey] (for Address Book support)
* libraries for supporting different extension programming languages
** [http://www.python.org python] (Python Language)
** [https://developer.mozilla.org/en-US/docs/Rhino rhino] (for JavaScript)
** [http://www.java.org java] (Java Language)
** [http://tomcat.apache.org tomcat] (Java Application Server)
** [http://www.beanshell.org beanshell] (Java-like Scripting Language)
* other libraries
** [http://www.zlib.net zlib] (Compression Library)
** [https://projects.coin-or.org/CoinMP coinmp] (Operations Research Solver)
** [http://lucene.apache.org lucene] (Java-based indexing and search technology)
** [http://apr.apache.org apr/apr-util] (Apache Portable Runtime)
** [http://code.google.com/p/ucpp/ ucpp] (Source Preprocessor)
** [http://creadur.apache.org/rat/ Creadur] (Release Audit Tool)

== Standards ==
* the [http://www.opendocumentformat.org/ OpenDocument] standard
* the [http://www.w3.org/XML/ XML] standard
* the [https://en.wikipedia.org/wiki/HTML#Current_variations HTML] standards
* Microsoft binary document formats
* [http://en.wikipedia.org/wiki/Office_Open_XML Microsoft XML] document formats
* [http://www.unicode.org Unicode]
* [http://en.wikipedia.org/wiki/Opentype OpenType]
* Security standards
* [http://www.w3.org/TR/SVG Scalable Vector Graphics]
* [http://en.wikipedia.org/wiki/SQL Structured Query Language]
* [http://en.wikipedia.org/wiki/PostScript PostScript] language
* [http://en.wikipedia.org/wiki/Pdf PDF] format
* [http://en.wikipedia.org/wiki/JPEG JPEG] graphics
* [http://en.wikipedia.org/wiki/Portable_Network_Graphics PNG] graphics
* [http://en.wikipedia.org/wiki/Gif GIF] graphics