How to install the DSP extension to the MoinMoin wiki
=====================================================
To install this extension basically means to put four files into  into four 
different folders. The four files are:
File 1: DSP.py, this file is the parser, creates moinmoin-wiki-syntax
File 2: DSP2XML.py, this file is used to convert the DSP to XML
File 3: DescriptionSet.py, contains the code that is used by the two files above
File 4: MiniPage.py, this file is a "macro" that is needed for the wiki-syntax, 
taken from the moinmoin macro-market, is available from 
<http://moinmoin.wikiwikiweb.de/MacroMarket/MiniPage>

File 1-3 should be contained in the distribution together with this file. File 4
can be downloded from <http://moinmoin.wikiwikiweb.de/MacroMarket/MiniPage>

Furthermore, you will need to have Moinmoin version 1.3 or later installed for
using this extension.

Placing of the files
====================
There are basically two ways to do the installation:
1) install the files for each wiki-instance, then the extension will only be 
available in the wiki-instances where it has been installed. 

2) install the files to work for the whole wiki (if wiki-instances are used the 
extension will in this case be available automatically)

1)Install into a wiki-instance
==============================

File 1, This file is a parser extension to the wiki and should be placed in the 
directory "<moinmoinWikiInstance>/data/plugin/parser/". More information about 
parser extension can be found here: <http://moinmo.in/ParserMarket>

File 2, this file is an action extension and should be placed in the directory 
"<moinmoinWikiInstance>/data/plugin/action/". More information about action 
extensions can be found here: <http://moinmo.in/ActionMarket>

File 3, This file should be put in a folder called "DescriptionSetProfile" 
(which it already should be with the distribution).  The folder can be put into 
one of the following locations:

1) In the code-base for Python, so that a running Python-program can find it
2) Anywhere in the file-system, just as long as the environment-variable 
$PYTHONPATH is set to the folder where the folder "DescriptionSetProfile" is 
located. This way a Python program can locate the file to execute.
As an example, if the folders looks like this: 
"<Somefolder-structure>/FolderExample/DescriptionSetProfile/DescriptionSet.py", 
the environment-variable PYTHONPATH needs add the path 
<Somefolder-structure>/FolderExample  

For both options the rights to read the file (and of course also the folders 
leading to it) should be given to the "user" that is running the wiki.

File 4, this file is a macro-extension and should be placed in the directory 
"<moinmoinWikiInstance>/data/plugin/macro/", please note that this file might 
already exist. If so, there is probably no need to insert the file contained in 
this distribution. The extension can be retrieved from the webpage of moinmoin 
wiki, see further: <http://moinmo.in/MacroMarket/MiniPage>. Details about 
installing macros on moinmoin can be found here: <http://moinmo.in/MacroMarket>

Note that you need to make sure that the file has the name MiniPage.py. When it 
is downloaded from the moinmoin-site the version-number can be in the name of 
the file. Then the wiki will not find the macro-extension.

When this is done, everything is installed and should be working. If the changes
does not have effect at once, the wiki instance needs to be restarted.

2) Install the extension into the whole wiki
============================================
For this type of installation the four files are copied into different folders 
of the "site-packages" of the Python-installation. On UNIX/Linux-system this is 
usually located here /usr/lib/pythonX.Y/site-packages (X.Y corresponds to the 
version number of Python). During the MoinMoin-installation a folder called 
MoinMoin has been created, ie 
<folder-path to site-packages>/site-packages/MoinMoin. Where to put the four 
files under this folder will be explained below:

File 1, This file is a parser extension to the wiki and should be placed in the 
directory "<folder-path to site-packages>/site-packages/MoinMoin/parser/". More 
information about parser extension can be found here: 
<http://moinmo.in/ParserMarket/InstallingParsers>

File 2, this file is an action extension and should be placed in the directory 
"<folder-path to site-packages>/site-packages/MoinMoin/action/". More 
information about action extensions can be found here: 
<http://moinmo.in/ActionMarket>

File 3, This file contains code that is used both by the action and the parser 
extension. The file should be put in a folder called "DescriptionSetProfile" 
(which it already should be with the distribution together with a file called 
__init__.py). This folder is in turn put directly under 
"<folder-path to site-packages>/site-packages/", ie the folder structure 
would be: "<folder-path to site-packages>/site-packages/DescriptionSetProfile". 
In this folder two files should now exist, DescriptionSet.py (ie File 3) and the
file __init__.py.

In case the file __init__.py does not exist, just create an empty file with that
name and everything should work. 

File 4, this file is a macro-extension and should be placed in the directory 
"<folder-path to site-packages>/site-packages/MoinMoin/macro/", please note that
this file might already exist. If so, there is probably no need to insert the 
file contained in this distribution. The extension is taken from the webpage of 
moinmoin wiki, see further: <http://moinmo.in/MacroMarket/MiniPage>. Details 
about installing macros on moinmoin can be found here: 
<http://moinmo.in/MacroMarket>

Note that you need to make sure that the file has the name MiniPage.py. When it 
is downloaded from the moinmoin-site the version-number can be in the name of 
the file. Then the wiki will not find the macro-extension.

When all files are put into the correct folder, everything is installed and 
should be working. If the changes does not have effect at once, the wiki might 
need to be restarted.

2008-10-03 Fredrik Enoksson <fenoksson (at) gmail.com>
