Added: incubator/shindig/trunk/site/src/site/xdoc/developers/index.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/site/src/site/xdoc/developers/index.xml?rev=759361&view=auto
==============================================================================
--- incubator/shindig/trunk/site/src/site/xdoc/developers/index.xml (added)
+++ incubator/shindig/trunk/site/src/site/xdoc/developers/index.xml Fri Mar 27
21:44:42 2009
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
+ <properties>
+ <title>Documentation Centre</title>
+ <author>Vincent Siveton</author>
+ <date>2009-03-25</date>
+ </properties>
+ <body>
+ <section name="Documentation Centre">
+ <p>This documentation centre is for developer who wants to use Shindig.
Shindig is developped in two languages:
+ Java and PHP and you need to read the specific documentation depending
the language wanted. Also, you could read
+ about which features Shindig uses.</p>
+ <ul>
+ <li><a href="./java/index.html">Java</a></li>
+ <li><a href="./php/index.html">PHP</a></li>
+ <li><a href="./features/index.html">Features</a></li>
+ </ul>
+ </section>
+
+ <section name="Developer Tools">
+ <p>Here are some useful developer OpenSocial tools.</p>
+ <ul>
+ <li><a
href="http://code.google.com/p/opensocial-development-environment/";>OpenSocial
Development Environment(OSDE)</a></li>
+ </ul>
+ </section>
+
+ <section name="Resources">
+ <ul>
+ <li><a href="../resources.html">Shindig resources</a></li>
+ <li><a
href="http://wiki.opensocial.org/index.php?title=Articles_%26_Tutorials#Tools_and_Utilities";>Articles
& Tutorials</a> from OpenSocial Foundation Wiki</li>
+ </ul>
+ </section>
+ </body>
+</document>
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/index.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/index.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: incubator/shindig/trunk/site/src/site/xdoc/developers/java/build.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/site/src/site/xdoc/developers/java/build.xml?rev=759361&view=auto
==============================================================================
--- incubator/shindig/trunk/site/src/site/xdoc/developers/java/build.xml (added)
+++ incubator/shindig/trunk/site/src/site/xdoc/developers/java/build.xml Fri
Mar 27 21:44:42 2009
@@ -0,0 +1,286 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
+ <properties>
+ <title>Building Java Shindig</title>
+ <author>Vincent Siveton</author>
+ <date>2009-03-25</date>
+ </properties>
+ <body>
+ <section name="Building and running Shindig for Java">
+ <p>This is the Java steps on how to build and run Shindig.</p>
+
+ <ul>
+ <li>
+ <a href="#Prequisites_before_building_Shindig">Prequisites</a>
+ </li>
+ <li>
+ <a href="#Getting_the_code">Get the code</a>
+ </li>
+ <li>
+ <a href="#Building_and_running_the_code_with_Maven">Build and run
the code (with
+ Maven)</a>
+ </li>
+ <li>
+ <a href="#Setting_up_an_Eclipse_project_to_build_Shindig">Setting up
an Eclipse
+ project</a>
+ </li>
+ <li>
+ <a href="#Generating_Code_Coverage_in_Eclipse">Generating Code
Coverage in
+ Eclipse</a>
+ </li>
+ <li>
+ <a href="#Running_inside_Eclipse">Running inside Eclipse</a>
+ </li>
+ <li>
+ <a href="#Running_with_Caja">Running with Caja</a>
+ </li>
+ </ul>
+
+ <subsection name="Prequisites before building Shindig">
+ <p>In order to build Shindig, you must have the following:</p>
+ <ul>
+ <li>Java (JDK/JRE) 1.5 or later installed on your system and the
JAVA_HOME
+ environment variable set. <ul>
+ <li>See: <a href="http://java.sun.com/";>http://java.sun.com/</a>
for
+ installation instructions.</li>
+ </ul>
+ </li>
+ <li>A Subversion client installed in order to checkout the code. <ul>
+ <li>Instructions for downloading and installing Subversion can
be found
+ here: <a href="http://subversion.tigris.org/";
+ >http://subversion.tigris.org/</a></li>
+ </ul>
+ </li>
+ <li>Apache Maven installed to perform the build. <ul>
+ <li>Instructions for downloading and installing Maven can be
found here:
+ <a href="http://maven.apache.org/download.html";
+ >http://maven.apache.org/download.html</a></li>
+ </ul>
+ </li>
+ </ul>
+ </subsection>
+
+ <subsection name="Getting the code">
+ <p>Create a subdirectory and checkout the Shindig code from its
Subversion
+ repository</p>
+ <ol>
+ <li><code>mkdir ~/src/shindig</code> (or wherever you'd like to put
it)</li>
+ <li>
+ <code>cd ~/src/shindig</code>
+ </li>
+ <li>
+ <code>svn co
http://svn.apache.org/repos/asf/incubator/shindig/trunk/
+ .</code>
+ </li>
+ </ol>
+ </subsection>
+
+ <subsection name="Building and running the code with Maven">
+ <p>To build a Web Archive (WAR) file for the Gadget server and run
tests, perform
+ the following:</p>
+ <ol>
+ <li>Make sure you have the <a href="#preReqs">prerequisites</a>
installed first.</li>
+ <li>
+ <code>cd ~/src/shindig/</code>
+ </li>
+ <li>
+ <code>mvn</code>
+ </li>
+ <li>Once the build successfully completes, you can install the built
WAR files
+ located in the /target subdirectory onto your JEE server.</li>
+ </ol>
+ <p>To run the code and start a Jetty server that will run on at
localhost:8080:</p>
+ <ul>
+ <li>
+ <code>mvn -Prun</code>
+ </li>
+ <li> Open in you browser <a
+
href="http://localhost:8080/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml";
+
>http://localhost:8080/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml</a>
+ </li>
+ </ul>
+ <p>To run the Jetty server on a different port, use:</p>
+ <ul>
+ <li>
+ <code>cd java/server</code>
+ </li>
+ <li>
+ <code>mvn clean install jetty:run
+ -DrunType=<full|gadgets|social>
+ -Djetty.port=<port></code>
+ </li>
+ </ul>
+
+ <p>Once you've either installed the WAR file on your JEE server, or
are running
+ locally using the Jetty server, you can test the Gadget server
using:</p>
+ <ul>
+
<li>http://localhost:<port>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml</li>
+ </ul>
+
+ <p><img src="./../../images/samples/task.png" alt="Sample
Container"/></p>
+ </subsection>
+
+ <subsection name="Setting up an Eclipse project to build Shindig">
+ <p>These steps, after completing the previous section, will allow you
to build from
+ within Eclipse using the Maven2 plugin. You should first install the
Maven
+ plugin, then create the new Java project.</p>
+ <ul>
+ <li>Create <code>~/.m2/settings.xml</code> consisting solely of</li>
+ </ul>
+ <source> <settings> </settings></source>
+ <ul>
+ <li>Install the Maven2 plugin <ol>
+ <li>Help -> Software Updates -> Find and Install</li>
+ <li>Search for new features to install</li>
+ <li>Create a new remote update site for the Maven 2 plugin <ul>
+ <li>Name: Maven2 - Sonatype</li>
+ <li>URL:
<code>http://m2eclipse.sonatype.org/update/</code></li>
+ </ul>
+ </li>
+ <li>Select the site and click "Finish"</li>
+ <li>There are optional dependencies on mylyn and subclipse. If
you don't
+ have these plugins, you can get them <a
+ href="http://m2eclipse.sonatype.org/update/";
+ title="Maven Integration for Eclipse updates">here</a>.
+ Otherwise, select only the Maven Integration plug-in.</li>
+ <li>Complete the installation</li>
+ </ol>
+ </li>
+ </ul>
+ <ul>
+ <li>Setup new workspace and project<br/> Creating a new workspace
eliminates the
+ performance cost from existing projects and makes it easier to
manage the
+ code. <ol>
+ <li>File -> Switch Workspace -> Other...</li>
+ <li>Select directory to store workspace <ul>
+ <li>Do not select a parent directory of the shindig source
(e.g.
+ ~/src/shindig) as Eclipse won't allow you to create the
Java
+ project.</li>
+ <li>Something like <code>~/eclipse/workspaces/shindig</code>
+ would work fine</li>
+ </ul>
+ </li>
+ <li>File -> New -> Java Project <ol>
+ <li>Name the project. The instructions below will assume
+ "SHINDIG".</li>
+ <li>Select 'Create project from existing source' and
navigate to
+ <code>.../src/shindig/java</code>
+ </li>
+ <li>Click Finish</li>
+ <li>If you see a dialog for "Open Associated Perspective",
click
+ Ok. Don't worry about the errors after loading as they will
+ be fixed in the next step.</li>
+ </ol>
+ </li>
+ <li>Right-click the project, select <code>Maven : Enable
Dependency
+ Management</code></li>
+ <li>Right-click the project, select <code>Maven : Update Source
+ Folders</code></li>
+ <li>Optionally, if you would like to be able to browse or step
into the
+ code of your dependent jars when debugging, you need the source
+ jars. Right-click the project, select <code>Maven : Download
+ Sources</code> and Eclipse will automatically know about these
+ sources when debugging. You can browse them under <code>Maven
+ Dependencies</code> in your project.</li>
+ <li>If you'll be using AllTests to run tests or generate code
coverage
+ stats, adjust the project's output folders. <ol>
+ <li>Project -> Properties -> Java Build Path
+ -> Source</li>
+ <li>Locate and open
<code>SHINDIG/gadgets/src/test/java</code></li>
+ <li>Select <code>Output Folder: (Default Output
Folder)</code>
+ and click Edit...</li>
+ <li>Select <code>Specific Output Folder</code></li>
+ <li>Enter <code>target/test-classes</code> and click OK.</li>
+ <li>Repeat for
+ <code>SHINDIG/social-api/src/test/java</code></li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ </ul>
+ </subsection>
+
+ <subsection name="Generating Code Coverage in Eclipse ">
+ <p>To generate code coverage statistics inside of Eclipse, install the
<a
+ href="http://www.eclemma.org";>EclEmma</a> plugin. Then</p>
+ <ul>
+ <li>Open <code>org.apache.shindig.gadgets.AllTests</code></li>
+ <li>Right-click in the class, and select <code>Coverage as ->
JUnit
+ Test</code></li>
+ </ul>
+ </subsection>
+
+ <subsection name="Running inside Eclipse">
+ <p>To debug the server in Eclipse, follow the last two steps <a
+ href="http://cwiki.apache.org/WICKET/maven-jetty-plugin.html";
target="_top"
+ >here</a> (takes a few minutes to set up):</p>
+ <ul>
+
+ <li>"Using eclipse external tools"</li>
+ <li>"Attaching to the server running in debug mode, using
eclipse"</li>
+ </ul>
+ <p><b>Note:</b> You must have set up Eclipse to build the code or do
<code>mvn
+ package</code> yourself after making changes, but you won't need
to restart
+ Jetty to see your changes.</p>
+ </subsection>
+
+ <subsection name="Running with Caja">
+ <p>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: <a
+ href="http://code.google.com/p/google-caja/wiki/CajaEasyIntro";
+ >http://code.google.com/p/google-caja/wiki/CajaEasyIntro</a>
+ </p>
+ <ol>
+ <li>Load this page: <a
+
href="http://localhost:8080/gadgets/files/samplecontainer/samplecontainer.html";
+ target="_top"
+
>http://localhost:8080/gadgets/files/samplecontainer/samplecontainer.html</a></li>
+
+ <li>Point it to this gadget: <a
+
href="http://localhost:8080/gadgets/files/samplecontainer/examples/SocialHelloWorld.xml";
+ target="_top"
+
>http://localhost:8080/gadgets/files/samplecontainer/examples/SocialHelloWorld.xml</a>
+ </li>
+ </ol>
+
+ <p>To see the cajoled code (Firefox only), right-click inside the
iframe and do
+ "This Frame -> View Frame Source"</p>
+ </subsection>
+
+ <subsection name="Additional reading">
+ <p> Read <a
+
href="http://svn.apache.org/repos/asf/incubator/shindig/trunk/java/README";
+ >java/README</a> for original instructions on how to start up any
of the
+ java shindig servers.</p>
+ <p>Read <a
+
href="http://svn.apache.org/repos/asf/incubator/shindig/trunk/javascript/README";
+ >javascript/README</a> for instructions for using the Shindig
Gadget
+ Container JavaScript to enable your page to render Gadgets using
gmodules.com or
+ a server started up as described above.</p>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/java/build.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/java/build.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/java/build.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: incubator/shindig/trunk/site/src/site/xdoc/developers/java/index.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/site/src/site/xdoc/developers/java/index.xml?rev=759361&view=auto
==============================================================================
--- incubator/shindig/trunk/site/src/site/xdoc/developers/java/index.xml (added)
+++ incubator/shindig/trunk/site/src/site/xdoc/developers/java/index.xml Fri
Mar 27 21:44:42 2009
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
+ <properties>
+ <title>Java Documentation</title>
+ <author>Vincent Siveton</author>
+ <date>2009-03-25</date>
+ </properties>
+ <body>
+ <section name="Documentation Centre for Java Shindig">
+ <p>This documentation centre is for developer who wants to work with the
Java version of Shindig.</p>
+ <ul>
+ <li><a href="./build.html">Building Java Shindig</a></li>
+ <li><a href="./samples.html">Using samples</a></li>
+ <li><a href="../../shindig-1.1.x/apidocs/index.html">Javadoc for
1.1.x</a></li>
+ <li><a href="../../shindig-1.1.x/index.html">Documentation for
1.1.x</a></li>
+ <li><a href="../../shindig-1.0.x/apidocs/index.html">Javadoc for
1.0.x</a></li>
+ <li><a href="../../shindig-1.0.x/index.html">Documentation for
1.0.x</a></li>
+ </ul>
+ </section>
+
+ <section name="Java Tools">
+ <ul>
+ <li><a
href="http://code.google.com/p/opensocial-java-client/";>OpenSocial RESTful Java
client library</a></li>
+ </ul>
+ </section>
+ </body>
+</document>
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/java/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/java/index.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/java/index.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: incubator/shindig/trunk/site/src/site/xdoc/developers/java/samples.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/site/src/site/xdoc/developers/java/samples.xml?rev=759361&view=auto
==============================================================================
--- incubator/shindig/trunk/site/src/site/xdoc/developers/java/samples.xml
(added)
+++ incubator/shindig/trunk/site/src/site/xdoc/developers/java/samples.xml Fri
Mar 27 21:44:42 2009
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
+ <properties>
+ <title>Samples for Java</title>
+ <author>Vincent Siveton</author>
+ <date>2009-03-25</date>
+ </properties>
+ <body>
+ <section name="Samples for Java">
+ <p>There is a JPA implementation of SPI in our SVN <a
+
href="http://svn.apache.org/repos/asf/incubator/shindig/trunk/java/samples";
+ >/java/samples</a></p>
+ </section>
+ <section name="Resources">
+ <ul>
+ <li>
+ <a
href="http://chrisschalk.com/shindig_docs/io/shindig-io.html";>Make Your Site
+ an OpenSocial Container Using Shindig</a>
+ </li>
+ <li>
+ <a
+
href="http://cwiki.apache.org/confluence/display/SHINDIG/Shindig+Spring+Example";
+ >Shindig Spring Example</a>
+ </li>
+ </ul>
+ </section>
+ </body>
+</document>
Propchange:
incubator/shindig/trunk/site/src/site/xdoc/developers/java/samples.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
incubator/shindig/trunk/site/src/site/xdoc/developers/java/samples.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange:
incubator/shindig/trunk/site/src/site/xdoc/developers/java/samples.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: incubator/shindig/trunk/site/src/site/xdoc/developers/php/build.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/site/src/site/xdoc/developers/php/build.xml?rev=759361&view=auto
==============================================================================
--- incubator/shindig/trunk/site/src/site/xdoc/developers/php/build.xml (added)
+++ incubator/shindig/trunk/site/src/site/xdoc/developers/php/build.xml Fri Mar
27 21:44:42 2009
@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
+ <properties>
+ <title>Building Shindig for PHP</title>
+ <author>Vincent Siveton</author>
+ <date>2009-03-25</date>
+ </properties>
+ <body>
+ <section name="Building and running Shindig for PHP">
+ <p>This is the PHP steps on how to build and run Shindig.</p>
+
+ <ul>
+ <li>
+ <a
href="#Prequisites_before_building_Shindig_for_PHP">Prequisites</a>
+ </li>
+ <li>
+ <a href="#Getting_the_code">Get the code</a>
+ </li>
+ <li>
+ <a href="#Running_Shindig">Running Shindig</a>
+ </li>
+ <li>
+ <a href="#Additional_reading">Additonal reading</a>
+ </li>
+ </ul>
+
+ <subsection name="Prequisites before building Shindig for PHP">
+ <p> In order to build and run Shindig for PHP, you must have the
following: </p>
+ <ul>
+ <li>A Subversion client installed in order to checkout the code. <ul>
+ <li>Instructions for downloading and installing Subversion can
be found
+ here: <a href="http://subversion.tigris.org/";
+ />http://subversion.tigris.org/</li>
+ </ul></li>
+ <li>Apache with mod_rewrite enabled. <ul>
+ <li>PHP 5.2.x with the <a
href="http://www.php.net/json";>json</a>, <a
+ href="http://www.php.net/simplexml";>simplexml</a>, <a
+ href="http://www.php.net/mcrypt";>mcrypt</a> and <a
+ href="http://www.php.net/curl";>curl</a> extentions
enabled.</li>
+ </ul></li>
+ </ul>
+ </subsection>
+
+ <subsection name="Getting the code">
+ <p> Create a subdirectory in your web document root, e.g.
/var/www/html and checkout
+ the Shindig code from its Subversion repository</p>
+ <ol>
+ <li>
+ <code>mkdir /var/www/html/shindig</code>
+ </li>
+ <li>
+ <code>cd /var/www/html/shindig</code>
+ </li>
+ <li>
+ <code>svn co
http://svn.apache.org/repos/asf/incubator/shindig/trunk/
+ .</code>
+ </li>
+ </ol>
+ </subsection>
+
+ <subsection name="Running Shindig">
+ <p>With PHP There is no need to build anything - the source code is
already built.</p>
+ <p>To run the code, you have several options:</p>
+
+ <h4>a. Create a new virtual host</h4>
+ <p>Point your apache to the php dir with a virtual host like:</p>
+ <pre>
+ <VirtualHost your_ip:your_port>
+
+ ServerName your.host
+ DocumentRoot /var/www/html/shindig/php
+ ... other normal settings in vhosts...
+ </VirtualHost>
+ </pre>
+
+ <p>Restart apache, and point your browser to:</p>
+
<p>http://your.host/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml</p>
+ <p>you should see something like <a
+
href="http://shindig.chabotc.com/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml";
+ >this</a>. </p>
+
+ <h4>b. Run with an existing host</h4>
+ <p>If you cannot/don't want to create a virtual host, you can edit the
file
+ php/config.php and change the web_prefix setting to '/shindig/php'.
</p>
+ <p>Then you can run the gadget by pointing your browser to: </p>
+
<p>http://your.host/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml</p>
+ </subsection>
+
+ <subsection name="Additional reading">
+ <p>Read <a
href="http://svn.apache.org/repos/asf/incubator/shindig/trunk/php/README";
+ >php/README</a> for original instructions on how to start up the
php shindig
+ server. </p>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/php/build.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/php/build.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/php/build.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: incubator/shindig/trunk/site/src/site/xdoc/developers/php/index.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/site/src/site/xdoc/developers/php/index.xml?rev=759361&view=auto
==============================================================================
--- incubator/shindig/trunk/site/src/site/xdoc/developers/php/index.xml (added)
+++ incubator/shindig/trunk/site/src/site/xdoc/developers/php/index.xml Fri Mar
27 21:44:42 2009
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
+ <properties>
+ <title>PHP Documentation</title>
+ <author>Vincent Siveton</author>
+ <date>2009-03-25</date>
+ </properties>
+ <body>
+ <section name="Documentation Centre for PHP Shindig">
+ <p>This documentation centre is for developer who wants to work with the
PHP version of Shindig.</p>
+ <ul>
+ <li><a href="./build.html">Building PHP Shindig</a></li>
+ </ul>
+ </section>
+
+ <section name="PHP Tools">
+ <ul>
+ <li><a
href="http://code.google.com/p/opensocial-php-client/";>OpenSocial RESTful PHP
client library</a></li>
+ <li><a href="http://www.aitoc.com/en/phpfoxmods_opensocial.html";>Open
Social Module for phpFox</a></li>
+ </ul>
+ </section>
+ </body>
+</document>
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/php/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/php/index.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: incubator/shindig/trunk/site/src/site/xdoc/developers/php/index.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: incubator/shindig/trunk/site/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/site/src/site/xdoc/index.xml?rev=759361&view=auto
==============================================================================
--- incubator/shindig/trunk/site/src/site/xdoc/index.xml (added)
+++ incubator/shindig/trunk/site/src/site/xdoc/index.xml Fri Mar 27 21:44:42
2009
@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
+ <properties>
+ <title>Welcome To Shindig!</title>
+ <author>Vincent Siveton</author>
+ <date>2009-03-25</date>
+ </properties>
+ <body>
+ <!-- TODO Add a Google CSE Search Box -->
+ <!-- TODO Add Stay Connected with Ning, Twitter... -->
+
+ <section name="Welcome To Shindig !">
+ <div class="logo">
+ <a href="http://www.opensocial.org/";>
+ <img src="./images/logos/opensocialsite-logo.png" alt="OpsenSocial
Logo"/>
+ </a>
+ </div>
+ <p> Shindig is an OpenSocial container and helps you to start hosting
OpenSocial apps
+ quickly by providing the code to render gadgets, proxy requests, and
handle REST and
+ RPC requests.</p>
+
+ <p> Shindig's goal is to allow new sites to start hosting social apps in
under an hour's
+ worth of work.</p>
+ </section>
+
+ <section name="What is Shindig?">
+ <div class="logo">
+ <img src="./images/gadget-server.png" alt="Gadget Server"/>
+ </div>
+ <p>Shindig is a container for hosting social application consisting of
four parts:</p>
+ <ul>
+ <li><b>Gadget Container JavaScript</b>: core JavaScript foundation for
general
+ gadget functionality (<a
+
href="http://code.google.com/apis/gadgets/docs/dev_guide.html";>read more
+ about gadget functionality</a>). This JavaScript manages security,
+ communication, UI layout, and feature extensions, such as the
OpenSocial API.</li>
+ <li><b>Gadget Rendering Server</b>: used to render the gadget XML into
JavaScript
+ and HTML for the container to expose via the container
JavaScript.</li>
+ <li><b>OpenSocial Container JavaScript</b>: JavaScript environment
that sits on top
+ of the Gadget Container JavaScript and provides OpenSocial specific
+ functionality (profiles, friends, activities, datastore).</li>
+ <li><b>OpenSocial Data Server</b>: an implementation of the server
interface to
+ container-specific information, including the OpenSocial REST APIs,
with clear
+ extension points so others can connect it to their own backends.</li>
+ </ul>
+ <p>Shindig is a reference implementation of OpenSocial specifications
for developers to
+ develop against container providers to use as a reference. Shindig
implements the <a
+ href="http://www.opensocial.org/page/specs-1";> OpenSocial API
+ specifications</a>.</p>
+ <p>See the <a href="./overview.html">overview</a> page for more
information.</p>
+ </section>
+ </body>
+</document>
Propchange: incubator/shindig/trunk/site/src/site/xdoc/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/shindig/trunk/site/src/site/xdoc/index.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: incubator/shindig/trunk/site/src/site/xdoc/index.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: incubator/shindig/trunk/site/src/site/xdoc/overview.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/site/src/site/xdoc/overview.xml?rev=759361&view=auto
==============================================================================
--- incubator/shindig/trunk/site/src/site/xdoc/overview.xml (added)
+++ incubator/shindig/trunk/site/src/site/xdoc/overview.xml Fri Mar 27 21:44:42
2009
@@ -0,0 +1,126 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
+ <properties>
+ <title>Overview Of Shindig</title>
+ <author>Vincent Siveton</author>
+ <date>2009-03-25</date>
+ </properties>
+ <body>
+ <section name="Introduction">
+ <p>Shindig, a word meaning party, was originally started by Google in
2007 as a
+ reference container for hosting OpenSocial compatible widgets in any
website.
+ Originally a port of Google's iGoogle gadget container, with Brain
McCallister's PHP
+ code, Shindig through off it's egg shell, and showed that Google was
serious about
+ making OpenSocial accessible to a larger number of sites. Since
December 2007,
+ Shindig is now an Apache project.</p>
+ </section>
+ <section name="Shindig's objectives">
+ <div class="logo">
+ <img src="./images/logos/java-logo.png" alt="Java"/>
+ <img src="./images/logos/php-logo.gif" alt="PHP"/>
+ </div>
+ <p> Shindig's primary goal is to provide infrastructure for those
wishing to host
+ OpenSocial apps on their websites. Another goal of Shindig is to be
language neutral
+ and cover multiple languages.</p>
+
+ <p>Currently, Java and PHP versions are availables and supported.</p>
+ </section>
+ <section name="Shindig Components">
+ <subsection name="Server Side">
+ <p>The Java and PHP version of Shindig have 3 major server side
components:</p>
+ <ol>
+ <li>Persistent Data Loading Mechanism;</li>
+ <li>Gadget Rendering Infrastructure;</li>
+ <li>OpenSocial server side implementation.</li>
+ </ol>
+ <p>
+ <img src="./images/shindig-server-java.jpg" alt="Shindig Java
Components"/>
+ </p>
+ <p>
+ <i>Components of Shindig Java Server Side container</i>
+ </p>
+
+ <p>
+ <img src="./images/shindig-server-php.jpg" alt="Shindig PHP
Components"/>
+ </p>
+ <p>
+ <i>Components of Shindig PHP Server Side container</i>
+ </p>
+ </subsection>
+ <subsection name="Client Side">
+ <p>The Javascript features are:</p>
+ <ul>
+ <li>Gadget container (gadget.js), fully opensocial gadget
compliant;</li>
+ <li>OpenSocial container;</li>
+ <li><a href="http://www.json.org/";>JSON</a>, Restful container and
+ <a href="http://code.google.com/p/google-caja/";>Caja</a>
support.</li>
+ </ul>
+ <p>
+ <img src="./images/shindig-client.jpg" alt="Shindig Client Flow"/>
+ </p>
+ </subsection>
+ </section>
+
+ <section name="OpenSocial Flow">
+ <p>The following is a typical flow to get a list of Friends.</p>
+ <subsection name="Server Side Flow">
+ <ol>
+ <li>Call JsonRpcServlet;</li>
+ <li>Get the appropriate handler;</li>
+ <li>Get the JSON object from the DB;</li>
+ <li>Populate responses into a list;</li>
+ <li>Return to the client.</li>
+ </ol>
+
+ <p>In the case of the REST use, the flow will be:</p>
+ <ol>
+ <li>Call DataServiceServlet;</li>
+ <li>Get the appropriate converter;</li>
+ <li>Get the handler;</li>
+ <li>Get the JSON object from the DB;</li>
+ <li>Return to the client.</li>
+ </ol>
+ </subsection>
+ <subsection name="Client Side Flow">
+ <ol>
+ <li>Create request object;</li>
+ <li>Populate request parameters;</li>
+ <li>Send the request.</li>
+ </ol>
+ </subsection>
+ </section>
+
+ <section name="Resources">
+ <ul>
+ <li><a
href="http://rajdeep.dua.googlepages.com/shindigPHP-overview-tidy_img.html";>
+ Shindig : An Architectural Overview (PHP Version)</a> by Rajdeep Dua.
+ </li>
+ <li><a
href="http://chrisschalk.com/shindig_docs/rajdeep/shindig-overview/onjava-shindig-overview-tidy.html";>
+ Architectural Overview of Shindig , an OpenSocial Reference
Implementation</a> by Rajdeep Dua.
+ </li>
+ </ul>
+ </section>
+ </body>
+</document>
Propchange: incubator/shindig/trunk/site/src/site/xdoc/overview.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/shindig/trunk/site/src/site/xdoc/overview.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: incubator/shindig/trunk/site/src/site/xdoc/overview.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: incubator/shindig/trunk/site/src/site/xdoc/source-repository.xml
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/site/src/site/xdoc/source-repository.xml?rev=759361&view=auto
==============================================================================
--- incubator/shindig/trunk/site/src/site/xdoc/source-repository.xml (added)
+++ incubator/shindig/trunk/site/src/site/xdoc/source-repository.xml Fri Mar 27
21:44:42 2009
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<document xmlns="http://maven.apache.org/XDOC/2.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0
http://maven.apache.org/xsd/xdoc-2.0.xsd";>
+ <properties>
+ <title>Source Repository</title>
+ <author>Vincent Siveton</author>
+ <date>2009-03-25</date>
+ </properties>
+ <body>
+ <section name="Source Repository">
+ <p>
+ Shindig projects use <a
href="http://subversion.tigris.org/";>Subversion</a> to manage their source code.
+ Instructions on Subversion use can be found in the online book
+ <a href="http://svnbook.red-bean.com/";>Version Control with
Subversion</a>.
+ </p>
+ <subsection name="Web Access">
+ <p>
+ The following list shows the links to the online source repositories
for the various versions of Shindig:
+ </p>
+ <source>
+<a
href="http://svn.apache.org/repos/asf/incubator/shindig/trunk/";>https://svn.apache.org/repos/asf/incubator/shindig/trunk/</a>
+</source>
+ </subsection>
+ <subsection name="Anonymous Access">
+ <p>
+ The source can be checked out anonymously from SVN with one of these
commands depending on the development
+ line you are looking for:
+ </p>
+ <source>$ svn checkout
http://svn.apache.org/repos/asf/incubator/shindig/trunk/ shindig</source>
+ </subsection>
+ <subsection name="Developer Access">
+ <p>
+ Everyone can access the Subversion repository via HTTP, but
committers must checkout the Subversion
+ repository via HTTPS to gain write access:
+ </p>
+ <source>$ svn checkout
https://svn.apache.org/repos/asf/incubator/shindig/trunk/ shindig</source>
+ <p>
+ To commit changes to the repository, execute the following command
to commit your changes (<code>svn</code> will
+ prompt you for your password):
+ </p>
+ <source>
+$ svn commit --username your-username -m "A message"</source>
+ </subsection>
+ <subsection name="Access from behind a Firewall">
+ <p>
+ For those users who are stuck behind a corporate firewall which is
blocking HTTP access to the Subversion
+ repository, you can try to access it via the developer connection:
+ </p>
+ <source>$ svn checkout
https://svn.apache.org/repos/asf/incubator/shindig/trunk/ shindig</source>
+ </subsection>
+ <subsection name="Access through a Proxy">
+ <p>
+ The Subversion client can go through a proxy, if you configure it to
do so. First, edit your <code>servers</code>
+ configuration file to indicate which proxy to use. The file's
location depends on your operating system. On
+ Linux or Unix it is located in the directory
<code>~/.subversion</code>. On Windows it is in
<code>%APPDATA%\Subversion</code>
+ (try <code>echo %APPDATA%</code>, note this is a hidden directory).
+ </p>
+ <p>
+ There are comments in the file explaining what to do. If you don't
have that file, get the latest Subversion
+ client and run any command; this will cause the configuration
directory and template files to be created.
+ </p>
+ <p>
+ Example: Edit the <code>servers</code> file and add something like:
+ </p>
+ <source>
+[global]
+http-proxy-host = your.proxy.name
+http-proxy-port = 3128</source>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: incubator/shindig/trunk/site/src/site/xdoc/source-repository.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/shindig/trunk/site/src/site/xdoc/source-repository.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Propchange: incubator/shindig/trunk/site/src/site/xdoc/source-repository.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
