On Tue, Oct 27, 2009 at 12:25 PM, <[email protected]> wrote: > Author: johnh > Date: Tue Oct 27 19:25:41 2009 > New Revision: 830304 > > URL: http://svn.apache.org/viewvc?rev=830304&view=rev > Log: > BUILD-JAVA documentation updates. Thanks to Ben McCann for providing this! > > Closes SHINDIG-1210. > > > Modified: > incubator/shindig/trunk/BUILD-JAVA > > Modified: incubator/shindig/trunk/BUILD-JAVA > URL: > http://svn.apache.org/viewvc/incubator/shindig/trunk/BUILD-JAVA?rev=830304&r1=830303&r2=830304&view=diff > > ============================================================================== > --- incubator/shindig/trunk/BUILD-JAVA (original) > +++ incubator/shindig/trunk/BUILD-JAVA Tue Oct 27 19:25:41 2009 > @@ -1,3 +1,14 @@ > +Checking out the source code from SVN > +============================================ > + > +1) A Subversion client installed in order to checkout the code. > + * Instructions for downloading and installing Subversion can be found > here: http://subversion.tigris.org/ > +2) Create a subdirectory and checkout the Apache Shindig code from its > Subversion repository > + * mkdir ~/src/shindig (or wherever you'd like to put it) > + * cd ~/src/shindig > +3) svn co http://svn.apache.org/repos/asf/incubator/shindig/trunk/ . > + > + > Installing and running the various java servers > ============================================ > > @@ -24,7 +35,7 @@ > * mvn -Prun -DrunType=gadgets - to run Jetty with only the gadgets > server > * mvn -Prun -DrunType=social - to run Jetty with only the social server > > -5) To Run with a differnt port > +5) To Run with a different port > * cd java/server > * mvn clean install jetty:run -DrunType=<full|gadgets|social> > -Djetty.port=<port> > > @@ -35,16 +46,19 @@ > http://localhost:8080/gadgets/files/samplecontainer/samplecontainer.html > > > +Editing the Shindig code with Eclipse > --------------------------------------------- > > -Three steps to Use with Eclipse: > - > * Install the Maven Eclipse plugin > * Create and import the Eclipse Project files > * Clean up some Build Path errors. > > 1 - Install the Maven Eclipse plugin from > http://m2eclipse.sonatype.org/update/ > + > + * There is an optional dependancy on Sublipse which you can get from > + http://subclipse.tigris.org/ > + If not installing this dependancy then select only the Maven > Integration plug-in. > > 2 - Creating and Importing the Eclipse Projects > > @@ -78,6 +92,16 @@ > > mvn eclipse:clean > > + > +Generating Code Coverage in Eclipse > +---------------------------------- > + > +To generate code coverage statistics inside of Eclipse, install the > EclEmma plugin > + * http://www.eclemma.org/ > + * Open org.apache.shindig.gadgets.AllTests > + * Right-click in the class, and select Coverage as -> JUnit Test > + > + > Building a Maven Site with Reports > ---------------------------------- > > @@ -91,7 +115,24 @@ > /~ieb/shindig is absolute site URL where you want the site to be hosted > from. > > > +Running with Caja > +---------------------------------- > + > +Caja is an important part of OpenSocial that greatly enhances JavaScript > security. > +Caja is managed in a separate open source project hosted by Google code > projects. > +For more information on Caja, see: > http://code.google.com/p/google-caja/wiki/CajaEasyIntro
This page does not exist. Please use http://code.google.com/p/google-caja/wiki/GettingStarted > > + > + 1) Load this page: > http://localhost:8080/gadgets/files/samplecontainer/samplecontainer.html > + 2) Point it to this gadget: > http://localhost:8080/gadgets/files/samplecontainer/examples/SocialHelloWorld.xml > > + > +To see the cajoled code (Firefox only), right-click inside the iframe and > do "This Frame -> View Frame Source" > + > + > +Additional Reading > +---------------------------------- > > - > For more information, see > http://incubator.apache.org/projects/shindig.html > > +Read javascript/README for instructions for using the Apache Shindig > Gadget Container JavaScript > +to enable your page to render Gadgets using gmodules.com or a server > started up as described above. > + > > >
