extensions/net.sf.basedb.examples/trunk/README

Code
Comments
Other
Rev Date Author Line
636 19 Mar 08 nicklas 1 == Requirements ==
636 19 Mar 08 nicklas 2
4240 15 Nov 16 nicklas 3  1. BASE 3.10 or later.
636 19 Mar 08 nicklas 4  
636 19 Mar 08 nicklas 5 == Introduction ==
636 19 Mar 08 nicklas 6
683 30 Apr 08 nicklas 7 This package contains a few simple variants of ''Hello world'' applications
683 30 Apr 08 nicklas 8 in the form of extensions to the BASE web client. The package installs
683 30 Apr 08 nicklas 9 several examples into the ''Extensions -> Hello world examples'' menu:
636 19 Mar 08 nicklas 10
683 30 Apr 08 nicklas 11  * Hello world! - A basic example using only javascript
683 30 Apr 08 nicklas 12  * Hello factory world! - An example that uses a custom action factory
683 30 Apr 08 nicklas 13  * Greetings Root! - An example of a custom action factory with parameters
683 30 Apr 08 nicklas 14  * Hello JSP world! - Uses a JSP file to display the message instead of javascript
683 30 Apr 08 nicklas 15  * Hello X-JSP world! - Another variant of a JSP file
683 30 Apr 08 nicklas 16  * Hello Servlet world! - Uses a servlet to generate the message
1150 31 Aug 09 nicklas 17  * Hello Servlet world (alternate)! - Uses an alternative servlet path
636 19 Mar 08 nicklas 18
1019 03 Apr 09 nicklas 19 There are also a few toolbar button extensions:
1019 03 Apr 09 nicklas 20
1019 03 Apr 09 nicklas 21  * More info - A toolbar button on all single-item toolbars and 
1019 03 Apr 09 nicklas 22    displays some information in a popup window about the current item.
1019 03 Apr 09 nicklas 23  * Annotation filter - A toolbar button on all list pages for annotatable
1019 03 Apr 09 nicklas 24    items which allows a user to show only items with/without annotations.
1019 03 Apr 09 nicklas 25
1269 11 Nov 10 nicklas 26 And a edit/save extension:
1269 11 Nov 10 nicklas 27  
1269 11 Nov 10 nicklas 28  * Sample history data - Two extensions that works together. The first adds
1269 11 Nov 10 nicklas 29    a tab to the "Edit sample" dialog were the user can select a file to link
1269 11 Nov 10 nicklas 30    with the sample. The second extensions attaches to the save event and 
1269 11 Nov 10 nicklas 31    saves the link.
1271 16 Nov 10 nicklas 32  * Last updated by - An on-save extension that creates an any-to-any link
1271 16 Nov 10 nicklas 33    between any item and the currently logged in user. This is a very simple
1271 16 Nov 10 nicklas 34    logging feature that stores information about the last update to an item.
1269 11 Nov 10 nicklas 35
1596 28 Mar 12 nicklas 36 And some extra list columns:
1596 28 Mar 12 nicklas 37
1596 28 Mar 12 nicklas 38  * Owner registration date - Adds a list column that display the registration
1596 28 Mar 12 nicklas 39    date of the owner of the item. The column is added to all list pages that
1596 28 Mar 12 nicklas 40    list items that have an owner.
1596 28 Mar 12 nicklas 41  * Onwer email - Adds a list column that display the email address of the
1596 28 Mar 12 nicklas 42    owner of the item. This uses a custom formatter to create mailto links
1596 28 Mar 12 nicklas 43    on the web page and a formatter that convert to upper case when exporting.
1596 28 Mar 12 nicklas 44    The column is added to all list pages that list items that have an owner.
1596 28 Mar 12 nicklas 45  * Data files - Adds a column to the raw bioassay list that display the
1596 28 Mar 12 nicklas 46    data files that are attached to each raw bioassay. This uses a custom
1596 28 Mar 12 nicklas 47    action factory and illustrates the possibility to create fullblown HTML
1596 28 Mar 12 nicklas 48    for the web page, and a text-only variant for the table exporter.
1596 28 Mar 12 nicklas 49
1604 18 Apr 12 nicklas 50 Item overview extensions:
1604 18 Apr 12 nicklas 51
1611 23 Apr 12 nicklas 52  * Loader that add the owner of an item to the overview.
1611 23 Apr 12 nicklas 53  * Validator that check that the owner has an URL and that it is valid.
1611 23 Apr 12 nicklas 54  * Loader that load the role membership of users.
1611 23 Apr 12 nicklas 55  * Validator that check that a user is a member of at least one role.
1611 23 Apr 12 nicklas 56  * A extra information section which display some information about the
1611 23 Apr 12 nicklas 57    currently selected node and item. 
1604 18 Apr 12 nicklas 58
1711 07 Aug 12 nicklas 59 Logging extensions:
1711 07 Aug 12 nicklas 60
1711 07 Aug 12 nicklas 61   * A logging extension that write information about created, updated and
1711 07 Aug 12 nicklas 62     deleted items to stdout. The logger is based on the default database 
1711 07 Aug 12 nicklas 63     logger.
1711 07 Aug 12 nicklas 64
4239 15 Nov 16 nicklas 65 A custom extension point:
4239 15 Nov 16 nicklas 66
4239 15 Nov 16 nicklas 67  * A simple example of defining a custom extension point. There is
4239 15 Nov 16 nicklas 68    one implementation provided in this package, but the main purpose
4239 15 Nov 16 nicklas 69    of the extension point is to make it easier for other extensions to
4239 15 Nov 16 nicklas 70    test and implement custom extension points.
4239 15 Nov 16 nicklas 71
1347 18 Apr 11 nicklas 72 This package contains the following plug-ins:
1347 18 Apr 11 nicklas 73
1347 18 Apr 11 nicklas 74  * An importer that pretends to be able to import samples. It will 
1347 18 Apr 11 nicklas 75    accept any file, but doesn't do anything. Main purpose is to 
1347 18 Apr 11 nicklas 76    show parameter handling with plug-ins.
1347 18 Apr 11 nicklas 77  * An analyser plug-in that does some bogus calculations on a 
1347 18 Apr 11 nicklas 78    bioassay set. Main purpose is to show how a plug-in can access
1347 18 Apr 11 nicklas 79    analysed data, do some calculations and store the result as
1347 18 Apr 11 nicklas 80    a new bioassay set.
1347 18 Apr 11 nicklas 81
1347 18 Apr 11 nicklas 82
636 19 Mar 08 nicklas 83 == Installation ==
636 19 Mar 08 nicklas 84
1392 15 Sep 11 nicklas 85  1. Download the base-examples-*.tar.gz file.
1392 15 Sep 11 nicklas 86  2. Unpack the downloaded file to a directory of your choice.
1392 15 Sep 11 nicklas 87  3. Copy the 'base-examples.jar' file to your BASE plug-ins directory
1392 15 Sep 11 nicklas 88     as configured in the base.config[plugins.dir] setting. 
1392 15 Sep 11 nicklas 89  4. Go to 'Administrate->Plug-ins & Extensions->Overview' page.
1392 15 Sep 11 nicklas 90  5. Run the installation wizard and select to install 'base-examples.jar'.
1392 15 Sep 11 nicklas 91  6. The ''Hello X-JSP world'' example requires that the X-JSP compiler is installed
683 30 Apr 08 nicklas 92     on the server. Read in the documentation how to do this.
6306 11 Jun 21 nicklas 93     https://base.thep.lu.se/chrome/site/latest/html/admin/plugins.installation.html
1392 15 Sep 11 nicklas 94  7. Done. You may have to use 'BASE->Reload permissions' from the menu to see the 
1392 15 Sep 11 nicklas 95     'Extensions' menu.
636 19 Mar 08 nicklas 96
1392 15 Sep 11 nicklas 97
636 19 Mar 08 nicklas 98 == Compiling ==
636 19 Mar 08 nicklas 99
636 19 Mar 08 nicklas 100 To compile this package you also need:
636 19 Mar 08 nicklas 101  
1433 02 Nov 11 nicklas 102  1. Ant 1.8
4236 15 Nov 16 nicklas 103  2. Java 1.8
636 19 Mar 08 nicklas 104
636 19 Mar 08 nicklas 105 Follow these instructions:
636 19 Mar 08 nicklas 106
691 12 May 08 nicklas 107  1. Type `ant download-lib` to automatically download the BASE core JAR file that
691 12 May 08 nicklas 108     are neeed for compilation. You can also do this manually by copying the 
2287 13 Mar 14 nicklas 109     base-core-3.x.jar and base-webclient-3.x.jar files from the BASE installation
1346 18 Apr 11 nicklas 110     directory (<basedir>/www/WEB-INF/lib/) to the ./lib/compile directory.
636 19 Mar 08 nicklas 111
1392 15 Sep 11 nicklas 112  2. Type 'ant' to compile the code and generate the 'base-examples.jar' 
1094 28 May 09 nicklas 113     file in the project directory. This file can be installed into BASE following
1094 28 May 09 nicklas 114     the intructions above.
1094 28 May 09 nicklas 115
1346 18 Apr 11 nicklas 116  3. Use 'ant package' to create a downloadable tar.gz.
1346 18 Apr 11 nicklas 117  
1346 18 Apr 11 nicklas 118  4. If you create a file called 'build.properties' and enter a the path to the
1346 18 Apr 11 nicklas 119     plug-ins directory under the key 'base.plugins', you can simply type 
1346 18 Apr 11 nicklas 120     'ant install' to copy the examples to the BASE plug-ins directory.

Generated on Tue Nov 21 03:24:05 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)