Versions Compared

Old Version 14

changes.mady.by.user Michael Hermanto

Saved on

compared with

New Version Current

changes.mady.by.user Michael Hermanto

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Proposal Details

Overview

The goal is to compile requirements and use cases that belong in the formal specification, and to identify authors of the original Common Container code, and developers who are interested in contributing to formalizing the specification.  This proposal is the starting point to gather the use cases, and existing documentation around the common container, which while existing in implementation, has little public documentation available.  

There was discussion at the Open Social 2.0 kickoff meeting that there was a need for a formal specification around the new Common Container JS code, before new proposals of additional container services could be made as addendums to a formal spec Common-Container.xml

Requirements

The framework lives in the container page and be the user-facing API to container developers. It provides functionalities at the top-most-level giving all abstraction of work needed to make gadget navigation (insertion/deletion) happen and to ensure that navigated gadgets continue to work. The framework insulates containers from releases that require simultaneous changes to the container and changes affecting the gadget render. Additionally, the framework allows container pages to be silently-updated by a new version of Shindig, ie: one release upgrades all containers. The framework should also provide a "common" ground for future container-and-gadget related improvements. The framework does not provide a layout mechanism in which multiple gadgets are draw on the page; this is left to the container developer to do whatever via element containing the gadget iframe.

Use Cases

  • To provide insert/open and remove/close a gadget into/from a container page, given all customizable parameters.
  • To provide automatic setup for container-and-gadget interaction , via gadgets.rpc.
  • To ensure inserted gadgets continue to work, in light of expiring security tokens.
  • To instantaneously insert a gadget, via pre-loading mechanism.
  • To facilitate latency timing.

...

Motivations, Features

Refer to [this|https://cwiki.apache.org/confluence/display/SHINDIG/Common+Container].

...