Welcome to jMaki 1.0 for Java


This bundle includes jMaki core, all widget libraries supported by jMaki
and samples.
----------------------------

1. jMaki bundle directory structure

  |-css -> Contains template pages and layouts
  |
  |
  |-core -> Use this to create bare bones jMaki applications
  |  | 
  |  |-resources
  |       |
  |       |-hello -> A simple widget	  
  |       |-hello2 -> A simple widget that takes parameters
  |
  |-lib -> Contains all library files
  |
  |-samples -> Contains all samples
  |  | 
  |  |-jmaki -> Driver Application for samples
  |  |-Containers -> Shows how to use actions with various containers
  |  |-Craig List Mashup -> Shows how to create a sophisticated  mashups
  |  |-Facelets -> Shows how to use facelets with jMaki
  |  |-Grizzly Comet -> Shows how to do server push
  |  |-Generic Service -> Demonstrates how to create a service
  |  |-Get Widget Data -> Shows how to interact with a widget using Glue
  |  |-Load Table -> Shows how to load data into a widget
  |  |-Map It -> Shows how to use maps and plot points
  |  |-RSS Data -> Shows how to pull RSS data into your widgets
  |
  |-widgets -> Contains all widgets zipped up

2. Setup

A. Copy the build.properties.sample file to your user home build.properties.
Uncomment and modify the java.autodeploy.dir property to point to the 
autodeploy directory of your server which supports servlet 2.4 and JSP 2.0
or better.  For most samples this is all you need to do.

For Glassfish this normally is:

java.autodeploy.dir=GLASSFISH_HOME/domains/domain1/autodeploy

For Tomcat it is:

TOMCAT_HOME/webapps

For BEA WebLogic 9.2 this normally is:

java.autodeploy.dir=WEB_LOGIC_HOME/domains/YOUR_DOMAIN/autodeploy

B. Ant

Samples require ant 1.6 or better to build. Get ant from:

http://ant.apache.org

C. Faclets Demo

The faclets demo requires JSF 1.1 or better support. We have tested it with
Glassfish which may be found at:

https://glassfish.dev.java.net

D. Grizzly Comet Demo Setup

The Grizzly Comet Demo Requires Glassfish and you can download it from:

https://glassfish.dev.java.net

For the Grizzly Demo you will need to set the javaee.home property in your
build.properties to hte location of your glassfish server.

You will also need to setup comet support on glassfish with the following command:

% ${glasfish.home}/bin/asadmin set server.http-service.http-listener.http-listener-1.property.cometSupport=true


3. Building and Deploying on Any Container

Either go to the sample directory of your choice and type:

ant deploy-java

Or to deploy all the J2EE 1.4 or better samples:

ant deploy-all-j2ee

If you are running on Glassfish deploy all samples using:

ant deploy-glassfish


4. Running

If you deployed all samples using the deploy-all target then open your browser to:

For Glassfish the default location is:

http://localhost:8080/jmaki/

For Tomcat the default location is:

http://localhost:8080/jmaki/

For BEA Weblogic the default location is:

http://localhost:7001/jmaki/


Otherwise, each individual sample contains a README file with the URL for
the particular sample.

5. Further Documentation:

Please use the jMaki site for more documentation:

https://ajax.dev.java.net/getstarted.html

For information on the data models used in jMaki see:

http://wiki.java.net/bin/view/Projects/jMakiDataModels

6. Feedback and Feature Requests:

Please use the jMaki forums to provide feedback and feature requests.

http://forums.java.net/jive/forum.jspa?forumID=96
