You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shindig.apache.org by vs...@apache.org on 2009/04/30 14:51:23 UTC
svn commit: r770209 - in /incubator/shindig/branches/1.0.x-incubating: ./
assembly/src/main/assembly/ assembly/src/main/assembly/binary-src/
features/ java/ javascript/ php/
Author: vsiveton
Date: Thu Apr 30 12:51:23 2009
New Revision: 770209
URL: http://svn.apache.org/viewvc?rev=770209&view=rev
Log:
o improved README, NOTICE and LICENSE
Added:
incubator/shindig/branches/1.0.x-incubating/java/LICENSE
incubator/shindig/branches/1.0.x-incubating/java/NOTICE
- copied, changed from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE
incubator/shindig/branches/1.0.x-incubating/php/LICENSE
- copied unchanged from r770160, incubator/shindig/branches/1.0.x-incubating/LICENSE
incubator/shindig/branches/1.0.x-incubating/php/NOTICE
- copied, changed from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE
Removed:
incubator/shindig/branches/1.0.x-incubating/LICENSE
incubator/shindig/branches/1.0.x-incubating/NOTICE
incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/binary-src/
Modified:
incubator/shindig/branches/1.0.x-incubating/README
incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml
incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml
incubator/shindig/branches/1.0.x-incubating/features/README
incubator/shindig/branches/1.0.x-incubating/java/README
incubator/shindig/branches/1.0.x-incubating/javascript/README
incubator/shindig/branches/1.0.x-incubating/php/README
Modified: incubator/shindig/branches/1.0.x-incubating/README
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/README?rev=770209&r1=770208&r2=770209&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/README (original)
+++ incubator/shindig/branches/1.0.x-incubating/README Thu Apr 30 12:51:23 2009
@@ -1,14 +1,38 @@
-Welcome to Apache Shindig!
+ Apache Shindig
-* Read java/README for instructions on using the java gadget servers.
+ What is it?
+ -----------
-* To build and run the Java server see BUILD-JAVA
+ Shindig is a JavaScript container and implementations of the backend APIs
+ and proxy required for hosting OpenSocial applications.
-* Read php/README for instructions on how to run a php gadget server
- instead of a java gadget server.
+ Documentation
+ -------------
-* Read javascript/README 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.
+ The most up-to-date documentation can be found at http://incubator.apache.org/shindig/.
-For more information, see http://incubator.apache.org/shindig/
+ Read BUILD-JAVA for instructions on how to build and run the Java server.
+
+ Read java/README for instructions on how to run a Java gadget server.
+
+ Read php/README for instructions on how to run a php gadget server.
+
+ Read javascript/README for instructions for using the Shindig Gadget Container
+ JavaScript to enable your page to render Gadgets.
+
+ Read features/README for instructions on how to use features.
+
+ Licensing
+ ---------
+
+ Please see the file called LICENSE in the java and php directories.
+
+ Shindig URLS
+ ------------
+
+ Home Page: http://incubator.apache.org/shindig/
+ Downloads: http://incubator.apache.org/shindig/download/index.html
+ Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
+ Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
+ Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
+ Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml?rev=770209&r1=770208&r2=770209&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml (original)
+++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml Thu Apr 30 12:51:23 2009
@@ -43,18 +43,21 @@
<outputDirectory>shindig-${pom.version}-java</outputDirectory>
<directory>../</directory>
<includes>
- <include>COMMITTERS</include>
<include>DISCLAIMER</include>
- <include>LICENSE</include>
- <include>NOTICE</include>
</includes>
+ <excludes>
+ <exclude>LICENSE</exclude>
+ <exclude>NOTICE</exclude>
+ <exclude>README</exclude>
+ </excludes>
</fileSet>
<fileSet>
<outputDirectory>shindig-${pom.version}-java</outputDirectory>
- <directory>src/main/assembly/binary-src/</directory>
- <filtered>true</filtered>
+ <directory>../java</directory>
<includes>
- <include>**/*</include>
+ <include>LICENSE</include>
+ <include>NOTICE</include>
+ <include>README</include>
</includes>
</fileSet>
</fileSets>
Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml?rev=770209&r1=770208&r2=770209&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml (original)
+++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml Thu Apr 30 12:51:23 2009
@@ -32,10 +32,7 @@
<include>features/**</include>
<include>javascript/**</include>
<include>config/**</include>
- <include>COMMITTERS</include>
<include>DISCLAIMER</include>
- <include>LICENSE</include>
- <include>NOTICE</include>
</includes>
<excludes>
<exclude>site/**</exclude>
@@ -63,6 +60,8 @@
<!-- misc -->
<exclude>*.patch</exclude>
<exclude>*.diff</exclude>
+ <exclude>LICENSE</exclude>
+ <exclude>NOTICE</exclude>
<exclude>README</exclude>
</excludes>
<lineEnding>unix</lineEnding>
Modified: incubator/shindig/branches/1.0.x-incubating/features/README
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/features/README?rev=770209&r1=770208&r2=770209&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/features/README (original)
+++ incubator/shindig/branches/1.0.x-incubating/features/README Thu Apr 30 12:51:23 2009
@@ -1,40 +1,68 @@
-You can automatically include new features into your shindig server by adding
-them to this directory. Features should exist in a self-contained directory
-with the following structure:
-
-features
- |_your-feature-name
- |_feature.xml
- |_code-to-run-inside-gadget.js
- |_code-to-run-inside-container.js
-
-The structure of feature.xml is as follows:
-TODO: link to xml schema for feature.xml
-
-<?xml version="1.0"?>
-<feature>
- <name>your-feature-name (required)</name>
- <dependency>any dependency you have (optional, may have multiple)</dependency>
- <gadget> (optional)
- <script src="code-to-run-inside-gadget.js"/> (optional, may have multiple,
- may use web resources as well but we strongly encourage bundling your
- javascript with the xml)
- </gadget>
- <container> (optional)
- <script src="code-to-run-inside-container.js"> (same as for <gadget>)
- </container>
-</feature>
-
-Please always make sure that all files you provide are encoded as utf8.
-
-When adding new features, your javascript should conform to shindig javascript
-coding conventions. This means that you should not be producing new globals and
-your feature should be compatible with Caja.
+ Apache Shindig Features
-When committing a new feature, you should update the features.txt file by
-running the following script in a unix-like environment:
+ What is it?
+ -----------
-ls -R1a features/**/*.xml > features/features.txt
+ Shindig is a JavaScript container and implementations of the backend APIs
+ and proxy required for hosting OpenSocial applications.
-TODO: Instructions for regenerating features.txt for other operating system
-environments.
+ This is the features component of Shindig.
+
+ Documentation
+ -------------
+
+ The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
+
+ Using features
+ --------------
+
+ You can automatically include new features into your shindig server by adding
+ them to this directory. Features should exist in a self-contained directory
+ with the following structure:
+
+ features
+ |_your-feature-name
+ |_feature.xml
+ |_code-to-run-inside-gadget.js
+ |_code-to-run-inside-container.js
+
+ The structure of feature.xml is as follows:
+ TODO: link to xml schema for feature.xml
+
+ <?xml version="1.0"?>
+ <feature>
+ <name>your-feature-name (required)</name>
+ <dependency>any dependency you have (optional, may have multiple)</dependency>
+ <gadget> (optional)
+ <script src="code-to-run-inside-gadget.js"/> (optional, may have multiple,
+ may use web resources as well but we strongly encourage bundling your
+ javascript with the xml)
+ </gadget>
+ <container> (optional)
+ <script src="code-to-run-inside-container.js"> (same as for <gadget>)
+ </container>
+ </feature>
+
+ Please always make sure that all files you provide are encoded as utf8.
+
+ When adding new features, your javascript should conform to shindig javascript
+ coding conventions. This means that you should not be producing new globals and
+ your feature should be compatible with Caja.
+
+ When committing a new feature, you should update the features.txt file by
+ running the following script in a unix-like environment:
+
+ ls -R1a features/**/*.xml > features/features.txt
+
+ TODO: Instructions for regenerating features.txt for other operating system
+ environments.
+
+ Shindig URLS
+ ------------
+
+ Home Page: http://incubator.apache.org/shindig/
+ Downloads: http://incubator.apache.org/shindig/download/index.html
+ Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
+ Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
+ Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
+ Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
Added: incubator/shindig/branches/1.0.x-incubating/java/LICENSE
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/LICENSE?rev=770209&view=auto
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/java/LICENSE (added)
+++ incubator/shindig/branches/1.0.x-incubating/java/LICENSE Thu Apr 30 12:51:23 2009
@@ -0,0 +1,212 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
+
+
+===============================================================================
+
+The Apache Shindig distribution includes a number of subcomponents
+with separate copyright notices and license terms. Your use of the
+code for the these subcomponents is subject to the terms and
+conditions of the following licenses.
+
+===============================================================================
Copied: incubator/shindig/branches/1.0.x-incubating/java/NOTICE (from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE)
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/NOTICE?p2=incubator/shindig/branches/1.0.x-incubating/java/NOTICE&p1=incubator/shindig/branches/1.0.x-incubating/NOTICE&r1=770145&r2=770209&rev=770209&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/NOTICE (original)
+++ incubator/shindig/branches/1.0.x-incubating/java/NOTICE Thu Apr 30 12:51:23 2009
@@ -1,16 +1,15 @@
-Apache Shindig
-Copyright 2009 The Apache Software Foundation
+ =========================================================================
+ == NOTICE file corresponding to the section 4 d of ==
+ == the Apache License, Version 2.0, ==
+ == in this case for the Apache Shindig distribution. ==
+ =========================================================================
-This product includes software developed at
-The Apache Software Foundation (http://www.apache.org/).
-
------------------------------------------------------------
This product includes software (Gadget Server, Gadget Container)
originally developed by Google Inc. (http://code.google.com/) and licensed
to the ASF as initial contribution for Shindig.
-This product includes the jquery.js file,
-Copyright (c) 2007 John Resig, http://jquery.com/
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
This distribution includes cryptographic software. The country in
which you currently reside may have restrictions on the import,
@@ -36,7 +35,3 @@
Apache Shindig interfaces with the Java JCE APIs to provide
encryption of messages using the AES standard.
-
- Apache Shindig PHP interfaces with the mcrypt API
- <http://mcrypt.sourceforge.net/> to provide encryption
- of messages using the AES standard.
Modified: incubator/shindig/branches/1.0.x-incubating/java/README
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/README?rev=770209&r1=770208&r2=770209&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/java/README (original)
+++ incubator/shindig/branches/1.0.x-incubating/java/README Thu Apr 30 12:51:23 2009
@@ -1,15 +1,68 @@
-There are four parts to the java gadget servers:
+ Apache Shindig Java
-* java/common The common java code that both the social data server and the
- gadget rendering server rely on.
+ What is it?
+ -----------
-* java/gadgets This server is used for rendering gadgets.
+ Shindig is a JavaScript container and implementations of the backend APIs
+ and proxy required for hosting OpenSocial applications.
-* java/social-api This server is used to provide social data for gadgets. Long
- term, it will implement the OpenSocial RESTful apis.
+ This is the Java implementation of Shindig. If you are looking to the PHP
+ implementation, please visit our website.
-* java/server This directory only contains a pom and a web.xml file. It is used
- to run both the gadget rendering code and the social data code at once. In
- order to use the samplecontainer you must run this server.
+ Documentation
+ -------------
-For more information, see http://incubator.apache.org/projects/shindig.html
+ The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
+ and at http://incubator.apache.org/shindig/developers/java/index.html for specific
+ Java documentation.
+
+ Release Notes
+ -------------
+
+ The full list of changes can be found at https://issues.apache.org/jira/browse/SHINDIG.
+
+ System Requirements
+ -------------------
+
+ Java:
+ 1.5 or above.
+ Servlet container:
+ Apache Tomcat or other compatible Java Servlet containers.
+ Memory:
+ No minimum requirement.
+ Disk:
+ No minimum requirement.
+ Operating System:
+ No minimum requirement. On Windows, Windows NT and above or Cygwin is
+ required for the startup scripts. Tested on Windows XP, Fedora Core
+ and Mac OS X.
+
+ Installing Shindig Java
+ -----------------------
+
+ Unzip the distribution archive, i.e. shindig-1.0-incubating-java.zip to
+ the directory you wish to install Shindig.
+
+ The following explains how to deploy the Shindig war file to Apache
+ Tomcat. If you are using an other container, please read its documentation
+ on how to proceed.
+
+ The easiest way to deploy Shindig on Apache Tomcat is to rename the
+ shindig-server-1.0-incubating.war file to ROOT.war and drop it in the
+ Tomcat webapps.
+ Be sure to delete $TOMCAT_HOME/webapps/ROOT dir before starting Tomcat.
+
+ Licensing
+ ---------
+
+ Please see the file called LICENSE.
+
+ Shindig URLS
+ ------------
+
+ Home Page: http://incubator.apache.org/shindig/
+ Downloads: http://incubator.apache.org/shindig/download/index.html
+ Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
+ Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
+ Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
+ Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
Modified: incubator/shindig/branches/1.0.x-incubating/javascript/README
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/javascript/README?rev=770209&r1=770208&r2=770209&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/javascript/README (original)
+++ incubator/shindig/branches/1.0.x-incubating/javascript/README Thu Apr 30 12:51:23 2009
@@ -1,87 +1,109 @@
-Using Shindig Gadget Container JavaScript
-=========================================
+ Apache Shindig Javascript
-1) Try out the samples.
- A) Set up your own Shindig Gadget Server. See java/README for details.
+ What is it?
+ -----------
- B) Assuming your server is running on http://yourserver:yourport/gadgets/...
- you can hit these html files in your favorite browser to see your local
- Shindig in action:
+ Shindig is a JavaScript container and implementations of the backend APIs
+ and proxy required for hosting OpenSocial applications.
- (Note: yourserver:yourport defaults to localhost:8080 for the java server,
- and just localhost for the php server)
+ This is the Javascript component of Shindig.
- * http://yourserver:yourport/gadgets/files/container/sample1.html - basic container
- * http://yourserver:yourport/gadgets/files/container/sample2.html - custom rendering
- * http://yourserver:yourport/gadgets/files/container/sample3.html - custom layouts
- * http://yourserver:yourport/gadgets/files/container/sample4.html - set pref
- * http://yourserver:yourport/gadgets/files/container/sample5.html - set pref
- * http://yourserver:yourport/gadgets/files/container/sample6.html - dynamic height
- * http://yourserver:yourport/gadgets/files/container/sample7.html - set title
+ Documentation
+ -------------
- These samples are very basic and aren't production-ready. Shindig will
- include a more advanced container at a later date but it hasn't been
- completed yet.
+ The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
+
+ Using Shindig Gadget Container JavaScript
+ -----------------------------------------
-2) Play around with the code.
+ 1) Try out the samples.
+ A) Set up your own Shindig Gadget Server. See java/README for details.
- A) Create an HTML file including the following <head> boilerplate:
- <script type="text/javascript" src="../../js/rpc.js?c=1"></script>
- <script type="text/javascript" src="cookies.js"></script>
- <script type="text/javascript" src="util.js"></script>
- <script type="text/javascript" src="gadgets.js"></script>
- <script type="text/javascript" src="cookiebaseduserprefstore.js"></script>
+ B) Assuming your server is running on http://yourserver:yourport/gadgets/...
+ you can hit these html files in your favorite browser to see your local
+ Shindig in action:
- B) For each Gadget you wish to add to the page:
- i) Create it. Example, for Gadget whose spec is at http://foo.com/spec.xml
+ (Note: yourserver:yourport defaults to localhost:8080 for the java server,
+ and just localhost for the php server)
- var gadget = gadgets.container.createGadget(
- {specUrl: "http://foo.com/spec.xml"});
+ * http://yourserver:yourport/gadgets/files/container/sample1.html - basic container
+ * http://yourserver:yourport/gadgets/files/container/sample2.html - custom rendering
+ * http://yourserver:yourport/gadgets/files/container/sample3.html - custom layouts
+ * http://yourserver:yourport/gadgets/files/container/sample4.html - set pref
+ * http://yourserver:yourport/gadgets/files/container/sample5.html - set pref
+ * http://yourserver:yourport/gadgets/files/container/sample6.html - dynamic height
+ * http://yourserver:yourport/gadgets/files/container/sample7.html - set title
- Check "gadgets.js" for other options to be set in createGadget. If you are
- debugging your own gadgets you can consider to use specVersion to get a more
- optimal use of the cache. Alternatively, gadgets.container.setNoCache(1)
+ These samples are very basic and aren't production-ready. Shindig will
+ include a more advanced container at a later date but it hasn't been
+ completed yet.
- ii) Add it to the container. Example:
+ 2) Play around with the code.
- gadgets.container.addGadget(gadget);
+ A) Create an HTML file including the following <head> boilerplate:
+ <script type="text/javascript" src="../../js/rpc.js?c=1"></script>
+ <script type="text/javascript" src="cookies.js"></script>
+ <script type="text/javascript" src="util.js"></script>
+ <script type="text/javascript" src="gadgets.js"></script>
+ <script type="text/javascript" src="cookiebaseduserprefstore.js"></script>
- If your setup is too complicated, you can need to tell each Gadget
- where its server is. Example
+ B) For each Gadget you wish to add to the page:
+ i) Create it. Example, for Gadget whose spec is at http://foo.com/spec.xml
+
+ var gadget = gadgets.container.createGadget(
+ {specUrl: "http://foo.com/spec.xml"});
+
+ Check "gadgets.js" for other options to be set in createGadget. If you are
+ debugging your own gadgets you can consider to use specVersion to get a more
+ optimal use of the cache. Alternatively, gadgets.container.setNoCache(1)
+
+ ii) Add it to the container. Example:
- gadget.setServerBase("http://yourserver:yourport/gadgets/");
+ gadgets.container.addGadget(gadget);
+
+ If your setup is too complicated, you can need to tell each Gadget
+ where its server is. Example
+
+ gadget.setServerBase("http://yourserver:yourport/gadgets/");
- iii) Ensure the Gadget's chrome ID is defined. This is the ID of the
- elements in which the Gadget is rendered. The way these are specified
- differs depending on the LayoutManager being used. Example with default
- LayoutManager:
+ iii) Ensure the Gadget's chrome ID is defined. This is the ID of the
+ elements in which the Gadget is rendered. The way these are specified
+ differs depending on the LayoutManager being used. Example with default
+ LayoutManager:
- gadgets.container.layoutManager.setGadgetChromeIds([ 'gadget-id-1' ]);
+ gadgets.container.layoutManager.setGadgetChromeIds([ 'gadget-id-1' ]);
- iv) Render it. The chrome element must exist when this call is performed
- (ie. this must occur onLoad of the document.body or in inline script).
+ iv) Render it. The chrome element must exist when this call is performed
+ (ie. this must occur onLoad of the document.body or in inline script).
- gadgets.container.renderGadget(gadget);
+ gadgets.container.renderGadget(gadget);
- You may also render several added Gadgets at once:
+ You may also render several added Gadgets at once:
- gadgets.container.renderGadgets();
+ gadgets.container.renderGadgets();
- C) Explore samples 2, 3, and 4 for examples using different LayoutManagers
- and supporting UserPrefs storage.
+ C) Explore samples 2, 3, and 4 for examples using different LayoutManagers
+ and supporting UserPrefs storage.
-4) Run the opensocial sample container
- A) Set up your own Shindig Gadget Server. See java/README for details. (If you
- are using the java based server make sure you run with mvn jetty:run-war)
+ 4) Run the opensocial sample container
+ A) Set up your own Shindig Gadget Server. See java/README for details. (If you
+ are using the java based server make sure you run with mvn jetty:run-war)
- B) Hit the sample container at
- http://yourserver:yourport/gadgets/files/samplecontainer/samplecontainer.html
+ B) Hit the sample container at
+ http://yourserver:yourport/gadgets/files/samplecontainer/samplecontainer.html
- C) See the sample container help document for more details on how it works:
- http://yourserver:yourport/gadgets/files/samplecontainer/getting-started.html
+ C) See the sample container help document for more details on how it works:
+ http://yourserver:yourport/gadgets/files/samplecontainer/getting-started.html
- D) Get, and try to run, coderunner.xml and compliancetests.xml from the project
- http://opensocial-resources.googlecode.com/
+ D) Get, and try to run, coderunner.xml and compliancetests.xml from the project
+ http://opensocial-resources.googlecode.com/
+ Shindig URLS
+ ------------
-For more information, see http://incubator.apache.org/projects/shindig.html
+ Home Page: http://incubator.apache.org/shindig/
+ Downloads: http://incubator.apache.org/shindig/download/index.html
+ Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
+ Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
+ Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
+ Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
Copied: incubator/shindig/branches/1.0.x-incubating/php/NOTICE (from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE)
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/php/NOTICE?p2=incubator/shindig/branches/1.0.x-incubating/php/NOTICE&p1=incubator/shindig/branches/1.0.x-incubating/NOTICE&r1=770145&r2=770209&rev=770209&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/NOTICE (original)
+++ incubator/shindig/branches/1.0.x-incubating/php/NOTICE Thu Apr 30 12:51:23 2009
@@ -1,16 +1,21 @@
-Apache Shindig
-Copyright 2009 The Apache Software Foundation
+ =========================================================================
+ == NOTICE file corresponding to the section 4 d of ==
+ == the Apache License, Version 2.0, ==
+ == in this case for the Apache Shindig distribution. ==
+ =========================================================================
-This product includes software developed at
-The Apache Software Foundation (http://www.apache.org/).
-
------------------------------------------------------------
This product includes software (Gadget Server, Gadget Container)
originally developed by Google Inc. (http://code.google.com/) and licensed
to the ASF as initial contribution for Shindig.
-This product includes the jquery.js file,
-Copyright (c) 2007 John Resig, http://jquery.com/
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+This product includes software (Zend) developed by
+Zend Technologies Ltd (http://framework.zend.com/).
+
+This product includes software (PHPUnit) developed by
+Sebastian Bergmann (http://www.phpunit.de/).
This distribution includes cryptographic software. The country in
which you currently reside may have restrictions on the import,
@@ -34,9 +39,6 @@
The following provides more details on the included cryptographic
software:
- Apache Shindig interfaces with the Java JCE APIs to provide
- encryption of messages using the AES standard.
-
Apache Shindig PHP interfaces with the mcrypt API
<http://mcrypt.sourceforge.net/> to provide encryption
of messages using the AES standard.
Modified: incubator/shindig/branches/1.0.x-incubating/php/README
URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/php/README?rev=770209&r1=770208&r2=770209&view=diff
==============================================================================
--- incubator/shindig/branches/1.0.x-incubating/php/README (original)
+++ incubator/shindig/branches/1.0.x-incubating/php/README Thu Apr 30 12:51:23 2009
@@ -1,109 +1,120 @@
-Welcome to Apache Shindig!
+ Apache Shindig PHP
-* Read javascript/README for instructions for using the Shindig Gadget
+ What is it?
+ -----------
+
+ Shindig is a JavaScript container and implementations of the backend APIs
+ and proxy required for hosting OpenSocial applications.
+
+ This is the PHP implementation of Shindig. If you are looking to the Java
+ implementation, please visit our website.
+
+ Documentation
+ -------------
+
+ The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
+ and at http://incubator.apache.org/shindig/developers/php/index.html
+ for specific PHP documentation.
+
+ Read javascript/README for instructions for using the Shindig Gadget
Container JavaScript to enable your page to render Gadgets.
-* Read the instructions below for how to use PHP Shindig
-* For more information, see http://incubator.apache.org/shindig/
+ Release Notes
+ -------------
-Installing and Running The PHP Shindig Gadget Server
-============================================
+ The full list of changes can be found at https://issues.apache.org/jira/browse/SHINDIG.
-Prequisites before building Shindig for PHP
-============================================
-In order to build and run Shindig for PHP, you must have the following:
-
-- A Subversion client installed in order to checkout the code.
- Instructions for downloading and installing Subversion can be found here:
- http://subversion.tigris.org/
-- Apache with mod_rewrite enabled.
-- PHP 5.2.x with the json, simplexml, mcrypt and curl extentions enabled.
-
-
-Getting the code (if you're running from svn and not a release tarball)
-============================================
-Create a subdirectory in your web document root, e.g. /var/www/html and
-checkout the Shindig code from its Subversion repository
-
-mkdir /var/www/html/shindig
-cd /var/www/html/shindig
-svn co http://svn.apache.org/repos/asf/incubator/shindig/trunk/ .
-
-
-Running Shindig from a release download
-============================================
-
-The instructions are identical as when running from an svn checkout, except
-that the /shindig/php directory in the virtual host becomes just /shindig, ie:
-
- <VirtualHost your_ip:your_port>
- ServerName your.host
- DocumentRoot /var/www/html/shindig
- ... other normal settings in vhosts...
- <Directory />
- AllowOverride All
- </Directory>
- </VirtualHost>
-
-Running Shindig from an svn checkout
-============================================
-With PHP There is no need to build anything - the source code
-is already built.
-
-To run the code, you have several options:
-
-a. Create a new virtual host
-
-Point your apache to the php dir with a virtual host like:
-
- <VirtualHost your_ip:your_port>
- ServerName your.host
- DocumentRoot /var/www/html/shindig/php
- ... other normal settings in vhosts...
- <Directory />
- AllowOverride All
- </Directory>
- </VirtualHost>
-
-
-Restart apache, and point your browser to:
-
-http://<your.host>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
-
-you should see something like this:
-http://shindig.chabotc.com/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
-
-b. Run with an existing host
-
-If you cannot/don't want to create a virtual host, you can edit the file php/config/container.php
-or php/config/local.php (see the comments php/config/container.php for documentation of the
-configuration system) and change the web_prefix setting to '/shindig/php'.
-
-In this case, you should also change all paths in shindig/config/container.js
-(see the comments there for documentation of the JSON configuration system).
-
-Then you can run the gadget by pointing your browser to:
-
-http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
-
-Going forward
-============================================
-Check out the php/config/container.php file, in local.php you only have to specificy the
-fields you want to overwrite with other values, for example on a production system you
-would probably want to have something like:
- $shindigConfig = array(
- 'debug' => false,
- 'allow_plaintext_token' => false,
- 'token_cipher_key' => 'MySecretKey',
- 'token_hmac_key' => 'MyOtherSecret',
- 'private_key_phrase' => 'MyCertificatePassword',
- 'person_service' => 'MyPeopleService',
- 'activity_service' => 'MyActivitiesService',
- 'app_data_service' => 'MyAppDataService',
- 'messages_service' => 'MyMessagesService',
- 'oauth_lookup_service' => 'MyOAuthLookupService'
- 'xrds_location' => 'http://www.mycontainer.com/xrds',
- 'check_file_exists' => false
- );
+ System Requirements
+ -------------------
+
+ PHP:
+ 5.2.x or above with the json, simplexml, mcrypt and curl extentions
+ enabled.
+ Web server:
+ Apache with mod_rewrite enabled.
+ Memory:
+ No minimum requirement.
+ Disk:
+ No minimum requirement.
+ Operating System:
+ No minimum requirement. On Windows, Windows NT and above or Cygwin is
+ required for the startup scripts. Tested on Windows XP, Fedora Core
+ and Mac OS X.
+
+ Installing Shindig
+ ------------------
+
+ Unzip the distribution archive, i.e. shindig-1.0-incubating-php.zip to
+ the web document root, e.g. /var/www/html.
+
+ Rename the created shindig-1.0-incubating-php dir to shindig.
+
+ a. Create a new virtual host
+
+ Point your Apache to the shindig dir with a virtual host like:
+
+ <VirtualHost your_ip:your_port>
+ ServerName your.host
+ DocumentRoot /var/www/html/shindig
+ ... other normal settings in vhosts...
+ <Directory>
+ AllowOverride All
+ </Directory>
+ </VirtualHost>
+
+ Restart apache, and point your browser to:
+
+ http://<your.host>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
+
+ b. Run with an existing host
+
+ If you cannot/don't want to create a virtual host, you can edit the file
+ php/config/container.php or php/config/local.php (see the comments
+ php/config/container.php for documentation of the configuration system)
+ and change the web_prefix setting to '/shindig/php'.
+
+ In this case, you should also change all paths in shindig/config/container.js
+ (see the comments there for documentation of the JSON configuration system).
+
+ Then you can run the gadget by pointing your browser to:
+
+ http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
+
+ Going forward
+ -------------
+
+ Check out the php/config/container.php file, in local.php you only have
+ to specificy the fields you want to overwrite with other values, for
+ example on a production system you would probably want to have something
+ like:
+ $shindigConfig = array(
+ 'debug' => false,
+ 'allow_plaintext_token' => false,
+ 'token_cipher_key' => 'MySecretKey',
+ 'token_hmac_key' => 'MyOtherSecret',
+ 'private_key_phrase' => 'MyCertificatePassword',
+ 'person_service' => 'MyPeopleService',
+ 'activity_service' => 'MyActivitiesService',
+ 'app_data_service' => 'MyAppDataService',
+ 'messages_service' => 'MyMessagesService',
+ 'oauth_lookup_service' => 'MyOAuthLookupService'
+ 'xrds_location' => 'http://www.mycontainer.com/xrds',
+ 'check_file_exists' => false
+ );
-And then implement your own service and oauth lookup classes.
+ And then implement your own service and oauth lookup classes.
+
+ Licensing
+ ---------
+
+ Please see the file called LICENSE.
+
+ Shindig URLS
+ ------------
+
+ Home Page: http://incubator.apache.org/shindig/
+ Downloads: http://incubator.apache.org/shindig/download/index.html
+ Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
+ Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
+ Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
+ Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
Re: svn commit: r770209 - in /incubator/shindig/branches/1.0.x-incubating: ./ assembly/src/main/assembly/ assembly/src/main/assembly/binary-src/ features/ java/ javascript/ php/
Posted by Vincent Demay <vi...@demay-fr.net>.
--
Vincent Demay
www.goojet.com
Le 30 avr. 09 à 14:51, vsiveton@apache.org a écrit :
> Author: vsiveton
> Date: Thu Apr 30 12:51:23 2009
> New Revision: 770209
>
> URL: http://svn.apache.org/viewvc?rev=770209&view=rev
> Log:
> o improved README, NOTICE and LICENSE
>
> Added:
> incubator/shindig/branches/1.0.x-incubating/java/LICENSE
> incubator/shindig/branches/1.0.x-incubating/java/NOTICE
> - copied, changed from r770145, incubator/shindig/branches/
> 1.0.x-incubating/NOTICE
> incubator/shindig/branches/1.0.x-incubating/php/LICENSE
> - copied unchanged from r770160, incubator/shindig/branches/
> 1.0.x-incubating/LICENSE
> incubator/shindig/branches/1.0.x-incubating/php/NOTICE
> - copied, changed from r770145, incubator/shindig/branches/
> 1.0.x-incubating/NOTICE
> Removed:
> incubator/shindig/branches/1.0.x-incubating/LICENSE
> incubator/shindig/branches/1.0.x-incubating/NOTICE
> incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
> assembly/binary-src/
> Modified:
> incubator/shindig/branches/1.0.x-incubating/README
> incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
> assembly/java.xml
> incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
> assembly/php.xml
> incubator/shindig/branches/1.0.x-incubating/features/README
> incubator/shindig/branches/1.0.x-incubating/java/README
> incubator/shindig/branches/1.0.x-incubating/javascript/README
> incubator/shindig/branches/1.0.x-incubating/php/README
>
> Modified: incubator/shindig/branches/1.0.x-incubating/README
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/README?rev=770209&r1=770208&r2=770209&view=diff
> ===
> ===
> ===
> =====================================================================
> --- incubator/shindig/branches/1.0.x-incubating/README (original)
> +++ incubator/shindig/branches/1.0.x-incubating/README Thu Apr 30
> 12:51:23 2009
> @@ -1,14 +1,38 @@
> -Welcome to Apache Shindig!
> + Apache Shindig
>
> -* Read java/README for instructions on using the java gadget servers.
> + What is it?
> + -----------
>
> -* To build and run the Java server see BUILD-JAVA
> + Shindig is a JavaScript container and implementations of the
> backend APIs
> + and proxy required for hosting OpenSocial applications.
>
> -* Read php/README for instructions on how to run a php gadget server
> - instead of a java gadget server.
> + Documentation
> + -------------
>
> -* Read javascript/README 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.
> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
> .
>
> -For more information, see http://incubator.apache.org/shindig/
> + Read BUILD-JAVA for instructions on how to build and run the Java
> server.
> +
> + Read java/README for instructions on how to run a Java gadget
> server.
> +
> + Read php/README for instructions on how to run a php gadget server.
> +
> + Read javascript/README for instructions for using the Shindig
> Gadget Container
> + JavaScript to enable your page to render Gadgets.
> +
> + Read features/README for instructions on how to use features.
> +
> + Licensing
> + ---------
> +
> + Please see the file called LICENSE in the java and php directories.
> +
> + Shindig URLS
> + ------------
> +
> + Home Page: http://incubator.apache.org/shindig/
> + Downloads: http://incubator.apache.org/shindig/download/index.html
> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>
> Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/
> main/assembly/java.xml
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml?rev=770209&r1=770208&r2=770209&view=diff
> ===
> ===
> ===
> =====================================================================
> --- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
> assembly/java.xml (original)
> +++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
> assembly/java.xml Thu Apr 30 12:51:23 2009
> @@ -43,18 +43,21 @@
> <outputDirectory>shindig-${pom.version}-java</outputDirectory>
> <directory>../</directory>
> <includes>
> - <include>COMMITTERS</include>
> <include>DISCLAIMER</include>
> - <include>LICENSE</include>
> - <include>NOTICE</include>
> </includes>
> + <excludes>
> + <exclude>LICENSE</exclude>
> + <exclude>NOTICE</exclude>
> + <exclude>README</exclude>
> + </excludes>
> </fileSet>
> <fileSet>
> <outputDirectory>shindig-${pom.version}-java</outputDirectory>
> - <directory>src/main/assembly/binary-src/</directory>
> - <filtered>true</filtered>
> + <directory>../java</directory>
> <includes>
> - <include>**/*</include>
> + <include>LICENSE</include>
> + <include>NOTICE</include>
> + <include>README</include>
> </includes>
> </fileSet>
> </fileSets>
>
> Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/
> main/assembly/php.xml
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml?rev=770209&r1=770208&r2=770209&view=diff
> ===
> ===
> ===
> =====================================================================
> --- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
> assembly/php.xml (original)
> +++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
> assembly/php.xml Thu Apr 30 12:51:23 2009
> @@ -32,10 +32,7 @@
> <include>features/**</include>
> <include>javascript/**</include>
> <include>config/**</include>
> - <include>COMMITTERS</include>
> <include>DISCLAIMER</include>
> - <include>LICENSE</include>
> - <include>NOTICE</include>
> </includes>
> <excludes>
> <exclude>site/**</exclude>
> @@ -63,6 +60,8 @@
> <!-- misc -->
> <exclude>*.patch</exclude>
> <exclude>*.diff</exclude>
> + <exclude>LICENSE</exclude>
> + <exclude>NOTICE</exclude>
> <exclude>README</exclude>
> </excludes>
> <lineEnding>unix</lineEnding>
>
> Modified: incubator/shindig/branches/1.0.x-incubating/features/README
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/features/README?rev=770209&r1=770208&r2=770209&view=diff
> ===
> ===
> ===
> =====================================================================
> --- incubator/shindig/branches/1.0.x-incubating/features/README
> (original)
> +++ incubator/shindig/branches/1.0.x-incubating/features/README Thu
> Apr 30 12:51:23 2009
> @@ -1,40 +1,68 @@
> -You can automatically include new features into your shindig server
> by adding
> -them to this directory. Features should exist in a self-contained
> directory
> -with the following structure:
> -
> -features
> - |_your-feature-name
> - |_feature.xml
> - |_code-to-run-inside-gadget.js
> - |_code-to-run-inside-container.js
> -
> -The structure of feature.xml is as follows:
> -TODO: link to xml schema for feature.xml
> -
> -<?xml version="1.0"?>
> -<feature>
> - <name>your-feature-name (required)</name>
> - <dependency>any dependency you have (optional, may have
> multiple)</dependency>
> - <gadget> (optional)
> - <script src="code-to-run-inside-gadget.js"/> (optional, may
> have multiple,
> - may use web resources as well but we strongly encourage
> bundling your
> - javascript with the xml)
> - </gadget>
> - <container> (optional)
> - <script src="code-to-run-inside-container.js"> (same as for
> <gadget>)
> - </container>
> -</feature>
> -
> -Please always make sure that all files you provide are encoded as
> utf8.
> -
> -When adding new features, your javascript should conform to shindig
> javascript
> -coding conventions. This means that you should not be producing new
> globals and
> -your feature should be compatible with Caja.
> + Apache Shindig Features
>
> -When committing a new feature, you should update the features.txt
> file by
> -running the following script in a unix-like environment:
> + What is it?
> + -----------
>
> -ls -R1a features/**/*.xml > features/features.txt
> + Shindig is a JavaScript container and implementations of the
> backend APIs
> + and proxy required for hosting OpenSocial applications.
>
> -TODO: Instructions for regenerating features.txt for other
> operating system
> -environments.
> + This is the features component of Shindig.
> +
> + Documentation
> + -------------
> +
> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
> +
> + Using features
> + --------------
> +
> + You can automatically include new features into your shindig
> server by adding
> + them to this directory. Features should exist in a self-contained
> directory
> + with the following structure:
> +
> + features
> + |_your-feature-name
> + |_feature.xml
> + |_code-to-run-inside-gadget.js
> + |_code-to-run-inside-container.js
> +
> + The structure of feature.xml is as follows:
> + TODO: link to xml schema for feature.xml
> +
> + <?xml version="1.0"?>
> + <feature>
> + <name>your-feature-name (required)</name>
> + <dependency>any dependency you have (optional, may have
> multiple)</dependency>
> + <gadget> (optional)
> + <script src="code-to-run-inside-gadget.js"/> (optional, may
> have multiple,
> + may use web resources as well but we strongly encourage
> bundling your
> + javascript with the xml)
> + </gadget>
> + <container> (optional)
> + <script src="code-to-run-inside-container.js"> (same as for
> <gadget>)
> + </container>
> + </feature>
> +
> + Please always make sure that all files you provide are encoded as
> utf8.
> +
> + When adding new features, your javascript should conform to
> shindig javascript
> + coding conventions. This means that you should not be producing
> new globals and
> + your feature should be compatible with Caja.
> +
> + When committing a new feature, you should update the features.txt
> file by
> + running the following script in a unix-like environment:
> +
> + ls -R1a features/**/*.xml > features/features.txt
> +
> + TODO: Instructions for regenerating features.txt for other
> operating system
> + environments.
> +
> + Shindig URLS
> + ------------
> +
> + Home Page: http://incubator.apache.org/shindig/
> + Downloads: http://incubator.apache.org/shindig/download/index.html
> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>
> Added: incubator/shindig/branches/1.0.x-incubating/java/LICENSE
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/LICENSE?rev=770209&view=auto
> ===
> ===
> ===
> =====================================================================
> --- incubator/shindig/branches/1.0.x-incubating/java/LICENSE (added)
> +++ incubator/shindig/branches/1.0.x-incubating/java/LICENSE Thu Apr
> 30 12:51:23 2009
> @@ -0,0 +1,212 @@
> +
> + Apache License
> + Version 2.0, January 2004
> + http://www.apache.org/licenses/
> +
> + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
> +
> + 1. Definitions.
> +
> + "License" shall mean the terms and conditions for use,
> reproduction,
> + and distribution as defined by Sections 1 through 9 of this
> document.
> +
> + "Licensor" shall mean the copyright owner or entity
> authorized by
> + the copyright owner that is granting the License.
> +
> + "Legal Entity" shall mean the union of the acting entity and
> all
> + other entities that control, are controlled by, or are under
> common
> + control with that entity. For the purposes of this definition,
> + "control" means (i) the power, direct or indirect, to cause the
> + direction or management of such entity, whether by contract or
> + otherwise, or (ii) ownership of fifty percent (50%) or more
> of the
> + outstanding shares, or (iii) beneficial ownership of such
> entity.
> +
> + "You" (or "Your") shall mean an individual or Legal Entity
> + exercising permissions granted by this License.
> +
> + "Source" form shall mean the preferred form for making
> modifications,
> + including but not limited to software source code,
> documentation
> + source, and configuration files.
> +
> + "Object" form shall mean any form resulting from mechanical
> + transformation or translation of a Source form, including but
> + not limited to compiled object code, generated documentation,
> + and conversions to other media types.
> +
> + "Work" shall mean the work of authorship, whether in Source or
> + Object form, made available under the License, as indicated
> by a
> + copyright notice that is included in or attached to the work
> + (an example is provided in the Appendix below).
> +
> + "Derivative Works" shall mean any work, whether in Source or
> Object
> + form, that is based on (or derived from) the Work and for
> which the
> + editorial revisions, annotations, elaborations, or other
> modifications
> + represent, as a whole, an original work of authorship. For
> the purposes
> + of this License, Derivative Works shall not include works
> that remain
> + separable from, or merely link (or bind by name) to the
> interfaces of,
> + the Work and Derivative Works thereof.
> +
> + "Contribution" shall mean any work of authorship, including
> + the original version of the Work and any modifications or
> additions
> + to that Work or Derivative Works thereof, that is intentionally
> + submitted to Licensor for inclusion in the Work by the
> copyright owner
> + or by an individual or Legal Entity authorized to submit on
> behalf of
> + the copyright owner. For the purposes of this definition,
> "submitted"
> + means any form of electronic, verbal, or written
> communication sent
> + to the Licensor or its representatives, including but not
> limited to
> + communication on electronic mailing lists, source code
> control systems,
> + and issue tracking systems that are managed by, or on behalf
> of, the
> + Licensor for the purpose of discussing and improving the
> Work, but
> + excluding communication that is conspicuously marked or
> otherwise
> + designated in writing by the copyright owner as "Not a
> Contribution."
> +
> + "Contributor" shall mean Licensor and any individual or Legal
> Entity
> + on behalf of whom a Contribution has been received by
> Licensor and
> + subsequently incorporated within the Work.
> +
> + 2. Grant of Copyright License. Subject to the terms and
> conditions of
> + this License, each Contributor hereby grants to You a
> perpetual,
> + worldwide, non-exclusive, no-charge, royalty-free, irrevocable
> + copyright license to reproduce, prepare Derivative Works of,
> + publicly display, publicly perform, sublicense, and
> distribute the
> + Work and such Derivative Works in Source or Object form.
> +
> + 3. Grant of Patent License. Subject to the terms and conditions of
> + this License, each Contributor hereby grants to You a
> perpetual,
> + worldwide, non-exclusive, no-charge, royalty-free, irrevocable
> + (except as stated in this section) patent license to make,
> have made,
> + use, offer to sell, sell, import, and otherwise transfer the
> Work,
> + where such license applies only to those patent claims
> licensable
> + by such Contributor that are necessarily infringed by their
> + Contribution(s) alone or by combination of their
> Contribution(s)
> + with the Work to which such Contribution(s) was submitted. If
> You
> + institute patent litigation against any entity (including a
> + cross-claim or counterclaim in a lawsuit) alleging that the
> Work
> + or a Contribution incorporated within the Work constitutes
> direct
> + or contributory patent infringement, then any patent licenses
> + granted to You under this
Re: svn commit: r770209 - in /incubator/shindig/branches/1.0.x-incubating: ./ assembly/src/main/assembly/ assembly/src/main/assembly/binary-src/ features/ java/ javascript/ php/
Posted by Ian Boston <ie...@tfd.co.uk>.
On 5 May 2009, at 11:44, Vincent Siveton wrote:
> Hi Ian,
>
> 2009/5/5 Ian Boston <ie...@tfd.co.uk>:
>> some comments.
>> Looking at the source assembly.
>> There is no LICENSE or NOTICE in the top level directory,
>> consequently there
>> are some subfolders that don't appear to be covered by a license.
>
> I could see two options:
> - aggregate all LICENSEs/ NOTICEs on root
> - just put ASL on root and add specific LICENSEs in sub dirs. NOTICE
> on root will be generic and will refer to specific NOTICEs in sub
> dirs.
>
> I am in favour of the last option.
yes, me too :)
>
>
>>
>> Looking at the Java assembly.
>> ====================
>> In the README,
>> "
>> Memory:
>> No minimum requirement.
>> Disk:
>> No minimum requirement.
>> "
>> Not exactly true, someone might think they could run this on a
>> phone...
>> (they probably could, who know why they would want to :))
>
> Agree
>
>> Memory:
>> 128MB Minimum
>> Disk
>> 128MB Minimum
>
> I think 32MB is enough for the diskspace (lets try to unzip tarballs)
I think you are right, then I thought about what happens when you
start a war inside tomcat, unpacks annother copy etc and soon you are
up to 4, but I am Ok with 32MB.....
>
>
>> =====================
>> In the war file:
>> Is it worth adding a line to the NOTICE file so that those
>> expecting to
>> see 3rd party libs listed there will go to the right place.
>> "This package includes bundled 3rd party dependencies which are
>> listed in
>> the DEPENDENCIES file."
>
> This file is generated by the
> org.apache:apache-jar-resource-bundle:1.4, which is compliant with
> legal-discuss (see thread on dev@maven in march 08)
Ok that sounds like a good place to send anyone who is not happy with
this. I am ok.
>
>
>> =====================
>>
>> In features-jar
>> The NOTICE and dependencies contain no mention of the OpenSocial
>> spec, I
>> think there may be some javascript from there and certainly we should
>> reference
>> http://code.google.com/apis/opensocial/terms.html
>>
>> =====================
>>
>> In gadgets-jar
>> Similarly we should probably reference
>> http://code.google.com/apis/gadgets/docs/terms.html
>>
>> =====================
>
> For both, I think it will be better to include the following project
> (using ASL)
>
> This product includes software (opensocial-resources) developed by
> Google (http://opensocial-resources.googlecode.com/svn/spec/0.8/)
yes makes sense.
Ian
>
>
>>
>> Other than that IMHO it looks Ok.
>> The changes to the NOTICE files are only a suggestion since I
>> noticed that
>> on the last release there were those that thought only NOTICE and
>> LICENSE
>> were valid locations. Just as LICENSE references NOTICE, if NOTICE
>> referenced DEPENDENCIES they might be more willing to accept.
>
> No worries, suggestions are always welcome.
> Our mentors will validate the tarballs during the release vote.
>
>> I hope I haven't opened a can of worms on the references to the
>> Gadget and
>> OpenSocial spec's.
>
> Thanks,
>
> Vincent
Re: svn commit: r770209 - in /incubator/shindig/branches/1.0.x-incubating:
./ assembly/src/main/assembly/ assembly/src/main/assembly/binary-src/
features/ java/ javascript/ php/
Posted by Vincent Siveton <vi...@gmail.com>.
Hi Ian,
2009/5/5 Ian Boston <ie...@tfd.co.uk>:
> some comments.
> Looking at the source assembly.
> There is no LICENSE or NOTICE in the top level directory, consequently there
> are some subfolders that don't appear to be covered by a license.
I could see two options:
- aggregate all LICENSEs/ NOTICEs on root
- just put ASL on root and add specific LICENSEs in sub dirs. NOTICE
on root will be generic and will refer to specific NOTICEs in sub
dirs.
I am in favour of the last option.
>
> Looking at the Java assembly.
> ====================
> In the README,
> "
> Memory:
> No minimum requirement.
> Disk:
> No minimum requirement.
> "
> Not exactly true, someone might think they could run this on a phone...
> (they probably could, who know why they would want to :))
Agree
> Memory:
> 128MB Minimum
> Disk
> 128MB Minimum
I think 32MB is enough for the diskspace (lets try to unzip tarballs)
> =====================
> In the war file:
> Is it worth adding a line to the NOTICE file so that those expecting to
> see 3rd party libs listed there will go to the right place.
> "This package includes bundled 3rd party dependencies which are listed in
> the DEPENDENCIES file."
This file is generated by the
org.apache:apache-jar-resource-bundle:1.4, which is compliant with
legal-discuss (see thread on dev@maven in march 08)
> =====================
>
> In features-jar
> The NOTICE and dependencies contain no mention of the OpenSocial spec, I
> think there may be some javascript from there and certainly we should
> reference
> http://code.google.com/apis/opensocial/terms.html
>
> =====================
>
> In gadgets-jar
> Similarly we should probably reference
> http://code.google.com/apis/gadgets/docs/terms.html
>
> =====================
For both, I think it will be better to include the following project (using ASL)
This product includes software (opensocial-resources) developed by
Google (http://opensocial-resources.googlecode.com/svn/spec/0.8/)
>
> Other than that IMHO it looks Ok.
> The changes to the NOTICE files are only a suggestion since I noticed that
> on the last release there were those that thought only NOTICE and LICENSE
> were valid locations. Just as LICENSE references NOTICE, if NOTICE
> referenced DEPENDENCIES they might be more willing to accept.
No worries, suggestions are always welcome.
Our mentors will validate the tarballs during the release vote.
> I hope I haven't opened a can of worms on the references to the Gadget and
> OpenSocial spec's.
Thanks,
Vincent
Re: svn commit: r770209 - in /incubator/shindig/branches/1.0.x-incubating: ./ assembly/src/main/assembly/ assembly/src/main/assembly/binary-src/ features/ java/ javascript/ php/
Posted by Ian Boston <ie...@tfd.co.uk>.
Good point,
(
wierd, mvn -Passembly clean install fails in the root folder OSX, ok
in the assembly folder, but hudson is Ok
error is
Failed to create assembly: File to filter not found: /Users/ieb/Apache/
shindig/trunk/assembly/../1.0.x-incubating/assembly/pom.xml (No such
file or directory)
I have no idea where the ../1.0.x-incubating is coming from.
).
Anyway, looking at the hudson artifacts.
some comments.
Looking at the source assembly.
There is no LICENSE or NOTICE in the top level directory, consequently
there are some subfolders that don't appear to be covered by a license.
eg
javascript
assembly
etc
features
site
config
java and php are covered.
Looking at the Java assembly.
====================
In the README,
"
Memory:
No minimum requirement.
Disk:
No minimum requirement.
"
Not exactly true, someone might think they could run this on a
phone... (they probably could, who know why they would want to :))
Memory:
128MB Minimum
Disk
128MB Minimum
=====================
In the war file:
Is it worth adding a line to the NOTICE file so that those
expecting to see 3rd party libs listed there will go to the right place.
"This package includes bundled 3rd party dependencies which are
listed in the DEPENDENCIES file."
=====================
In features-jar
The NOTICE and dependencies contain no mention of the OpenSocial
spec, I think there may be some javascript from there and certainly we
should reference
http://code.google.com/apis/opensocial/terms.html
=====================
In gadgets-jar
Similarly we should probably reference http://code.google.com/apis/gadgets/docs/terms.html
=====================
Other than that IMHO it looks Ok.
The changes to the NOTICE files are only a suggestion since I noticed
that on the last release there were those that thought only NOTICE and
LICENSE were valid locations. Just as LICENSE references NOTICE, if
NOTICE referenced DEPENDENCIES they might be more willing to accept.
I hope I haven't opened a can of worms on the references to the Gadget
and OpenSocial spec's.
Ian
On 4 May 2009, at 23:25, Vincent Siveton wrote:
> Hi Ian,
>
> 2009/5/4 Ian Boston <ie...@tfd.co.uk>:
>> I am getting a build failure on the source assembly.
>> Not certain why yet.
>
> Thanks for your response :)
>
> You could always have a look to Hudson for the assemblies.
> The main point is to see if legal sources are conform or not.
>
> Cheers,
>
> Vincent
Re: svn commit: r770209 - in /incubator/shindig/branches/1.0.x-incubating:
./ assembly/src/main/assembly/ assembly/src/main/assembly/binary-src/
features/ java/ javascript/ php/
Posted by Vincent Siveton <vi...@gmail.com>.
Hi Ian,
2009/5/4 Ian Boston <ie...@tfd.co.uk>:
> I am getting a build failure on the source assembly.
> Not certain why yet.
Thanks for your response :)
You could always have a look to Hudson for the assemblies.
The main point is to see if legal sources are conform or not.
Cheers,
Vincent
Re: svn commit: r770209 - in /incubator/shindig/branches/1.0.x-incubating: ./ assembly/src/main/assembly/ assembly/src/main/assembly/binary-src/ features/ java/ javascript/ php/
Posted by Ian Boston <ie...@tfd.co.uk>.
I am getting a build failure on the source assembly.
Not certain why yet.
Ian
On 4 May 2009, at 17:41, Vincent Siveton wrote:
> Hi,
>
> Could you review this commit please?
> If we are all agree, I could retry to do the 1.0.x release this
> week...
>
> For lazy people, you could find the generated assemblies from Hudson:
> http://incubator.apache.org/shindig/download/index.html
>
> Cheers,
>
> Vincent
>
> 2009/4/30, Vincent Siveton <vi...@gmail.com>:
>> I just updated the legal files and the README.
>>
>> Please review this commit.
>>
>> Vincent
>>
>> 2009/4/30 <vs...@apache.org>:
>>
>>> Author: vsiveton
>>> Date: Thu Apr 30 12:51:23 2009
>>> New Revision: 770209
>>>
>>> URL: http://svn.apache.org/viewvc?rev=770209&view=rev
>>> Log:
>>> o improved README, NOTICE and LICENSE
>>>
>>> Added:
>>> incubator/shindig/branches/1.0.x-incubating/java/LICENSE
>>> incubator/shindig/branches/1.0.x-incubating/java/NOTICE
>>> - copied, changed from r770145, incubator/shindig/branches/
>>> 1.0.x-incubating/NOTICE
>>> incubator/shindig/branches/1.0.x-incubating/php/LICENSE
>>> - copied unchanged from r770160, incubator/shindig/branches/
>>> 1.0.x-incubating/LICENSE
>>> incubator/shindig/branches/1.0.x-incubating/php/NOTICE
>>> - copied, changed from r770145, incubator/shindig/branches/
>>> 1.0.x-incubating/NOTICE
>>> Removed:
>>> incubator/shindig/branches/1.0.x-incubating/LICENSE
>>> incubator/shindig/branches/1.0.x-incubating/NOTICE
>>> incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
>>> assembly/binary-src/
>>> Modified:
>>> incubator/shindig/branches/1.0.x-incubating/README
>>> incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
>>> assembly/java.xml
>>> incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
>>> assembly/php.xml
>>> incubator/shindig/branches/1.0.x-incubating/features/README
>>> incubator/shindig/branches/1.0.x-incubating/java/README
>>> incubator/shindig/branches/1.0.x-incubating/javascript/README
>>> incubator/shindig/branches/1.0.x-incubating/php/README
>>>
>>> Modified: incubator/shindig/branches/1.0.x-incubating/README
>>> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/README?rev=770209&r1=770208&r2=770209&view=diff
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> --- incubator/shindig/branches/1.0.x-incubating/README (original)
>>> +++ incubator/shindig/branches/1.0.x-incubating/README Thu Apr 30
>>> 12:51:23 2009
>>> @@ -1,14 +1,38 @@
>>> -Welcome to Apache Shindig!
>>> + Apache Shindig
>>>
>>> -* Read java/README for instructions on using the java gadget
>>> servers.
>>> + What is it?
>>> + -----------
>>>
>>> -* To build and run the Java server see BUILD-JAVA
>>> + Shindig is a JavaScript container and implementations of the
>>> backend APIs
>>> + and proxy required for hosting OpenSocial applications.
>>>
>>> -* Read php/README for instructions on how to run a php gadget
>>> server
>>> - instead of a java gadget server.
>>> + Documentation
>>> + -------------
>>>
>>> -* Read javascript/README 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.
>>> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
>>> .
>>>
>>> -For more information, see http://incubator.apache.org/shindig/
>>> + Read BUILD-JAVA for instructions on how to build and run the
>>> Java server.
>>> +
>>> + Read java/README for instructions on how to run a Java gadget
>>> server.
>>> +
>>> + Read php/README for instructions on how to run a php gadget
>>> server.
>>> +
>>> + Read javascript/README for instructions for using the Shindig
>>> Gadget Container
>>> + JavaScript to enable your page to render Gadgets.
>>> +
>>> + Read features/README for instructions on how to use features.
>>> +
>>> + Licensing
>>> + ---------
>>> +
>>> + Please see the file called LICENSE in the java and php
>>> directories.
>>> +
>>> + Shindig URLS
>>> + ------------
>>> +
>>> + Home Page: http://incubator.apache.org/shindig/
>>> + Downloads: http://incubator.apache.org/shindig/download/index.html
>>> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
>>> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
>>> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
>>> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>>>
>>> Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/
>>> main/assembly/java.xml
>>> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml?rev=770209&r1=770208&r2=770209&view=diff
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> --- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
>>> assembly/java.xml (original)
>>> +++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
>>> assembly/java.xml Thu Apr 30 12:51:23 2009
>>> @@ -43,18 +43,21 @@
>>> <outputDirectory>shindig-${pom.version}-java</outputDirectory>
>>> <directory>../</directory>
>>> <includes>
>>> - <include>COMMITTERS</include>
>>> <include>DISCLAIMER</include>
>>> - <include>LICENSE</include>
>>> - <include>NOTICE</include>
>>> </includes>
>>> + <excludes>
>>> + <exclude>LICENSE</exclude>
>>> + <exclude>NOTICE</exclude>
>>> + <exclude>README</exclude>
>>> + </excludes>
>>> </fileSet>
>>> <fileSet>
>>> <outputDirectory>shindig-${pom.version}-java</outputDirectory>
>>> - <directory>src/main/assembly/binary-src/</directory>
>>> - <filtered>true</filtered>
>>> + <directory>../java</directory>
>>> <includes>
>>> - <include>**/*</include>
>>> + <include>LICENSE</include>
>>> + <include>NOTICE</include>
>>> + <include>README</include>
>>> </includes>
>>> </fileSet>
>>> </fileSets>
>>>
>>> Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/
>>> main/assembly/php.xml
>>> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml?rev=770209&r1=770208&r2=770209&view=diff
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> --- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
>>> assembly/php.xml (original)
>>> +++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/
>>> assembly/php.xml Thu Apr 30 12:51:23 2009
>>> @@ -32,10 +32,7 @@
>>> <include>features/**</include>
>>> <include>javascript/**</include>
>>> <include>config/**</include>
>>> - <include>COMMITTERS</include>
>>> <include>DISCLAIMER</include>
>>> - <include>LICENSE</include>
>>> - <include>NOTICE</include>
>>> </includes>
>>> <excludes>
>>> <exclude>site/**</exclude>
>>> @@ -63,6 +60,8 @@
>>> <!-- misc -->
>>> <exclude>*.patch</exclude>
>>> <exclude>*.diff</exclude>
>>> + <exclude>LICENSE</exclude>
>>> + <exclude>NOTICE</exclude>
>>> <exclude>README</exclude>
>>> </excludes>
>>> <lineEnding>unix</lineEnding>
>>>
>>> Modified: incubator/shindig/branches/1.0.x-incubating/features/
>>> README
>>> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/features/README?rev=770209&r1=770208&r2=770209&view=diff
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> --- incubator/shindig/branches/1.0.x-incubating/features/README
>>> (original)
>>> +++ incubator/shindig/branches/1.0.x-incubating/features/README
>>> Thu Apr 30 12:51:23 2009
>>> @@ -1,40 +1,68 @@
>>> -You can automatically include new features into your shindig
>>> server by adding
>>> -them to this directory. Features should exist in a self-contained
>>> directory
>>> -with the following structure:
>>> -
>>> -features
>>> - |_your-feature-name
>>> - |_feature.xml
>>> - |_code-to-run-inside-gadget.js
>>> - |_code-to-run-inside-container.js
>>> -
>>> -The structure of feature.xml is as follows:
>>> -TODO: link to xml schema for feature.xml
>>> -
>>> -<?xml version="1.0"?>
>>> -<feature>
>>> - <name>your-feature-name (required)</name>
>>> - <dependency>any dependency you have (optional, may have
>>> multiple)</dependency>
>>> - <gadget> (optional)
>>> - <script src="code-to-run-inside-gadget.js"/> (optional, may
>>> have multiple,
>>> - may use web resources as well but we strongly encourage
>>> bundling your
>>> - javascript with the xml)
>>> - </gadget>
>>> - <container> (optional)
>>> - <script src="code-to-run-inside-container.js"> (same as for
>>> <gadget>)
>>> - </container>
>>> -</feature>
>>> -
>>> -Please always make sure that all files you provide are encoded as
>>> utf8.
>>> -
>>> -When adding new features, your javascript should conform to
>>> shindig javascript
>>> -coding conventions. This means that you should not be producing
>>> new globals and
>>> -your feature should be compatible with Caja.
>>> + Apache Shindig Features
>>>
>>> -When committing a new feature, you should update the features.txt
>>> file by
>>> -running the following script in a unix-like environment:
>>> + What is it?
>>> + -----------
>>>
>>> -ls -R1a features/**/*.xml > features/features.txt
>>> + Shindig is a JavaScript container and implementations of the
>>> backend APIs
>>> + and proxy required for hosting OpenSocial applications.
>>>
>>> -TODO: Instructions for regenerating features.txt for other
>>> operating system
>>> -environments.
>>> + This is the features component of Shindig.
>>> +
>>> + Documentation
>>> + -------------
>>> +
>>> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
>>> +
>>> + Using features
>>> + --------------
>>> +
>>> + You can automatically include new features into your shindig
>>> server by adding
>>> + them to this directory. Features should exist in a self-
>>> contained directory
>>> + with the following structure:
>>> +
>>> + features
>>> + |_your-feature-name
>>> + |_feature.xml
>>> + |_code-to-run-inside-gadget.js
>>> + |_code-to-run-inside-container.js
>>> +
>>> + The structure of feature.xml is as follows:
>>> + TODO: link to xml schema for feature.xml
>>> +
>>> + <?xml version="1.0"?>
>>> + <feature>
>>> + <name>your-feature-name (required)</name>
>>> + <dependency>any dependency you have (optional, may have
>>> multiple)</dependency>
>>> + <gadget> (optional)
>>> + <script src="code-to-run-inside-gadget.js"/> (optional, may
>>> have multiple,
>>> + may use web resources as well but we strongly encourage
>>> bundling your
>>> + javascript with the xml)
>>> + </gadget>
>>> + <container> (optional)
>>> + <script src="code-to-run-inside-container.js"> (same as for
>>> <gadget>)
>>> + </container>
>>> + </feature>
>>> +
>>> + Please always make sure that all files you provide are encoded
>>> as utf8.
>>> +
>>> + When adding new features, your javascript should conform to
>>> shindig javascript
>>> + coding conventions. This means that you should not be producing
>>> new globals and
>>> + your feature should be compatible with Caja.
>>> +
>>> + When committing a new feature, you should update the
>>> features.txt file by
>>> + running the following script in a unix-like environment:
>>> +
>>> + ls -R1a features/**/*.xml > features/features.txt
>>> +
>>> + TODO: Instructions for regenerating features.txt for other
>>> operating system
>>> + environments.
>>> +
>>> + Shindig URLS
>>> + ------------
>>> +
>>> + Home Page: http://incubator.apache.org/shindig/
>>> + Downloads: http://incubator.apache.org/shindig/download/index.html
>>> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
>>> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
>>> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
>>> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>>>
>>> Added: incubator/shindig/branches/1.0.x-incubating/java/LICENSE
>>> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/LICENSE?rev=770209&view=auto
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> --- incubator/shindig/branches/1.0.x-incubating/java/LICENSE (added)
>>> +++ incubator/shindig/branches/1.0.x-incubating/java/LICENSE Thu
>>> Apr 30 12:51:23 2009
>>> @@ -0,0 +1,212 @@
>>> +
>>> + Apache License
>>> + Version 2.0, January 2004
>>> + http://www.apache.org/licenses/
>>> +
>>> + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
>>> +
>>> + 1. Definitions.
>>> +
>>> + "License" shall mean the terms and conditions for use,
>>> reproduction,
>>> + and distribution as defined by Sections 1 through 9 of this
>>> document.
>>> +
>>> + "Licensor" shall mean the copyright owner or entity
>>> authorized by
>>> + the copyright owner that is granting the License.
>>> +
>>> + "Legal Entity" shall mean the union of the acting entity
>>> and all
>>> + other entities that control, are controlled by, or are
>>> under common
>>> + control with that entity. For the purposes of this
>>> definition,
>>> + "control" means (i) the power, direct or indirect, to cause
>>> the
>>> + direction or management of such entity, whether by contract
>>> or
>>> + otherwise, or (ii) ownership of fifty percent (50%) or more
>>> of the
>>> + outstanding shares, or (iii) beneficial ownership of such
>>> entity.
>>> +
>>> + "You" (or "Your") shall mean an individual or Legal Entity
>>> + exercising permissions granted by this License.
>>> +
>>> + "Source" form shall mean the preferred form for making
>>> modifications,
>>> + including but not limited to software source code,
>>> documentation
>>> + source, and configuration files.
>>> +
>>> + "Object" form shall mean any form resulting from mechanical
>>> + transformation or translation of a Source form, including but
>>> + not limited to compiled object code, generated documentation,
>>> + and conversions to other media types.
>>> +
>>> + "Work" shall mean the work of authorship, whether in Source
>>> or
>>> + Object form, made available under the License, as indicated
>>> by a
>>> + copyright notice that is included in or attached to the work
>>> + (an example is provided in the Appendix below).
>>> +
>>> + "Derivative Works" shall mean any work, whether in Source
>>> or Object
>>> + form, that is based on (or derived from) the Work and for
>>> which the
>>> + editorial revisions, annotations, elaborations, or other
>>> modifications
>>> + represent, as a whole, an original work of authorship. For
>>> the purposes
>>> + of this License, Derivative Works shall not include works
>>> that remain
>>> + separable from, or merely link (or bind by name) to the
>>> interfaces of,
>>> + the Work and Derivative Works thereof.
>>> +
>>> + "Contribution" shall mean any work of authorship, including
>>> + the original version of the Work and any modifications or
>>> additions
>>> + to that Work or Derivative Works thereof, that is
>>> intentionally
>>> + submitted to Licensor for inclusion in the Work by the
>>> copyright owner
>>> + or by an individual or Legal Entity authorized to submit on
>>> behalf of
>>> + the copyright owner. For the purposes of this definition,
>>> "submitted"
>>> + means any form of electronic, verbal, or written
>>> communication sent
>>> + to the Licensor or its representatives, including but not
>>> limited to
>>> + communication on electronic mailing lists, source code
>>> control systems,
>>> + and issue tracking systems that are managed by, or on
>>> behalf of, the
>>> + Licensor for the purpose of discussing and improving the
>>> Work, but
>>> + excluding communication that is conspicuously marked or
>>> otherwise
>>> + designated in writing by the copyright owner as "Not a
>>> Contribution."
>>> +
>>> + "Contributor" shall mean Licensor and any individual or
>>> Legal Entity
>>> + on behalf of whom a Contribution has been received by
>>> Licensor and
>>> + subsequently incorporated within the Work.
>>> +
>>> + 2. Grant of Copyright License. Subject to the terms and
>>> conditions of
>>> + this License, each Contributor hereby grants to You a
>>> perpetual,
>>> + worldwide, non-exclusive, no-charge, royalty-free,
>>> irrevocable
>>> + copyright license to reproduce, prepare Derivative Works of,
>>> + publicly display, publicly perform, sublicense, and
>>> distribute the
>>> + Work and such Derivative Works in Source or Object form.
>>> +
>>> + 3. Grant of Patent License. Subject to the terms and
>>> conditions of
>>> + this License, each Contributor hereby grants to You a
>>> perpetual,
>>> + worldwide, non-exclusive, no-charge, royalty-free,
>>> irrevocable
>>> + (except as stated in this section) patent license to make,
>>> have made,
>>> + use, offer to sell, sell, import, and otherwise transfer
>>> the Work,
>>> + where such license applies only to those patent claims
>>> licensable
>>> + by such Contributor that are necessarily infringed by their
>>> + Contribution(s) alone or by combination of their
>>> Contribution(s)
>>> + with the Work to which such Contribution(s) was submitted.
>>> If You
>>> + institute patent litigation against any entity (including a
>>> + cross-claim or counterclaim in a lawsuit) alleging that the
>>> Work
>>> + or a Contribution incorporated within the Work constitutes
>>> direct
>>> + or contributory patent infringement, then any patent licenses
>>> + granted to You under this License for that Work shall
>>> terminate
>>> + as of the date such litigation is filed.
>>> +
>>> + 4. Redistribution. You may reproduce and distribute copies of
>>> the
>>> + Work or Derivative Works thereof in any medium, with or
>>> without
>>> + modifications, and in Source or Object form, provided that
>>> You
>>> + meet the following conditions:
>>> +
>>> + (a) You must give any other recipients of the Work or
>>> + Derivative Works a copy of this License; and
>>> +
>>> + (b) You must cause any modified files to carry prominent
>>> notices
>>> + stating that You changed the files; and
>>> +
>>> + (c) You must retain, in the Source form of any Derivative
>>> Works
>>> + that You distribute, all copyright, patent, trademark,
>>> and
>>> + attribution notices from the Source form of the Work,
>>> + excluding those notices that do not pertain to any part
>>> of
>>> + the Derivative Works; and
>>> +
>>> + (d) If the Work includes a "NOTICE" text file as part of its
>>> + distribution, then any Derivative Works that You
>>> distribute must
>>> + include a readable copy of the attribution notices
>>> contained
>>> + within such NOTICE file, excluding those notices that
>>> do not
>>> + pertain to any part of the Derivative Works, in at
>>> least one
>>> + of the following places: within a NOTICE text file
>>> distributed
>>> + as part of the Derivative Works; within the Source form
>>> or
>>> + documentation, if provided along with the Derivative
>>> Works; or,
>>> + within a display generated by the Derivative Works, if
>>> and
>>> + wherever such third-party notices normally appear. The
>>> contents
>>> + of the NOTICE file are for informational purposes only
>>> and
>>> + do not modify the License. You may add Your own
>>> attribution
>>> + notices within Derivative Works that You distribute,
>>> alongside
>>> + or as an addendum to the NOTICE text from the Work,
>>> provided
>>> + that such additional attribution notices cannot be
>>> construed
>>> + as modifying the License.
>>> +
>>> + You may add Your own copyright statement to Your
>>> modifications and
>>> + may provide additional or different license terms and
>>> conditions
>>> + for use, reproduction, or distribution of Your
>>> modifications, or
>>> + for any such Derivative Works as a whole, provided Your use,
>>> + reproduction, and distribution of the Work otherwise
>>> complies with
>>> + the conditions stated in this License.
>>> +
>>> + 5. Submission of Contributions. Unless You explicitly state
>>> otherwise,
>>> + any Contribution intentionally submitted for inclusion in
>>> the Work
>>> + by You to the Licensor shall be under the terms and
>>> conditions of
>>> + this License, without any additional terms or conditions.
>>> + Notwithstanding the above, nothing herein shall supersede
>>> or modify
>>> + the terms of any separate license agreement you may have
>>> executed
>>> + with Licensor regarding such Contributions.
>>> +
>>> + 6. Trademarks. This License does not grant permission to use
>>> the trade
>>> + names, trademarks, service marks, or product names of the
>>> Licensor,
>>> + except as required for reasonable and customary use in
>>> describing the
>>> + origin of the Work and reproducing the content of the
>>> NOTICE file.
>>> +
>>> + 7. Disclaimer of Warranty. Unless required by applicable law or
>>> + agreed to in writing, Licensor provides the Work (and each
>>> + Contributor provides its Contributions) on an "AS IS" BASIS,
>>> + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
>>> express or
>>> + implied, including, without limitation, any warranties or
>>> conditions
>>> + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
>>> + PARTICULAR PURPOSE. You are solely responsible for
>>> determining the
>>> + appropriateness of using or redistributing the Work and
>>> assume any
>>> + risks associated with Your exercise of permissions under
>>> this License.
>>> +
>>> + 8. Limitation of Liability. In no event and under no legal
>>> theory,
>>> + whether in tort (including negligence), contract, or
>>> otherwise,
>>> + unless required by applicable law (such as deliberate and
>>> grossly
>>> + negligent acts) or agreed to in writing, shall any
>>> Contributor be
>>> + liable to You for damages, including any direct, indirect,
>>> special,
>>> + incidental, or consequential damages of any character
>>> arising as a
>>> + result of this License or out of the use or inability to
>>> use the
>>> + Work (including but not limited to damages for loss of
>>> goodwill,
>>> + work stoppage, computer failure or malfunction, or any and
>>> all
>>> + other commercial damages or losses), even if such Contributor
>>> + has been advised of the possibility of such damages.
>>> +
>>> + 9. Accepting Warranty or Additional Liability. While
>>> redistributing
>>> + the Work or Derivative Works thereof, You may choose to
>>> offer,
>>> + and charge a fee for, acceptance of support, warranty,
>>> indemnity,
>>> + or other liability obligations and/or rights consistent
>>> with this
>>> + License. However, in accepting such obligations, You may
>>> act only
>>> + on Your own behalf and on Your sole responsibility, not on
>>> behalf
>>> + of any other Contributor, and only if You agree to indemnify,
>>> + defend, and hold each Contributor harmless for any liability
>>> + incurred by, or claims asserted against, such Contributor
>>> by reason
>>> + of your accepting any such warranty or additional liability.
>>> +
>>> + END OF TERMS AND CONDITIONS
>>> +
>>> + APPENDIX: How to apply the Apache License to your work.
>>> +
>>> + To apply the Apache License to your work, attach the
>>> following
>>> + boilerplate notice, with the fields enclosed by brackets "[]"
>>> + replaced with your own identifying information. (Don't
>>> include
>>> + the brackets!) The text should be enclosed in the
>>> appropriate
>>> + comment syntax for the file format. We also recommend that a
>>> + file or class name and description of purpose be included
>>> on the
>>> + same "printed page" as the copyright notice for easier
>>> + identification within third-party archives.
>>> +
>>> + Copyright [yyyy] [name of copyright owner]
>>> +
>>> + Licensed 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.
>>> +
>>> +
>>> +
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> +
>>> +The Apache Shindig distribution includes a number of subcomponents
>>> +with separate copyright notices and license terms. Your use of the
>>> +code for the these subcomponents is subject to the terms and
>>> +conditions of the following licenses.
>>> +
>>> +
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>>
>>> Copied: incubator/shindig/branches/1.0.x-incubating/java/NOTICE
>>> (from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE)
>>> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/NOTICE?p2=incubator/shindig/branches/1.0.x-incubating/java/NOTICE&p1=incubator/shindig/branches/1.0.x-incubating/NOTICE&r1=770145&r2=770209&rev=770209&view=diff
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> --- incubator/shindig/branches/1.0.x-incubating/NOTICE (original)
>>> +++ incubator/shindig/branches/1.0.x-incubating/java/NOTICE Thu
>>> Apr 30 12:51:23 2009
>>> @@ -1,16 +1,15 @@
>>> -Apache Shindig
>>> -Copyright 2009 The Apache Software Foundation
>>> +
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> + == NOTICE file corresponding to the section 4 d
>>> of ==
>>> + == the Apache License, Version
>>> 2.0, ==
>>> + == in this case for the Apache Shindig
>>> distribution. ==
>>> +
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>>
>>> -This product includes software developed at
>>> -The Apache Software Foundation (http://www.apache.org/).
>>> -
>>> ------------------------------------------------------------
>>> This product includes software (Gadget Server, Gadget Container)
>>> originally developed by Google Inc. (http://code.google.com/) and
>>> licensed
>>> to the ASF as initial contribution for Shindig.
>>>
>>> -This product includes the jquery.js file,
>>> -Copyright (c) 2007 John Resig, http://jquery.com/
>>> +This product includes software developed at
>>> +The Apache Software Foundation (http://www.apache.org/).
>>>
>>> This distribution includes cryptographic software. The country in
>>> which you currently reside may have restrictions on the import,
>>> @@ -36,7 +35,3 @@
>>>
>>> Apache Shindig interfaces with the Java JCE APIs to provide
>>> encryption of messages using the AES standard.
>>> -
>>> - Apache Shindig PHP interfaces with the mcrypt API
>>> - <http://mcrypt.sourceforge.net/> to provide encryption
>>> - of messages using the AES standard.
>>>
>>> Modified: incubator/shindig/branches/1.0.x-incubating/java/README
>>> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/README?rev=770209&r1=770208&r2=770209&view=diff
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> --- incubator/shindig/branches/1.0.x-incubating/java/README
>>> (original)
>>> +++ incubator/shindig/branches/1.0.x-incubating/java/README Thu
>>> Apr 30 12:51:23 2009
>>> @@ -1,15 +1,68 @@
>>> -There are four parts to the java gadget servers:
>>> + Apache Shindig Java
>>>
>>> -* java/common The common java code that both the social data
>>> server and the
>>> - gadget rendering server rely on.
>>> + What is it?
>>> + -----------
>>>
>>> -* java/gadgets This server is used for rendering gadgets.
>>> + Shindig is a JavaScript container and implementations of the
>>> backend APIs
>>> + and proxy required for hosting OpenSocial applications.
>>>
>>> -* java/social-api This server is used to provide social data for
>>> gadgets. Long
>>> - term, it will implement the OpenSocial RESTful apis.
>>> + This is the Java implementation of Shindig. If you are looking
>>> to the PHP
>>> + implementation, please visit our website.
>>>
>>> -* java/server This directory only contains a pom and a web.xml
>>> file. It is used
>>> - to run both the gadget rendering code and the social data code
>>> at once. In
>>> - order to use the samplecontainer you must run this server.
>>> + Documentation
>>> + -------------
>>>
>>> -For more information, see http://incubator.apache.org/projects/shindig.html
>>> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
>>> + and at http://incubator.apache.org/shindig/developers/java/index.html
>>> for specific
>>> + Java documentation.
>>> +
>>> + Release Notes
>>> + -------------
>>> +
>>> + The full list of changes can be found at https://issues.apache.org/jira/browse/SHINDIG
>>> .
>>> +
>>> + System Requirements
>>> + -------------------
>>> +
>>> + Java:
>>> + 1.5 or above.
>>> + Servlet container:
>>> + Apache Tomcat or other compatible Java Servlet containers.
>>> + Memory:
>>> + No minimum requirement.
>>> + Disk:
>>> + No minimum requirement.
>>> + Operating System:
>>> + No minimum requirement. On Windows, Windows NT and above or
>>> Cygwin is
>>> + required for the startup scripts. Tested on Windows XP,
>>> Fedora Core
>>> + and Mac OS X.
>>> +
>>> + Installing Shindig Java
>>> + -----------------------
>>> +
>>> + Unzip the distribution archive, i.e. shindig-1.0-incubating-
>>> java.zip to
>>> + the directory you wish to install Shindig.
>>> +
>>> + The following explains how to deploy the Shindig war file to
>>> Apache
>>> + Tomcat. If you are using an other container, please read its
>>> documentation
>>> + on how to proceed.
>>> +
>>> + The easiest way to deploy Shindig on Apache Tomcat is to rename
>>> the
>>> + shindig-server-1.0-incubating.war file to ROOT.war and drop it
>>> in the
>>> + Tomcat webapps.
>>> + Be sure to delete $TOMCAT_HOME/webapps/ROOT dir before starting
>>> Tomcat.
>>> +
>>> + Licensing
>>> + ---------
>>> +
>>> + Please see the file called LICENSE.
>>> +
>>> + Shindig URLS
>>> + ------------
>>> +
>>> + Home Page: http://incubator.apache.org/shindig/
>>> + Downloads: http://incubator.apache.org/shindig/download/index.html
>>> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
>>> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
>>> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
>>> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>>>
>>> Modified: incubator/shindig/branches/1.0.x-incubating/javascript/
>>> README
>>> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/javascript/README?rev=770209&r1=770208&r2=770209&view=diff
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> --- incubator/shindig/branches/1.0.x-incubating/javascript/README
>>> (original)
>>> +++ incubator/shindig/branches/1.0.x-incubating/javascript/README
>>> Thu Apr 30 12:51:23 2009
>>> @@ -1,87 +1,109 @@
>>> -Using Shindig Gadget Container JavaScript
>>> -=========================================
>>> + Apache Shindig Javascript
>>>
>>> -1) Try out the samples.
>>> - A) Set up your own Shindig Gadget Server. See java/README for
>>> details.
>>> + What is it?
>>> + -----------
>>>
>>> - B) Assuming your server is running on http://
>>> yourserver:yourport/gadgets/...
>>> - you can hit these html files in your favorite browser to
>>> see your local
>>> - Shindig in action:
>>> + Shindig is a JavaScript container and implementations of the
>>> backend APIs
>>> + and proxy required for hosting OpenSocial applications.
>>>
>>> - (Note: yourserver:yourport defaults to localhost:8080 for
>>> the java server,
>>> - and just localhost for the php server)
>>> + This is the Javascript component of Shindig.
>>>
>>> - * http://yourserver:yourport/gadgets/files/container/
>>> sample1.html - basic container
>>> - * http://yourserver:yourport/gadgets/files/container/
>>> sample2.html - custom rendering
>>> - * http://yourserver:yourport/gadgets/files/container/
>>> sample3.html - custom layouts
>>> - * http://yourserver:yourport/gadgets/files/container/
>>> sample4.html - set pref
>>> - * http://yourserver:yourport/gadgets/files/container/
>>> sample5.html - set pref
>>> - * http://yourserver:yourport/gadgets/files/container/
>>> sample6.html - dynamic height
>>> - * http://yourserver:yourport/gadgets/files/container/
>>> sample7.html - set title
>>> + Documentation
>>> + -------------
>>>
>>> - These samples are very basic and aren't production-ready.
>>> Shindig will
>>> - include a more advanced container at a later date but it
>>> hasn't been
>>> - completed yet.
>>> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
>>> +
>>> + Using Shindig Gadget Container JavaScript
>>> + -----------------------------------------
>>>
>>> -2) Play around with the code.
>>> + 1) Try out the samples.
>>> + A) Set up your own Shindig Gadget Server. See java/README
>>> for details.
>>>
>>> - A) Create an HTML file including the following <head>
>>> boilerplate:
>>> - <script type="text/javascript" src="../../js/rpc.js?c=1"></
>>> script>
>>> - <script type="text/javascript" src="cookies.js"></script>
>>> - <script type="text/javascript" src="util.js"></script>
>>> - <script type="text/javascript" src="gadgets.js"></script>
>>> - <script type="text/javascript"
>>> src="cookiebaseduserprefstore.js"></script>
>>> + B) Assuming your server is running on http://
>>> yourserver:yourport/gadgets/...
>>> + you can hit these html files in your favorite browser to
>>> see your local
>>> + Shindig in action:
>>>
>>> - B) For each Gadget you wish to add to the page:
>>> - i) Create it. Example, for Gadget whose spec is at http://foo.com/spec.xml
>>> + (Note: yourserver:yourport defaults to localhost:8080 for
>>> the java server,
>>> + and just localhost for the php server)
>>>
>>> - var gadget = gadgets.container.createGadget(
>>> - {specUrl: "http://foo.com/spec.xml"});
>>> + * http://yourserver:yourport/gadgets/files/container/
>>> sample1.html - basic container
>>> + * http://yourserver:yourport/gadgets/files/container/
>>> sample2.html - custom rendering
>>> + * http://yourserver:yourport/gadgets/files/container/
>>> sample3.html - custom layouts
>>> + * http://yourserver:yourport/gadgets/files/container/
>>> sample4.html - set pref
>>> + * http://yourserver:yourport/gadgets/files/container/
>>> sample5.html - set pref
>>> + * http://yourserver:yourport/gadgets/files/container/
>>> sample6.html - dynamic height
>>> + * http://yourserver:yourport/gadgets/files/container/
>>> sample7.html - set title
>>>
>>> - Check "gadgets.js" for other options to be set in createGadget.
>>> If you are
>>> - debugging your own gadgets you can consider to use specVersion
>>> to get a more
>>> - optimal use of the cache. Alternatively,
>>> gadgets.container.setNoCache(1)
>>> + These samples are very basic and aren't production-ready.
>>> Shindig will
>>> + include a more advanced container at a later date but it
>>> hasn't been
>>> + completed yet.
>>>
>>> - ii) Add it to the container. Example:
>>> + 2) Play around with the code.
>>>
>>> - gadgets.container.addGadget(gadget);
>>> + A) Create an HTML file including the following <head>
>>> boilerplate:
>>> + <script type="text/javascript" src="../../js/rpc.js?
>>> c=1"></script>
>>> + <script type="text/javascript" src="cookies.js"></script>
>>> + <script type="text/javascript" src="util.js"></script>
>>> + <script type="text/javascript" src="gadgets.js"></script>
>>> + <script type="text/javascript"
>>> src="cookiebaseduserprefstore.js"></script>
>>>
>>> - If your setup is too complicated, you can need to tell each
>>> Gadget
>>> - where its server is. Example
>>> + B) For each Gadget you wish to add to the page:
>>> + i) Create it. Example, for Gadget whose spec is at http://foo.com/spec.xml
>>> +
>>> + var gadget = gadgets.container.createGadget(
>>> + {specUrl: "http://foo.com/spec.xml"});
>>> +
>>> + Check "gadgets.js" for other options to be set in
>>> createGadget. If you are
>>> + debugging your own gadgets you can consider to use
>>> specVersion to get a more
>>> + optimal use of the cache. Alternatively,
>>> gadgets.container.setNoCache(1)
>>> +
>>> + ii) Add it to the container. Example:
>>>
>>> - gadget.setServerBase("http://yourserver:yourport/gadgets/");
>>> + gadgets.container.addGadget(gadget);
>>> +
>>> + If your setup is too complicated, you can need to tell each
>>> Gadget
>>> + where its server is. Example
>>> +
>>> + gadget.setServerBase("http://yourserver:yourport/gadgets/");
>>>
>>> - iii) Ensure the Gadget's chrome ID is defined. This is the
>>> ID of the
>>> - elements in which the Gadget is rendered. The way these
>>> are specified
>>> - differs depending on the LayoutManager being used.
>>> Example with default
>>> - LayoutManager:
>>> + iii) Ensure the Gadget's chrome ID is defined. This is
>>> the ID of the
>>> + elements in which the Gadget is rendered. The way these
>>> are specified
>>> + differs depending on the LayoutManager being used.
>>> Example with default
>>> + LayoutManager:
>>>
>>> -
>>> gadgets.container.layoutManager.setGadgetChromeIds([ 'gadget-
>>> id-1' ]);
>>> +
>>> gadgets.container.layoutManager.setGadgetChromeIds([ 'gadget-
>>> id-1' ]);
>>>
>>> - iv) Render it. The chrome element must exist when this call
>>> is performed
>>> - (ie. this must occur onLoad of the document.body or in
>>> inline script).
>>> + iv) Render it. The chrome element must exist when this
>>> call is performed
>>> + (ie. this must occur onLoad of the document.body or in
>>> inline script).
>>>
>>> - gadgets.container.renderGadget(gadget);
>>> + gadgets.container.renderGadget(gadget);
>>>
>>> - You may also render several added Gadgets at once:
>>> + You may also render several added Gadgets at once:
>>>
>>> - gadgets.container.renderGadgets();
>>> + gadgets.container.renderGadgets();
>>>
>>> - C) Explore samples 2, 3, and 4 for examples using different
>>> LayoutManagers
>>> - and supporting UserPrefs storage.
>>> + C) Explore samples 2, 3, and 4 for examples using different
>>> LayoutManagers
>>> + and supporting UserPrefs storage.
>>>
>>> -4) Run the opensocial sample container
>>> - A) Set up your own Shindig Gadget Server. See java/README for
>>> details. (If you
>>> - are using the java based server make sure you run with mvn
>>> jetty:run-war)
>>> + 4) Run the opensocial sample container
>>> + A) Set up your own Shindig Gadget Server. See java/README
>>> for details. (If you
>>> + are using the java based server make sure you run with mvn
>>> jetty:run-war)
>>>
>>> - B) Hit the sample container at
>>> - http://yourserver:yourport/gadgets/files/samplecontainer/
>>> samplecontainer.html
>>> + B) Hit the sample container at
>>> + http://yourserver:yourport/gadgets/files/samplecontainer/
>>> samplecontainer.html
>>>
>>> - C) See the sample container help document for more details on
>>> how it works:
>>> - http://yourserver:yourport/gadgets/files/samplecontainer/
>>> getting-started.html
>>> + C) See the sample container help document for more details
>>> on how it works:
>>> + http://yourserver:yourport/gadgets/files/samplecontainer/
>>> getting-started.html
>>>
>>> - D) Get, and try to run, coderunner.xml and compliancetests.xml
>>> from the project
>>> - http://opensocial-resources.googlecode.com/
>>> + D) Get, and try to run, coderunner.xml and
>>> compliancetests.xml from the project
>>> + http://opensocial-resources.googlecode.com/
>>>
>>> + Shindig URLS
>>> + ------------
>>>
>>> -For more information, see http://incubator.apache.org/projects/shindig.html
>>> + Home Page: http://incubator.apache.org/shindig/
>>> + Downloads: http://incubator.apache.org/shindig/download/index.html
>>> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
>>> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
>>> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
>>> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>>>
>>> Copied: incubator/shindig/branches/1.0.x-incubating/php/NOTICE
>>> (from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE)
>>> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/php/NOTICE?p2=incubator/shindig/branches/1.0.x-incubating/php/NOTICE&p1=incubator/shindig/branches/1.0.x-incubating/NOTICE&r1=770145&r2=770209&rev=770209&view=diff
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> --- incubator/shindig/branches/1.0.x-incubating/NOTICE (original)
>>> +++ incubator/shindig/branches/1.0.x-incubating/php/NOTICE Thu Apr
>>> 30 12:51:23 2009
>>> @@ -1,16 +1,21 @@
>>> -Apache Shindig
>>> -Copyright 2009 The Apache Software Foundation
>>> +
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> + == NOTICE file corresponding to the section 4 d
>>> of ==
>>> + == the Apache License, Version
>>> 2.0, ==
>>> + == in this case for the Apache Shindig
>>> distribution. ==
>>> +
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>>
>>> -This product includes software developed at
>>> -The Apache Software Foundation (http://www.apache.org/).
>>> -
>>> ------------------------------------------------------------
>>> This product includes software (Gadget Server, Gadget Container)
>>> originally developed by Google Inc. (http://code.google.com/) and
>>> licensed
>>> to the ASF as initial contribution for Shindig.
>>>
>>> -This product includes the jquery.js file,
>>> -Copyright (c) 2007 John Resig, http://jquery.com/
>>> +This product includes software developed at
>>> +The Apache Software Foundation (http://www.apache.org/).
>>> +
>>> +This product includes software (Zend) developed by
>>> +Zend Technologies Ltd (http://framework.zend.com/).
>>> +
>>> +This product includes software (PHPUnit) developed by
>>> +Sebastian Bergmann (http://www.phpunit.de/).
>>>
>>> This distribution includes cryptographic software. The country in
>>> which you currently reside may have restrictions on the import,
>>> @@ -34,9 +39,6 @@
>>> The following provides more details on the included cryptographic
>>> software:
>>>
>>> - Apache Shindig interfaces with the Java JCE APIs to provide
>>> - encryption of messages using the AES standard.
>>> -
>>> Apache Shindig PHP interfaces with the mcrypt API
>>> <http://mcrypt.sourceforge.net/> to provide encryption
>>> of messages using the AES standard.
>>>
>>> Modified: incubator/shindig/branches/1.0.x-incubating/php/README
>>> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/php/README?rev=770209&r1=770208&r2=770209&view=diff
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> =
>>> ====================================================================
>>> --- incubator/shindig/branches/1.0.x-incubating/php/README
>>> (original)
>>> +++ incubator/shindig/branches/1.0.x-incubating/php/README Thu Apr
>>> 30 12:51:23 2009
>>> @@ -1,109 +1,120 @@
>>> -Welcome to Apache Shindig!
>>> + Apache Shindig PHP
>>>
>>> -* Read javascript/README for instructions for using the Shindig
>>> Gadget
>>> + What is it?
>>> + -----------
>>> +
>>> + Shindig is a JavaScript container and implementations of the
>>> backend APIs
>>> + and proxy required for hosting OpenSocial applications.
>>> +
>>> + This is the PHP implementation of Shindig. If you are looking
>>> to the Java
>>> + implementation, please visit our website.
>>> +
>>> + Documentation
>>> + -------------
>>> +
>>> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
>>> + and at http://incubator.apache.org/shindig/developers/php/index.html
>>> + for specific PHP documentation.
>>> +
>>> + Read javascript/README for instructions for using the Shindig
>>> Gadget
>>> Container JavaScript to enable your page to render Gadgets.
>>> -* Read the instructions below for how to use PHP Shindig
>>> -* For more information, see http://incubator.apache.org/shindig/
>>>
>>> + Release Notes
>>> + -------------
>>>
>>> -Installing and Running The PHP Shindig Gadget Server
>>> -============================================
>>> + The full list of changes can be found at https://issues.apache.org/jira/browse/SHINDIG
>>> .
>>>
>>> -Prequisites before building Shindig for PHP
>>> -============================================
>>> -In order to build and run Shindig for PHP, you must have the
>>> following:
>>> -
>>> -- A Subversion client installed in order to checkout the code.
>>> - Instructions for downloading and installing Subversion can be
>>> found here:
>>> - http://subversion.tigris.org/
>>> -- Apache with mod_rewrite enabled.
>>> -- PHP 5.2.x with the json, simplexml, mcrypt and curl extentions
>>> enabled.
>>> -
>>> -
>>> -Getting the code (if you're running from svn and not a release
>>> tarball)
>>> -============================================
>>> -Create a subdirectory in your web document root, e.g. /var/www/
>>> html and
>>> -checkout the Shindig code from its Subversion repository
>>> -
>>> -mkdir /var/www/html/shindig
>>> -cd /var/www/html/shindig
>>> -svn co http://svn.apache.org/repos/asf/incubator/shindig/trunk/ .
>>> -
>>> -
>>> -Running Shindig from a release download
>>> -============================================
>>> -
>>> -The instructions are identical as when running from an svn
>>> checkout, except
>>> -that the /shindig/php directory in the virtual host becomes just /
>>> shindig, ie:
>>> -
>>> - <VirtualHost your_ip:your_port>
>>> - ServerName your.host
>>> - DocumentRoot /var/www/html/shindig
>>> - ... other normal settings in vhosts...
>>> - <Directory />
>>> - AllowOverride All
>>> - </Directory>
>>> - </VirtualHost>
>>> -
>>> -Running Shindig from an svn checkout
>>> -============================================
>>> -With PHP There is no need to build anything - the source code
>>> -is already built.
>>> -
>>> -To run the code, you have several options:
>>> -
>>> -a. Create a new virtual host
>>> -
>>> -Point your apache to the php dir with a virtual host like:
>>> -
>>> - <VirtualHost your_ip:your_port>
>>> - ServerName your.host
>>> - DocumentRoot /var/www/html/shindig/php
>>> - ... other normal settings in vhosts...
>>> - <Directory />
>>> - AllowOverride All
>>> - </Directory>
>>> - </VirtualHost>
>>> -
>>> -
>>> -Restart apache, and point your browser to:
>>> -
>>> -http://<your.host>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
>>> -
>>> -you should see something like this:
>>> -http://shindig.chabotc.com/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
>>> -
>>> -b. Run with an existing host
>>> -
>>> -If you cannot/don't want to create a virtual host, you can edit
>>> the file php/config/container.php
>>> -or php/config/local.php (see the comments php/config/
>>> container.php for documentation of the
>>> -configuration system) and change the web_prefix setting to '/
>>> shindig/php'.
>>> -
>>> -In this case, you should also change all paths in shindig/config/
>>> container.js
>>> -(see the comments there for documentation of the JSON
>>> configuration system).
>>> -
>>> -Then you can run the gadget by pointing your browser to:
>>> -
>>> -http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
>>> -
>>> -Going forward
>>> -============================================
>>> -Check out the php/config/container.php file, in local.php you
>>> only have to specificy the
>>> -fields you want to overwrite with other values, for example on a
>>> production system you
>>> -would probably want to have something like:
>>> - $shindigConfig = array(
>>> - 'debug' => false,
>>> - 'allow_plaintext_token' => false,
>>> - 'token_cipher_key' => 'MySecretKey',
>>> - 'token_hmac_key' => 'MyOtherSecret',
>>> - 'private_key_phrase' => 'MyCertificatePassword',
>>> - 'person_service' => 'MyPeopleService',
>>> - 'activity_service' => 'MyActivitiesService',
>>> - 'app_data_service' => 'MyAppDataService',
>>> - 'messages_service' => 'MyMessagesService',
>>> - 'oauth_lookup_service' => 'MyOAuthLookupService'
>>> - 'xrds_location' => 'http://www.mycontainer.com/xrds',
>>> - 'check_file_exists' => false
>>> - );
>>> + System Requirements
>>> + -------------------
>>> +
>>> + PHP:
>>> + 5.2.x or above with the json, simplexml, mcrypt and curl
>>> extentions
>>> + enabled.
>>> + Web server:
>>> + Apache with mod_rewrite enabled.
>>> + Memory:
>>> + No minimum requirement.
>>> + Disk:
>>> + No minimum requirement.
>>> + Operating System:
>>> + No minimum requirement. On Windows, Windows NT and above or
>>> Cygwin is
>>> + required for the startup scripts. Tested on Windows XP,
>>> Fedora Core
>>> + and Mac OS X.
>>> +
>>> + Installing Shindig
>>> + ------------------
>>> +
>>> + Unzip the distribution archive, i.e. shindig-1.0-incubating-
>>> php.zip to
>>> + the web document root, e.g. /var/www/html.
>>> +
>>> + Rename the created shindig-1.0-incubating-php dir to shindig.
>>> +
>>> + a. Create a new virtual host
>>> +
>>> + Point your Apache to the shindig dir with a virtual host like:
>>> +
>>> + <VirtualHost your_ip:your_port>
>>> + ServerName your.host
>>> + DocumentRoot /var/www/html/shindig
>>> + ... other normal settings in vhosts...
>>> + <Directory>
>>> + AllowOverride All
>>> + </Directory>
>>> + </VirtualHost>
>>> +
>>> + Restart apache, and point your browser to:
>>> +
>>> + http://<your.host>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
>>> +
>>> + b. Run with an existing host
>>> +
>>> + If you cannot/don't want to create a virtual host, you can edit
>>> the file
>>> + php/config/container.php or php/config/local.php (see the
>>> comments
>>> + php/config/container.php for documentation of the configuration
>>> system)
>>> + and change the web_prefix setting to '/shindig/php'.
>>> +
>>> + In this case, you should also change all paths in shindig/
>>> config/container.js
>>> + (see the comments there for documentation of the JSON
>>> configuration system).
>>> +
>>> + Then you can run the gadget by pointing your browser to:
>>> +
>>> + http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
>>> +
>>> + Going forward
>>> + -------------
>>> +
>>> + Check out the php/config/container.php file, in local.php you
>>> only have
>>> + to specificy the fields you want to overwrite with other
>>> values, for
>>> + example on a production system you would probably want to have
>>> something
>>> + like:
>>> + $shindigConfig = array(
>>> + 'debug' => false,
>>> + 'allow_plaintext_token' => false,
>>> + 'token_cipher_key' => 'MySecretKey',
>>> + 'token_hmac_key' => 'MyOtherSecret',
>>> + 'private_key_phrase' => 'MyCertificatePassword',
>>> + 'person_service' => 'MyPeopleService',
>>> + 'activity_service' => 'MyActivitiesService',
>>> + 'app_data_service' => 'MyAppDataService',
>>> + 'messages_service' => 'MyMessagesService',
>>> + 'oauth_lookup_service' => 'MyOAuthLookupService'
>>> + 'xrds_location' => 'http://www.mycontainer.com/xrds',
>>> + 'check_file_exists' => false
>>> + );
>>>
>>> -And then implement your own service and oauth lookup classes.
>>> + And then implement your own service and oauth lookup classes.
>>> +
>>> + Licensing
>>> + ---------
>>> +
>>> + Please see the file called LICENSE.
>>> +
>>> + Shindig URLS
>>> + ------------
>>> +
>>> + Home Page: http://incubator.apache.org/shindig/
>>> + Downloads: http://incubator.apache.org/shindig/download/index.html
>>> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
>>> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
>>> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
>>> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>>>
>>>
>>>
>>
Re: svn commit: r770209 - in /incubator/shindig/branches/1.0.x-incubating:
./ assembly/src/main/assembly/ assembly/src/main/assembly/binary-src/
features/ java/ javascript/ php/
Posted by Vincent Siveton <vi...@gmail.com>.
Hi,
Could you review this commit please?
If we are all agree, I could retry to do the 1.0.x release this week...
For lazy people, you could find the generated assemblies from Hudson:
http://incubator.apache.org/shindig/download/index.html
Cheers,
Vincent
2009/4/30, Vincent Siveton <vi...@gmail.com>:
> I just updated the legal files and the README.
>
> Please review this commit.
>
> Vincent
>
> 2009/4/30 <vs...@apache.org>:
>
> > Author: vsiveton
> > Date: Thu Apr 30 12:51:23 2009
> > New Revision: 770209
> >
> > URL: http://svn.apache.org/viewvc?rev=770209&view=rev
> > Log:
> > o improved README, NOTICE and LICENSE
> >
> > Added:
> > incubator/shindig/branches/1.0.x-incubating/java/LICENSE
> > incubator/shindig/branches/1.0.x-incubating/java/NOTICE
> > - copied, changed from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE
> > incubator/shindig/branches/1.0.x-incubating/php/LICENSE
> > - copied unchanged from r770160, incubator/shindig/branches/1.0.x-incubating/LICENSE
> > incubator/shindig/branches/1.0.x-incubating/php/NOTICE
> > - copied, changed from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE
> > Removed:
> > incubator/shindig/branches/1.0.x-incubating/LICENSE
> > incubator/shindig/branches/1.0.x-incubating/NOTICE
> > incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/binary-src/
> > Modified:
> > incubator/shindig/branches/1.0.x-incubating/README
> > incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml
> > incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml
> > incubator/shindig/branches/1.0.x-incubating/features/README
> > incubator/shindig/branches/1.0.x-incubating/java/README
> > incubator/shindig/branches/1.0.x-incubating/javascript/README
> > incubator/shindig/branches/1.0.x-incubating/php/README
> >
> > Modified: incubator/shindig/branches/1.0.x-incubating/README
> > URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/README?rev=770209&r1=770208&r2=770209&view=diff
> > ==============================================================================
> > --- incubator/shindig/branches/1.0.x-incubating/README (original)
> > +++ incubator/shindig/branches/1.0.x-incubating/README Thu Apr 30 12:51:23 2009
> > @@ -1,14 +1,38 @@
> > -Welcome to Apache Shindig!
> > + Apache Shindig
> >
> > -* Read java/README for instructions on using the java gadget servers.
> > + What is it?
> > + -----------
> >
> > -* To build and run the Java server see BUILD-JAVA
> > + Shindig is a JavaScript container and implementations of the backend APIs
> > + and proxy required for hosting OpenSocial applications.
> >
> > -* Read php/README for instructions on how to run a php gadget server
> > - instead of a java gadget server.
> > + Documentation
> > + -------------
> >
> > -* Read javascript/README 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.
> > + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/.
> >
> > -For more information, see http://incubator.apache.org/shindig/
> > + Read BUILD-JAVA for instructions on how to build and run the Java server.
> > +
> > + Read java/README for instructions on how to run a Java gadget server.
> > +
> > + Read php/README for instructions on how to run a php gadget server.
> > +
> > + Read javascript/README for instructions for using the Shindig Gadget Container
> > + JavaScript to enable your page to render Gadgets.
> > +
> > + Read features/README for instructions on how to use features.
> > +
> > + Licensing
> > + ---------
> > +
> > + Please see the file called LICENSE in the java and php directories.
> > +
> > + Shindig URLS
> > + ------------
> > +
> > + Home Page: http://incubator.apache.org/shindig/
> > + Downloads: http://incubator.apache.org/shindig/download/index.html
> > + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> > + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> > + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> > + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
> >
> > Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml
> > URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml?rev=770209&r1=770208&r2=770209&view=diff
> > ==============================================================================
> > --- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml (original)
> > +++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml Thu Apr 30 12:51:23 2009
> > @@ -43,18 +43,21 @@
> > <outputDirectory>shindig-${pom.version}-java</outputDirectory>
> > <directory>../</directory>
> > <includes>
> > - <include>COMMITTERS</include>
> > <include>DISCLAIMER</include>
> > - <include>LICENSE</include>
> > - <include>NOTICE</include>
> > </includes>
> > + <excludes>
> > + <exclude>LICENSE</exclude>
> > + <exclude>NOTICE</exclude>
> > + <exclude>README</exclude>
> > + </excludes>
> > </fileSet>
> > <fileSet>
> > <outputDirectory>shindig-${pom.version}-java</outputDirectory>
> > - <directory>src/main/assembly/binary-src/</directory>
> > - <filtered>true</filtered>
> > + <directory>../java</directory>
> > <includes>
> > - <include>**/*</include>
> > + <include>LICENSE</include>
> > + <include>NOTICE</include>
> > + <include>README</include>
> > </includes>
> > </fileSet>
> > </fileSets>
> >
> > Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml
> > URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml?rev=770209&r1=770208&r2=770209&view=diff
> > ==============================================================================
> > --- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml (original)
> > +++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml Thu Apr 30 12:51:23 2009
> > @@ -32,10 +32,7 @@
> > <include>features/**</include>
> > <include>javascript/**</include>
> > <include>config/**</include>
> > - <include>COMMITTERS</include>
> > <include>DISCLAIMER</include>
> > - <include>LICENSE</include>
> > - <include>NOTICE</include>
> > </includes>
> > <excludes>
> > <exclude>site/**</exclude>
> > @@ -63,6 +60,8 @@
> > <!-- misc -->
> > <exclude>*.patch</exclude>
> > <exclude>*.diff</exclude>
> > + <exclude>LICENSE</exclude>
> > + <exclude>NOTICE</exclude>
> > <exclude>README</exclude>
> > </excludes>
> > <lineEnding>unix</lineEnding>
> >
> > Modified: incubator/shindig/branches/1.0.x-incubating/features/README
> > URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/features/README?rev=770209&r1=770208&r2=770209&view=diff
> > ==============================================================================
> > --- incubator/shindig/branches/1.0.x-incubating/features/README (original)
> > +++ incubator/shindig/branches/1.0.x-incubating/features/README Thu Apr 30 12:51:23 2009
> > @@ -1,40 +1,68 @@
> > -You can automatically include new features into your shindig server by adding
> > -them to this directory. Features should exist in a self-contained directory
> > -with the following structure:
> > -
> > -features
> > - |_your-feature-name
> > - |_feature.xml
> > - |_code-to-run-inside-gadget.js
> > - |_code-to-run-inside-container.js
> > -
> > -The structure of feature.xml is as follows:
> > -TODO: link to xml schema for feature.xml
> > -
> > -<?xml version="1.0"?>
> > -<feature>
> > - <name>your-feature-name (required)</name>
> > - <dependency>any dependency you have (optional, may have multiple)</dependency>
> > - <gadget> (optional)
> > - <script src="code-to-run-inside-gadget.js"/> (optional, may have multiple,
> > - may use web resources as well but we strongly encourage bundling your
> > - javascript with the xml)
> > - </gadget>
> > - <container> (optional)
> > - <script src="code-to-run-inside-container.js"> (same as for <gadget>)
> > - </container>
> > -</feature>
> > -
> > -Please always make sure that all files you provide are encoded as utf8.
> > -
> > -When adding new features, your javascript should conform to shindig javascript
> > -coding conventions. This means that you should not be producing new globals and
> > -your feature should be compatible with Caja.
> > + Apache Shindig Features
> >
> > -When committing a new feature, you should update the features.txt file by
> > -running the following script in a unix-like environment:
> > + What is it?
> > + -----------
> >
> > -ls -R1a features/**/*.xml > features/features.txt
> > + Shindig is a JavaScript container and implementations of the backend APIs
> > + and proxy required for hosting OpenSocial applications.
> >
> > -TODO: Instructions for regenerating features.txt for other operating system
> > -environments.
> > + This is the features component of Shindig.
> > +
> > + Documentation
> > + -------------
> > +
> > + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
> > +
> > + Using features
> > + --------------
> > +
> > + You can automatically include new features into your shindig server by adding
> > + them to this directory. Features should exist in a self-contained directory
> > + with the following structure:
> > +
> > + features
> > + |_your-feature-name
> > + |_feature.xml
> > + |_code-to-run-inside-gadget.js
> > + |_code-to-run-inside-container.js
> > +
> > + The structure of feature.xml is as follows:
> > + TODO: link to xml schema for feature.xml
> > +
> > + <?xml version="1.0"?>
> > + <feature>
> > + <name>your-feature-name (required)</name>
> > + <dependency>any dependency you have (optional, may have multiple)</dependency>
> > + <gadget> (optional)
> > + <script src="code-to-run-inside-gadget.js"/> (optional, may have multiple,
> > + may use web resources as well but we strongly encourage bundling your
> > + javascript with the xml)
> > + </gadget>
> > + <container> (optional)
> > + <script src="code-to-run-inside-container.js"> (same as for <gadget>)
> > + </container>
> > + </feature>
> > +
> > + Please always make sure that all files you provide are encoded as utf8.
> > +
> > + When adding new features, your javascript should conform to shindig javascript
> > + coding conventions. This means that you should not be producing new globals and
> > + your feature should be compatible with Caja.
> > +
> > + When committing a new feature, you should update the features.txt file by
> > + running the following script in a unix-like environment:
> > +
> > + ls -R1a features/**/*.xml > features/features.txt
> > +
> > + TODO: Instructions for regenerating features.txt for other operating system
> > + environments.
> > +
> > + Shindig URLS
> > + ------------
> > +
> > + Home Page: http://incubator.apache.org/shindig/
> > + Downloads: http://incubator.apache.org/shindig/download/index.html
> > + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> > + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> > + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> > + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
> >
> > Added: incubator/shindig/branches/1.0.x-incubating/java/LICENSE
> > URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/LICENSE?rev=770209&view=auto
> > ==============================================================================
> > --- incubator/shindig/branches/1.0.x-incubating/java/LICENSE (added)
> > +++ incubator/shindig/branches/1.0.x-incubating/java/LICENSE Thu Apr 30 12:51:23 2009
> > @@ -0,0 +1,212 @@
> > +
> > + Apache License
> > + Version 2.0, January 2004
> > + http://www.apache.org/licenses/
> > +
> > + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
> > +
> > + 1. Definitions.
> > +
> > + "License" shall mean the terms and conditions for use, reproduction,
> > + and distribution as defined by Sections 1 through 9 of this document.
> > +
> > + "Licensor" shall mean the copyright owner or entity authorized by
> > + the copyright owner that is granting the License.
> > +
> > + "Legal Entity" shall mean the union of the acting entity and all
> > + other entities that control, are controlled by, or are under common
> > + control with that entity. For the purposes of this definition,
> > + "control" means (i) the power, direct or indirect, to cause the
> > + direction or management of such entity, whether by contract or
> > + otherwise, or (ii) ownership of fifty percent (50%) or more of the
> > + outstanding shares, or (iii) beneficial ownership of such entity.
> > +
> > + "You" (or "Your") shall mean an individual or Legal Entity
> > + exercising permissions granted by this License.
> > +
> > + "Source" form shall mean the preferred form for making modifications,
> > + including but not limited to software source code, documentation
> > + source, and configuration files.
> > +
> > + "Object" form shall mean any form resulting from mechanical
> > + transformation or translation of a Source form, including but
> > + not limited to compiled object code, generated documentation,
> > + and conversions to other media types.
> > +
> > + "Work" shall mean the work of authorship, whether in Source or
> > + Object form, made available under the License, as indicated by a
> > + copyright notice that is included in or attached to the work
> > + (an example is provided in the Appendix below).
> > +
> > + "Derivative Works" shall mean any work, whether in Source or Object
> > + form, that is based on (or derived from) the Work and for which the
> > + editorial revisions, annotations, elaborations, or other modifications
> > + represent, as a whole, an original work of authorship. For the purposes
> > + of this License, Derivative Works shall not include works that remain
> > + separable from, or merely link (or bind by name) to the interfaces of,
> > + the Work and Derivative Works thereof.
> > +
> > + "Contribution" shall mean any work of authorship, including
> > + the original version of the Work and any modifications or additions
> > + to that Work or Derivative Works thereof, that is intentionally
> > + submitted to Licensor for inclusion in the Work by the copyright owner
> > + or by an individual or Legal Entity authorized to submit on behalf of
> > + the copyright owner. For the purposes of this definition, "submitted"
> > + means any form of electronic, verbal, or written communication sent
> > + to the Licensor or its representatives, including but not limited to
> > + communication on electronic mailing lists, source code control systems,
> > + and issue tracking systems that are managed by, or on behalf of, the
> > + Licensor for the purpose of discussing and improving the Work, but
> > + excluding communication that is conspicuously marked or otherwise
> > + designated in writing by the copyright owner as "Not a Contribution."
> > +
> > + "Contributor" shall mean Licensor and any individual or Legal Entity
> > + on behalf of whom a Contribution has been received by Licensor and
> > + subsequently incorporated within the Work.
> > +
> > + 2. Grant of Copyright License. Subject to the terms and conditions of
> > + this License, each Contributor hereby grants to You a perpetual,
> > + worldwide, non-exclusive, no-charge, royalty-free, irrevocable
> > + copyright license to reproduce, prepare Derivative Works of,
> > + publicly display, publicly perform, sublicense, and distribute the
> > + Work and such Derivative Works in Source or Object form.
> > +
> > + 3. Grant of Patent License. Subject to the terms and conditions of
> > + this License, each Contributor hereby grants to You a perpetual,
> > + worldwide, non-exclusive, no-charge, royalty-free, irrevocable
> > + (except as stated in this section) patent license to make, have made,
> > + use, offer to sell, sell, import, and otherwise transfer the Work,
> > + where such license applies only to those patent claims licensable
> > + by such Contributor that are necessarily infringed by their
> > + Contribution(s) alone or by combination of their Contribution(s)
> > + with the Work to which such Contribution(s) was submitted. If You
> > + institute patent litigation against any entity (including a
> > + cross-claim or counterclaim in a lawsuit) alleging that the Work
> > + or a Contribution incorporated within the Work constitutes direct
> > + or contributory patent infringement, then any patent licenses
> > + granted to You under this License for that Work shall terminate
> > + as of the date such litigation is filed.
> > +
> > + 4. Redistribution. You may reproduce and distribute copies of the
> > + Work or Derivative Works thereof in any medium, with or without
> > + modifications, and in Source or Object form, provided that You
> > + meet the following conditions:
> > +
> > + (a) You must give any other recipients of the Work or
> > + Derivative Works a copy of this License; and
> > +
> > + (b) You must cause any modified files to carry prominent notices
> > + stating that You changed the files; and
> > +
> > + (c) You must retain, in the Source form of any Derivative Works
> > + that You distribute, all copyright, patent, trademark, and
> > + attribution notices from the Source form of the Work,
> > + excluding those notices that do not pertain to any part of
> > + the Derivative Works; and
> > +
> > + (d) If the Work includes a "NOTICE" text file as part of its
> > + distribution, then any Derivative Works that You distribute must
> > + include a readable copy of the attribution notices contained
> > + within such NOTICE file, excluding those notices that do not
> > + pertain to any part of the Derivative Works, in at least one
> > + of the following places: within a NOTICE text file distributed
> > + as part of the Derivative Works; within the Source form or
> > + documentation, if provided along with the Derivative Works; or,
> > + within a display generated by the Derivative Works, if and
> > + wherever such third-party notices normally appear. The contents
> > + of the NOTICE file are for informational purposes only and
> > + do not modify the License. You may add Your own attribution
> > + notices within Derivative Works that You distribute, alongside
> > + or as an addendum to the NOTICE text from the Work, provided
> > + that such additional attribution notices cannot be construed
> > + as modifying the License.
> > +
> > + You may add Your own copyright statement to Your modifications and
> > + may provide additional or different license terms and conditions
> > + for use, reproduction, or distribution of Your modifications, or
> > + for any such Derivative Works as a whole, provided Your use,
> > + reproduction, and distribution of the Work otherwise complies with
> > + the conditions stated in this License.
> > +
> > + 5. Submission of Contributions. Unless You explicitly state otherwise,
> > + any Contribution intentionally submitted for inclusion in the Work
> > + by You to the Licensor shall be under the terms and conditions of
> > + this License, without any additional terms or conditions.
> > + Notwithstanding the above, nothing herein shall supersede or modify
> > + the terms of any separate license agreement you may have executed
> > + with Licensor regarding such Contributions.
> > +
> > + 6. Trademarks. This License does not grant permission to use the trade
> > + names, trademarks, service marks, or product names of the Licensor,
> > + except as required for reasonable and customary use in describing the
> > + origin of the Work and reproducing the content of the NOTICE file.
> > +
> > + 7. Disclaimer of Warranty. Unless required by applicable law or
> > + agreed to in writing, Licensor provides the Work (and each
> > + Contributor provides its Contributions) on an "AS IS" BASIS,
> > + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> > + implied, including, without limitation, any warranties or conditions
> > + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
> > + PARTICULAR PURPOSE. You are solely responsible for determining the
> > + appropriateness of using or redistributing the Work and assume any
> > + risks associated with Your exercise of permissions under this License.
> > +
> > + 8. Limitation of Liability. In no event and under no legal theory,
> > + whether in tort (including negligence), contract, or otherwise,
> > + unless required by applicable law (such as deliberate and grossly
> > + negligent acts) or agreed to in writing, shall any Contributor be
> > + liable to You for damages, including any direct, indirect, special,
> > + incidental, or consequential damages of any character arising as a
> > + result of this License or out of the use or inability to use the
> > + Work (including but not limited to damages for loss of goodwill,
> > + work stoppage, computer failure or malfunction, or any and all
> > + other commercial damages or losses), even if such Contributor
> > + has been advised of the possibility of such damages.
> > +
> > + 9. Accepting Warranty or Additional Liability. While redistributing
> > + the Work or Derivative Works thereof, You may choose to offer,
> > + and charge a fee for, acceptance of support, warranty, indemnity,
> > + or other liability obligations and/or rights consistent with this
> > + License. However, in accepting such obligations, You may act only
> > + on Your own behalf and on Your sole responsibility, not on behalf
> > + of any other Contributor, and only if You agree to indemnify,
> > + defend, and hold each Contributor harmless for any liability
> > + incurred by, or claims asserted against, such Contributor by reason
> > + of your accepting any such warranty or additional liability.
> > +
> > + END OF TERMS AND CONDITIONS
> > +
> > + APPENDIX: How to apply the Apache License to your work.
> > +
> > + To apply the Apache License to your work, attach the following
> > + boilerplate notice, with the fields enclosed by brackets "[]"
> > + replaced with your own identifying information. (Don't include
> > + the brackets!) The text should be enclosed in the appropriate
> > + comment syntax for the file format. We also recommend that a
> > + file or class name and description of purpose be included on the
> > + same "printed page" as the copyright notice for easier
> > + identification within third-party archives.
> > +
> > + Copyright [yyyy] [name of copyright owner]
> > +
> > + Licensed 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.
> > +
> > +
> > +===============================================================================
> > +
> > +The Apache Shindig distribution includes a number of subcomponents
> > +with separate copyright notices and license terms. Your use of the
> > +code for the these subcomponents is subject to the terms and
> > +conditions of the following licenses.
> > +
> > +===============================================================================
> >
> > Copied: incubator/shindig/branches/1.0.x-incubating/java/NOTICE (from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE)
> > URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/NOTICE?p2=incubator/shindig/branches/1.0.x-incubating/java/NOTICE&p1=incubator/shindig/branches/1.0.x-incubating/NOTICE&r1=770145&r2=770209&rev=770209&view=diff
> > ==============================================================================
> > --- incubator/shindig/branches/1.0.x-incubating/NOTICE (original)
> > +++ incubator/shindig/branches/1.0.x-incubating/java/NOTICE Thu Apr 30 12:51:23 2009
> > @@ -1,16 +1,15 @@
> > -Apache Shindig
> > -Copyright 2009 The Apache Software Foundation
> > + =========================================================================
> > + == NOTICE file corresponding to the section 4 d of ==
> > + == the Apache License, Version 2.0, ==
> > + == in this case for the Apache Shindig distribution. ==
> > + =========================================================================
> >
> > -This product includes software developed at
> > -The Apache Software Foundation (http://www.apache.org/).
> > -
> > ------------------------------------------------------------
> > This product includes software (Gadget Server, Gadget Container)
> > originally developed by Google Inc. (http://code.google.com/) and licensed
> > to the ASF as initial contribution for Shindig.
> >
> > -This product includes the jquery.js file,
> > -Copyright (c) 2007 John Resig, http://jquery.com/
> > +This product includes software developed at
> > +The Apache Software Foundation (http://www.apache.org/).
> >
> > This distribution includes cryptographic software. The country in
> > which you currently reside may have restrictions on the import,
> > @@ -36,7 +35,3 @@
> >
> > Apache Shindig interfaces with the Java JCE APIs to provide
> > encryption of messages using the AES standard.
> > -
> > - Apache Shindig PHP interfaces with the mcrypt API
> > - <http://mcrypt.sourceforge.net/> to provide encryption
> > - of messages using the AES standard.
> >
> > Modified: incubator/shindig/branches/1.0.x-incubating/java/README
> > URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/README?rev=770209&r1=770208&r2=770209&view=diff
> > ==============================================================================
> > --- incubator/shindig/branches/1.0.x-incubating/java/README (original)
> > +++ incubator/shindig/branches/1.0.x-incubating/java/README Thu Apr 30 12:51:23 2009
> > @@ -1,15 +1,68 @@
> > -There are four parts to the java gadget servers:
> > + Apache Shindig Java
> >
> > -* java/common The common java code that both the social data server and the
> > - gadget rendering server rely on.
> > + What is it?
> > + -----------
> >
> > -* java/gadgets This server is used for rendering gadgets.
> > + Shindig is a JavaScript container and implementations of the backend APIs
> > + and proxy required for hosting OpenSocial applications.
> >
> > -* java/social-api This server is used to provide social data for gadgets. Long
> > - term, it will implement the OpenSocial RESTful apis.
> > + This is the Java implementation of Shindig. If you are looking to the PHP
> > + implementation, please visit our website.
> >
> > -* java/server This directory only contains a pom and a web.xml file. It is used
> > - to run both the gadget rendering code and the social data code at once. In
> > - order to use the samplecontainer you must run this server.
> > + Documentation
> > + -------------
> >
> > -For more information, see http://incubator.apache.org/projects/shindig.html
> > + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
> > + and at http://incubator.apache.org/shindig/developers/java/index.html for specific
> > + Java documentation.
> > +
> > + Release Notes
> > + -------------
> > +
> > + The full list of changes can be found at https://issues.apache.org/jira/browse/SHINDIG.
> > +
> > + System Requirements
> > + -------------------
> > +
> > + Java:
> > + 1.5 or above.
> > + Servlet container:
> > + Apache Tomcat or other compatible Java Servlet containers.
> > + Memory:
> > + No minimum requirement.
> > + Disk:
> > + No minimum requirement.
> > + Operating System:
> > + No minimum requirement. On Windows, Windows NT and above or Cygwin is
> > + required for the startup scripts. Tested on Windows XP, Fedora Core
> > + and Mac OS X.
> > +
> > + Installing Shindig Java
> > + -----------------------
> > +
> > + Unzip the distribution archive, i.e. shindig-1.0-incubating-java.zip to
> > + the directory you wish to install Shindig.
> > +
> > + The following explains how to deploy the Shindig war file to Apache
> > + Tomcat. If you are using an other container, please read its documentation
> > + on how to proceed.
> > +
> > + The easiest way to deploy Shindig on Apache Tomcat is to rename the
> > + shindig-server-1.0-incubating.war file to ROOT.war and drop it in the
> > + Tomcat webapps.
> > + Be sure to delete $TOMCAT_HOME/webapps/ROOT dir before starting Tomcat.
> > +
> > + Licensing
> > + ---------
> > +
> > + Please see the file called LICENSE.
> > +
> > + Shindig URLS
> > + ------------
> > +
> > + Home Page: http://incubator.apache.org/shindig/
> > + Downloads: http://incubator.apache.org/shindig/download/index.html
> > + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> > + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> > + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> > + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
> >
> > Modified: incubator/shindig/branches/1.0.x-incubating/javascript/README
> > URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/javascript/README?rev=770209&r1=770208&r2=770209&view=diff
> > ==============================================================================
> > --- incubator/shindig/branches/1.0.x-incubating/javascript/README (original)
> > +++ incubator/shindig/branches/1.0.x-incubating/javascript/README Thu Apr 30 12:51:23 2009
> > @@ -1,87 +1,109 @@
> > -Using Shindig Gadget Container JavaScript
> > -=========================================
> > + Apache Shindig Javascript
> >
> > -1) Try out the samples.
> > - A) Set up your own Shindig Gadget Server. See java/README for details.
> > + What is it?
> > + -----------
> >
> > - B) Assuming your server is running on http://yourserver:yourport/gadgets/...
> > - you can hit these html files in your favorite browser to see your local
> > - Shindig in action:
> > + Shindig is a JavaScript container and implementations of the backend APIs
> > + and proxy required for hosting OpenSocial applications.
> >
> > - (Note: yourserver:yourport defaults to localhost:8080 for the java server,
> > - and just localhost for the php server)
> > + This is the Javascript component of Shindig.
> >
> > - * http://yourserver:yourport/gadgets/files/container/sample1.html - basic container
> > - * http://yourserver:yourport/gadgets/files/container/sample2.html - custom rendering
> > - * http://yourserver:yourport/gadgets/files/container/sample3.html - custom layouts
> > - * http://yourserver:yourport/gadgets/files/container/sample4.html - set pref
> > - * http://yourserver:yourport/gadgets/files/container/sample5.html - set pref
> > - * http://yourserver:yourport/gadgets/files/container/sample6.html - dynamic height
> > - * http://yourserver:yourport/gadgets/files/container/sample7.html - set title
> > + Documentation
> > + -------------
> >
> > - These samples are very basic and aren't production-ready. Shindig will
> > - include a more advanced container at a later date but it hasn't been
> > - completed yet.
> > + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
> > +
> > + Using Shindig Gadget Container JavaScript
> > + -----------------------------------------
> >
> > -2) Play around with the code.
> > + 1) Try out the samples.
> > + A) Set up your own Shindig Gadget Server. See java/README for details.
> >
> > - A) Create an HTML file including the following <head> boilerplate:
> > - <script type="text/javascript" src="../../js/rpc.js?c=1"></script>
> > - <script type="text/javascript" src="cookies.js"></script>
> > - <script type="text/javascript" src="util.js"></script>
> > - <script type="text/javascript" src="gadgets.js"></script>
> > - <script type="text/javascript" src="cookiebaseduserprefstore.js"></script>
> > + B) Assuming your server is running on http://yourserver:yourport/gadgets/...
> > + you can hit these html files in your favorite browser to see your local
> > + Shindig in action:
> >
> > - B) For each Gadget you wish to add to the page:
> > - i) Create it. Example, for Gadget whose spec is at http://foo.com/spec.xml
> > + (Note: yourserver:yourport defaults to localhost:8080 for the java server,
> > + and just localhost for the php server)
> >
> > - var gadget = gadgets.container.createGadget(
> > - {specUrl: "http://foo.com/spec.xml"});
> > + * http://yourserver:yourport/gadgets/files/container/sample1.html - basic container
> > + * http://yourserver:yourport/gadgets/files/container/sample2.html - custom rendering
> > + * http://yourserver:yourport/gadgets/files/container/sample3.html - custom layouts
> > + * http://yourserver:yourport/gadgets/files/container/sample4.html - set pref
> > + * http://yourserver:yourport/gadgets/files/container/sample5.html - set pref
> > + * http://yourserver:yourport/gadgets/files/container/sample6.html - dynamic height
> > + * http://yourserver:yourport/gadgets/files/container/sample7.html - set title
> >
> > - Check "gadgets.js" for other options to be set in createGadget. If you are
> > - debugging your own gadgets you can consider to use specVersion to get a more
> > - optimal use of the cache. Alternatively, gadgets.container.setNoCache(1)
> > + These samples are very basic and aren't production-ready. Shindig will
> > + include a more advanced container at a later date but it hasn't been
> > + completed yet.
> >
> > - ii) Add it to the container. Example:
> > + 2) Play around with the code.
> >
> > - gadgets.container.addGadget(gadget);
> > + A) Create an HTML file including the following <head> boilerplate:
> > + <script type="text/javascript" src="../../js/rpc.js?c=1"></script>
> > + <script type="text/javascript" src="cookies.js"></script>
> > + <script type="text/javascript" src="util.js"></script>
> > + <script type="text/javascript" src="gadgets.js"></script>
> > + <script type="text/javascript" src="cookiebaseduserprefstore.js"></script>
> >
> > - If your setup is too complicated, you can need to tell each Gadget
> > - where its server is. Example
> > + B) For each Gadget you wish to add to the page:
> > + i) Create it. Example, for Gadget whose spec is at http://foo.com/spec.xml
> > +
> > + var gadget = gadgets.container.createGadget(
> > + {specUrl: "http://foo.com/spec.xml"});
> > +
> > + Check "gadgets.js" for other options to be set in createGadget. If you are
> > + debugging your own gadgets you can consider to use specVersion to get a more
> > + optimal use of the cache. Alternatively, gadgets.container.setNoCache(1)
> > +
> > + ii) Add it to the container. Example:
> >
> > - gadget.setServerBase("http://yourserver:yourport/gadgets/");
> > + gadgets.container.addGadget(gadget);
> > +
> > + If your setup is too complicated, you can need to tell each Gadget
> > + where its server is. Example
> > +
> > + gadget.setServerBase("http://yourserver:yourport/gadgets/");
> >
> > - iii) Ensure the Gadget's chrome ID is defined. This is the ID of the
> > - elements in which the Gadget is rendered. The way these are specified
> > - differs depending on the LayoutManager being used. Example with default
> > - LayoutManager:
> > + iii) Ensure the Gadget's chrome ID is defined. This is the ID of the
> > + elements in which the Gadget is rendered. The way these are specified
> > + differs depending on the LayoutManager being used. Example with default
> > + LayoutManager:
> >
> > - gadgets.container.layoutManager.setGadgetChromeIds([ 'gadget-id-1' ]);
> > + gadgets.container.layoutManager.setGadgetChromeIds([ 'gadget-id-1' ]);
> >
> > - iv) Render it. The chrome element must exist when this call is performed
> > - (ie. this must occur onLoad of the document.body or in inline script).
> > + iv) Render it. The chrome element must exist when this call is performed
> > + (ie. this must occur onLoad of the document.body or in inline script).
> >
> > - gadgets.container.renderGadget(gadget);
> > + gadgets.container.renderGadget(gadget);
> >
> > - You may also render several added Gadgets at once:
> > + You may also render several added Gadgets at once:
> >
> > - gadgets.container.renderGadgets();
> > + gadgets.container.renderGadgets();
> >
> > - C) Explore samples 2, 3, and 4 for examples using different LayoutManagers
> > - and supporting UserPrefs storage.
> > + C) Explore samples 2, 3, and 4 for examples using different LayoutManagers
> > + and supporting UserPrefs storage.
> >
> > -4) Run the opensocial sample container
> > - A) Set up your own Shindig Gadget Server. See java/README for details. (If you
> > - are using the java based server make sure you run with mvn jetty:run-war)
> > + 4) Run the opensocial sample container
> > + A) Set up your own Shindig Gadget Server. See java/README for details. (If you
> > + are using the java based server make sure you run with mvn jetty:run-war)
> >
> > - B) Hit the sample container at
> > - http://yourserver:yourport/gadgets/files/samplecontainer/samplecontainer.html
> > + B) Hit the sample container at
> > + http://yourserver:yourport/gadgets/files/samplecontainer/samplecontainer.html
> >
> > - C) See the sample container help document for more details on how it works:
> > - http://yourserver:yourport/gadgets/files/samplecontainer/getting-started.html
> > + C) See the sample container help document for more details on how it works:
> > + http://yourserver:yourport/gadgets/files/samplecontainer/getting-started.html
> >
> > - D) Get, and try to run, coderunner.xml and compliancetests.xml from the project
> > - http://opensocial-resources.googlecode.com/
> > + D) Get, and try to run, coderunner.xml and compliancetests.xml from the project
> > + http://opensocial-resources.googlecode.com/
> >
> > + Shindig URLS
> > + ------------
> >
> > -For more information, see http://incubator.apache.org/projects/shindig.html
> > + Home Page: http://incubator.apache.org/shindig/
> > + Downloads: http://incubator.apache.org/shindig/download/index.html
> > + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> > + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> > + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> > + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
> >
> > Copied: incubator/shindig/branches/1.0.x-incubating/php/NOTICE (from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE)
> > URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/php/NOTICE?p2=incubator/shindig/branches/1.0.x-incubating/php/NOTICE&p1=incubator/shindig/branches/1.0.x-incubating/NOTICE&r1=770145&r2=770209&rev=770209&view=diff
> > ==============================================================================
> > --- incubator/shindig/branches/1.0.x-incubating/NOTICE (original)
> > +++ incubator/shindig/branches/1.0.x-incubating/php/NOTICE Thu Apr 30 12:51:23 2009
> > @@ -1,16 +1,21 @@
> > -Apache Shindig
> > -Copyright 2009 The Apache Software Foundation
> > + =========================================================================
> > + == NOTICE file corresponding to the section 4 d of ==
> > + == the Apache License, Version 2.0, ==
> > + == in this case for the Apache Shindig distribution. ==
> > + =========================================================================
> >
> > -This product includes software developed at
> > -The Apache Software Foundation (http://www.apache.org/).
> > -
> > ------------------------------------------------------------
> > This product includes software (Gadget Server, Gadget Container)
> > originally developed by Google Inc. (http://code.google.com/) and licensed
> > to the ASF as initial contribution for Shindig.
> >
> > -This product includes the jquery.js file,
> > -Copyright (c) 2007 John Resig, http://jquery.com/
> > +This product includes software developed at
> > +The Apache Software Foundation (http://www.apache.org/).
> > +
> > +This product includes software (Zend) developed by
> > +Zend Technologies Ltd (http://framework.zend.com/).
> > +
> > +This product includes software (PHPUnit) developed by
> > +Sebastian Bergmann (http://www.phpunit.de/).
> >
> > This distribution includes cryptographic software. The country in
> > which you currently reside may have restrictions on the import,
> > @@ -34,9 +39,6 @@
> > The following provides more details on the included cryptographic
> > software:
> >
> > - Apache Shindig interfaces with the Java JCE APIs to provide
> > - encryption of messages using the AES standard.
> > -
> > Apache Shindig PHP interfaces with the mcrypt API
> > <http://mcrypt.sourceforge.net/> to provide encryption
> > of messages using the AES standard.
> >
> > Modified: incubator/shindig/branches/1.0.x-incubating/php/README
> > URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/php/README?rev=770209&r1=770208&r2=770209&view=diff
> > ==============================================================================
> > --- incubator/shindig/branches/1.0.x-incubating/php/README (original)
> > +++ incubator/shindig/branches/1.0.x-incubating/php/README Thu Apr 30 12:51:23 2009
> > @@ -1,109 +1,120 @@
> > -Welcome to Apache Shindig!
> > + Apache Shindig PHP
> >
> > -* Read javascript/README for instructions for using the Shindig Gadget
> > + What is it?
> > + -----------
> > +
> > + Shindig is a JavaScript container and implementations of the backend APIs
> > + and proxy required for hosting OpenSocial applications.
> > +
> > + This is the PHP implementation of Shindig. If you are looking to the Java
> > + implementation, please visit our website.
> > +
> > + Documentation
> > + -------------
> > +
> > + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
> > + and at http://incubator.apache.org/shindig/developers/php/index.html
> > + for specific PHP documentation.
> > +
> > + Read javascript/README for instructions for using the Shindig Gadget
> > Container JavaScript to enable your page to render Gadgets.
> > -* Read the instructions below for how to use PHP Shindig
> > -* For more information, see http://incubator.apache.org/shindig/
> >
> > + Release Notes
> > + -------------
> >
> > -Installing and Running The PHP Shindig Gadget Server
> > -============================================
> > + The full list of changes can be found at https://issues.apache.org/jira/browse/SHINDIG.
> >
> > -Prequisites before building Shindig for PHP
> > -============================================
> > -In order to build and run Shindig for PHP, you must have the following:
> > -
> > -- A Subversion client installed in order to checkout the code.
> > - Instructions for downloading and installing Subversion can be found here:
> > - http://subversion.tigris.org/
> > -- Apache with mod_rewrite enabled.
> > -- PHP 5.2.x with the json, simplexml, mcrypt and curl extentions enabled.
> > -
> > -
> > -Getting the code (if you're running from svn and not a release tarball)
> > -============================================
> > -Create a subdirectory in your web document root, e.g. /var/www/html and
> > -checkout the Shindig code from its Subversion repository
> > -
> > -mkdir /var/www/html/shindig
> > -cd /var/www/html/shindig
> > -svn co http://svn.apache.org/repos/asf/incubator/shindig/trunk/ .
> > -
> > -
> > -Running Shindig from a release download
> > -============================================
> > -
> > -The instructions are identical as when running from an svn checkout, except
> > -that the /shindig/php directory in the virtual host becomes just /shindig, ie:
> > -
> > - <VirtualHost your_ip:your_port>
> > - ServerName your.host
> > - DocumentRoot /var/www/html/shindig
> > - ... other normal settings in vhosts...
> > - <Directory />
> > - AllowOverride All
> > - </Directory>
> > - </VirtualHost>
> > -
> > -Running Shindig from an svn checkout
> > -============================================
> > -With PHP There is no need to build anything - the source code
> > -is already built.
> > -
> > -To run the code, you have several options:
> > -
> > -a. Create a new virtual host
> > -
> > -Point your apache to the php dir with a virtual host like:
> > -
> > - <VirtualHost your_ip:your_port>
> > - ServerName your.host
> > - DocumentRoot /var/www/html/shindig/php
> > - ... other normal settings in vhosts...
> > - <Directory />
> > - AllowOverride All
> > - </Directory>
> > - </VirtualHost>
> > -
> > -
> > -Restart apache, and point your browser to:
> > -
> > -http://<your.host>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
> > -
> > -you should see something like this:
> > -http://shindig.chabotc.com/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
> > -
> > -b. Run with an existing host
> > -
> > -If you cannot/don't want to create a virtual host, you can edit the file php/config/container.php
> > -or php/config/local.php (see the comments php/config/container.php for documentation of the
> > -configuration system) and change the web_prefix setting to '/shindig/php'.
> > -
> > -In this case, you should also change all paths in shindig/config/container.js
> > -(see the comments there for documentation of the JSON configuration system).
> > -
> > -Then you can run the gadget by pointing your browser to:
> > -
> > -http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
> > -
> > -Going forward
> > -============================================
> > -Check out the php/config/container.php file, in local.php you only have to specificy the
> > -fields you want to overwrite with other values, for example on a production system you
> > -would probably want to have something like:
> > - $shindigConfig = array(
> > - 'debug' => false,
> > - 'allow_plaintext_token' => false,
> > - 'token_cipher_key' => 'MySecretKey',
> > - 'token_hmac_key' => 'MyOtherSecret',
> > - 'private_key_phrase' => 'MyCertificatePassword',
> > - 'person_service' => 'MyPeopleService',
> > - 'activity_service' => 'MyActivitiesService',
> > - 'app_data_service' => 'MyAppDataService',
> > - 'messages_service' => 'MyMessagesService',
> > - 'oauth_lookup_service' => 'MyOAuthLookupService'
> > - 'xrds_location' => 'http://www.mycontainer.com/xrds',
> > - 'check_file_exists' => false
> > - );
> > + System Requirements
> > + -------------------
> > +
> > + PHP:
> > + 5.2.x or above with the json, simplexml, mcrypt and curl extentions
> > + enabled.
> > + Web server:
> > + Apache with mod_rewrite enabled.
> > + Memory:
> > + No minimum requirement.
> > + Disk:
> > + No minimum requirement.
> > + Operating System:
> > + No minimum requirement. On Windows, Windows NT and above or Cygwin is
> > + required for the startup scripts. Tested on Windows XP, Fedora Core
> > + and Mac OS X.
> > +
> > + Installing Shindig
> > + ------------------
> > +
> > + Unzip the distribution archive, i.e. shindig-1.0-incubating-php.zip to
> > + the web document root, e.g. /var/www/html.
> > +
> > + Rename the created shindig-1.0-incubating-php dir to shindig.
> > +
> > + a. Create a new virtual host
> > +
> > + Point your Apache to the shindig dir with a virtual host like:
> > +
> > + <VirtualHost your_ip:your_port>
> > + ServerName your.host
> > + DocumentRoot /var/www/html/shindig
> > + ... other normal settings in vhosts...
> > + <Directory>
> > + AllowOverride All
> > + </Directory>
> > + </VirtualHost>
> > +
> > + Restart apache, and point your browser to:
> > +
> > + http://<your.host>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
> > +
> > + b. Run with an existing host
> > +
> > + If you cannot/don't want to create a virtual host, you can edit the file
> > + php/config/container.php or php/config/local.php (see the comments
> > + php/config/container.php for documentation of the configuration system)
> > + and change the web_prefix setting to '/shindig/php'.
> > +
> > + In this case, you should also change all paths in shindig/config/container.js
> > + (see the comments there for documentation of the JSON configuration system).
> > +
> > + Then you can run the gadget by pointing your browser to:
> > +
> > + http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
> > +
> > + Going forward
> > + -------------
> > +
> > + Check out the php/config/container.php file, in local.php you only have
> > + to specificy the fields you want to overwrite with other values, for
> > + example on a production system you would probably want to have something
> > + like:
> > + $shindigConfig = array(
> > + 'debug' => false,
> > + 'allow_plaintext_token' => false,
> > + 'token_cipher_key' => 'MySecretKey',
> > + 'token_hmac_key' => 'MyOtherSecret',
> > + 'private_key_phrase' => 'MyCertificatePassword',
> > + 'person_service' => 'MyPeopleService',
> > + 'activity_service' => 'MyActivitiesService',
> > + 'app_data_service' => 'MyAppDataService',
> > + 'messages_service' => 'MyMessagesService',
> > + 'oauth_lookup_service' => 'MyOAuthLookupService'
> > + 'xrds_location' => 'http://www.mycontainer.com/xrds',
> > + 'check_file_exists' => false
> > + );
> >
> > -And then implement your own service and oauth lookup classes.
> > + And then implement your own service and oauth lookup classes.
> > +
> > + Licensing
> > + ---------
> > +
> > + Please see the file called LICENSE.
> > +
> > + Shindig URLS
> > + ------------
> > +
> > + Home Page: http://incubator.apache.org/shindig/
> > + Downloads: http://incubator.apache.org/shindig/download/index.html
> > + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> > + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> > + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> > + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
> >
> >
> >
>
Re: svn commit: r770209 - in /incubator/shindig/branches/1.0.x-incubating:
./ assembly/src/main/assembly/ assembly/src/main/assembly/binary-src/
features/ java/ javascript/ php/
Posted by Vincent Siveton <vi...@gmail.com>.
I just updated the legal files and the README.
Please review this commit.
Vincent
2009/4/30 <vs...@apache.org>:
> Author: vsiveton
> Date: Thu Apr 30 12:51:23 2009
> New Revision: 770209
>
> URL: http://svn.apache.org/viewvc?rev=770209&view=rev
> Log:
> o improved README, NOTICE and LICENSE
>
> Added:
> incubator/shindig/branches/1.0.x-incubating/java/LICENSE
> incubator/shindig/branches/1.0.x-incubating/java/NOTICE
> - copied, changed from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE
> incubator/shindig/branches/1.0.x-incubating/php/LICENSE
> - copied unchanged from r770160, incubator/shindig/branches/1.0.x-incubating/LICENSE
> incubator/shindig/branches/1.0.x-incubating/php/NOTICE
> - copied, changed from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE
> Removed:
> incubator/shindig/branches/1.0.x-incubating/LICENSE
> incubator/shindig/branches/1.0.x-incubating/NOTICE
> incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/binary-src/
> Modified:
> incubator/shindig/branches/1.0.x-incubating/README
> incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml
> incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml
> incubator/shindig/branches/1.0.x-incubating/features/README
> incubator/shindig/branches/1.0.x-incubating/java/README
> incubator/shindig/branches/1.0.x-incubating/javascript/README
> incubator/shindig/branches/1.0.x-incubating/php/README
>
> Modified: incubator/shindig/branches/1.0.x-incubating/README
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/README?rev=770209&r1=770208&r2=770209&view=diff
> ==============================================================================
> --- incubator/shindig/branches/1.0.x-incubating/README (original)
> +++ incubator/shindig/branches/1.0.x-incubating/README Thu Apr 30 12:51:23 2009
> @@ -1,14 +1,38 @@
> -Welcome to Apache Shindig!
> + Apache Shindig
>
> -* Read java/README for instructions on using the java gadget servers.
> + What is it?
> + -----------
>
> -* To build and run the Java server see BUILD-JAVA
> + Shindig is a JavaScript container and implementations of the backend APIs
> + and proxy required for hosting OpenSocial applications.
>
> -* Read php/README for instructions on how to run a php gadget server
> - instead of a java gadget server.
> + Documentation
> + -------------
>
> -* Read javascript/README 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.
> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/.
>
> -For more information, see http://incubator.apache.org/shindig/
> + Read BUILD-JAVA for instructions on how to build and run the Java server.
> +
> + Read java/README for instructions on how to run a Java gadget server.
> +
> + Read php/README for instructions on how to run a php gadget server.
> +
> + Read javascript/README for instructions for using the Shindig Gadget Container
> + JavaScript to enable your page to render Gadgets.
> +
> + Read features/README for instructions on how to use features.
> +
> + Licensing
> + ---------
> +
> + Please see the file called LICENSE in the java and php directories.
> +
> + Shindig URLS
> + ------------
> +
> + Home Page: http://incubator.apache.org/shindig/
> + Downloads: http://incubator.apache.org/shindig/download/index.html
> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>
> Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml?rev=770209&r1=770208&r2=770209&view=diff
> ==============================================================================
> --- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml (original)
> +++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/java.xml Thu Apr 30 12:51:23 2009
> @@ -43,18 +43,21 @@
> <outputDirectory>shindig-${pom.version}-java</outputDirectory>
> <directory>../</directory>
> <includes>
> - <include>COMMITTERS</include>
> <include>DISCLAIMER</include>
> - <include>LICENSE</include>
> - <include>NOTICE</include>
> </includes>
> + <excludes>
> + <exclude>LICENSE</exclude>
> + <exclude>NOTICE</exclude>
> + <exclude>README</exclude>
> + </excludes>
> </fileSet>
> <fileSet>
> <outputDirectory>shindig-${pom.version}-java</outputDirectory>
> - <directory>src/main/assembly/binary-src/</directory>
> - <filtered>true</filtered>
> + <directory>../java</directory>
> <includes>
> - <include>**/*</include>
> + <include>LICENSE</include>
> + <include>NOTICE</include>
> + <include>README</include>
> </includes>
> </fileSet>
> </fileSets>
>
> Modified: incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml?rev=770209&r1=770208&r2=770209&view=diff
> ==============================================================================
> --- incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml (original)
> +++ incubator/shindig/branches/1.0.x-incubating/assembly/src/main/assembly/php.xml Thu Apr 30 12:51:23 2009
> @@ -32,10 +32,7 @@
> <include>features/**</include>
> <include>javascript/**</include>
> <include>config/**</include>
> - <include>COMMITTERS</include>
> <include>DISCLAIMER</include>
> - <include>LICENSE</include>
> - <include>NOTICE</include>
> </includes>
> <excludes>
> <exclude>site/**</exclude>
> @@ -63,6 +60,8 @@
> <!-- misc -->
> <exclude>*.patch</exclude>
> <exclude>*.diff</exclude>
> + <exclude>LICENSE</exclude>
> + <exclude>NOTICE</exclude>
> <exclude>README</exclude>
> </excludes>
> <lineEnding>unix</lineEnding>
>
> Modified: incubator/shindig/branches/1.0.x-incubating/features/README
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/features/README?rev=770209&r1=770208&r2=770209&view=diff
> ==============================================================================
> --- incubator/shindig/branches/1.0.x-incubating/features/README (original)
> +++ incubator/shindig/branches/1.0.x-incubating/features/README Thu Apr 30 12:51:23 2009
> @@ -1,40 +1,68 @@
> -You can automatically include new features into your shindig server by adding
> -them to this directory. Features should exist in a self-contained directory
> -with the following structure:
> -
> -features
> - |_your-feature-name
> - |_feature.xml
> - |_code-to-run-inside-gadget.js
> - |_code-to-run-inside-container.js
> -
> -The structure of feature.xml is as follows:
> -TODO: link to xml schema for feature.xml
> -
> -<?xml version="1.0"?>
> -<feature>
> - <name>your-feature-name (required)</name>
> - <dependency>any dependency you have (optional, may have multiple)</dependency>
> - <gadget> (optional)
> - <script src="code-to-run-inside-gadget.js"/> (optional, may have multiple,
> - may use web resources as well but we strongly encourage bundling your
> - javascript with the xml)
> - </gadget>
> - <container> (optional)
> - <script src="code-to-run-inside-container.js"> (same as for <gadget>)
> - </container>
> -</feature>
> -
> -Please always make sure that all files you provide are encoded as utf8.
> -
> -When adding new features, your javascript should conform to shindig javascript
> -coding conventions. This means that you should not be producing new globals and
> -your feature should be compatible with Caja.
> + Apache Shindig Features
>
> -When committing a new feature, you should update the features.txt file by
> -running the following script in a unix-like environment:
> + What is it?
> + -----------
>
> -ls -R1a features/**/*.xml > features/features.txt
> + Shindig is a JavaScript container and implementations of the backend APIs
> + and proxy required for hosting OpenSocial applications.
>
> -TODO: Instructions for regenerating features.txt for other operating system
> -environments.
> + This is the features component of Shindig.
> +
> + Documentation
> + -------------
> +
> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
> +
> + Using features
> + --------------
> +
> + You can automatically include new features into your shindig server by adding
> + them to this directory. Features should exist in a self-contained directory
> + with the following structure:
> +
> + features
> + |_your-feature-name
> + |_feature.xml
> + |_code-to-run-inside-gadget.js
> + |_code-to-run-inside-container.js
> +
> + The structure of feature.xml is as follows:
> + TODO: link to xml schema for feature.xml
> +
> + <?xml version="1.0"?>
> + <feature>
> + <name>your-feature-name (required)</name>
> + <dependency>any dependency you have (optional, may have multiple)</dependency>
> + <gadget> (optional)
> + <script src="code-to-run-inside-gadget.js"/> (optional, may have multiple,
> + may use web resources as well but we strongly encourage bundling your
> + javascript with the xml)
> + </gadget>
> + <container> (optional)
> + <script src="code-to-run-inside-container.js"> (same as for <gadget>)
> + </container>
> + </feature>
> +
> + Please always make sure that all files you provide are encoded as utf8.
> +
> + When adding new features, your javascript should conform to shindig javascript
> + coding conventions. This means that you should not be producing new globals and
> + your feature should be compatible with Caja.
> +
> + When committing a new feature, you should update the features.txt file by
> + running the following script in a unix-like environment:
> +
> + ls -R1a features/**/*.xml > features/features.txt
> +
> + TODO: Instructions for regenerating features.txt for other operating system
> + environments.
> +
> + Shindig URLS
> + ------------
> +
> + Home Page: http://incubator.apache.org/shindig/
> + Downloads: http://incubator.apache.org/shindig/download/index.html
> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>
> Added: incubator/shindig/branches/1.0.x-incubating/java/LICENSE
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/LICENSE?rev=770209&view=auto
> ==============================================================================
> --- incubator/shindig/branches/1.0.x-incubating/java/LICENSE (added)
> +++ incubator/shindig/branches/1.0.x-incubating/java/LICENSE Thu Apr 30 12:51:23 2009
> @@ -0,0 +1,212 @@
> +
> + Apache License
> + Version 2.0, January 2004
> + http://www.apache.org/licenses/
> +
> + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
> +
> + 1. Definitions.
> +
> + "License" shall mean the terms and conditions for use, reproduction,
> + and distribution as defined by Sections 1 through 9 of this document.
> +
> + "Licensor" shall mean the copyright owner or entity authorized by
> + the copyright owner that is granting the License.
> +
> + "Legal Entity" shall mean the union of the acting entity and all
> + other entities that control, are controlled by, or are under common
> + control with that entity. For the purposes of this definition,
> + "control" means (i) the power, direct or indirect, to cause the
> + direction or management of such entity, whether by contract or
> + otherwise, or (ii) ownership of fifty percent (50%) or more of the
> + outstanding shares, or (iii) beneficial ownership of such entity.
> +
> + "You" (or "Your") shall mean an individual or Legal Entity
> + exercising permissions granted by this License.
> +
> + "Source" form shall mean the preferred form for making modifications,
> + including but not limited to software source code, documentation
> + source, and configuration files.
> +
> + "Object" form shall mean any form resulting from mechanical
> + transformation or translation of a Source form, including but
> + not limited to compiled object code, generated documentation,
> + and conversions to other media types.
> +
> + "Work" shall mean the work of authorship, whether in Source or
> + Object form, made available under the License, as indicated by a
> + copyright notice that is included in or attached to the work
> + (an example is provided in the Appendix below).
> +
> + "Derivative Works" shall mean any work, whether in Source or Object
> + form, that is based on (or derived from) the Work and for which the
> + editorial revisions, annotations, elaborations, or other modifications
> + represent, as a whole, an original work of authorship. For the purposes
> + of this License, Derivative Works shall not include works that remain
> + separable from, or merely link (or bind by name) to the interfaces of,
> + the Work and Derivative Works thereof.
> +
> + "Contribution" shall mean any work of authorship, including
> + the original version of the Work and any modifications or additions
> + to that Work or Derivative Works thereof, that is intentionally
> + submitted to Licensor for inclusion in the Work by the copyright owner
> + or by an individual or Legal Entity authorized to submit on behalf of
> + the copyright owner. For the purposes of this definition, "submitted"
> + means any form of electronic, verbal, or written communication sent
> + to the Licensor or its representatives, including but not limited to
> + communication on electronic mailing lists, source code control systems,
> + and issue tracking systems that are managed by, or on behalf of, the
> + Licensor for the purpose of discussing and improving the Work, but
> + excluding communication that is conspicuously marked or otherwise
> + designated in writing by the copyright owner as "Not a Contribution."
> +
> + "Contributor" shall mean Licensor and any individual or Legal Entity
> + on behalf of whom a Contribution has been received by Licensor and
> + subsequently incorporated within the Work.
> +
> + 2. Grant of Copyright License. Subject to the terms and conditions of
> + this License, each Contributor hereby grants to You a perpetual,
> + worldwide, non-exclusive, no-charge, royalty-free, irrevocable
> + copyright license to reproduce, prepare Derivative Works of,
> + publicly display, publicly perform, sublicense, and distribute the
> + Work and such Derivative Works in Source or Object form.
> +
> + 3. Grant of Patent License. Subject to the terms and conditions of
> + this License, each Contributor hereby grants to You a perpetual,
> + worldwide, non-exclusive, no-charge, royalty-free, irrevocable
> + (except as stated in this section) patent license to make, have made,
> + use, offer to sell, sell, import, and otherwise transfer the Work,
> + where such license applies only to those patent claims licensable
> + by such Contributor that are necessarily infringed by their
> + Contribution(s) alone or by combination of their Contribution(s)
> + with the Work to which such Contribution(s) was submitted. If You
> + institute patent litigation against any entity (including a
> + cross-claim or counterclaim in a lawsuit) alleging that the Work
> + or a Contribution incorporated within the Work constitutes direct
> + or contributory patent infringement, then any patent licenses
> + granted to You under this License for that Work shall terminate
> + as of the date such litigation is filed.
> +
> + 4. Redistribution. You may reproduce and distribute copies of the
> + Work or Derivative Works thereof in any medium, with or without
> + modifications, and in Source or Object form, provided that You
> + meet the following conditions:
> +
> + (a) You must give any other recipients of the Work or
> + Derivative Works a copy of this License; and
> +
> + (b) You must cause any modified files to carry prominent notices
> + stating that You changed the files; and
> +
> + (c) You must retain, in the Source form of any Derivative Works
> + that You distribute, all copyright, patent, trademark, and
> + attribution notices from the Source form of the Work,
> + excluding those notices that do not pertain to any part of
> + the Derivative Works; and
> +
> + (d) If the Work includes a "NOTICE" text file as part of its
> + distribution, then any Derivative Works that You distribute must
> + include a readable copy of the attribution notices contained
> + within such NOTICE file, excluding those notices that do not
> + pertain to any part of the Derivative Works, in at least one
> + of the following places: within a NOTICE text file distributed
> + as part of the Derivative Works; within the Source form or
> + documentation, if provided along with the Derivative Works; or,
> + within a display generated by the Derivative Works, if and
> + wherever such third-party notices normally appear. The contents
> + of the NOTICE file are for informational purposes only and
> + do not modify the License. You may add Your own attribution
> + notices within Derivative Works that You distribute, alongside
> + or as an addendum to the NOTICE text from the Work, provided
> + that such additional attribution notices cannot be construed
> + as modifying the License.
> +
> + You may add Your own copyright statement to Your modifications and
> + may provide additional or different license terms and conditions
> + for use, reproduction, or distribution of Your modifications, or
> + for any such Derivative Works as a whole, provided Your use,
> + reproduction, and distribution of the Work otherwise complies with
> + the conditions stated in this License.
> +
> + 5. Submission of Contributions. Unless You explicitly state otherwise,
> + any Contribution intentionally submitted for inclusion in the Work
> + by You to the Licensor shall be under the terms and conditions of
> + this License, without any additional terms or conditions.
> + Notwithstanding the above, nothing herein shall supersede or modify
> + the terms of any separate license agreement you may have executed
> + with Licensor regarding such Contributions.
> +
> + 6. Trademarks. This License does not grant permission to use the trade
> + names, trademarks, service marks, or product names of the Licensor,
> + except as required for reasonable and customary use in describing the
> + origin of the Work and reproducing the content of the NOTICE file.
> +
> + 7. Disclaimer of Warranty. Unless required by applicable law or
> + agreed to in writing, Licensor provides the Work (and each
> + Contributor provides its Contributions) on an "AS IS" BASIS,
> + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> + implied, including, without limitation, any warranties or conditions
> + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
> + PARTICULAR PURPOSE. You are solely responsible for determining the
> + appropriateness of using or redistributing the Work and assume any
> + risks associated with Your exercise of permissions under this License.
> +
> + 8. Limitation of Liability. In no event and under no legal theory,
> + whether in tort (including negligence), contract, or otherwise,
> + unless required by applicable law (such as deliberate and grossly
> + negligent acts) or agreed to in writing, shall any Contributor be
> + liable to You for damages, including any direct, indirect, special,
> + incidental, or consequential damages of any character arising as a
> + result of this License or out of the use or inability to use the
> + Work (including but not limited to damages for loss of goodwill,
> + work stoppage, computer failure or malfunction, or any and all
> + other commercial damages or losses), even if such Contributor
> + has been advised of the possibility of such damages.
> +
> + 9. Accepting Warranty or Additional Liability. While redistributing
> + the Work or Derivative Works thereof, You may choose to offer,
> + and charge a fee for, acceptance of support, warranty, indemnity,
> + or other liability obligations and/or rights consistent with this
> + License. However, in accepting such obligations, You may act only
> + on Your own behalf and on Your sole responsibility, not on behalf
> + of any other Contributor, and only if You agree to indemnify,
> + defend, and hold each Contributor harmless for any liability
> + incurred by, or claims asserted against, such Contributor by reason
> + of your accepting any such warranty or additional liability.
> +
> + END OF TERMS AND CONDITIONS
> +
> + APPENDIX: How to apply the Apache License to your work.
> +
> + To apply the Apache License to your work, attach the following
> + boilerplate notice, with the fields enclosed by brackets "[]"
> + replaced with your own identifying information. (Don't include
> + the brackets!) The text should be enclosed in the appropriate
> + comment syntax for the file format. We also recommend that a
> + file or class name and description of purpose be included on the
> + same "printed page" as the copyright notice for easier
> + identification within third-party archives.
> +
> + Copyright [yyyy] [name of copyright owner]
> +
> + Licensed 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.
> +
> +
> +===============================================================================
> +
> +The Apache Shindig distribution includes a number of subcomponents
> +with separate copyright notices and license terms. Your use of the
> +code for the these subcomponents is subject to the terms and
> +conditions of the following licenses.
> +
> +===============================================================================
>
> Copied: incubator/shindig/branches/1.0.x-incubating/java/NOTICE (from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE)
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/NOTICE?p2=incubator/shindig/branches/1.0.x-incubating/java/NOTICE&p1=incubator/shindig/branches/1.0.x-incubating/NOTICE&r1=770145&r2=770209&rev=770209&view=diff
> ==============================================================================
> --- incubator/shindig/branches/1.0.x-incubating/NOTICE (original)
> +++ incubator/shindig/branches/1.0.x-incubating/java/NOTICE Thu Apr 30 12:51:23 2009
> @@ -1,16 +1,15 @@
> -Apache Shindig
> -Copyright 2009 The Apache Software Foundation
> + =========================================================================
> + == NOTICE file corresponding to the section 4 d of ==
> + == the Apache License, Version 2.0, ==
> + == in this case for the Apache Shindig distribution. ==
> + =========================================================================
>
> -This product includes software developed at
> -The Apache Software Foundation (http://www.apache.org/).
> -
> ------------------------------------------------------------
> This product includes software (Gadget Server, Gadget Container)
> originally developed by Google Inc. (http://code.google.com/) and licensed
> to the ASF as initial contribution for Shindig.
>
> -This product includes the jquery.js file,
> -Copyright (c) 2007 John Resig, http://jquery.com/
> +This product includes software developed at
> +The Apache Software Foundation (http://www.apache.org/).
>
> This distribution includes cryptographic software. The country in
> which you currently reside may have restrictions on the import,
> @@ -36,7 +35,3 @@
>
> Apache Shindig interfaces with the Java JCE APIs to provide
> encryption of messages using the AES standard.
> -
> - Apache Shindig PHP interfaces with the mcrypt API
> - <http://mcrypt.sourceforge.net/> to provide encryption
> - of messages using the AES standard.
>
> Modified: incubator/shindig/branches/1.0.x-incubating/java/README
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/java/README?rev=770209&r1=770208&r2=770209&view=diff
> ==============================================================================
> --- incubator/shindig/branches/1.0.x-incubating/java/README (original)
> +++ incubator/shindig/branches/1.0.x-incubating/java/README Thu Apr 30 12:51:23 2009
> @@ -1,15 +1,68 @@
> -There are four parts to the java gadget servers:
> + Apache Shindig Java
>
> -* java/common The common java code that both the social data server and the
> - gadget rendering server rely on.
> + What is it?
> + -----------
>
> -* java/gadgets This server is used for rendering gadgets.
> + Shindig is a JavaScript container and implementations of the backend APIs
> + and proxy required for hosting OpenSocial applications.
>
> -* java/social-api This server is used to provide social data for gadgets. Long
> - term, it will implement the OpenSocial RESTful apis.
> + This is the Java implementation of Shindig. If you are looking to the PHP
> + implementation, please visit our website.
>
> -* java/server This directory only contains a pom and a web.xml file. It is used
> - to run both the gadget rendering code and the social data code at once. In
> - order to use the samplecontainer you must run this server.
> + Documentation
> + -------------
>
> -For more information, see http://incubator.apache.org/projects/shindig.html
> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
> + and at http://incubator.apache.org/shindig/developers/java/index.html for specific
> + Java documentation.
> +
> + Release Notes
> + -------------
> +
> + The full list of changes can be found at https://issues.apache.org/jira/browse/SHINDIG.
> +
> + System Requirements
> + -------------------
> +
> + Java:
> + 1.5 or above.
> + Servlet container:
> + Apache Tomcat or other compatible Java Servlet containers.
> + Memory:
> + No minimum requirement.
> + Disk:
> + No minimum requirement.
> + Operating System:
> + No minimum requirement. On Windows, Windows NT and above or Cygwin is
> + required for the startup scripts. Tested on Windows XP, Fedora Core
> + and Mac OS X.
> +
> + Installing Shindig Java
> + -----------------------
> +
> + Unzip the distribution archive, i.e. shindig-1.0-incubating-java.zip to
> + the directory you wish to install Shindig.
> +
> + The following explains how to deploy the Shindig war file to Apache
> + Tomcat. If you are using an other container, please read its documentation
> + on how to proceed.
> +
> + The easiest way to deploy Shindig on Apache Tomcat is to rename the
> + shindig-server-1.0-incubating.war file to ROOT.war and drop it in the
> + Tomcat webapps.
> + Be sure to delete $TOMCAT_HOME/webapps/ROOT dir before starting Tomcat.
> +
> + Licensing
> + ---------
> +
> + Please see the file called LICENSE.
> +
> + Shindig URLS
> + ------------
> +
> + Home Page: http://incubator.apache.org/shindig/
> + Downloads: http://incubator.apache.org/shindig/download/index.html
> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>
> Modified: incubator/shindig/branches/1.0.x-incubating/javascript/README
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/javascript/README?rev=770209&r1=770208&r2=770209&view=diff
> ==============================================================================
> --- incubator/shindig/branches/1.0.x-incubating/javascript/README (original)
> +++ incubator/shindig/branches/1.0.x-incubating/javascript/README Thu Apr 30 12:51:23 2009
> @@ -1,87 +1,109 @@
> -Using Shindig Gadget Container JavaScript
> -=========================================
> + Apache Shindig Javascript
>
> -1) Try out the samples.
> - A) Set up your own Shindig Gadget Server. See java/README for details.
> + What is it?
> + -----------
>
> - B) Assuming your server is running on http://yourserver:yourport/gadgets/...
> - you can hit these html files in your favorite browser to see your local
> - Shindig in action:
> + Shindig is a JavaScript container and implementations of the backend APIs
> + and proxy required for hosting OpenSocial applications.
>
> - (Note: yourserver:yourport defaults to localhost:8080 for the java server,
> - and just localhost for the php server)
> + This is the Javascript component of Shindig.
>
> - * http://yourserver:yourport/gadgets/files/container/sample1.html - basic container
> - * http://yourserver:yourport/gadgets/files/container/sample2.html - custom rendering
> - * http://yourserver:yourport/gadgets/files/container/sample3.html - custom layouts
> - * http://yourserver:yourport/gadgets/files/container/sample4.html - set pref
> - * http://yourserver:yourport/gadgets/files/container/sample5.html - set pref
> - * http://yourserver:yourport/gadgets/files/container/sample6.html - dynamic height
> - * http://yourserver:yourport/gadgets/files/container/sample7.html - set title
> + Documentation
> + -------------
>
> - These samples are very basic and aren't production-ready. Shindig will
> - include a more advanced container at a later date but it hasn't been
> - completed yet.
> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
> +
> + Using Shindig Gadget Container JavaScript
> + -----------------------------------------
>
> -2) Play around with the code.
> + 1) Try out the samples.
> + A) Set up your own Shindig Gadget Server. See java/README for details.
>
> - A) Create an HTML file including the following <head> boilerplate:
> - <script type="text/javascript" src="../../js/rpc.js?c=1"></script>
> - <script type="text/javascript" src="cookies.js"></script>
> - <script type="text/javascript" src="util.js"></script>
> - <script type="text/javascript" src="gadgets.js"></script>
> - <script type="text/javascript" src="cookiebaseduserprefstore.js"></script>
> + B) Assuming your server is running on http://yourserver:yourport/gadgets/...
> + you can hit these html files in your favorite browser to see your local
> + Shindig in action:
>
> - B) For each Gadget you wish to add to the page:
> - i) Create it. Example, for Gadget whose spec is at http://foo.com/spec.xml
> + (Note: yourserver:yourport defaults to localhost:8080 for the java server,
> + and just localhost for the php server)
>
> - var gadget = gadgets.container.createGadget(
> - {specUrl: "http://foo.com/spec.xml"});
> + * http://yourserver:yourport/gadgets/files/container/sample1.html - basic container
> + * http://yourserver:yourport/gadgets/files/container/sample2.html - custom rendering
> + * http://yourserver:yourport/gadgets/files/container/sample3.html - custom layouts
> + * http://yourserver:yourport/gadgets/files/container/sample4.html - set pref
> + * http://yourserver:yourport/gadgets/files/container/sample5.html - set pref
> + * http://yourserver:yourport/gadgets/files/container/sample6.html - dynamic height
> + * http://yourserver:yourport/gadgets/files/container/sample7.html - set title
>
> - Check "gadgets.js" for other options to be set in createGadget. If you are
> - debugging your own gadgets you can consider to use specVersion to get a more
> - optimal use of the cache. Alternatively, gadgets.container.setNoCache(1)
> + These samples are very basic and aren't production-ready. Shindig will
> + include a more advanced container at a later date but it hasn't been
> + completed yet.
>
> - ii) Add it to the container. Example:
> + 2) Play around with the code.
>
> - gadgets.container.addGadget(gadget);
> + A) Create an HTML file including the following <head> boilerplate:
> + <script type="text/javascript" src="../../js/rpc.js?c=1"></script>
> + <script type="text/javascript" src="cookies.js"></script>
> + <script type="text/javascript" src="util.js"></script>
> + <script type="text/javascript" src="gadgets.js"></script>
> + <script type="text/javascript" src="cookiebaseduserprefstore.js"></script>
>
> - If your setup is too complicated, you can need to tell each Gadget
> - where its server is. Example
> + B) For each Gadget you wish to add to the page:
> + i) Create it. Example, for Gadget whose spec is at http://foo.com/spec.xml
> +
> + var gadget = gadgets.container.createGadget(
> + {specUrl: "http://foo.com/spec.xml"});
> +
> + Check "gadgets.js" for other options to be set in createGadget. If you are
> + debugging your own gadgets you can consider to use specVersion to get a more
> + optimal use of the cache. Alternatively, gadgets.container.setNoCache(1)
> +
> + ii) Add it to the container. Example:
>
> - gadget.setServerBase("http://yourserver:yourport/gadgets/");
> + gadgets.container.addGadget(gadget);
> +
> + If your setup is too complicated, you can need to tell each Gadget
> + where its server is. Example
> +
> + gadget.setServerBase("http://yourserver:yourport/gadgets/");
>
> - iii) Ensure the Gadget's chrome ID is defined. This is the ID of the
> - elements in which the Gadget is rendered. The way these are specified
> - differs depending on the LayoutManager being used. Example with default
> - LayoutManager:
> + iii) Ensure the Gadget's chrome ID is defined. This is the ID of the
> + elements in which the Gadget is rendered. The way these are specified
> + differs depending on the LayoutManager being used. Example with default
> + LayoutManager:
>
> - gadgets.container.layoutManager.setGadgetChromeIds([ 'gadget-id-1' ]);
> + gadgets.container.layoutManager.setGadgetChromeIds([ 'gadget-id-1' ]);
>
> - iv) Render it. The chrome element must exist when this call is performed
> - (ie. this must occur onLoad of the document.body or in inline script).
> + iv) Render it. The chrome element must exist when this call is performed
> + (ie. this must occur onLoad of the document.body or in inline script).
>
> - gadgets.container.renderGadget(gadget);
> + gadgets.container.renderGadget(gadget);
>
> - You may also render several added Gadgets at once:
> + You may also render several added Gadgets at once:
>
> - gadgets.container.renderGadgets();
> + gadgets.container.renderGadgets();
>
> - C) Explore samples 2, 3, and 4 for examples using different LayoutManagers
> - and supporting UserPrefs storage.
> + C) Explore samples 2, 3, and 4 for examples using different LayoutManagers
> + and supporting UserPrefs storage.
>
> -4) Run the opensocial sample container
> - A) Set up your own Shindig Gadget Server. See java/README for details. (If you
> - are using the java based server make sure you run with mvn jetty:run-war)
> + 4) Run the opensocial sample container
> + A) Set up your own Shindig Gadget Server. See java/README for details. (If you
> + are using the java based server make sure you run with mvn jetty:run-war)
>
> - B) Hit the sample container at
> - http://yourserver:yourport/gadgets/files/samplecontainer/samplecontainer.html
> + B) Hit the sample container at
> + http://yourserver:yourport/gadgets/files/samplecontainer/samplecontainer.html
>
> - C) See the sample container help document for more details on how it works:
> - http://yourserver:yourport/gadgets/files/samplecontainer/getting-started.html
> + C) See the sample container help document for more details on how it works:
> + http://yourserver:yourport/gadgets/files/samplecontainer/getting-started.html
>
> - D) Get, and try to run, coderunner.xml and compliancetests.xml from the project
> - http://opensocial-resources.googlecode.com/
> + D) Get, and try to run, coderunner.xml and compliancetests.xml from the project
> + http://opensocial-resources.googlecode.com/
>
> + Shindig URLS
> + ------------
>
> -For more information, see http://incubator.apache.org/projects/shindig.html
> + Home Page: http://incubator.apache.org/shindig/
> + Downloads: http://incubator.apache.org/shindig/download/index.html
> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>
> Copied: incubator/shindig/branches/1.0.x-incubating/php/NOTICE (from r770145, incubator/shindig/branches/1.0.x-incubating/NOTICE)
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/php/NOTICE?p2=incubator/shindig/branches/1.0.x-incubating/php/NOTICE&p1=incubator/shindig/branches/1.0.x-incubating/NOTICE&r1=770145&r2=770209&rev=770209&view=diff
> ==============================================================================
> --- incubator/shindig/branches/1.0.x-incubating/NOTICE (original)
> +++ incubator/shindig/branches/1.0.x-incubating/php/NOTICE Thu Apr 30 12:51:23 2009
> @@ -1,16 +1,21 @@
> -Apache Shindig
> -Copyright 2009 The Apache Software Foundation
> + =========================================================================
> + == NOTICE file corresponding to the section 4 d of ==
> + == the Apache License, Version 2.0, ==
> + == in this case for the Apache Shindig distribution. ==
> + =========================================================================
>
> -This product includes software developed at
> -The Apache Software Foundation (http://www.apache.org/).
> -
> ------------------------------------------------------------
> This product includes software (Gadget Server, Gadget Container)
> originally developed by Google Inc. (http://code.google.com/) and licensed
> to the ASF as initial contribution for Shindig.
>
> -This product includes the jquery.js file,
> -Copyright (c) 2007 John Resig, http://jquery.com/
> +This product includes software developed at
> +The Apache Software Foundation (http://www.apache.org/).
> +
> +This product includes software (Zend) developed by
> +Zend Technologies Ltd (http://framework.zend.com/).
> +
> +This product includes software (PHPUnit) developed by
> +Sebastian Bergmann (http://www.phpunit.de/).
>
> This distribution includes cryptographic software. The country in
> which you currently reside may have restrictions on the import,
> @@ -34,9 +39,6 @@
> The following provides more details on the included cryptographic
> software:
>
> - Apache Shindig interfaces with the Java JCE APIs to provide
> - encryption of messages using the AES standard.
> -
> Apache Shindig PHP interfaces with the mcrypt API
> <http://mcrypt.sourceforge.net/> to provide encryption
> of messages using the AES standard.
>
> Modified: incubator/shindig/branches/1.0.x-incubating/php/README
> URL: http://svn.apache.org/viewvc/incubator/shindig/branches/1.0.x-incubating/php/README?rev=770209&r1=770208&r2=770209&view=diff
> ==============================================================================
> --- incubator/shindig/branches/1.0.x-incubating/php/README (original)
> +++ incubator/shindig/branches/1.0.x-incubating/php/README Thu Apr 30 12:51:23 2009
> @@ -1,109 +1,120 @@
> -Welcome to Apache Shindig!
> + Apache Shindig PHP
>
> -* Read javascript/README for instructions for using the Shindig Gadget
> + What is it?
> + -----------
> +
> + Shindig is a JavaScript container and implementations of the backend APIs
> + and proxy required for hosting OpenSocial applications.
> +
> + This is the PHP implementation of Shindig. If you are looking to the Java
> + implementation, please visit our website.
> +
> + Documentation
> + -------------
> +
> + The most up-to-date documentation can be found at http://incubator.apache.org/shindig/
> + and at http://incubator.apache.org/shindig/developers/php/index.html
> + for specific PHP documentation.
> +
> + Read javascript/README for instructions for using the Shindig Gadget
> Container JavaScript to enable your page to render Gadgets.
> -* Read the instructions below for how to use PHP Shindig
> -* For more information, see http://incubator.apache.org/shindig/
>
> + Release Notes
> + -------------
>
> -Installing and Running The PHP Shindig Gadget Server
> -============================================
> + The full list of changes can be found at https://issues.apache.org/jira/browse/SHINDIG.
>
> -Prequisites before building Shindig for PHP
> -============================================
> -In order to build and run Shindig for PHP, you must have the following:
> -
> -- A Subversion client installed in order to checkout the code.
> - Instructions for downloading and installing Subversion can be found here:
> - http://subversion.tigris.org/
> -- Apache with mod_rewrite enabled.
> -- PHP 5.2.x with the json, simplexml, mcrypt and curl extentions enabled.
> -
> -
> -Getting the code (if you're running from svn and not a release tarball)
> -============================================
> -Create a subdirectory in your web document root, e.g. /var/www/html and
> -checkout the Shindig code from its Subversion repository
> -
> -mkdir /var/www/html/shindig
> -cd /var/www/html/shindig
> -svn co http://svn.apache.org/repos/asf/incubator/shindig/trunk/ .
> -
> -
> -Running Shindig from a release download
> -============================================
> -
> -The instructions are identical as when running from an svn checkout, except
> -that the /shindig/php directory in the virtual host becomes just /shindig, ie:
> -
> - <VirtualHost your_ip:your_port>
> - ServerName your.host
> - DocumentRoot /var/www/html/shindig
> - ... other normal settings in vhosts...
> - <Directory />
> - AllowOverride All
> - </Directory>
> - </VirtualHost>
> -
> -Running Shindig from an svn checkout
> -============================================
> -With PHP There is no need to build anything - the source code
> -is already built.
> -
> -To run the code, you have several options:
> -
> -a. Create a new virtual host
> -
> -Point your apache to the php dir with a virtual host like:
> -
> - <VirtualHost your_ip:your_port>
> - ServerName your.host
> - DocumentRoot /var/www/html/shindig/php
> - ... other normal settings in vhosts...
> - <Directory />
> - AllowOverride All
> - </Directory>
> - </VirtualHost>
> -
> -
> -Restart apache, and point your browser to:
> -
> -http://<your.host>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
> -
> -you should see something like this:
> -http://shindig.chabotc.com/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
> -
> -b. Run with an existing host
> -
> -If you cannot/don't want to create a virtual host, you can edit the file php/config/container.php
> -or php/config/local.php (see the comments php/config/container.php for documentation of the
> -configuration system) and change the web_prefix setting to '/shindig/php'.
> -
> -In this case, you should also change all paths in shindig/config/container.js
> -(see the comments there for documentation of the JSON configuration system).
> -
> -Then you can run the gadget by pointing your browser to:
> -
> -http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
> -
> -Going forward
> -============================================
> -Check out the php/config/container.php file, in local.php you only have to specificy the
> -fields you want to overwrite with other values, for example on a production system you
> -would probably want to have something like:
> - $shindigConfig = array(
> - 'debug' => false,
> - 'allow_plaintext_token' => false,
> - 'token_cipher_key' => 'MySecretKey',
> - 'token_hmac_key' => 'MyOtherSecret',
> - 'private_key_phrase' => 'MyCertificatePassword',
> - 'person_service' => 'MyPeopleService',
> - 'activity_service' => 'MyActivitiesService',
> - 'app_data_service' => 'MyAppDataService',
> - 'messages_service' => 'MyMessagesService',
> - 'oauth_lookup_service' => 'MyOAuthLookupService'
> - 'xrds_location' => 'http://www.mycontainer.com/xrds',
> - 'check_file_exists' => false
> - );
> + System Requirements
> + -------------------
> +
> + PHP:
> + 5.2.x or above with the json, simplexml, mcrypt and curl extentions
> + enabled.
> + Web server:
> + Apache with mod_rewrite enabled.
> + Memory:
> + No minimum requirement.
> + Disk:
> + No minimum requirement.
> + Operating System:
> + No minimum requirement. On Windows, Windows NT and above or Cygwin is
> + required for the startup scripts. Tested on Windows XP, Fedora Core
> + and Mac OS X.
> +
> + Installing Shindig
> + ------------------
> +
> + Unzip the distribution archive, i.e. shindig-1.0-incubating-php.zip to
> + the web document root, e.g. /var/www/html.
> +
> + Rename the created shindig-1.0-incubating-php dir to shindig.
> +
> + a. Create a new virtual host
> +
> + Point your Apache to the shindig dir with a virtual host like:
> +
> + <VirtualHost your_ip:your_port>
> + ServerName your.host
> + DocumentRoot /var/www/html/shindig
> + ... other normal settings in vhosts...
> + <Directory>
> + AllowOverride All
> + </Directory>
> + </VirtualHost>
> +
> + Restart apache, and point your browser to:
> +
> + http://<your.host>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
> +
> + b. Run with an existing host
> +
> + If you cannot/don't want to create a virtual host, you can edit the file
> + php/config/container.php or php/config/local.php (see the comments
> + php/config/container.php for documentation of the configuration system)
> + and change the web_prefix setting to '/shindig/php'.
> +
> + In this case, you should also change all paths in shindig/config/container.js
> + (see the comments there for documentation of the JSON configuration system).
> +
> + Then you can run the gadget by pointing your browser to:
> +
> + http://<your.host>/shindig/php/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
> +
> + Going forward
> + -------------
> +
> + Check out the php/config/container.php file, in local.php you only have
> + to specificy the fields you want to overwrite with other values, for
> + example on a production system you would probably want to have something
> + like:
> + $shindigConfig = array(
> + 'debug' => false,
> + 'allow_plaintext_token' => false,
> + 'token_cipher_key' => 'MySecretKey',
> + 'token_hmac_key' => 'MyOtherSecret',
> + 'private_key_phrase' => 'MyCertificatePassword',
> + 'person_service' => 'MyPeopleService',
> + 'activity_service' => 'MyActivitiesService',
> + 'app_data_service' => 'MyAppDataService',
> + 'messages_service' => 'MyMessagesService',
> + 'oauth_lookup_service' => 'MyOAuthLookupService'
> + 'xrds_location' => 'http://www.mycontainer.com/xrds',
> + 'check_file_exists' => false
> + );
>
> -And then implement your own service and oauth lookup classes.
> + And then implement your own service and oauth lookup classes.
> +
> + Licensing
> + ---------
> +
> + Please see the file called LICENSE.
> +
> + Shindig URLS
> + ------------
> +
> + Home Page: http://incubator.apache.org/shindig/
> + Downloads: http://incubator.apache.org/shindig/download/index.html
> + Mailing Lists: http://incubator.apache.org/shindig/mail-lists.html
> + Source Code: http://svn.apache.org/repos/asf/incubator/shindig/
> + Issue Tracking: https://issues.apache.org/jira/browse/SHINDIG
> + Wiki: http://cwiki.apache.org/confluence/display/SHINDIG/
>
>
>