What is this?
=============
This is openoffice.org-voikko, Finnish spellchecker and hyphenator extensions
for OpenOffice.org based on libvoikko.
License
=======
This package is distributed under the terms of GNU General Public License,
version 2 or later (see COPYING).
Authors
=======
2005 - 2008 Harri Pitkänen (hatapitk@iki.fi)
Porting status
==============
- Linux: This is the primary development platform, and should always work
- FreeBSD: Status unknown
- Windows: Supported with some limitations
- Mac OS X: Version 10.5 (Intel) with X11 is supported
Build requirements
==================
- OpenOffice.org (Office and SDK), version 2.0.4 or later.
- Libvoikko version 1.5 or later, and compatible versions of Suomi-malaga and
malaga.
- On Linux: the C++ compiler from the GCC, version 3.4 or later. Other tools
needed for compilation are usually present in default setups of any
distribution.
- On Windows: Microsoft Visual C++ 2005 (the Express Edition is sufficient),
GNU make, GNU sed and Info-Zip zip.
- On OS X: Xcode tools from the operating system installation CD, and OpenOffice.org
version 2.3 or later and SDK. Static versions of libvoikko and its dependencies
are needed to build a standalone extension.
Instructions for compilation
============================
- Install all of the required software listed above.
- In a shell, run the SDK setup script which is located in the SDK installation
directory. It is called setsdkenv_unix on Linux and OS X, and setsdkenv_windows on
Windows. During the first run, this script will ask the location of certain
tools. You should answer the questions, although at least on Linux the
defaults are usually correct. Answers to these questions will be saved under
the home directory of the user (for example to a file
openoffice.org2.0_sdk/setsdkenv_unix.sh).
* On OS X and Windows you must make sure that neither OpenOffice.org nor its
SDK have spaces in their installation path. If detection of office
installation fails on OS X, add symolic link "program -> MacOS" under the
directory "Contents" of the office installation.
- Run "make oxt". This will build the extensions package voikko.oxt under
subdirectory build.
* There are some settings available that can be used to customize the build.
Please see "build settings" in Makefile. You may use any of these settings
by running "make VARIABLE=value" instead of "make".
Supported Make targets
======================
- extension-files
Builds the extension files under build/oxt.
- oxt
Builds the extensions package voikko.oxt under subdirectory build.
- all
Same as 'oxt'.
- install-unpacked DESTDIR=some_directory
Installs the unpacked extension under directory DESTDIR. Default
for DESTDIR is /usr/lib/openoffice.org-voikko.
- dist-gzip
Builds the source package.
- clean
Removes all files generated by other targets.
Diagnostic tools
================
Compiling openoffice.org-voikko with DEBUG=LOG or DEBUG=FULL will create a
build that prints some useful diagnostic output to stdout.
To debug possible initialization errors in production builds, try listing
spelling suggestions for string "VoikkoGetStatusInformation". This will
return "OK" if there were no initialization errors. Otherwise the returned
string will contain the initialization error message from libvoikko.
Bug reports and patches
=======================
Patches and bug reports can be sent to the author (hatapitk@iki.fi). The web
site for openoffice.org-voikko is located at http://voikko.sourceforge.net
Change history
==============
Version 2.0 is an almost total rewrite of the previous version 1.2. This
version is designed to work well with libvoikko and aims to use the best
current practices for OpenOffice.org extension development. The old code
was based on the internals of OpenOffice.org 1.0 and designed to work with
a non-free Finnish spellchecking library.
The license has been changed from LGPL to GPL to reflect the fact that this
extension is useless without libvoikko, which is distributed under the GPL.
For changes since 2.0 see ChangeLog.
