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

Last change on this file since 691 was 691, checked in by Nicklas Nordborg, 14 years ago

Fixes #103: Create example extensions

  • Property svn:mime-type set to text/x-trac-wiki
File size: 2.0 KB
RevLine 
[636]1== Requirements ==
2
3 1. BASE 2.7.0 or later.
4 
5== Introduction ==
6
[683]7This package contains a few simple variants of ''Hello world'' applications
8in the form of extensions to the BASE web client. The package installs
9several examples into the ''Extensions -> Hello world examples'' menu:
[636]10
[683]11 * Hello world! - A basic example using only javascript
12 * Hello factory world! - An example that uses a custom action factory
13 * Greetings Root! - An example of a custom action factory with parameters
14 * Hello JSP world! - Uses a JSP file to display the message instead of javascript
15 * Hello X-JSP world! - Another variant of a JSP file
16 * Hello Servlet world! - Uses a servlet to generate the message
[636]17
18== Installation ==
19
20 1. Unpack the tar.gz file to a directory of your choice.
[638]21 2. Copy the extension-examples.jar to your BASE extensions directory: WEB-INF/extensions.
[636]22 3. Run the 'Extensions -> Manual scan' command if you have disabled automatic
23    installation. Otherwise, just wait a bit and the automatic installation will
24    find and install the new extensions.
25 4. If you are logged in, you may have to logout and then login again to see
26    the new menu items.
[683]27 5. The 'Hello X-JSP world' example requires that the X-JSP compiler is installed
28    on the server. Read in the documentation how to do this.
29    http://base.thep.lu.se/chrome/site/latest/html/admindoc/extensions/admin.extensions.html
30 6. Done. The examples can be found in the ''Extensions -> Hello world examples'' menu.
[636]31
32== Compiling ==
33
34To compile this package you also need:
35 
36 1. Ant 1.6
37 2. Java 1.6
38
39Follow these instructions:
40
[691]41 1. Type `ant download-lib` to automatically download the BASE core JAR file that
42    are neeed for compilation. You can also do this manually by copying the
43    BASE2Core.jar and BASE2Webclient.jar files from the BASE installation directory
44    (<basedir>/www/WEB-INF/lib/) to the ./lib/compile directory.
45 
46 2. Type 'ant' to compile the code and generate the 'extension-examples.jar' file
[638]47    in the project directory.
[636]48
[638]49 3. Use 'ant package' to create a downloadable tar.gz package.
Note: See TracBrowser for help on using the repository browser.