Blog | Roadmap | Browse Source | View Tickets | Trac Login

Developers installation guide - OSX

This document is a step by step guide for setting up your Mac to run ICE as a developer.

Note: You will need root access to do the following steps

1 Required software

OpenOffice.org 2.0

NB: There is no need to run OpenOffice.org 2.0 it is only used to automate either the latest OpenOffice.org or NeoOffice

  1. Download OpenOffce.org 2.0 for Mac OS X 127Mb

  2. Open the OpenOffice.org dmg file

  3. Drag the OpenOffice.org app file into your application directory

OpenOffice.org or Neo Office

Either download and install OpenOffice.org or Neo Office (this is what's used to write with).

MacPorts

Download and install MacPorts from http://www.macports.org

You should add /opt/local/bin (or wherever you chose to install MacPorts) to your shell's path as well as /usr/local/bin.

export PATH=$PATH:/opt/local/bin:/usr/local/bin

If you are behind a web proxy set the http_proxy environment variable e.g.

export http_proxy=http://proxy.usq.edu.au:8000 

2 Install packages

Before doing any installing make sure you have Xcode installed, it is available on your systems OS disk and is needed to build the packages.

sudo port selfupdate
sudo port install subversion
sudo port install python25
sudo port install python_select
sudo port install py25-hashlib
sudo port install py25-libxml2
sudo port install py25-setuptools
sudo port install py25-cheetah
sudo port install py25-paste
sudo port install py25-pil

If MacPorts fails

If an install fails using MacPorts:

sudo port clean $port-name

Set MacPorts python 2.5 as the default

sudo python_select python25

2.1 Other packages

Google Data API

Homepage: http://code.google.com/p/gdata-python-client/

This is required for Atom publishing.

  1. Download and extract gdata source from http://code.google.com/p/gdata-python-client/downloads/list

  2. Build and install

    cd ${GDATA_SRC_DIR}
    python setup.py install

PyLucene

Homepage: http://pylucene.osafoundation.org/

This is required for searching.

  1. Download and extract PyLucene 2.3.x source from http://downloads.osafoundation.org/PyLucene/jcc/

  2. Build and install JCC (included with PyLucene)

    cd ${PYLUCENE_SRC_DIR}/jcc
    python setup.py build
    sudo python setup.py install
  3. Modify the Makefile for a MacPorts python 2.5 installation

    Example Makefile configuration

    # Mac OS X (MacPorts Python 2.5, Java 1.5)
    PREFIX_PYTHON=/opt/local
    ANT=ant
    PYTHON=$(PREFIX_PYTHON)/bin/python
    JCC=$(PYTHON) -m jcc
    NUM_FILES=1
  4. Build and install PyLucene

    make all
    sudo make install

pysvn

Homepage: http://pysvn.tigris.org/

  1. Download and extract pysvn 1.5.3 source from http://pysvn.tigris.org/project_downloads.html

  2. Modify setup.py to work properly with MacPorts packages

    sed -e "215s/fix, os/fix, 'lib', os/;574s/libdb-4.3/db44\/libdb-4.4/" setup.py > fixed-setup.py
  3. Build and install pysvn

    cd ${PYSVN_SRC_DIR}/Source
    python fixed-setup.py configure
    make
    sudo cp -r pysvn /opt/local/lib/python2.5/site-packages

py2app

Homepage: http://www.undefined.org/python/

This is only required for building the Mac OS X compiled binary.

  1. Download and install py2app

    sudo easy_install-2.5 -U py2app

2.2 Verify the packages are installed

The Python packages can be verified by:

python
>>> import gdata
>>> import libxml2
>>> import lucene
>>> import paste
>>> import py2app
>>> import pysvn
>>> import Cheetah
>>> import Image

3 Configure OOo

  1. Open Configure OpenOffice.org

  2. When the document loads select enable macros.

  3. From the menubar select ICE...Change port

  4. Enter 2002

  5. Close the document and restart the application

4 Source code

  1. Checkout the source code:

    svn co http://ice.usq.edu.au/svn/ice/trunk/apps ice-source
  2. Run ICE from the source

    cd ice-source/apps/ice
    python ice2.py

5 Configure ICE

5.1 Add a SVN repository

  1. Start the ICE server

    Go to StartProgram FilesICE 2.0ICE server

  2. Go to http://localhost:8000, the Config editor page will load

  3. Enter a SVN URL in the New repository URL: field or fill in the information required under Advanced repository settings

  4. Click Save and then click Close editor.

  5. Enter your username and password for the SVN URL provided.

    ICE will then checkout the content from the given SVN URL.

5.2 Add document templates

Before you can create documents using ICE you will need to add some ICE templates. In order to use the ICE templates affectively also install the word processor toolbars.

  1. Create a folder called templates in the root of your repository. For example if your content was located in ~\ICE\MyFiles make the directory ~\ICE\MyFiles\templates

  2. Download either an OpenOffice.org template (Default.odt) and/or Word template (Default.doc) into the templates directory you just added. Change these files or add others into the template directory as required.

    You should now be able to create new files using the Add tab in ICE.