Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
src
LICENSE
NOTICE
README
pom.xml

README

                          Apache Shindig Features

  What is it?
  -----------

  Shindig is a JavaScript container and implementations of the backend APIs
  and proxy required for hosting OpenSocial applications.

  This is the features component of Shindig.

  Documentation
  -------------

  The most up-to-date documentation can be found at http://shindig.apache.org/

  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.

  Licensing
  ---------

  Please see the file called LICENSE.


  Shindig URLS
  ------------

  Home Page:          http://shindig.apache.org/
  Downloads:          http://shindig.apache.org/download/index.html
  Mailing Lists:      http://shindig.apache.org/mail-lists.html
  Source Code:        http://svn.apache.org/repos/asf/shindig/
  Issue Tracking:     https://issues.apache.org/jira/browse/SHINDIG
  Wiki:               http://cwiki.apache.org/confluence/display/SHINDIG/
Something went wrong with that request. Please try again.