Building AbiWord and Plugin Installers

by Ryan Pavlik (rp), with fantastic help from "Sum1" and Marc Maurer (uwog)

General Instructions

These instructions are designed to provide the reader with the ability to create self-contained installation files (installers), such as those available for download on the web site. Ryan Pavlik builds the provided installers using this procedure for Windows releases in the 2.3.x series starting with 2.3.4, and will provide binaries similarly for the 2.4.x series. PLEASE NOTE: You do not need to follow these instructions to install AbiWord on Windows! Please use a pre-made installer available at www.abisource.com/download/ - they are standard and known to be reliable.

Several of the sections include a "One-Time Prep" subsection and an "Each Build" subsection. While these are generally proper classifications, please note that after a make realclean or any removal of the \abi\src\MINGW32_1.0.10_i386_OBJ\bin directory, any files copied to there must be recopied, even if the instructions to copy are listed under the "One-Time Prep" heading. Any steps preceded by "//" are C-style comments, and should NOT BE COMPLETED. They have not yet been removed because I'm not sure my new steps are better yet.

What You'll Need (besides a tarball or a checkout of Abi)

Files

Sources

Abi: http://www.abisource.com/downloads

TML: http://www.gimp.org/~tml/gimp/win32/downloads.html

GW32: http://sourceforge.net/project/showfiles.php?group_id=23617

Mikey: http://www.bluey.com/abiword

Preparing MSYS/MinGW

Installing MSYS, DTK, MinGW

Download the latest MSYS, and MinGW from www.mingw.org

Install MinGW according to instructions, to c:\MinGW or d:\MinGW preferably. (I used d:\MinGW)

Install MSYS according to instructions, probably to c:\MSYS or d:\MSYS (I used d:\MSYS), make sure to tell it where you installed MinGW at the appropriate point in the installer.

Download these files from the MinGW web site: msys-automake-1.8.2.tar.bz2, msys-autoconf-2.59.tar.bz2, msys-libtool-1.5.tar.bz2, and unzip them all into d:\MSYS\1.0 or equivalent.

// SKIP THIS STEP - Install the MSYS DTK.

// SKIP THIS STEP - Install MSYS again to the same location and with the same settings. This is to overwrite outdated tools installed by the DTK.

Download the latest CVSNT ZIP file from http://www.cvsnt.org/wiki/Download and extract to D:\cvs, C:\CVS, or some similar location without spaces.

Add your CVS install directory to your path.

Download and install the latest ActivePerl from http://activestate.org/Products/Download/Download.plex?id=ActivePerl (Use the MSI package) to a nice location like D:\Perl

Installing Dependencies

Make sure you have downloaded all files in the above table.

Extract all files in the above table up until the first starred note into MinGW, so that their directories overwrite those already installed. This will insert the bin files into MinGW/bin, includes into MinGW/include, and so on.

Move the four files after the first starred note (they are not zipped) into the location listed in their note.

Install NSIS according to instructions.

Unzip the plugins into the NSIS plugins subdirectory.

If NSIS is not in C:\Program Files\NSIS

Open the Control Panel, go into System.

In Windows XP/2000, on the Advanced Tab, click "Environment Variables". In any other Windows, dig around until you find something similar.

Add a new variable, named NSIS_ROOT, and set the value to the MSYS path to the NSIS root (for instance, "/d/Program Files/NSIS")

Building the Installers

Preparing your AbiWord Source Tree

From CVS

Create a a directory with no spaces in the name (easier) in a shallow directory of one of your drives (c:\abisource, d:\srctrees\abihead)

Click Start, Run, enter "cmd" (for WinNT/2k/XP, "command" for all other versions)

Execute the following commands:

set CVSROOT=:pserver:anoncvs@cvs.abisource.com:/cvsroot

cvs login

Password is anoncvs

only needs to be performed once

Close your command window.

Open MSYS.

cd to the directory you just made using msys syntax (cd /c/abisource, cd /d/srctrees/abihead)

execute these commands:

export CVSROOT=:pserver:anoncvs@cvs.abisource.com:/cvsroot

cvs -z3 co abi abidistfiles abiword-docs abiword-plugins expat fribidi libiconv libpng link-grammar popt

cvs -z3 co -r wv-1-0-0-STABLE wv

From a Tarball

Create a a directory with no spaces in the name (easier) in a shallow directory of one of your drives (c:\abisource, d:\srctrees\abihead)

Untar your tarball there (in msys, copy it in and run tar xvzf abiword-2.3.4.tar.gz or tar xvjf abiword-2.3.4.tar.bz2)

Inside what you have untarred, delete the zlib directory

For both CVS and Tarballs

Complete the above steps for your chosen method of source distribution.

Make a new directory inside your AbiWord source directory (parent of abi directory) named libs.

Make a new directory within it named zlib.

Unzip your zlib download within there.

Building AbiWord Core Installer

Open MSYS

cd into your AbiWord source directory, and the abi subdirectory within (cd /d/srctrees/abihead/abi for me)

Execute the command "make distribution" (no quotes)

Your installer will be in the abi/dist directory.

Tools Plugins Installer Build

One-Time Prep:

Download the link-grammar module from AbiWord CVS

cd into link-grammar

./configure --prefix=/mingw

make

make install

Download the gtkmathview cvs module from GNOME CVS using these steps:

Click Start, Run, cmd to open a command console, then execute these commands

set CVSROOT=:pserver:anonymous@anoncvs.gnome.org:/cvs/gnom

cvs login

no password

cvs -z3 co gtkmathview (ignore the error about a file conflict)

Close the command dialog and go back into msys

cd into that directory

Execute the following commands in that directory in MSYS

./autogen.sh

CC=g++ LDFLAGS="-Wl,--enable-runtime-pseudo-reloc" ./configure --prefix=/mingw --disable-boxml --disable-gmetadom --disable-libxml2-reader --disable-custom-reader --enable-pipe --disable-tfm --disable-svg --disable-gtk --with-t1lib=no

make && make install

Each Build:

Copy the file D:\MinGW\etc\gtkmathview\gtkmathview.conf.xml to abi\src\MINGW32_1.0.10_i386_OBJ\AbiSuite\math (you will have to create this directory)

Copy the file D:\MinGW\share\gtkmathview\dictionary.xml to abi\src\MINGW32_1.0.10_i386_OBJ\AbiSuite\math

copy D:\MinGW\bin\liblink-grammar-4.dll to \abi\src\MINGW32_1.0.10_i386_OBJ\bin

copy /mingw/share/link-grammar/en folder to \abi\src\MINGW32_1.0.10_i386_OBJ\bin\

Copy libxml2.dll from the zip file it came in or mingw/bin to abi\src\MINGW32_1.0.10_i386_OBJ\bin

Open MSYS

cd into abi

export PKG_CONFIG_PATH=/mingw/lib/pkgconfig

make disttools

Your installer is in abi\dist

Import/Export Plugins Installer Build

One-Time Prep

Download and unzip psiconv

Open MSYS

cd into psiconv-0.9.7

run ./configure --prefix=/mingw

open up the source tree and find and open configuration.c

in configuration.c, you'll need to change two index() calls to strchr() and save

in the psiconv directory, make install

in MinGW\include, copy windef.h to windef.h.bak

open windef.h up in an editor

find (at about line 315) typedef struct tagPOINT {

Insert #define POINT ICKY_WIN_POINT before it and save

Rename libbz2.dll.a in mingw\lib to _libbz2.dll.a

Each Build:

copy libwpd-stream-0.8.dll and libwpd-0.8.dll files from libwpd-0.8.2 or mingw/bin to abi\src\MINGW32_1.0.10_i386_OBJ\plugins

Open MSYS and cd into the abi/ directory

make distimpexp

Your installer is in abi\dist