Apache OpenOffice Wiki - User contributions [en]

Documentation/Building Guide AOO/Step by step Linux

2025-04-25T05:12:47Z

Petko: update the build-script link to Github resource.

{{DISPLAYTITLE:Step by step building guide on Linux}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Linux. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This version limits itself to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step instructions for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]].

= Preparation of the development system =

Releases are built using CentOS and Fedora virtual machines.
However, any modern distribution should be able to build {{AOO}}.

This chapter lists some Linux distributions the developers have experience with. Select your distribution of choice and follow the corresponding chapter. When your system is ready, step to the [[#Obtain the source code|next chapter]].

==CentOS 5 for AOO 4.1.x==

CentOS 5 is our reference environment for build through the 4.1.x series. As it is a very old environment, it is '''not''' recommended to use it for your first build. But is important to document how to build on CentOS 5 since this is where the release through 4.1.x are built.

A 32-bit VM is used to build 32-bit releases. A 64-bit VM is used to build 64-bit releases.

===Setup a VM===

KVM given here as example:

* for the 64-bit distribution:
$ wget -O /tmp/CentOS-5-64.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/x86_64/CentOS-5.11-x86_64-netinstall.iso
$ fallocate -l 61440M /vms/centos5_64.img
$ sudo virt-install --boot cdrom --name centos5_64 --memory 8192 -f /vms/centos5_64.img --cdrom /tmp/CentOS-5-64.iso
* for the 32-bit distribution:
$ wget -O /tmp/CentOS-5-32.iso http://mirror.nsc.liu.se/centos-store/5.11/isos/i386/CentOS-5.11-i386-netinstall.iso
$ fallocate -l 61440M /vms/centos5_32.img
$ sudo virt-install --boot cdrom --name centos5_32 --memory 8192 -f /vms/centos5_32.img --cdrom /tmp/CentOS-5-32.iso

* Install the system; installation will start with the above command and use the following values when asked:
** Installation method: HTTP with website <code>mirror.nsc.liu.se</code> and CentOS directory:
*** 64 bit: <code>/centos-store/5.11/os/x86_64</code>
*** 32 bit: <code>/centos-store/5.11/os/i386</code>
** Partitioning: do '''not''' follow the automatic procedure, but rather assign 60000M to /, rest swap (you will need ~55 GBytes for a full build with all languages and langpacks)
** Setup Base system only
* Reboot the VM and configure it
** You'll probably want a non-root user with sudo access and you may want to disable some services.
** You'll need to point URLs to vault: <code>sudo vim /etc/yum.repos.d/CentOS-Base.repo</code> and in the enabled repositories comment out mirrorlist and add (respectively):
*** 64 bit: <code>baseurl=http://vault.centos.org/5.11/os/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/x86_64/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/x86_64/</code>
*** 32 bit: <code>baseurl=http://vault.centos.org/5.11/os/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/updates/i386/</code>, <code>baseurl=http://vault.centos.org/5.11/extras/i386/</code>
** <code>$ sudo yum update -y</code>
** <code>$ sudo reboot</code>

Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory.

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs):

$ wget http://archives.fedoraproject.org/pub/archive/epel/5/i386/epel-release-5-4.noarch.rpm
$ sudo rpm -ivh epel-release-5-4.noarch.rpm
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.6.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
mesa-libGLU-devel \
git \
ccache

Configure ccache:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

Ant 1.7.1 is now available in the CentOS repositories:

$ sudo yum install ant17 ant17-apache-regexp

However, this will still cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install OpenSSL===

The OpenSSL version included with CentOs does not support the TLS versions required for today's https connections.

As root:
# cd /usr/local/src
# wget https://www.openssl.org/source/openssl-1.0.2a.tar.gz
# tar xzf openssl-1.0.2a.tar.gz
# cd openssl-1.0.2a
# ./config -fpic shared; make
# make install
# echo "/usr/local/ssl/lib" >> /etc/ld.so.conf
# ldconfig

===Install Perl modules===

We can no longer use the system Perl and standard packages on CentOS 5, which are too old, so we will need to build newer versions.

Be root, then:

# cd /usr/local/src
# wget http://www.cpan.org/src/5.0/perl-5.14.4.tar.gz
# tar xvf perl-5.14.4.tar.gz
# cd perl-5.14.4
# export OPENSSL_PREFIX=/usr/local/ssl
# ./configure.gnu ; make
# make install
# /usr/local/bin/perl -MCPAN -e shell
''[ reply "yes" to all questions to carry out cpan's autoconfiguration ]''
cpan[1]> force install Archive::Zip
cpan[2]> install XML::Parser LWP::UserAgent Digest::SHA Digest::MD5 LWP::Protocol::https
cpan[3]> exit
#

Make sure that /usr/local/bin/perl is in your $PATH and is used before any other versions.

The next step will be [[#Obtain the source code|obtaining the source code]].

==CentOS 7 and Fedora 19 for AOO 4.2.x and later==

Although CentOS 5 was our reference environment for build through the 4.1.x series, as it is a very old environment, it is not a viable system to use for building AOO 4.2.x and later, mainly due to some dependencies no longer being available for CentOS5 (such as ''gstreamer-1.x''). Not to say that you can't do so, but we have switched to CentOS 7 for our reference build of 64-bit releases. Other than that, the actual setups and builds for both OSs are strikingly similar.

32-bit releases are built on Fedora 19 VMs. Refer to [[#32 bit hints|this paragraph]] for more information

===Setup a VM===

We have had good results installing CentOS 7 x86_64 under both VirtualBox and VMware. Our community builds are actually done on a VMware Fusion VM. Build times are mostly sensitive to the number of CPUs and allocated RAM; our setup is a 8 core VM with 24GB of memory. We recommend CentOS 7.5

===Setup repositories and packages===

EPEL is needed for dpkg (to build DEBs) and for ccache (to speed up repeated builds, optional but recommended):

$ sudo yum install epel-release
$ sudo yum update -y

Now you can install all dependencies:

$ sudo yum install \
gcc \
expat-devel \
openssl-devel \
autoconf \
gcc-c++ \
cups-devel \
pam-devel \
java-1.7.0-openjdk-devel \
rpm-build \
dpkg \
fakeroot \
gperf \
freetype-devel \
libX11-devel \
libXt-devel \
fontconfig-devel \
libXrandr-devel \
bison \
flex \
GConf2-devel \
gnome-vfs2-devel \
gtk2-devel \
gstreamer-devel \
gstreamer-plugins-base-devel \
gstreamer1-devel \
gstreamer1-plugins-base-devel \
mesa-libGLU-devel \
wget \
subversion \
ccache \
glib2-devel \
dbus-glib-devel \
perl \
ORBit2-devel

Configure ccache to use at least 2 GBytes:

$ ccache -M 2G

This leaves out Ant and Perl.

===Download Ant===

The version of Ant installed via yum can cause configure to fail, so a manual download is needed. Ant will live in ~/ant and we need to download it manually.

$ cd
$ wget http://mirrors.nxnethosting.com/apache//ant/binaries/apache-ant-1.9.15-bin.tar.bz2
$ tar xvf apache-ant-1.9.15-bin.tar.bz2
$ ln -s apache-ant-1.9.15 ant

===Install Perl modules===

We can use the system Perl and standard packages on CentOS 6, see https://bz.apache.org/ooo/show_bug.cgi?id=127120

$ sudo yum install \
cpan \
perl-libwww-perl \
perl-Archive-Zip \
perl-Digest-SHA \
perl-XML-Parser \
perl-Crypt-SSLeay \
perl-Env \
perl-IPC-Cmd \
perl-LWP-Protocol-https

$ sudo cpan File::Path

===Build and Packaging tools===

Download, configure, build and install dmake and epm
$ wget https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz
$ # extract the archive, then
$ cd dmake-4.13.1
$ ./configure --prefix=/usr/local; make install

$ wget https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz
$ # extract the archive, then
$ cd epm-5.0.0
$ ./configure --prefix=/usr/local ; make install

Note: if you get <code>Error: ERROR: More than one new package in directory</code> at the end of the build, you may have to use an older EPM. In that case, just add <code>--with-epm-url=http://sourceforge.net/projects/oooextras.mirror/files/epm-3.7.tar.gz</code> to the options you pass to <code>./configure</code>.

The next step will be [[#Obtain the source code|obtaining the source code]].

===32 bit hints===

====Fedora19====

Fedora19 is the Fedora release on which RHEL7 (and thus CentOS7) is based. The 32bit version of Fedora19 is much more stable as a build platform for AOO for 32bit Linux platforms, and is compatible with CentOS7.

The community builds of AOO 4.2.x and later are built on Fedora19.

====CentOS7====

Alternatively, you can also use CentOS 7.

There is not a EPEL release for CentOS 7 32bit, so you'll need to download, build and install dpkg and GNUtar directly. You may also need fakeroot (or pseudo):

$ wget ftp://ftp.de.debian.org//debian/pool/main/d/dpkg/dpkg_1.19.3.tar.xz
$ wget http://ftp.gnu.org/gnu/tar/tar-1.30.tar.gz

==Ubuntu 16.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

* Updated Install requirements. OpenJDK 6 or 7 is not available for Ubuntu 16.04:

sudo apt-get install openjdk-8-jdk fakeroot

Draft: With Version 4.2 we start to update the build enviroment to Ubuntu 18.04 and Debian 9. You can follow [https://wiki.openoffice.org/wiki/User:Mechtilde/AOOBauen AOOBauen]

==Ubuntu 18.04==
{{DraftPage|EN}}
The process to build {{AOo|EN}} is currently undergoing experimentation. As steps are firmed up they will be added here.

Ensure that the required package repositories are activated:
$ sudo add-apt-repository universe
$ sudo apt update

Install build dependencies:
$ sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev libpam0g-dev \
gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev libxrandr-dev patch \
libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev junit junit4 libidl-dev liborbit2-dev \
openjdk-8-jdk liblablgl-ocaml-dev git

==OpenSUSE Leap==

Install build dependencies:
$ sudo zypper in gcc libexpat-devel libopenssl-devel autoconf gcc-c++ cups-devel pam-devel \
java-1_8_0-openjdk-devel rpm-build gperf freetype-devel libX11-devel libXt-devel \
fontconfig-devel libXrandr-devel bison flex gconf2-devel gnome-vfs2-devel gtk2-devel \
gstreamer-devel gstreamer-plugins-base-devel Mesa-devel git wget glib2-devel \
dbus-1-glib-devel perl orbit2-devel gdk-pixbuf-xlib-devel glu-devel ant \
libXinerama-devel libnsl-devel perl-Archive-Zip zip

If you plan to build Debian (.deb) archives for distribution:
$ sudo zypper in dpkg fakeroot

The AOO41X branch only compiles as-is since November 2024.
In order to compile the code from an earlier date, two commits must be cherry-picked from trunk:
$ git cherry-pick -x 722adfc9d670a35708718ff1651ed0e282febbd7
$ git cherry-pick -x b63eebb52dbe154d19c050aa3bfc61207daf1ef4

=Obtain the source code=

This chapter lists the commands for cloning the {{AOo}} Git repository. For information about the possible ways of obtaining the source code, refer to the [[Documentation/Building_Guide_AOO#Getting_the_source | Building Guide]].

Create folder for source (this is a suggested location, replace <yourusername> with your user name)

$ sudo mkdir /source
$ sudo chown <yourusername> /source
$ cd /source
$ git clone https://gitbox.apache.org/repos/asf/openoffice.git
$ cd openoffice/
$ git checkout <branch>

Please replace <code><branch></code> with the branch you want to compile e.g. AOO419 or AOO42X

=Configure=

The scripts at https://github.com/apache/openoffice-devtools/tree/main/build-scripts are used to prepare the release builds.

Template:API project

2025-04-23T14:48:01Z

Petko:

{| align=right style="margin-left: 15px; border:1px solid #aaaaaa; background-color:#f9f9f9; padding:5px; font-size: 95%;" class=box
|---
!align=center style="background:#ccccff;" |

[[File:Writer Icon.png]]

'''''[[API|API Project]]'''''

Please view the [[Wiki Contribution Guidelines|guidelines]]
<BR>before contributing.''
|-
|
'''''Popular Subcategories:'''''
<DynamicPageList>
category=API
namespace=Category
ordermethod=categoryadd
order=descending
count=5
</DynamicPageList>
* [[:Category:Writer|... more Subcategories]]

'''''Project To-Dos:'''''
<DynamicPageList>
category=API/To-Dos
ordermethod=categoryadd
order=descending
count=5
</DynamicPageList>
* [[:Category:API/CoreDoc|... more Internal Documentation]]
'''''API Documentation:'''''

* [[Documentation/DevGuide/Text/Text_Documents|Development Guide API]]
* [http://api.openoffice.org/ API Project Website]

'''''Ongoing FAQ:'''''
<DynamicPageList>
category=API/FAQ
ordermethod=categoryadd
order=descending
count=5
</DynamicPageList>
* [[:Category:API/Effort|... more API Efforts]]

{{ListofProjects}}


[[Category:{{{Category|API}}}]]


|-
|'''[http://api.openoffice.org API.OpenOffice.org]'''

|}
<noinclude>
[[Category:Wiki Templates for Navigation]]
</noinclude>

API

2025-04-23T14:41:33Z

Petko: added the template back again.

{{Template: API project}}

The {{AOo}} '''[[Wikipedia:API|API]]''' Wiki. '''API''' stands for '''Application programming interface'''.

[[OpenOffice.org|Apache OpenOffice]] offers a language independent '''API''' which allows to program the office in different programming languages (e.g. C++, Java, Python, CLI, StarBasic, ...). It allows to use {{AOo}} as service provider in other applications, extend it with new functionality or simply customize and control {{AOo}}.

The API is based on the [[Uno|UNO]] component technology and that makes it really flexible and makes it possible to use one and the same API from different programming languages, all languages which are supported by [[Uno|UNO]].

==API Reference==
We try to provide always the latest version of a generated API IDL reference documentation online. You can find it on the [https://www.openoffice.org/api/ www.openoffice.org/api/] on the left side under [https://www.openoffice.org/api/docs/common/ref/com/sun/star/module-ix.html IDL reference]. Maybe interesting for you are the two links '''Use''' and '''DevGuide''' in the top menubar of a single type documentation page.
* Use: links to an overview page where you can find all places where this type is used or referenced in the API and in the [[Documentation/DevGuide|Developer's Guide]]
* DevGuide: links to a sub-section of the documentation page where you can find cross-references into the [[Documentation/DevGuide|Developer's Guide]] where this type is described in detail and especially the concepts behind.

Also of interest here are the online available reference documentation of the [[Uno|UNO]] runtime for [https://www.openoffice.org/api/docs/cpp/ref/names/index.html C++] and [https://www.openoffice.org/api/docs/java/ref/overview-summary.html Java].

===References from the WIKI into the generated IDL reference===
When we moved the [[Documentation/DevGuide|Developer's Guide]] into the wiki we thought about a way how we could achieve the useful IDL tags. The tags that get automatically converted into links to the related type in the generated IDL reference. In the end the [[MediaWiki_Extension/Extension_IDLTags|IDLTags]] extension was developed that allows exactly the same functionality.

'''PLEASE''' whenever you want or have to reference an IDL type please use one of the '''IDL tags''' to create a link automatically. It will help our users and developers to find the appropriate information faster, and it will help to improve the overall navigation between the documentation (guides, examples, tutorials, ...) in the wiki and the type reference.

== API Changes==
Sometimes it makes sense, and it is necessary to change existing API's (or configuration etc.) incompatible and break potentially existing macros or extensions. The goal is to avoid such changes and try to provide workarounds but from time to time it's better to allow such changes. We take this serious and don't make such changes in every release but under certain conditions that you find under '''[[API/Concepts_API_changes|Concepts for incompatible API changes and an API deprecation process]]'''.

A summary and overview with detailed description of such changes can be found under '''[[API/Incompatible_API_changes|Documented incompatible API changes]]'''

==Supported Languages==

==Code Snippets, Examples and Tutorials ==
The idea is to collect small snippets or more complex examples showing different API use cases in different programming languages. Or to collect tutorials explaining things in more detail and step by step. Whereas [[API/Tutorials|Tutorials]] are more intended for beginners the [[API/Samples|Samples]] section is intended for more experienced users or simply as reference. Ideally all snippets/examples/tutorials would be available in all supported languages.

This new sections in the wiki should extend the already existing [http://codesnippets.services.openoffice.org/ Code Snippet Base]. But with the advantage of easier contribution and easier maintenance.

* [[API/Samples|Samples]]
* [[API/Tutorials|Tutorials]]

==Things in progress - Efforts==
<DynamicPageList>category=API
category=Effort</DynamicPageList> <noinclude>[[Category:API]]</noinclude>
* [[API/Concepts_API_changes|Concepts for incompatible API changes and an API deprecation process]]
==Things to be Done==
* [[API/To-Dos]] - An overview of API To-Dos where you will hopefully find something interesting if you plan to support the API project.

==FAQ==
* [[API/FAQ]] - A list of frequently asked questions related to the API

==Terms==

[[Category:Project]]
[[Category:API]]

Template:API project

2025-04-23T14:41:00Z

Petko: chanege DPL into DynamicPageList, removed + and +** in front of category. removed empty namespace variable.

{| align=right style="margin-left: 15px; border:1px solid #aaaaaa; background-color:#f9f9f9; padding:5px; font-size: 95%;" class=box
|---
!align=center style="background:#ccccff;" |

[[File:Writer Icon.png]]

'''''[[API|API Project]]'''''

Please view the [[Wiki Contribution Guidelines|guidelines]]
<BR>before contributing.''
|-
|
'''''Popular Subcategories:'''''
<DynamicPageList>
category=API
namespace=Category
ordermethod=counter
order=descending
count=5
</DynamicPageList>
* [[:Category:Writer|... more Subcategories]]

'''''Project To-Dos:'''''
<DynamicPageList>
category=API/To-Dos
ordermethod=counter
order=descending
count=5
</DynamicPageList>
* [[:Category:API/CoreDoc|... more Internal Documentation]]
'''''API Documentation:'''''

* [[Documentation/DevGuide/Text/Text_Documents|Development Guide API]]
* [http://api.openoffice.org/ API Project Website]

'''''Ongoing FAQ:'''''
<DynamicPageList>
category=API/FAQ
ordermethod=counter
order=descending
count=5
</DynamicPageList>
* [[:Category:API/Effort|... more API Efforts]]

{{ListofProjects}}


[[Category:{{{Category|API}}}]]


|-
|'''[http://api.openoffice.org API.OpenOffice.org]'''

|}
<noinclude>
[[Category:Wiki Templates for Navigation]]
</noinclude>

API

2025-04-23T14:26:13Z

Petko: chanege DPL into DynamicPageList, and remove the template

The {{AOo}} '''[[Wikipedia:API|API]]''' Wiki. '''API''' stands for '''Application programming interface'''.

[[OpenOffice.org|Apache OpenOffice]] offers a language independent '''API''' which allows to program the office in different programming languages (e.g. C++, Java, Python, CLI, StarBasic, ...). It allows to use {{AOo}} as service provider in other applications, extend it with new functionality or simply customize and control {{AOo}}.

The API is based on the [[Uno|UNO]] component technology and that makes it really flexible and makes it possible to use one and the same API from different programming languages, all languages which are supported by [[Uno|UNO]].

==API Reference==
We try to provide always the latest version of a generated API IDL reference documentation online. You can find it on the [https://www.openoffice.org/api/ www.openoffice.org/api/] on the left side under [https://www.openoffice.org/api/docs/common/ref/com/sun/star/module-ix.html IDL reference]. Maybe interesting for you are the two links '''Use''' and '''DevGuide''' in the top menubar of a single type documentation page.
* Use: links to an overview page where you can find all places where this type is used or referenced in the API and in the [[Documentation/DevGuide|Developer's Guide]]
* DevGuide: links to a sub-section of the documentation page where you can find cross-references into the [[Documentation/DevGuide|Developer's Guide]] where this type is described in detail and especially the concepts behind.

Also of interest here are the online available reference documentation of the [[Uno|UNO]] runtime for [https://www.openoffice.org/api/docs/cpp/ref/names/index.html C++] and [https://www.openoffice.org/api/docs/java/ref/overview-summary.html Java].

===References from the WIKI into the generated IDL reference===
When we moved the [[Documentation/DevGuide|Developer's Guide]] into the wiki we thought about a way how we could achieve the useful IDL tags. The tags that get automatically converted into links to the related type in the generated IDL reference. In the end the [[MediaWiki_Extension/Extension_IDLTags|IDLTags]] extension was developed that allows exactly the same functionality.

'''PLEASE''' whenever you want or have to reference an IDL type please use one of the '''IDL tags''' to create a link automatically. It will help our users and developers to find the appropriate information faster, and it will help to improve the overall navigation between the documentation (guides, examples, tutorials, ...) in the wiki and the type reference.

== API Changes==
Sometimes it makes sense, and it is necessary to change existing API's (or configuration etc.) incompatible and break potentially existing macros or extensions. The goal is to avoid such changes and try to provide workarounds but from time to time it's better to allow such changes. We take this serious and don't make such changes in every release but under certain conditions that you find under '''[[API/Concepts_API_changes|Concepts for incompatible API changes and an API deprecation process]]'''.

A summary and overview with detailed description of such changes can be found under '''[[API/Incompatible_API_changes|Documented incompatible API changes]]'''

==Supported Languages==

==Code Snippets, Examples and Tutorials ==
The idea is to collect small snippets or more complex examples showing different API use cases in different programming languages. Or to collect tutorials explaining things in more detail and step by step. Whereas [[API/Tutorials|Tutorials]] are more intended for beginners the [[API/Samples|Samples]] section is intended for more experienced users or simply as reference. Ideally all snippets/examples/tutorials would be available in all supported languages.

This new sections in the wiki should extend the already existing [http://codesnippets.services.openoffice.org/ Code Snippet Base]. But with the advantage of easier contribution and easier maintenance.

* [[API/Samples|Samples]]
* [[API/Tutorials|Tutorials]]

==Things in progress - Efforts==
<DynamicPageList>category=API
category=Effort</DynamicPageList> <noinclude>[[Category:API]]</noinclude>
* [[API/Concepts_API_changes|Concepts for incompatible API changes and an API deprecation process]]
==Things to be Done==
* [[API/To-Dos]] - An overview of API To-Dos where you will hopefully find something interesting if you plan to support the API project.

==FAQ==
* [[API/FAQ]] - A list of frequently asked questions related to the API

==Terms==

[[Category:Project]]
[[Category:API]]

Documentation/FAQ/ProjectLevel/SourceTechQuestions/BuildQuestions

2024-10-27T20:08:16Z

Petko:

[[Category:Documentation/FAQ/ProjectLevel/SourceTechQuestions/BuildQuestions]]

{{Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project Build Questions}}

Search the FAQs: <googlefaq/>

This page has FAQs that address {{AOo}} at the Project Build Level.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/ProjectLevel/SourceTechQuestions/BuildQuestions
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>

<td>

===Add a new FAQ entry===

<inputbox>

bgcolor=#EEE

type=create

default=Documentation/FAQ/ProjectLevel/SourceTechQuestions/BuildQuestions/<FAQ_TITLE>

preload=Documentation/FAQ_Template

buttonlabel=Add new FAQ

break=no

</inputbox>

'''Instructions'''

* Do '''not ask questions''' here, but '''give answers'''.

* If you have a '''question to ask''', go to the [https://forum.openoffice.org User Forum].

* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''

</td></tr></table>

Documentation/FAQ/Macros

2024-10-27T19:08:28Z

Petko:

{{Documentation/FAQTOC}}
{{DISPLAYTITLE:{{AOo}} Macros FAQ}}
Search the FAQs: <googlefaq/>
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Macros
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Macros/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org/en/forum/ User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

[[Category: Documentation/FAQ]]
[[Category:User FAQ]]

Documentation/FAQ/Databases/MS Access

2024-10-27T19:07:14Z

Petko:

[[Category:Documentation/FAQ/Databases/MS Access]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Base FAQ - MS Access}}
Search the FAQs: <googlefaq/>
This page has FAQs about databases from MS Access in OpenOffice Base.
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Databases/MS_Access
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Databases/MS_Access/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org/en/ User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

[[Category:Documentation/FAQ/Databases/MS Access]]
[[Category:Documentation/FAQ]]

Documentation/FAQ/Databases

2024-10-27T19:06:48Z

Petko:

{{Documentation/FAQTOC}}
{{DISPLAYTITLE:{{AOo}} Base FAQ}}
*[https://wiki.openoffice.org/wiki/FAQ_(Base) The Base FAQ]

Search the FAQs: <googlefaq/>
This list is ordered by popularity. The most popular FAQs are at the top. But also take a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Databases
notcategory=NL
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Databases/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org/en/forum/ User Forum].
* Replace the part ''<FAQ_TITLE>'' in the input box above by the title you would like to give the FAQ item and click {{button|Add New FAQ}}
</td></tr></table>

[[Category:Documentation/FAQ]]
[[Category:User FAQ]]

Documentation/FAQ/Formula

2024-10-27T19:06:24Z

Petko:

{{DISPLAYTITLE:{{AOo}} Math FAQ}}__NOTOC__{{Documentation/FAQTOC}}{{Note| A useful first resource is the '''[[Documentation/Reference/Math_commands|OpenOffice Math Syntax Reference]]'''.}}
Search the FAQs: <googlefaq/>
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

Below the list you can find some more FAQs that have special characters in the title.

<DynamicPageList>
category=Documentation/FAQ/Formula
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<div style="background-color:#EEE;border:solid 1pt #AAA;padding:10px;margin-top:20px">
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Formula/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org/en/forum/ User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</div>

[[Category: Documentation/FAQ]]
[[Category:User FAQ]]

Documentation/FAQ/Impress

2024-10-27T19:06:05Z

Petko:

{{Documentation/FAQTOC}}
{{DISPLAYTITLE:{{AOo}} Impress FAQ}}
Search the FAQs: <googlefaq/>
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Impress
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Impress/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org/en/forum/ User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

[[Category: Documentation/FAQ]]
[[Category:User FAQ]]

Documentation/FAQ/Draw

2024-10-27T19:05:42Z

Petko:

{{Documentation/FAQTOC}}
{{DISPLAYTITLE:{{AOo}} Draw FAQ}}
Search the FAQs: <googlefaq/>
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Draw
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Draw/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

[[Category: Documentation/FAQ]]
[[Category:User FAQ]]

Documentation/FAQ/Calc/Miscellaneous

2024-10-27T19:05:23Z

Petko:

[[Category:Documentation/FAQ/Calc]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Calc FAQ - Miscellaneous questions}}
Search the FAQs: <googlefaq/>
This page has FAQs about {{AOo}} Calc that don't fit into the other Calc FAQ sections.
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Calc/Miscellaneous
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Calc/Miscellaneous/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org/ User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

Documentation/FAQ/Calc/Errors

2024-10-27T19:05:04Z

Petko:

[[Category:Documentation/FAQ/Calc]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Calc FAQ - Error handling}}
Search the FAQs: <googlefaq/>
This page has FAQs about error handling in {{AOo}} Calc.
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Calc/Errors
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Calc/Errors/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org/ User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

Documentation/FAQ/Calc/Charts

2024-10-27T19:04:48Z

Petko:

[[Category:Documentation/FAQ/Calc]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Calc FAQ - Charts}}
Search the FAQs: <googlefaq/>
This page has FAQs about using charts in OpenOffice.org Calc and possibly in the other modules, too.
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Calc/Charts
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Calc/Charts/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

Documentation/FAQ/Calc/Printing

2024-10-27T19:04:31Z

Petko:

[[Category:Documentation/FAQ/Calc]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Calc FAQ - Printing Spreadsheets}}
Search the FAQs: <googlefaq/>
This page has FAQs about printing spreadsheets in OpenOffice.org Calc.
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Calc/Printing
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Calc/Printing/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

Documentation/FAQ/Calc/Files

2024-10-27T19:04:11Z

Petko:

[[Category:Documentation/FAQ/Calc]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Calc FAQ - File handling}}
Search the FAQs: <googlefaq/>
This page has FAQs about file handling in OpenOffice.org Calc.
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Calc/Files
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Calc/Files/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

Documentation/FAQ/Calc/Formatting

2024-10-27T19:03:53Z

Petko:

[[Category:Documentation/FAQ/Calc]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Calc FAQ - Formatting Spreadsheets}}
Search the FAQs: <googlefaq/>
This page has FAQs about formatting spreadsheets in OpenOffice Calc.
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Calc/Formatting
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Calc/Formatting/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

Documentation/FAQ/Writer/Printing

2024-10-27T19:03:27Z

Petko:

{{Documentation/FAQTOC|ShowPrevNext=none}}
{{DISPLAYTITLE: Writer FAQ - Printing}}
Search the FAQs: <googlefaq/>
{{Tip|
For more information, see these chapters in the Writer Guide:
* Printing, Faxing, Exporting, and E-mailing ([https://wiki.openoffice.org/w/images/5/50/0205WG-PrintingWithWriter.pdf for OOo 2.x], [https://wiki.openoffice.org/w/images/0/04/0205WG33-PrintingExportingEmailing.pdf for OOo 3.0])
* Using Mail Merge ([https://wiki.openoffice.org/w/images/c/cb/0211WG-UsingMailMerge.pdf for OOo 2.x], [https://wiki.openoffice.org/w/images/b/b7/0211WG33-UsingMailMerge.pdf for OOo 3.0])
}}

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Writer/Printing
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Writer/Printing/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

[[Category: Documentation/FAQ/Writer]]

Documentation/FAQ/Writer/IndexToc

2024-10-27T19:03:06Z

Petko:

[[Category:User FAQ]]
{{Documentation/FAQTOC|ShowPrevNext=none}}
{{DISPLAYTITLE: Writer FAQ - Indexes, Tables of Contents}}
Search the FAQs: <googlefaq/>
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Writer/IndexToc
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Writer/IndexToc/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

[[Category: Documentation/FAQ/Writer]]

Documentation/FAQ/Writer/GraphicsFramesObjects

2024-10-27T19:02:46Z

Petko:

[[Category:Documentation/FAQ/Writer]]
{{Documentation/FAQTOC|ShowPrevNext=none}}
{{DISPLAYTITLE: Writer FAQ - Graphics, Frames and Objects}}
Search the FAQs: <googlefaq/>
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Writer/GraphicsFramesObjects
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Writer/GraphicsFramesObjects/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

Documentation/FAQ/Writer/FormattingText

2024-10-27T19:02:24Z

Petko:

[[Category:Documentation/FAQ/Writer]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Writer FAQ - Formatting Text}}
Search the FAQs: <googlefaq/>
This page has FAQs about formatting text in Writer.
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

More information can be found in the Writer Guide, available from the [http://documentation.openoffice.org/manuals/oooauthors2/ OOo Documentation Project].

<DynamicPageList>
category=Documentation/FAQ/Writer/FormattingText
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Writer/FormattingText/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

Documentation/FAQ/Writer/FormattingPagesAndDocuments

2024-10-27T19:02:05Z

Petko:

[[Category:Documentation/FAQ/Writer]]
{{Documentation/FAQTOC}}
Search the FAQs: <googlefaq/>
{{DISPLAYTITLE: Writer FAQ - Formatting Pages and Documents}}
This page has FAQs about formatting pages and documents in Writer.
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

More information can be found in the Writer Guide, available from the [https://www.openoffice.org/documentation/ AOO Documentation Project].

<DynamicPageList>
category=Documentation/FAQ/Writer/FormattingPagesAndDocuments
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Writer/FormattingPagesAndDocuments/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org/en/forum User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

Documentation/FAQ/Writer/DocumentManagement

2024-10-27T19:01:42Z

Petko:

[[Category:Documentation/FAQ/Writer]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Writer FAQ - Document Management}}
Search the FAQs: <googlefaq/>
This page has FAQs about document management, file formats, and similar topics.
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

More information can be found in the Writer Guide, available from the [https://www.openoffice.org/documentation/manuals/oooauthors2/ {{AOo}} Documentation Project].

<DynamicPageList>
category=Documentation/FAQ/Writer/DocumentManagement
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Writer/DocumentManagement/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org/ User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

Documentation/FAQ/Installation

2024-10-27T19:01:17Z

Petko:

{{Documentation/FAQTOC|ShowPrevNext=none}}
{{DISPLAYTITLE:Installation FAQ}}
Search the FAQs: <googlefaq/>
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Installation
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Installation/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

[[Category: Documentation/FAQ]]
[[Category:Documentation/Setup]]
[[Category:User FAQ]]

Documentation/FAQ/General

2024-10-27T19:00:49Z

Petko:

[[Category:User_FAQ]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE:General Questions}}
Search the FAQs: <googlefaq/>
This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/General
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/General/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [https://forum.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

[[Category: Documentation/FAQ]]
[[fa:FA/rules/wiki/documention:FAQ]]

Documentation/FAQ/ProjectLevel/SourceTechQuestions/XMLQuestions

2024-10-27T19:00:28Z

Petko:

[[Category:Documentation/FAQ/ProjectLevel/SourceTechQuestions/XMLQuestions]]
{{Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project XML Questions}}

Search the FAQs: <googlefaq/>

This page has FAQs that address {{AOo}} at the Project XML Level.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/ProjectLevel/SourceTechQuestions/XMLQuestions
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>

<td>

===Add a new FAQ entry===

<inputbox>

bgcolor=#EEE

type=create

default=Documentation/FAQ/ProjectLevel/SourceTechQuestions/XMLQuestions/<FAQ_TITLE>

preload=Documentation/FAQ_Template

buttonlabel=Add new FAQ

break=no

</inputbox>

'''Instructions'''

* Do '''not ask questions''' here, but '''give answers'''.

* If you have a '''question to ask''', go to the [https://forum.openoffice.org User Forum].

* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''

</td></tr></table>

Documentation/FAQ/ProjectLevel/SourceTechQuestions/DeveloperQuestions

2024-10-27T19:00:03Z

Petko:

[[Category:Documentation/FAQ/ProjectLevel/SourceTechQuestions/DeveloperQuestions]]
{{Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project Developer Questions}}

Search the FAQs: <googlefaq/>

This page has FAQs that address {{AOo}} at the Project Developer Level.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>

category=Documentation/FAQ/ProjectLevel/SourceTechQuestions/DeveloperQuestions

ordermethod=none

order=descending

replaceintitle=/Documentation.*\//,

secseparators=<br>

</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>

<td>

===Add a new FAQ entry===

<inputbox>

bgcolor=#EEE

type=create

default=Documentation/FAQ/ProjectLevel/SourceTechQuestions/DeveloperQuestions/<FAQ_TITLE>

preload=Documentation/FAQ_Template

buttonlabel=Add new FAQ

break=no

</inputbox>

'''Instructions'''

* Do '''not ask questions''' here, but '''give answers'''.

* If you have a '''question to ask''', go to the [https://forum.openoffice.org User Forum].

* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''

</td></tr></table>

Documentation/FAQ/ProjectLevel/SourceTechQuestions/BuildQuestions

2024-10-27T18:59:36Z

Petko:

[[Category:Documentation/FAQ/ProjectLevel/SourceTechQuestions/BuildQuestions]]

{{Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project Build Questions}}

Search the FAQs: <googlefaq/>

This page has FAQs that address {{AOo}} at the Project Build Level.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>

category=Documentation/FAQ/ProjectLevel/SourceTechQuestions/BuildQuestions
ordermethod=none

order=descending

replaceintitle=/Documentation.*\//,

secseparators=<br>

</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>

<td>

===Add a new FAQ entry===

<inputbox>

bgcolor=#EEE

type=create

default=Documentation/FAQ/ProjectLevel/SourceTechQuestions/BuildQuestions/<FAQ_TITLE>

preload=Documentation/FAQ_Template

buttonlabel=Add new FAQ

break=no

</inputbox>

'''Instructions'''

* Do '''not ask questions''' here, but '''give answers'''.

* If you have a '''question to ask''', go to the [https://forum.openoffice.org User Forum].

* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''

</td></tr></table>

Documentation/FAQ/ProjectLevel/SourceTechQuestions/APIQuestions

2024-10-27T18:59:05Z

Petko:

[[Category:Documentation/FAQ/ProjectLevel/SourceTechQuestions]]

{{Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project API Questions}}

Search the FAQs: <googlefaq/>

This page has FAQs that address {{AOo}} at the Project API Level.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>

category=Documentation/FAQ/ProjectLevel/SourceTechQuestions/APIQuestions

ordermethod=none

order=descending

replaceintitle=/Documentation.*\//,

secseparators=<br>

</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>

<td>

===Add a new FAQ entry===

<inputbox>

bgcolor=#EEE

type=create

default=Documentation/FAQ/ProjectLevel/SourceTechQuestions/APIQuestions/<FAQ_TITLE>

preload=Documentation/FAQ_Template

buttonlabel=Add new FAQ

break=no

</inputbox>

'''Instructions'''

* Do '''not ask questions''' here, but '''give answers'''.

* If you have a '''question to ask''', go to the [https://forum.openoffice.org User Forum].

* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''

</td></tr></table>

Documentation/FAQ/ProjectLevel/BugZillaQuestions

2024-10-27T18:57:46Z

Petko:

[[Category:Documentation/FAQ/ProjectLevel]]

{{Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project Bugzilla Questions}}

Search the FAQs: <googlefaq/>

This page has FAQs that address the {{AOo}} Implementation of Bugzilla for Issue Tracking.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>

category=Documentation/FAQ/ProjectLevel/BugzillaQuestions

ordermethod=none

order=descending

replaceintitle=/Documentation.*\//,

secseparators=<br>

</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>

<td>

===Add a new FAQ entry===

<inputbox>

bgcolor=#EEE

type=create

default=Documentation/FAQ/ProjectLevel/BugzillaQuestions/<FAQ_TITLE>

preload=Documentation/FAQ_Template

buttonlabel=Add new FAQ

break=no

</inputbox>

'''Instructions'''

* Do '''not ask questions''' here, but '''give answers'''.

* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].

* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''

</td></tr></table>

Documentation/FAQ/ProjectLevel/BusinessLicense

2024-10-27T18:56:28Z

Petko:

[[Category:Documentation/FAQ/ProjectLevel]]
{{Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project Business & License Questions}}

Search the FAQs: <googlefaq/>

This page has FAQs that address {{AOo}} at the Project Business & License Level.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>

category=Documentation/FAQ/ProjectLevel/BusinessLicense

ordermethod=none

order=descending

replaceintitle=/Documentation.*\//,

secseparators=<br>

</DynamicPageList>

== See Also ==
[https://www.apache.org/licenses/LICENSE-2.0 Apache License Version 2.0]
[https://www.apache.org/foundation/license-faq.html Apache Foundation Frequent Questions about ALv2]

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>

<td>

===Add a new FAQ entry===

<inputbox>

bgcolor=#EEE

type=create

default=Documentation/FAQ/ProjectLevel/BusinessLicense/<FAQ_TITLE>

preload=Documentation/FAQ_Template

buttonlabel=Add new FAQ

break=no

</inputbox>

Documentation/FAQ/ProjectLevel/CommunityQuestions

2024-10-27T18:51:09Z

Petko:

[[Category:Documentation/FAQ/ProjectLevel]]

{{Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project Community Questions}}

Search the FAQs: <googlefaq/>

This page has FAQs that address {{AOo}} at the Project Community Level.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>

category=Documentation/FAQ/ProjectLevel/CommunityQuestions

ordermethod=counter

order=descending

replaceintitle=/Documentation.*\//,

secseparators=<br>

</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>

<td>

===Add a new FAQ entry===

<inputbox>

bgcolor=#EEE

type=create

default=Documentation/FAQ/ProjectLevel/CommunityQuestions/<FAQ_TITLE>

preload=Documentation/FAQ_Template

buttonlabel=Add new FAQ

break=no

</inputbox>

'''Instructions'''

* Do '''not ask questions''' here, but '''give answers'''.

* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].

* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''

</td></tr></table>

Documentation/FAQ/ProjectLevel/OverviewQuestions

2024-10-27T18:48:38Z

Petko:

[[Category:Documentation/FAQ/ProjectLevel]]
{{Documentation/FAQTOC}}

{{DISPLAYTITLE: {{AOo}} - Project Overview Questions}}

Search the FAQs: <googlefaq/>

This page has FAQs that address {{AOo}} at the Project Overview Level.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/ProjectLevel/OverviewQuestions
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>

<td>

===Add a new FAQ entry===

<inputbox>

bgcolor=#EEE

type=create

default=Documentation/FAQ/ProjectLevel/OverviewQuestions/<FAQ_TITLE>

preload=Documentation/FAQ_Template

buttonlabel=Add new FAQ

break=no

</inputbox>

'''Instructions'''

* Do '''not ask questions''' here, but '''give answers'''.

* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].

* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''

Documentation/FAQ/Writer/AutomaticFunctions

2024-10-27T18:46:20Z

Petko: set

[[Category:Documentation/FAQ/Writer]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Writer FAQ - Automatic Functions}}
Search the FAQs: <googlefaq/>
This page has FAQs about the automatic functions in OpenOffice.org Writer, including AutoFormat, AutoCorrect, and others.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Writer/AutomaticFunctions
ordermethod=none
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Writer/AutomaticFunctions/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

MediaWiki Extension/Extension IDLTags

2024-10-27T09:59:24Z

Petko: /* Function renderIDLTOPIC */ updated function

== IDLTags extension for Mediawiki ==

When we moved the Developer's Guide into the wiki we thought about a way how we could achieve the useful IDL tags. The tags that get automatically converted into links to the related type in the generated IDL reference.

The IDLTags extension was written by Clayton Cornell and Terry Ellison to manage the IDL links in the OpenOffice.org Developer's Guide, as well as other documentation, like the BASIC Programming Guide. The extension converts Java paths, like com.sun.star.frame.Desktop to link back to the online IDL documentation, such as
<b>http://api.openoffice.org/docs/common/ref/com/sun/star/frame/Desktop.html</b> which then gets redirected to
<b>https://www.openoffice.org/api/docs/common/ref/com/sun/star/frame/Desktop.html</b>.

On the Mediawiki these links are, for instance, present on the pages of the OpenOffice Developers Guide. Yes, there are quite a lot of them there. Supposedly it was designed to have to enter as less characters in the wiki as possible. They invented some tags to use.

These are:
{| class="wikitable" border="1"
!Tag || Use
|-
| <nowiki><idl> </idl></nowiki> || link
|-
| <nowiki><idls> </idls></nowiki> || probably used for services
|-
| <nowiki><idlm> </idlm></nowiki> || probably used for methods
|-
| <nowiki><idlmodule> </idlmodule></nowiki> || used for modules to lead to the index page
|-
| <nowiki><idltopic> </idltopic></nowiki> ||
|-
|}

This last tag is mentioned, but does not seem to have a function in the extension and will be ignored further.

On the wikipages these tags contain a part of the IDL reference to link back to:

<nowiki><idl></nowiki>'''com.sun.star.frame.Desktop'''<nowiki></idl></nowiki>

<nowiki><idls></nowiki>'''com.sun.star.lang.DisposedException'''<nowiki></idls></nowiki>

<nowiki><idlm></nowiki>'''com.sun.star.uno.XComponentContext:getServiceManager'''<nowiki></idlm></nowiki>

<nowiki><idlmodule></nowiki>'''com.sun.star.awt'''<nowiki></idlmodule></nowiki>

=== Use ===

This extension converts the content of the tag to a regular link.
It is written in PHP and uses, besides functions from PHP, internal functions of Mediawiki.

== Functions ==
It consist of five separate functions, one for each tag:

=== Function renderIDL ===
Function renderIDL uses the function str_replace from PHP to convert to URL:

<syntaxhighlight lang="php"> function renderIDL($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . str_replace('.', '/', $output) . '.html';
return $this->createAnchor($url, $output);
}
</syntaxhighlight>

===Function renderIDLM ===
Function renderIDLM used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">function renderIDLM($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$page = str_replace('.', '/', $output);
$anchor = str_replace(':', '.html#', $page);
$function = preg_replace('/^.*:/', '', $page);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . $anchor;
return $this->createAnchor($url, $function);
}
</syntaxhighlight>

=== Function renderIDLS ===
Function renderIDLS used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">
function renderIDLS($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$function = preg_replace('/^.*\./', '', $output);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . str_replace('.', '/', $output) . '.html';
return $this->createAnchor($url, $function);
}
</syntaxhighlight>

=== Function renderIDLMODULE ===
Function renderIDLMODULE used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">
function renderIDLMODULE($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$function = preg_replace('/^.*\./', '', $output);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . str_replace('.', '/', $output) . '/module-ix.html';
return $this->createAnchor($url, $output);
}
</syntaxhighlight>

=== Function renderIDLTOPIC ===
The use or purpose of this function is unknown. Tags in the wiki are commented out.

<syntaxhighlight lang="php">function renderIDLTOPIC( $input, $args, $parser ) {
return '';
}</syntaxhighlight>

== A problem arose ==
The extension worked for a long time, but since some time contents of a lot of pages of the Developers Guide were no longer displayed. Investigation learned that the text still was there, but that it wasn't rendered on the page.
Editing the pages was still possible by tweaking the URL of the page from (as an example):

<code><nowiki>https://wiki.openoffice.org/wiki/Documentation/DevGuide/Documentation/DevGuide/FirstSteps/First Contact</nowiki></code>

to

<code><nowiki>https://wiki.openoffice.org/</nowiki><span style="color:#FFFFFF; background:#ff0000">w/index.php?title=</span><nowiki>Documentation/DevGuide/Documentation/DevGuide/FirstSteps/First Contact</nowiki><span style="color:#FFFFFF; background:#ff0000">&action=edit</span></code>

That would bring up the content of the page and the possibility to edit it.
That investigation also led to the conclusion that effected pages contained one or more of the IDLS, IDLM or IDLMODULE tags. Further was determined that pages that only contained IDL tags were displayed correctly.

It was likely that the extension IDLTags did no longer do his fabulous work. Arrigo Marchiori set us on the right track pointing out that the function ereg_replace was deprecated and removed from PHP 7.0.* and therefore can't be used anymore.
The version of Mediawiki for AOo uses version 7.4.33 of PHP.

This broke the existing extension so that it didn't render the IDLM, IDLS and IDLMODULE tags anymore. As a result of this the content of pages on the Mediawiki that contained one or more of these tags were no longer displayed. They rendered full white.
Therefore function renderIDLM, function renderIDLS and function renderIDLMODULE did no longer do their work and content of pages that contained one of these tags were no longer displayed correctly but only fully white rendered.

== Fix ==
The functions needed to be adapted to use another function than ereg_replace. That function proved to be preg_replace and Carl Marcum worked his magic on this one. He also changed the old redirect to the new places on the {{AOo}} website: https://www.openoffice.org/api/docs/common/ref/

<syntaxhighlight lang="php">function renderIDLM( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$page = preg_replace ('/\./','/',$output);
$anchor = preg_replace ('/:/','.html#',$page);
$function = preg_replace ('/^.*:/','',$page);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
$anchor.'" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>
----------

<syntaxhighlight lang="php">function renderIDLS( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = preg_replace ('/^.*\./','',$output);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
preg_replace ('/\./','/',$output).'.html" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>
----------

<syntaxhighlight lang="php">function renderIDLMODULE( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = preg_replace ('/^.*\./','',$output);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
preg_replace ('/\./','/',$output).'/module-ix.html" class="external text">'.$output.'</a>';
return $output;
}</syntaxhighlight>
----------

Using this new adapted functions the links in the DevGuide function again as of 2020-12-17.

== References ==
References to this page on the wiki are on:
* https://wiki.openoffice.org/wiki/Documentation/DevGuide/Contributing_to_the_Developers_Guide#IDL_extension_and_links

* https://wiki.openoffice.org/wiki/API

* https://wiki.openoffice.org/wiki/Help:Extensions

(please add to the list if you come across one that is not yet listed)

MediaWiki Extension/Extension IDLTags

2024-10-27T09:58:23Z

Petko: /* Function renderIDLMODULE */ update function

== IDLTags extension for Mediawiki ==

When we moved the Developer's Guide into the wiki we thought about a way how we could achieve the useful IDL tags. The tags that get automatically converted into links to the related type in the generated IDL reference.

The IDLTags extension was written by Clayton Cornell and Terry Ellison to manage the IDL links in the OpenOffice.org Developer's Guide, as well as other documentation, like the BASIC Programming Guide. The extension converts Java paths, like com.sun.star.frame.Desktop to link back to the online IDL documentation, such as
<b>http://api.openoffice.org/docs/common/ref/com/sun/star/frame/Desktop.html</b> which then gets redirected to
<b>https://www.openoffice.org/api/docs/common/ref/com/sun/star/frame/Desktop.html</b>.

On the Mediawiki these links are, for instance, present on the pages of the OpenOffice Developers Guide. Yes, there are quite a lot of them there. Supposedly it was designed to have to enter as less characters in the wiki as possible. They invented some tags to use.

These are:
{| class="wikitable" border="1"
!Tag || Use
|-
| <nowiki><idl> </idl></nowiki> || link
|-
| <nowiki><idls> </idls></nowiki> || probably used for services
|-
| <nowiki><idlm> </idlm></nowiki> || probably used for methods
|-
| <nowiki><idlmodule> </idlmodule></nowiki> || used for modules to lead to the index page
|-
| <nowiki><idltopic> </idltopic></nowiki> ||
|-
|}

This last tag is mentioned, but does not seem to have a function in the extension and will be ignored further.

On the wikipages these tags contain a part of the IDL reference to link back to:

<nowiki><idl></nowiki>'''com.sun.star.frame.Desktop'''<nowiki></idl></nowiki>

<nowiki><idls></nowiki>'''com.sun.star.lang.DisposedException'''<nowiki></idls></nowiki>

<nowiki><idlm></nowiki>'''com.sun.star.uno.XComponentContext:getServiceManager'''<nowiki></idlm></nowiki>

<nowiki><idlmodule></nowiki>'''com.sun.star.awt'''<nowiki></idlmodule></nowiki>

=== Use ===

This extension converts the content of the tag to a regular link.
It is written in PHP and uses, besides functions from PHP, internal functions of Mediawiki.

== Functions ==
It consist of five separate functions, one for each tag:

=== Function renderIDL ===
Function renderIDL uses the function str_replace from PHP to convert to URL:

<syntaxhighlight lang="php"> function renderIDL($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . str_replace('.', '/', $output) . '.html';
return $this->createAnchor($url, $output);
}
</syntaxhighlight>

===Function renderIDLM ===
Function renderIDLM used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">function renderIDLM($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$page = str_replace('.', '/', $output);
$anchor = str_replace(':', '.html#', $page);
$function = preg_replace('/^.*:/', '', $page);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . $anchor;
return $this->createAnchor($url, $function);
}
</syntaxhighlight>

=== Function renderIDLS ===
Function renderIDLS used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">
function renderIDLS($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$function = preg_replace('/^.*\./', '', $output);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . str_replace('.', '/', $output) . '.html';
return $this->createAnchor($url, $function);
}
</syntaxhighlight>

=== Function renderIDLMODULE ===
Function renderIDLMODULE used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">
function renderIDLMODULE($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$function = preg_replace('/^.*\./', '', $output);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . str_replace('.', '/', $output) . '/module-ix.html';
return $this->createAnchor($url, $output);
}
</syntaxhighlight>

=== Function renderIDLTOPIC ===
The use or purpose of this function is unknown. Tags in the wiki are commented out.

<syntaxhighlight lang="php">function renderIDLTOPIC( $input, $args, $parser ) {
$parser->disableCache();
return '';
}</syntaxhighlight>

== A problem arose ==
The extension worked for a long time, but since some time contents of a lot of pages of the Developers Guide were no longer displayed. Investigation learned that the text still was there, but that it wasn't rendered on the page.
Editing the pages was still possible by tweaking the URL of the page from (as an example):

<code><nowiki>https://wiki.openoffice.org/wiki/Documentation/DevGuide/Documentation/DevGuide/FirstSteps/First Contact</nowiki></code>

to

<code><nowiki>https://wiki.openoffice.org/</nowiki><span style="color:#FFFFFF; background:#ff0000">w/index.php?title=</span><nowiki>Documentation/DevGuide/Documentation/DevGuide/FirstSteps/First Contact</nowiki><span style="color:#FFFFFF; background:#ff0000">&action=edit</span></code>

That would bring up the content of the page and the possibility to edit it.
That investigation also led to the conclusion that effected pages contained one or more of the IDLS, IDLM or IDLMODULE tags. Further was determined that pages that only contained IDL tags were displayed correctly.

It was likely that the extension IDLTags did no longer do his fabulous work. Arrigo Marchiori set us on the right track pointing out that the function ereg_replace was deprecated and removed from PHP 7.0.* and therefore can't be used anymore.
The version of Mediawiki for AOo uses version 7.4.33 of PHP.

This broke the existing extension so that it didn't render the IDLM, IDLS and IDLMODULE tags anymore. As a result of this the content of pages on the Mediawiki that contained one or more of these tags were no longer displayed. They rendered full white.
Therefore function renderIDLM, function renderIDLS and function renderIDLMODULE did no longer do their work and content of pages that contained one of these tags were no longer displayed correctly but only fully white rendered.

== Fix ==
The functions needed to be adapted to use another function than ereg_replace. That function proved to be preg_replace and Carl Marcum worked his magic on this one. He also changed the old redirect to the new places on the {{AOo}} website: https://www.openoffice.org/api/docs/common/ref/

<syntaxhighlight lang="php">function renderIDLM( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$page = preg_replace ('/\./','/',$output);
$anchor = preg_replace ('/:/','.html#',$page);
$function = preg_replace ('/^.*:/','',$page);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
$anchor.'" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>
----------

<syntaxhighlight lang="php">function renderIDLS( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = preg_replace ('/^.*\./','',$output);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
preg_replace ('/\./','/',$output).'.html" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>
----------

<syntaxhighlight lang="php">function renderIDLMODULE( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = preg_replace ('/^.*\./','',$output);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
preg_replace ('/\./','/',$output).'/module-ix.html" class="external text">'.$output.'</a>';
return $output;
}</syntaxhighlight>
----------

Using this new adapted functions the links in the DevGuide function again as of 2020-12-17.

== References ==
References to this page on the wiki are on:
* https://wiki.openoffice.org/wiki/Documentation/DevGuide/Contributing_to_the_Developers_Guide#IDL_extension_and_links

* https://wiki.openoffice.org/wiki/API

* https://wiki.openoffice.org/wiki/Help:Extensions

(please add to the list if you come across one that is not yet listed)

MediaWiki Extension/Extension IDLTags

2024-10-27T09:57:33Z

Petko: /* Function renderIDLS */ update function

== IDLTags extension for Mediawiki ==

When we moved the Developer's Guide into the wiki we thought about a way how we could achieve the useful IDL tags. The tags that get automatically converted into links to the related type in the generated IDL reference.

The IDLTags extension was written by Clayton Cornell and Terry Ellison to manage the IDL links in the OpenOffice.org Developer's Guide, as well as other documentation, like the BASIC Programming Guide. The extension converts Java paths, like com.sun.star.frame.Desktop to link back to the online IDL documentation, such as
<b>http://api.openoffice.org/docs/common/ref/com/sun/star/frame/Desktop.html</b> which then gets redirected to
<b>https://www.openoffice.org/api/docs/common/ref/com/sun/star/frame/Desktop.html</b>.

On the Mediawiki these links are, for instance, present on the pages of the OpenOffice Developers Guide. Yes, there are quite a lot of them there. Supposedly it was designed to have to enter as less characters in the wiki as possible. They invented some tags to use.

These are:
{| class="wikitable" border="1"
!Tag || Use
|-
| <nowiki><idl> </idl></nowiki> || link
|-
| <nowiki><idls> </idls></nowiki> || probably used for services
|-
| <nowiki><idlm> </idlm></nowiki> || probably used for methods
|-
| <nowiki><idlmodule> </idlmodule></nowiki> || used for modules to lead to the index page
|-
| <nowiki><idltopic> </idltopic></nowiki> ||
|-
|}

This last tag is mentioned, but does not seem to have a function in the extension and will be ignored further.

On the wikipages these tags contain a part of the IDL reference to link back to:

<nowiki><idl></nowiki>'''com.sun.star.frame.Desktop'''<nowiki></idl></nowiki>

<nowiki><idls></nowiki>'''com.sun.star.lang.DisposedException'''<nowiki></idls></nowiki>

<nowiki><idlm></nowiki>'''com.sun.star.uno.XComponentContext:getServiceManager'''<nowiki></idlm></nowiki>

<nowiki><idlmodule></nowiki>'''com.sun.star.awt'''<nowiki></idlmodule></nowiki>

=== Use ===

This extension converts the content of the tag to a regular link.
It is written in PHP and uses, besides functions from PHP, internal functions of Mediawiki.

== Functions ==
It consist of five separate functions, one for each tag:

=== Function renderIDL ===
Function renderIDL uses the function str_replace from PHP to convert to URL:

<syntaxhighlight lang="php"> function renderIDL($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . str_replace('.', '/', $output) . '.html';
return $this->createAnchor($url, $output);
}
</syntaxhighlight>

===Function renderIDLM ===
Function renderIDLM used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">function renderIDLM($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$page = str_replace('.', '/', $output);
$anchor = str_replace(':', '.html#', $page);
$function = preg_replace('/^.*:/', '', $page);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . $anchor;
return $this->createAnchor($url, $function);
}
</syntaxhighlight>

=== Function renderIDLS ===
Function renderIDLS used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">
function renderIDLS($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$function = preg_replace('/^.*\./', '', $output);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . str_replace('.', '/', $output) . '.html';
return $this->createAnchor($url, $function);
}
</syntaxhighlight>

=== Function renderIDLMODULE ===
Function renderIDLMODULE used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">function renderIDLM( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$page = ereg_replace ('\.','/',$output);
$anchor = ereg_replace (':','.html#',$page);
$function = ereg_replace ('^.*:','',$page);
$output = '<a href="http://api.openoffice.org/docs/common/ref/' .
$anchor.'" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>

=== Function renderIDLTOPIC ===
The use or purpose of this function is unknown. Tags in the wiki are commented out.

<syntaxhighlight lang="php">function renderIDLTOPIC( $input, $args, $parser ) {
$parser->disableCache();
return '';
}</syntaxhighlight>

== A problem arose ==
The extension worked for a long time, but since some time contents of a lot of pages of the Developers Guide were no longer displayed. Investigation learned that the text still was there, but that it wasn't rendered on the page.
Editing the pages was still possible by tweaking the URL of the page from (as an example):

<code><nowiki>https://wiki.openoffice.org/wiki/Documentation/DevGuide/Documentation/DevGuide/FirstSteps/First Contact</nowiki></code>

to

<code><nowiki>https://wiki.openoffice.org/</nowiki><span style="color:#FFFFFF; background:#ff0000">w/index.php?title=</span><nowiki>Documentation/DevGuide/Documentation/DevGuide/FirstSteps/First Contact</nowiki><span style="color:#FFFFFF; background:#ff0000">&action=edit</span></code>

That would bring up the content of the page and the possibility to edit it.
That investigation also led to the conclusion that effected pages contained one or more of the IDLS, IDLM or IDLMODULE tags. Further was determined that pages that only contained IDL tags were displayed correctly.

It was likely that the extension IDLTags did no longer do his fabulous work. Arrigo Marchiori set us on the right track pointing out that the function ereg_replace was deprecated and removed from PHP 7.0.* and therefore can't be used anymore.
The version of Mediawiki for AOo uses version 7.4.33 of PHP.

This broke the existing extension so that it didn't render the IDLM, IDLS and IDLMODULE tags anymore. As a result of this the content of pages on the Mediawiki that contained one or more of these tags were no longer displayed. They rendered full white.
Therefore function renderIDLM, function renderIDLS and function renderIDLMODULE did no longer do their work and content of pages that contained one of these tags were no longer displayed correctly but only fully white rendered.

== Fix ==
The functions needed to be adapted to use another function than ereg_replace. That function proved to be preg_replace and Carl Marcum worked his magic on this one. He also changed the old redirect to the new places on the {{AOo}} website: https://www.openoffice.org/api/docs/common/ref/

<syntaxhighlight lang="php">function renderIDLM( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$page = preg_replace ('/\./','/',$output);
$anchor = preg_replace ('/:/','.html#',$page);
$function = preg_replace ('/^.*:/','',$page);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
$anchor.'" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>
----------

<syntaxhighlight lang="php">function renderIDLS( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = preg_replace ('/^.*\./','',$output);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
preg_replace ('/\./','/',$output).'.html" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>
----------

<syntaxhighlight lang="php">function renderIDLMODULE( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = preg_replace ('/^.*\./','',$output);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
preg_replace ('/\./','/',$output).'/module-ix.html" class="external text">'.$output.'</a>';
return $output;
}</syntaxhighlight>
----------

Using this new adapted functions the links in the DevGuide function again as of 2020-12-17.

== References ==
References to this page on the wiki are on:
* https://wiki.openoffice.org/wiki/Documentation/DevGuide/Contributing_to_the_Developers_Guide#IDL_extension_and_links

* https://wiki.openoffice.org/wiki/API

* https://wiki.openoffice.org/wiki/Help:Extensions

(please add to the list if you come across one that is not yet listed)

MediaWiki Extension/Extension IDLTags

2024-10-27T09:56:31Z

Petko: /* Function renderIDLM */ updated function

== IDLTags extension for Mediawiki ==

When we moved the Developer's Guide into the wiki we thought about a way how we could achieve the useful IDL tags. The tags that get automatically converted into links to the related type in the generated IDL reference.

The IDLTags extension was written by Clayton Cornell and Terry Ellison to manage the IDL links in the OpenOffice.org Developer's Guide, as well as other documentation, like the BASIC Programming Guide. The extension converts Java paths, like com.sun.star.frame.Desktop to link back to the online IDL documentation, such as
<b>http://api.openoffice.org/docs/common/ref/com/sun/star/frame/Desktop.html</b> which then gets redirected to
<b>https://www.openoffice.org/api/docs/common/ref/com/sun/star/frame/Desktop.html</b>.

On the Mediawiki these links are, for instance, present on the pages of the OpenOffice Developers Guide. Yes, there are quite a lot of them there. Supposedly it was designed to have to enter as less characters in the wiki as possible. They invented some tags to use.

These are:
{| class="wikitable" border="1"
!Tag || Use
|-
| <nowiki><idl> </idl></nowiki> || link
|-
| <nowiki><idls> </idls></nowiki> || probably used for services
|-
| <nowiki><idlm> </idlm></nowiki> || probably used for methods
|-
| <nowiki><idlmodule> </idlmodule></nowiki> || used for modules to lead to the index page
|-
| <nowiki><idltopic> </idltopic></nowiki> ||
|-
|}

This last tag is mentioned, but does not seem to have a function in the extension and will be ignored further.

On the wikipages these tags contain a part of the IDL reference to link back to:

<nowiki><idl></nowiki>'''com.sun.star.frame.Desktop'''<nowiki></idl></nowiki>

<nowiki><idls></nowiki>'''com.sun.star.lang.DisposedException'''<nowiki></idls></nowiki>

<nowiki><idlm></nowiki>'''com.sun.star.uno.XComponentContext:getServiceManager'''<nowiki></idlm></nowiki>

<nowiki><idlmodule></nowiki>'''com.sun.star.awt'''<nowiki></idlmodule></nowiki>

=== Use ===

This extension converts the content of the tag to a regular link.
It is written in PHP and uses, besides functions from PHP, internal functions of Mediawiki.

== Functions ==
It consist of five separate functions, one for each tag:

=== Function renderIDL ===
Function renderIDL uses the function str_replace from PHP to convert to URL:

<syntaxhighlight lang="php"> function renderIDL($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . str_replace('.', '/', $output) . '.html';
return $this->createAnchor($url, $output);
}
</syntaxhighlight>

===Function renderIDLM ===
Function renderIDLM used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">function renderIDLM($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$page = str_replace('.', '/', $output);
$anchor = str_replace(':', '.html#', $page);
$function = preg_replace('/^.*:/', '', $page);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . $anchor;
return $this->createAnchor($url, $function);
}
</syntaxhighlight>

=== Function renderIDLS ===
Function renderIDLS used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">function renderIDLS( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = ereg_replace ('^.*\.','',$output);
$output = '<a href="http://api.openoffice.org/docs/common/ref/' .
ereg_replace ('\.','/',$output).'.html" class="external
text">'.$function.'</a>';
return $output;
}</syntaxhighlight>

=== Function renderIDLMODULE ===
Function renderIDLMODULE used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">function renderIDLM( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$page = ereg_replace ('\.','/',$output);
$anchor = ereg_replace (':','.html#',$page);
$function = ereg_replace ('^.*:','',$page);
$output = '<a href="http://api.openoffice.org/docs/common/ref/' .
$anchor.'" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>

=== Function renderIDLTOPIC ===
The use or purpose of this function is unknown. Tags in the wiki are commented out.

<syntaxhighlight lang="php">function renderIDLTOPIC( $input, $args, $parser ) {
$parser->disableCache();
return '';
}</syntaxhighlight>

== A problem arose ==
The extension worked for a long time, but since some time contents of a lot of pages of the Developers Guide were no longer displayed. Investigation learned that the text still was there, but that it wasn't rendered on the page.
Editing the pages was still possible by tweaking the URL of the page from (as an example):

<code><nowiki>https://wiki.openoffice.org/wiki/Documentation/DevGuide/Documentation/DevGuide/FirstSteps/First Contact</nowiki></code>

to

<code><nowiki>https://wiki.openoffice.org/</nowiki><span style="color:#FFFFFF; background:#ff0000">w/index.php?title=</span><nowiki>Documentation/DevGuide/Documentation/DevGuide/FirstSteps/First Contact</nowiki><span style="color:#FFFFFF; background:#ff0000">&action=edit</span></code>

That would bring up the content of the page and the possibility to edit it.
That investigation also led to the conclusion that effected pages contained one or more of the IDLS, IDLM or IDLMODULE tags. Further was determined that pages that only contained IDL tags were displayed correctly.

It was likely that the extension IDLTags did no longer do his fabulous work. Arrigo Marchiori set us on the right track pointing out that the function ereg_replace was deprecated and removed from PHP 7.0.* and therefore can't be used anymore.
The version of Mediawiki for AOo uses version 7.4.33 of PHP.

This broke the existing extension so that it didn't render the IDLM, IDLS and IDLMODULE tags anymore. As a result of this the content of pages on the Mediawiki that contained one or more of these tags were no longer displayed. They rendered full white.
Therefore function renderIDLM, function renderIDLS and function renderIDLMODULE did no longer do their work and content of pages that contained one of these tags were no longer displayed correctly but only fully white rendered.

== Fix ==
The functions needed to be adapted to use another function than ereg_replace. That function proved to be preg_replace and Carl Marcum worked his magic on this one. He also changed the old redirect to the new places on the {{AOo}} website: https://www.openoffice.org/api/docs/common/ref/

<syntaxhighlight lang="php">function renderIDLM( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$page = preg_replace ('/\./','/',$output);
$anchor = preg_replace ('/:/','.html#',$page);
$function = preg_replace ('/^.*:/','',$page);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
$anchor.'" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>
----------

<syntaxhighlight lang="php">function renderIDLS( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = preg_replace ('/^.*\./','',$output);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
preg_replace ('/\./','/',$output).'.html" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>
----------

<syntaxhighlight lang="php">function renderIDLMODULE( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = preg_replace ('/^.*\./','',$output);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
preg_replace ('/\./','/',$output).'/module-ix.html" class="external text">'.$output.'</a>';
return $output;
}</syntaxhighlight>
----------

Using this new adapted functions the links in the DevGuide function again as of 2020-12-17.

== References ==
References to this page on the wiki are on:
* https://wiki.openoffice.org/wiki/Documentation/DevGuide/Contributing_to_the_Developers_Guide#IDL_extension_and_links

* https://wiki.openoffice.org/wiki/API

* https://wiki.openoffice.org/wiki/Help:Extensions

(please add to the list if you come across one that is not yet listed)

MediaWiki Extension/Extension IDLTags

2024-10-27T09:55:08Z

Petko: /* Function renderIDL */ updated function

== IDLTags extension for Mediawiki ==

When we moved the Developer's Guide into the wiki we thought about a way how we could achieve the useful IDL tags. The tags that get automatically converted into links to the related type in the generated IDL reference.

The IDLTags extension was written by Clayton Cornell and Terry Ellison to manage the IDL links in the OpenOffice.org Developer's Guide, as well as other documentation, like the BASIC Programming Guide. The extension converts Java paths, like com.sun.star.frame.Desktop to link back to the online IDL documentation, such as
<b>http://api.openoffice.org/docs/common/ref/com/sun/star/frame/Desktop.html</b> which then gets redirected to
<b>https://www.openoffice.org/api/docs/common/ref/com/sun/star/frame/Desktop.html</b>.

On the Mediawiki these links are, for instance, present on the pages of the OpenOffice Developers Guide. Yes, there are quite a lot of them there. Supposedly it was designed to have to enter as less characters in the wiki as possible. They invented some tags to use.

These are:
{| class="wikitable" border="1"
!Tag || Use
|-
| <nowiki><idl> </idl></nowiki> || link
|-
| <nowiki><idls> </idls></nowiki> || probably used for services
|-
| <nowiki><idlm> </idlm></nowiki> || probably used for methods
|-
| <nowiki><idlmodule> </idlmodule></nowiki> || used for modules to lead to the index page
|-
| <nowiki><idltopic> </idltopic></nowiki> ||
|-
|}

This last tag is mentioned, but does not seem to have a function in the extension and will be ignored further.

On the wikipages these tags contain a part of the IDL reference to link back to:

<nowiki><idl></nowiki>'''com.sun.star.frame.Desktop'''<nowiki></idl></nowiki>

<nowiki><idls></nowiki>'''com.sun.star.lang.DisposedException'''<nowiki></idls></nowiki>

<nowiki><idlm></nowiki>'''com.sun.star.uno.XComponentContext:getServiceManager'''<nowiki></idlm></nowiki>

<nowiki><idlmodule></nowiki>'''com.sun.star.awt'''<nowiki></idlmodule></nowiki>

=== Use ===

This extension converts the content of the tag to a regular link.
It is written in PHP and uses, besides functions from PHP, internal functions of Mediawiki.

== Functions ==
It consist of five separate functions, one for each tag:

=== Function renderIDL ===
Function renderIDL uses the function str_replace from PHP to convert to URL:

<syntaxhighlight lang="php"> function renderIDL($input, $args, $parser) {
$output = $parser->recursiveTagParse($input);
$url = 'https://www.openoffice.org/api/docs/common/ref/' . str_replace('.', '/', $output) . '.html';
return $this->createAnchor($url, $output);
}
</syntaxhighlight>

===Function renderIDLM ===
Function renderIDLM used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">function renderIDLM( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$page = ereg_replace ('\.','/',$output);
$anchor = ereg_replace (':','.html#',$page);
$function = ereg_replace ('^.*:','',$page);
$output = '<a href="http://api.openoffice.org/docs/common/ref/' .
$anchor.'" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>

=== Function renderIDLS ===
Function renderIDLS used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">function renderIDLS( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = ereg_replace ('^.*\.','',$output);
$output = '<a href="http://api.openoffice.org/docs/common/ref/' .
ereg_replace ('\.','/',$output).'.html" class="external
text">'.$function.'</a>';
return $output;
}</syntaxhighlight>

=== Function renderIDLMODULE ===
Function renderIDLMODULE used to use the function ereg_replace from PHP to convert to URL:

<syntaxhighlight lang="php">function renderIDLM( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$page = ereg_replace ('\.','/',$output);
$anchor = ereg_replace (':','.html#',$page);
$function = ereg_replace ('^.*:','',$page);
$output = '<a href="http://api.openoffice.org/docs/common/ref/' .
$anchor.'" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>

=== Function renderIDLTOPIC ===
The use or purpose of this function is unknown. Tags in the wiki are commented out.

<syntaxhighlight lang="php">function renderIDLTOPIC( $input, $args, $parser ) {
$parser->disableCache();
return '';
}</syntaxhighlight>

== A problem arose ==
The extension worked for a long time, but since some time contents of a lot of pages of the Developers Guide were no longer displayed. Investigation learned that the text still was there, but that it wasn't rendered on the page.
Editing the pages was still possible by tweaking the URL of the page from (as an example):

<code><nowiki>https://wiki.openoffice.org/wiki/Documentation/DevGuide/Documentation/DevGuide/FirstSteps/First Contact</nowiki></code>

to

<code><nowiki>https://wiki.openoffice.org/</nowiki><span style="color:#FFFFFF; background:#ff0000">w/index.php?title=</span><nowiki>Documentation/DevGuide/Documentation/DevGuide/FirstSteps/First Contact</nowiki><span style="color:#FFFFFF; background:#ff0000">&action=edit</span></code>

That would bring up the content of the page and the possibility to edit it.
That investigation also led to the conclusion that effected pages contained one or more of the IDLS, IDLM or IDLMODULE tags. Further was determined that pages that only contained IDL tags were displayed correctly.

It was likely that the extension IDLTags did no longer do his fabulous work. Arrigo Marchiori set us on the right track pointing out that the function ereg_replace was deprecated and removed from PHP 7.0.* and therefore can't be used anymore.
The version of Mediawiki for AOo uses version 7.4.33 of PHP.

This broke the existing extension so that it didn't render the IDLM, IDLS and IDLMODULE tags anymore. As a result of this the content of pages on the Mediawiki that contained one or more of these tags were no longer displayed. They rendered full white.
Therefore function renderIDLM, function renderIDLS and function renderIDLMODULE did no longer do their work and content of pages that contained one of these tags were no longer displayed correctly but only fully white rendered.

== Fix ==
The functions needed to be adapted to use another function than ereg_replace. That function proved to be preg_replace and Carl Marcum worked his magic on this one. He also changed the old redirect to the new places on the {{AOo}} website: https://www.openoffice.org/api/docs/common/ref/

<syntaxhighlight lang="php">function renderIDLM( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$page = preg_replace ('/\./','/',$output);
$anchor = preg_replace ('/:/','.html#',$page);
$function = preg_replace ('/^.*:/','',$page);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
$anchor.'" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>
----------

<syntaxhighlight lang="php">function renderIDLS( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = preg_replace ('/^.*\./','',$output);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
preg_replace ('/\./','/',$output).'.html" class="external text">'.$function.'</a>';
return $output;
}</syntaxhighlight>
----------

<syntaxhighlight lang="php">function renderIDLMODULE( $input, $args, $parser ) {
$parser->disableCache();
$output = $parser->recursiveTagParse( $input );
$function = preg_replace ('/^.*\./','',$output);
$output = '<a href="https://www.openoffice.org/api/docs/common/ref/' .
preg_replace ('/\./','/',$output).'/module-ix.html" class="external text">'.$output.'</a>';
return $output;
}</syntaxhighlight>
----------

Using this new adapted functions the links in the DevGuide function again as of 2020-12-17.

== References ==
References to this page on the wiki are on:
* https://wiki.openoffice.org/wiki/Documentation/DevGuide/Contributing_to_the_Developers_Guide#IDL_extension_and_links

* https://wiki.openoffice.org/wiki/API

* https://wiki.openoffice.org/wiki/Help:Extensions

(please add to the list if you come across one that is not yet listed)

Documentation/FAQ/Writer/AutomaticFunctions

2024-10-23T05:50:03Z

Petko: activated backward compatibility

[[Category:Documentation/FAQ/Writer]]
{{Documentation/FAQTOC}}
{{DISPLAYTITLE: Writer FAQ - Automatic Functions}}
Search the FAQs: <googlefaq/>
This page has FAQs about the automatic functions in OpenOffice.org Writer, including AutoFormat, AutoCorrect, and others.

This list is ordered by popularity. The most popular FAQs are at the top. But also have a look at the bottom to find any new entries.

<DynamicPageList>
category=Documentation/FAQ/Writer/AutomaticFunctions
ordermethod=counter
order=descending
replaceintitle=/Documentation.*\//,
secseparators=<br>
</DynamicPageList>

<table border=1 cellpadding=5 style="width:100%; border-collapse: collapse; border-color:#AAA; background-color:#EEE;"><tr>
<td>
===Add a new FAQ entry===
<inputbox>
bgcolor=#EEE
type=create
default=Documentation/FAQ/Writer/AutomaticFunctions/<FAQ_TITLE>
preload=Documentation/FAQ_Template
buttonlabel=Add new FAQ
break=no
</inputbox>
'''Instructions'''
* Do '''not ask questions''' here, but '''give answers'''.
* If you have a '''question to ask''', go to the [http://user.services.openoffice.org User Forum].
* Replace ''<FAQ_TITLE>'' part in the input box above by the title you would like to give the FAQ item and click '''Add New FAQ'''
</td></tr></table>

Template:Documentation/GS4WriterTOC

2024-09-11T11:54:07Z

Petko: Blanked the page

{{DISPLAYTITLE:What is Writer?}}
{{Documentation/GS4WriterTOC
|ShowPrevNext=block
|PrevPage=Documentation/AOO4_User_Guides/Getting Started/Getting started with writer
|NextPage=Documentation/AOO4_User_Guides/Getting Started/Getting started with writer/Writer interface
}}__NOTOC__

== What Is Writer? ==
Writer is the word processor component of Apache OpenOffice. In addition to the usual features of a word processor (spelling check, thesaurus, hyphenation, autocorrect, find and replace, automatic generation of tables of contents and indexes, mail merge and others), Writer provides these important features:

* Templates and styles (see [[Documentation/AOO4_User_Guides/Getting Started/Using Styles and Templates|Chapter 2]])
* Page layout methods, including frames, columns, and tables
* Embedding or linking of graphics, spreadsheets, and other objects
* Built-in drawing tools
* Master documents to group a collection of documents into a single document
* Change tracking during revisions
* Database integration, including a bibliography database
* Export to PDF, including bookmarks (see [[Documentation/AOO4_User_Guides/Getting Started/Printing, Exporting, Emailing|Chapter 9]])
* And many more

These features are covered in detail in the ''Writer Guide''.

{{CCBY}}
[[Category:Getting Started (Documentation)]]

Documentation/AOO4 User Guides/Getting Started/Getting started with writer/What is writer

2024-09-11T11:53:10Z

Petko: Created page with "test"

{{DISPLAYTITLE:Examples of Style Use}}
{{Documentation/StylesAOO4TOC
|ShowPrevNext=block
|PrevPage=Documentation/AOO4_User_Guides/Getting Started/Using styles and templates/Organizing templates
|NextPage=Documentation/AOO4_User_Guides/Getting Started/Getting Started with Writer
}}__NOTOC__

== Examples of Style Use ==
The following examples of common use of page and paragraph styles are taken from Writer. There are many other ways to use styles; see the guides for the various components for details.

=== Defining a Different First Page for a Document ===
Many documents, such as letters and reports, have a first page that is different from the other pages in the document. For example, the first page of a letter typically has a different header, or the first page of a report might have no header or footer, while the other pages do. With Apache OpenOffice, you can define the ''page style'' for the first page and specify the style for the following pages to be applied automatically.

As an example, we can use the ''First Page'' and ''Default'' page styles that come with Apache OpenOffice. The figure below shows what we want to happen: the first page is to be followed by the default page, and all the following pages are to be in the ''Default'' page style. Details are in Chapter 4 (Formatting Pages) in the ''Writer Guide''.

[[Image:AOO41GS2_033.png|300px|center]]
<center>''Figure 33: Flow of page styles''</center>

=== Dividing a Document into Chapters ===
Similarly, you can divide a document into chapters. Each chapter might start with the ''First Page'' style, with the following pages using the'' Default'' page style, as above. At the end of the chapter, insert a manual page break and specify the next page to have the ''First Page'' style to start the next chapter, as shown in the figure below.

[[Image:AOO41GS2_034.png|400px|center]]
<center>''Figure 34: Dividing a document into chapters using page styles''</center>

=== Changing Page Orientation Within a Document ===
A Writer document can contain pages in more than one orientation. A common scenario is to have a landscape page in the middle of a document, where the other pages are in a portrait orientation. This can be done with page breaks and page styles. Position the cursor at the point where you want to start the new (landscape) page. Click {{menu|Insert|Manual Break}} on the main menu. In the Insert Break dialog, select '''Page Break''' under Type, and select a page style with landscape orientation in the Page Style list. Click {{button|OK}} to insert the page. To go back to the portrait page style, insert another page break and select the portrait page style you are using (which may be Default Page Style, if you haven't selected or created a different one).

=== Different Headers on Right and Left Pages ===
Page styles can be set up to have the facing left and right pages ''mirrored'' or only right (first pages of chapters are often defined to be right-page only) or only left. When you insert a header on a page style set up for mirrored pages or right-and-left pages, you can have the contents of the header be the same on all pages or be different on the right and left pages. For example, you can put the page number on the left-hand edge of the left pages and on the right-hand edge of the right pages, put the document title on the right-hand page only, or make other changes.

=== Controlling Page Breaks Automatically ===
Writer automatically flows text from one page to the next. If you do not like the default settings, you can change them. For example, you can require a paragraph to start on a new page or column and specify the style of the new page. A typical use is for chapter titles to always start on a new right-hand (odd-numbered) page.

=== Compiling an Automatic Table of Contents ===
To compile an automatic table of contents, first apply styles to the headings you want to appear in the contents list, then use {{menu|Tools|Outline Numbering}} to tell Writer which styles go with which level in the table of contents. See [[Documentation/AOO4_User_Guides/Getting Started/Getting Started with Writer|Chapter 3]] for more information.

=== Defining a Sequence of Styles ===
You can set up one paragraph style so that when you press ''Enter'' at the end of that paragraph, the following paragraph automatically has the style you wish applied to it. For example, you could define a ''Heading 1'' paragraph to be followed by a ''Text Body'' paragraph. A more complex example would be: ''Title'' followed by ''Author'' followed by ''Abstract'' followed by ''Heading 1'' followed by ''Text Body''. By setting up these sequences, you can often avoid manually applying styles.

{{CCBY}}
[[Category:Getting Started (Documentation)]]

Icon Design

2023-02-06T06:35:58Z

Petko: changed email to dev mailing list; added dark theme link

= The Basics about Icon Design =

See also the [http://ui.openoffice.org/VisualDesign/docs/SOIconDesignGuide.pdf StarOffice Icon Design Guide]

== Icon sizes ==

==== For [[toolbar icons]] ====

* 16 x 16 pixel
* 26 x 26 pixel

==== For [[MimeType Icons]] ====

* 16 x 16 pixel
* 32 x 32 pixel
* 48 x 48 pixel
* 128 x 128 pixel
* 265 x 265 pixel

<br>

== Icon File Formats ==

==== For [[toolbar icons]] ====

* .png

==== For [[MimeType Icons]] ====

* .png
* .ico
* .icon

<br>

== Color Language and Symbolism ==

==== For [[toolbar icons]] ====

* The Color palette
* Symbol languages

==== For [[MimeType Icons]] ====

* The Color palette
* Symbol languages

<br>

== A Unique Style ==

== Icon Behavior ==

Design proposal for [http://ui.openoffice.org/VisualDesign/OOo_galaxy_disabled.html disabled toolbar icons]

== [[Icon Themes]] ==

The new [[Galaxy]] style

The [[classic]] theme

The [[High Contrast Icons]]

The [[Dark Theme Icons]]

----

== The [[Evolution of OpenOffice.org Icons]] ==

=== Evolution of toolbar icons ===

Some examples of most popular toolbar icons:

=== Evolution of mime type icons ===

The evolution of OpenOffice.org mime type icons
Overview of all [http://ui.openoffice.org/VisualDesign/OOo30MimeType.html OpenOffice.org 3.0 mime type icons]
Overview of all [http://ui.openoffice.org/VisualDesign/OOo20MimeType.html OpenOffice.org 2.0 mime type icons]

----

Contact: mailto:dev@openoffice.apache.org

[[Category:Visual Design]]
[[Category:Icons]]
[[Category:Project]]

Sfx2

2022-08-23T00:43:39Z

Petko: adding other links explaining sfx2

This is a legacy framework module, describing the GUI for AOO application.

see:
https://wiki.openoffice.org/wiki/Framework/Article/Implementation_of_the_Dispatch_API_In_SFX2#Items_and_UNO_structs

https://wiki.openoffice.org/wiki/SFX2_Refactoring

https://docs.libreoffice.org/sfx2.html

Documentation/Building Guide AOO/Step by step with a Docker Container

2021-11-15T21:16:08Z

Petko: first draft for building from Docker

{{DISPLAYTITLE:Step by step building guide with a Docker Container}}
[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code on Docker Containers. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

This page focuses on docker container. The goal is to provide a simple to create Build environment to build the Linux Version of Apache OpenOffice (R).
= Prerequisite to this guide =
you need to have a normal docker installation on your system and a git instance installed.
= Building your Docker image =
you need the Dockerfile for building the docker image.
Create a build folder on your host, and put the file into that folder. We assume here that the folder is /workspace/docker
# cd /workspace/docker
# wget dockerfile@address TBD .
#docker build
= building Apache OpenOffice (R) =
== Getting the Code ==
mkdir /workspace/AOO
cd /workspace/AOO
git clone https://gitbox.apache.org/repos/asf/openoffice.git .
== starting the image and adding the sourcecode ==
docker run -ti -v /workspace/AOO:/workspace/AOO aoo_centos
== configure ==
See the buildscript at https://svn.apache.org/viewvc/openoffice/devtools/build-scripts/
<!--
== bootstrap ==

== build AOO ==

= The dockerfile explained =
--!>

Documentation/Building Guide AOO

2021-11-15T21:15:40Z

Petko: /* Linux */ Adding Docker Container

{{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.

These instructions are for the "'''trunk'''" branch, that is the current development release. If you are looking for instructions to build specific releases, refer to section [[#Step-by-Step Building Guide for Different Platforms]] as well.

Here is the short version for the brave and impatient:
# <code>git clone https://gitbox.apache.org/repos/asf/openoffice.git</code><br />or<br /><code>git clone https://github.com/apache/openoffice.git</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.)
# Enjoy

The compilation can be automated by the [https://svn.apache.org/viewvc/openoffice/devtools/build-scripts build scripts].

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

{{Note|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.}}
* How to use cache

{{SeeAlso|EN|*[[How_to_build_Symphony%27s_source_code]] }}

= Getting help =
You can get help by searching this wiki or by asking questions on the [https://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 =

Since August 2019, the source code is available as Git repository at https://gitbox.apache.org/repos/asf/openoffice.git, or https://github.com/apache/openoffice.

Check it out with

git clone https://gitbox.apache.org/repos/asf/openoffice.git
or
git clone https://github.com/apache/openoffice.git

Git is the preferred way for developers to obtain the source code. After cloning the repository as described above, you will be able to track the current development branches and also quickly switch to the latest official releases ("tags"). For example, to check out the source code for {{AOO}} 4.1.8 issue the command:

git checkout tags/AOO418-GA

If a full-blown repository clone is not necessary, for example because you just want to download and build a specific release, more details about how to check out source code can be found [https://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 version control overhead).

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

= 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 <code>main/sw/</code>. More information on the organization of the modules in the source code directories [[Source_code_directories | here]].
;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.

Official releases are built using [https://svn.apache.org/viewvc/openoffice/devtools/build-scripts build scripts] to automate the process.

== 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 [https://www.oracle.com/technetwork/java/javase/downloads/jre7-downloads-1880261.html JDK 1.7] or higher. [https://openjdk.java.net/ OpenJDK] is supported as well.
For Windows [https://www.oracle.com/technetwork/java/javase/downloads/index.html/ JDK 1.7] or JDK 1.8 is recommended.
The JDK's bitness must match the target platform's, e.g. when building for Win32, use a 32-bit JDK even if compiling on Win64.
| --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
* XML::Parser
* LWP::UserAgent
* Digest::SHA
* Digest::MD5
* LWP::Protocol::https

On Linux, use whenever possible your package manager to install the required modules. On Windows, use cygwin's setup-x86.exe or setup-x86_64.exe.

The name of packages varies depending on the system:

{| class="wikitable" border="1"
|-
! Perl Module
! CentOS/Fedora
! Debian/Ubuntu
! Windows/cygwin
|-
| Archive::Zip
| perl-Archive-Zip
| libarchive-zip-perl
| perl-Archive-Zip
|-
| XML::Parser
| perl-XML-Parser
| libxml-parser-perl
| perl-XML-Parser
|-
| LWP::UserAgent
| perl-libwww-perl
| libwww-perl
| perl-libwww-perl
|-
| Digest::SHA
| perl-Digest-SHA
| perl
| perl-Digest-SHA
|-
| Digest::MD5
| perl-Digest-MD5
| perl
| perl
|-
| LWP::Protocol::https
| perl-LWP-Protocol-https
| liblwp-protocol-https-perl
| perl-LWP-Protocol-https
|}

On some rather old systems, ''LWP::Protocol::https'' is installed in the same package as ''LWP::UserAgent''; in this case, you need to install further dependencies in order to use ''LWP::UserAgent'' with the HTTPS protocol with no errors; on CentOS 5, for example, you need to install the ''Crypt::SSLeay'' module, provided by the ''perl-Crypt-SSLeay'' package.

On Mac OS X, bootstrap may fail to download external dependencies from HTTPS URLs (you may get an error with a message like "Can't verify SSL peers without knowing which Certificate Authorities to trust"), even if configure found all required modules; in this case, install the ''Mozilla::CA'' module using cpan.

On CentOS, ''perl-Digest-SHA'' might be only provided through the EPEL repository.

The prefered way to install Perl modules is using your system's package manager; alternatively, and as last resort, Perl modules 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 appears accepts commands. Install missing modules with
install <module-name>
Find more details [https://wiki.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
| [https://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
| [https://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 MozillaBuild tools<sup>2</sup> are needed to build the NSS module. MozillaBuild tools version 3.0 or newer require a 64-bit Windows. When building on 32-bit Windows it is recommended to use version 2.2.0. They can be obtained [https://ftp.mozilla.org/pub/mozilla/libraries/win32/ here].
|- valign="top"
| unowinreg.dll
| [https://tools.openoffice.org/unowinreg_prebuild/680/ pre-built unowinreg.dll] (see NOTE)
Required for building the ODK which is included in the build unless disabled. This file is required for non-Windows builds. Without this file, configure will try to set up cross-compiling with windows.
NOTE: Not for windows. Required on all non-windows platforms. Download by directly saving unowinreg.dll into /main/external/unowinreg from the link provided above, or by using wget:
cd $SRC/main && wget -O external/unowinreg/unowinreg.dll https://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 [https://ftp.mozilla.org/pub/mozilla/libraries/win32/ MozillaBuild tools]. 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. To see all configure options for your system, type:
configure --help

A typical configuration call starts like this --
./configure \
--with-dmake-url=<nowiki>https://github.com/jimjag/dmake/archive/v4.13.1/dmake-4.13.1.tar.gz</nowiki> \
--with-epm-url=<nowiki>https://github.com/jimjag/epm/archive/v5.0.0/epm-5.0.0.tar.gz</nowiki>
It tells configure where to find the source code of external tools dmake and epm.

By default only source code under [https://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 [https://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>[https://github.com/apache/openoffice/blob/trunk/main/solenv/inc/langlist.mk 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.

To build with symbolic generation, add option
--enable-symbols
This would allow you to work with debugging symbols in gdb.

Another useful option for interactive debugging features is dbgutil. Add option,
--enable-dbgutil
for this feature. This will result in a [[Non Product Build]]. Also see the Debugging information on this page.

By default the result binaries will be packaged in the default format used by your OS/Distribution. Using 'installed' for package format puts OpenOffice into your ''installset'' directory (browse down ../installed/install). This will save you time for testing since you can then directly run OpenOffice from this area.

Add option
--with-package-format="installed"

This will speed up development process since it skipped packaging. In some cases, packaging rips the debugging symbol, so this would be necessary for symbolic generation.

{{Note| Additional package format options will be ignored with the "installed" option.}}

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

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="wikitable" border="1"
|-
!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 [https://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. In some cases a new compilation will not work correctly unless the old output is removed.

{|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
|}

==Build Cleanup==
In the event that you want to change configuration parameters used for building, you will probably need to "clean" your build output tree before starting again.

To do this, navigate to the "main" directory, then source your environment shell script as you did for building:

<tt>source <shell-script-name></tt>

then do:

dmake clean

=Step-by-Step Building Guide for Different Platforms=

This section is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code. A more thorough explanation of what the individual steps do and why they are necessary can be found in the other sections of this document.

The guides limit themselves to either relatively recent versions of operating systems, or systems in which the OpenOffice PMC are activity using. A historical version of the step-by-step guide for different platforms can be found [[Documentation/Building_Guide_AOO/Old_step_by_step|here]]

==[[Documentation/Building Guide AOO/Step by step Linux|Linux]]==
===[[Documentation/Building Guide AOO/Step by step with a Docker Container|Docker]]===

==[[Documentation/Building Guide AOO/Step by step Windows|Windows]]==

==[[Documentation/Building Guide AOO/Building on MacOsX|Mac OS X]]==

= Building Apache OpenOffice with an IDE =
== [[OpenOffice and Eclipse|Building with Eclipse]] ==

= Additional Build Resources =
It can be useful to build an older version of {{AOO}} on newer build environments, for example in order to regression test a bug in the latest version.

Older source code may need some integrations, that are described on this page: [[Building old versions]].

== [[Debugging|Debugging]] ==

[[Category:Documentation]]
[[Category:Development]]
[[Category:Porting]]
[[Category:Build_System]]

QA/test automation

2021-10-24T20:02:46Z

Petko:

{{DISPLAYTITLE: Apache OpenOffice Test Automation}}
[[Category: Quality Assurance]]
[[Category: TestAutomation]]

== Test Automation ==

Apache OpenOffice supports [http://en.wikipedia.org/wiki/Test_automation automated testing] which helps to save a lot time compared to manual testing. Apache OpenOffice test automation does two kinds of functional testing: GUI testing and UNO API testing. Test code is written in Java and can be run on any platform supported by Apache OpenOffice.

== Getting Started ==

Please see the guide [[QA/test_automation_guide | Getting Started with Test Automation]]. Tell us your test result on the [mailto:dev@openoffice.apache.org mailing list]. We are looking forward to your contribution to test automation.

== Test Automation Development ==
To develop test automation code, you need some basic Java and JUnit skills, that can be acquired from:
*[http://junit.sourceforge.net/doc/cookbook/cookbook.htm JUnit Cookbook]. It shows how to use JUnit 4. If you know Java, it's very easy for you to understand it.
*[[QA/dev_gui_testing|GUI Testing Development]]
*[[QA/dev_api_testing|UNO API Testing Development]]
== Test Automatization with Dogtail ==
Dogtail automatization speccializes in testing accessibility. It is using python as a base.
More Details can be found in [[QA/dogtail|automatitation for doctail]]

QA/dogtail

2021-10-24T20:02:23Z

Petko:

{{DISPLAYTITLE: Apache OpenOffice Accesibnility Test Automation}}
[[Category: Quality Assurance]]
[[Category: TestAutomation]]

QA/dogtail

2021-10-24T20:02:06Z

Petko: Created page with "{{DISPLAYTITLE: Apache OpenOffice Test Automation}} Category: Quality Assurance Category: TestAutomation"

{{DISPLAYTITLE: Apache OpenOffice Test Automation}}
[[Category: Quality Assurance]]
[[Category: TestAutomation]]