| 1 | Prerequisites |
|---|
| 2 | ================== |
|---|
| 3 | The following should be installed to run the ojims editor: |
|---|
| 4 | 1. Python2.5 - see http://www.python.org/download/ |
|---|
| 5 | 2. Pylons - see http://docs.pythonweb.org/display/pylonsdocs/Installing+Pylons |
|---|
| 6 | 3. Genshi - see http://genshi.edgewall.org/wiki/Download |
|---|
| 7 | 4. FormEncode - see http://www.formencode.org/download.html |
|---|
| 8 | 5. ndgCommon - see http://proj.badc.rl.ac.uk/ndg/browser/ndgCommon |
|---|
| 9 | |
|---|
| 10 | NB, it is easier to setup the prereqs by using easy_install - http://peak.telecommunity.com/DevCenter/EasyInstall |
|---|
| 11 | - then you can just run, easy_install pylons, easy_install genshi, etc. |
|---|
| 12 | |
|---|
| 13 | Installation and Setup |
|---|
| 14 | ====================== |
|---|
| 15 | Once the prereqs are installed and the codebase is extracted to a local: |
|---|
| 16 | |
|---|
| 17 | i) Copy the development.ini, helpText.config and milk.config files in the top level MILK |
|---|
| 18 | directory to the milk_server directory below |
|---|
| 19 | ii) Adjust the content of these files as follows: |
|---|
| 20 | |
|---|
| 21 | development.ini |
|---|
| 22 | - adjust the host and port settings appropriately |
|---|
| 23 | - turn debug on/off |
|---|
| 24 | - adjust logging level of server output (adjust the logger_root settings) |
|---|
| 25 | |
|---|
| 26 | milk.config |
|---|
| 27 | adjust: |
|---|
| 28 | [DEFAULT] |
|---|
| 29 | - server - NB, this should match the host and port settings in the development.ini file |
|---|
| 30 | - mailServer - SMTP server to sending mails |
|---|
| 31 | - metadataMaintainer - email address to which correction comments will be mailed |
|---|
| 32 | - tbrecipient mail address to which trackback comments are sent |
|---|
| 33 | - proxyServer - proxy server to use, if required |
|---|
| 34 | - debug - for more verbose logging |
|---|
| 35 | [SEARCH] |
|---|
| 36 | - discoveryURL - url to discovery service; defaults to discovery service on the current stack |
|---|
| 37 | |
|---|
| 38 | [WMC_CLIENT] |
|---|
| 39 | - url - if a WMC client is to be used to retrieve data for visualisation purposes, specify |
|---|
| 40 | the url to it here |
|---|
| 41 | |
|---|
| 42 | [NDG_B_SERVICE] |
|---|
| 43 | - add details of providers and their associated browse services, to be exposed by this |
|---|
| 44 | browse service - format: 'provider ID: hostname' |
|---|
| 45 | |
|---|
| 46 | [NDG_EXIST] |
|---|
| 47 | - add appropriate eXist DB servers and the providers which they serve |
|---|
| 48 | - passwordFile - specify password file with content format: |
|---|
| 49 | |
|---|
| 50 | 'db host name' 'user ID' 'password' |
|---|
| 51 | |
|---|
| 52 | [DISCOVERY] |
|---|
| 53 | - discoveryServiceURL - if a different discovery service is to be used from the default |
|---|
| 54 | one (defined in ndg.common.src.clients.ws.discovery.discoveryserviceclient) |
|---|
| 55 | |
|---|
| 56 | [MILK_SERVER] |
|---|
| 57 | - configure the MILK stack to provide editor, browse, discovery, or any combination of the |
|---|
| 58 | three, services |
|---|
| 59 | |
|---|
| 60 | helpText.config |
|---|
| 61 | Adjust any of the help text contain in the file to suit purpose. NB, any help text |
|---|
| 62 | here is set on the globals object as a new field - e.g. having a line, |
|---|
| 63 | ' |
|---|
| 64 | blah: some help text |
|---|
| 65 | ' |
|---|
| 66 | in this file will set up data on the globals variable so that: |
|---|
| 67 | |
|---|
| 68 | g.blah will output, 'some help text' when used. |
|---|
| 69 | |
|---|
| 70 | |
|---|
| 71 | iii) From the milk_server directory, run: |
|---|
| 72 | |
|---|
| 73 | paster serve --reload development.ini |
|---|
| 74 | |
|---|
| 75 | Vocab server autocomplete client |
|---|
| 76 | ------------------- |
|---|
| 77 | Also included in the codebase is a client for doing ajax based autocomplete vocab |
|---|
| 78 | term searches against a vocab server for an input text field. Details on how |
|---|
| 79 | to set this up for use are available in milk_server/controllers/vocabsearch/README.txt. |
|---|
| 80 | |
|---|
| 81 | Further Notes |
|---|
| 82 | ----------------- |
|---|
| 83 | i) The editor uses the browse service under the covers, so if this is enabled, browse |
|---|
| 84 | functionality will also be available |
|---|
| 85 | ii) Browse links exposed by searches in the discovery service are generated using the |
|---|
| 86 | results from the discovery service; if these are invalid, it is likely that the moles |
|---|
| 87 | data has not been properly passed along the pipeline from document publication to |
|---|
| 88 | ingestion in the discovery service |
|---|
| 89 | (NB, for info on how the discovery ingest works, see: |
|---|
| 90 | |
|---|
| 91 | http://proj.badc.rl.ac.uk/badc/wiki/opman/FeedHarvester and |
|---|
| 92 | http://proj.badc.rl.ac.uk/badc/wiki/opman/OAIIngester |
|---|
| 93 | |
|---|
| 94 | TODO |
|---|
| 95 | -------------- |
|---|
| 96 | i) The retrieve controller which represents the browse service is very ropey and could do |
|---|
| 97 | with a lot of tidying up |
|---|
| 98 | ii) The discovery controller which represents the discovery service is very ropey and |
|---|
| 99 | could do with a lot of tidying up |
|---|
| 100 | iii) Implementation of new security layer; this is being developed by Phil Kershaw and |
|---|
| 101 | should sit on top of the MILK stack without any extra modification. When it is available, |
|---|
| 102 | the existing security code should be entirely removed, as it currently is not doing anything. |
|---|
| 103 | |
|---|
