Adding collective.xdv to your Plone instance

We will assume that you have a passing familiarity with Plone's configuration/build system, Buildout  — if not, don't worry, it should be pretty simple to follow along even if you don't. I also assume that you already have Plone and Firefox + Firebug installed.

A note about the setup

Setting up collective.xdv takes some grunt work because it has some slightly unusual dependencies. When this solution ships with Plone itself, this will of course already be handled for you. So bear with us through the install instructions — and rest safe in the knowledge that this will be much easier in the future. It's the price you pay for being on the forefront of technology — but we can promise you that it will be worth it!

The installation process involves the usual steps of

• adding collective.xdv to buildout
• running buildout
• installing collective.xdv in your Plone site

Adding collective.xdv to buildout

As the installation process is not entirely consistent across platforms yet, you'll need to follow the platform specific instructions on the following pages. It is well-worth checking the installation instructions on the collective.xdv page in the Python Package Index for the latest information on recent releases. The following pages go over the same instructions in a little more detail:

• Windows
• Mac OS X
• Linux

Running Buildout

Once you have edited your configuration file according to the platform instructions above, it's time to run Buildout, so the system can add and set up collective.xdv for you. Open a terminal window (or on Windows, start > run > cmd) and on the command line, cd to the the root of your Plone instance (same directory as buildout.cfg is located in) and run Buildout like this:

$ bin/buildout

or, if you're using Windows XP or older:

> bin\buildout

You will see output similar to this:

Getting distribution for 'collective.xdv==1.0'.
Got collective.xdv 1.0.
Getting distribution for 'dv.xdvserver'.
Got dv.xdvserver 1.0b4.
Getting distribution for 'plone.postpublicationhook'.
Got plone.postpublicationhook 1.0rc1.
Getting distribution for 'plone.app.registry'.
Got plone.app.registry 1.0a1.
Getting distribution for 'plone.synchronize'.
Got plone.synchronize 1.0b1.

If everything went according to plan, we now have collective.xdv installed. Time to start Plone and activate it for our site.

Issues and Problems

If you get errors when doing this instead of the above output, please contact the Plone support forums to get more help with your specific setup.

Especially, if you're on Mac OS X, there might be some  issues. We have been working on fixing the Mac situation for a while, and it should be fixed by the time you read this — but if it isn't, let us know!