plugins/base2/net.sf.basedb.examples/trunk/README

Code
Comments
Other
Rev Date Author Line
647 11 Apr 08 nicklas 1 == Requirements ==
647 11 Apr 08 nicklas 2
1292 24 Feb 11 nicklas 3  1. BASE 2.17.0 or later.
647 11 Apr 08 nicklas 4  
647 11 Apr 08 nicklas 5 == Introduction ==
647 11 Apr 08 nicklas 6
647 11 Apr 08 nicklas 7 This package contains some simple BASE plug-in examples. The target
647 11 Apr 08 nicklas 8 group is developers that want's to create their own BASE plug-ins.
647 11 Apr 08 nicklas 9 To install the plug-ins you need a local installation of BASE or 
647 11 Apr 08 nicklas 10 administrator access to an existing BASE installation. We don't 
647 11 Apr 08 nicklas 11 recommend that the example plug-ins are installed on a production 
647 11 Apr 08 nicklas 12 server.
647 11 Apr 08 nicklas 13
647 11 Apr 08 nicklas 14 Read http://base.thep.lu.se/chrome/site/latest/html/developerdoc/plugin_developer/plugin_developer.html
647 11 Apr 08 nicklas 15 for more information about developing BASE plug-ins.
647 11 Apr 08 nicklas 16
647 11 Apr 08 nicklas 17 Currently, this package contains the following plug-ins:
647 11 Apr 08 nicklas 18
647 11 Apr 08 nicklas 19  * An importer that pretends to be able to import samples. It will 
647 11 Apr 08 nicklas 20    accept any file, but doesn't do anything. Main purpose is to 
647 11 Apr 08 nicklas 21    show parameter handling with plug-ins.
647 11 Apr 08 nicklas 22  * An analyser plug-in that does some bogus calculations on a 
647 11 Apr 08 nicklas 23    bioassay set. Main purpose is to show how a plug-in can access
647 11 Apr 08 nicklas 24    analysed data, do some calculations and store the result as
647 11 Apr 08 nicklas 25    a new bioassay set.
647 11 Apr 08 nicklas 26
647 11 Apr 08 nicklas 27 == Installation ==
647 11 Apr 08 nicklas 28
647 11 Apr 08 nicklas 29  1. Unpack the tar.gz file to a directory of your choice. 
647 11 Apr 08 nicklas 30  2. Copy the example-plugins.jar to your BASE plug-in directory. 
647 11 Apr 08 nicklas 31  3. Install the plug-ins using the BASE web interface. See
647 11 Apr 08 nicklas 32     http://base.thep.lu.se/chrome/site/latest/html/admindoc/plugin_installation/plugins.installation.html
647 11 Apr 08 nicklas 33     for more information.
647 11 Apr 08 nicklas 34  4. Done. 
647 11 Apr 08 nicklas 35
647 11 Apr 08 nicklas 36 == Compiling ==
647 11 Apr 08 nicklas 37
647 11 Apr 08 nicklas 38 To compile this package you also need:
647 11 Apr 08 nicklas 39  
647 11 Apr 08 nicklas 40  1. Ant 1.6
647 11 Apr 08 nicklas 41  2. Java 1.6
647 11 Apr 08 nicklas 42
647 11 Apr 08 nicklas 43 Follow these instructions:
647 11 Apr 08 nicklas 44
1291 24 Feb 11 nicklas 45  1. Type 'ant download-lib' to download dependencies that are not included in
1291 24 Feb 11 nicklas 46     the subversion repository.
1291 24 Feb 11 nicklas 47     
1291 24 Feb 11 nicklas 48  2. Type 'ant' to compile the code and generate the 'example-plugins.jar' file
647 11 Apr 08 nicklas 49     in the project directory.
647 11 Apr 08 nicklas 50
1291 24 Feb 11 nicklas 51  3. Use 'ant package' to create a downloadable tar.gz package in the project
647 11 Apr 08 nicklas 52     directory.
647 11 Apr 08 nicklas 53