source: extensions/net.sf.basedb.examples/trunk/README @ 1346

Last change on this file since 1346 was 1346, checked in by Nicklas Nordborg, 12 years ago

Fixes #310: Update extension examples to BASE 3

There are no code changes. It is minor changes in packaging, file names, etc.

  • Property svn:mime-type set to text/x-trac-wiki
File size: 3.3 KB

Requirements

  1. BASE 3.0 or later.

Introduction

This package contains a few simple variants of Hello world applications in the form of extensions to the BASE web client. The package installs several examples into the Extensions -> Hello world examples menu:

  • Hello world! - A basic example using only javascript
  • Hello factory world! - An example that uses a custom action factory
  • Greetings Root! - An example of a custom action factory with parameters
  • Hello JSP world! - Uses a JSP file to display the message instead of javascript
  • Hello X-JSP world! - Another variant of a JSP file
  • Hello Servlet world! - Uses a servlet to generate the message
  • Hello Servlet world (alternate)! - Uses an alternative servlet path

There are also a few toolbar button extensions:

  • More info - A toolbar button on all single-item toolbars and displays some information in a popup window about the current item.
  • Annotation filter - A toolbar button on all list pages for annotatable items which allows a user to show only items with/without annotations.

And a edit/save extension:

  • Sample history data - Two extensions that works together. The first adds a tab to the "Edit sample" dialog were the user can select a file to link with the sample. The second extensions attaches to the save event and saves the link.
  • Last updated by - An on-save extension that creates an any-to-any link between any item and the currently logged in user. This is a very simple logging feature that stores information about the last update to an item.

Installation

  1. Unpack the tar.gz file to a directory of your choice.
  2. Copy the extension-examples.jar to your BASE plug-ins directory as configured in base.config[plugins.dir] setting.
  3. Run the Extensions -> Manual scan command and click the 'Start' button. If all goes well several new extensions and more should now be installed.
  4. If you are logged in, you may have to logout and then login again to see the new menu items, or use the File -> Reload permissions menu.
  5. The Hello X-JSP world example requires that the X-JSP compiler is installed on the server. Read in the documentation how to do this. http://base.thep.lu.se/chrome/site/latest/html/admindoc/extensions/admin.extensions.html
  6. Done. The examples can be found in the Extensions -> Hello world examples menu.

Compiling

To compile this package you also need:

  1. Ant 1.6
  2. Java 1.6

Follow these instructions:

  1. Type ant download-lib to automatically download the BASE core JAR file that are neeed for compilation. You can also do this manually by copying the base-core-3.0.0.jar and base-webclient-3.0.0.jar files from the BASE installation directory (<basedir>/www/WEB-INF/lib/) to the ./lib/compile directory.
  1. Type 'ant' to compile the code and generate the 'extension-examples.jar' file in the project directory. This file can be installed into BASE following the intructions above.
  1. Use 'ant package' to create a downloadable tar.gz.

  1. If you create a file called 'build.properties' and enter a the path to the plug-ins directory under the key 'base.plugins', you can simply type 'ant install' to copy the examples to the BASE plug-ins directory.
Note: See TracBrowser for help on using the repository browser.