Shindig
  1. Shindig
  2. SHINDIG-1523

allow localizable params in feature specification

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.0.0, 2.0.2, 2.5.0-beta1
    • Fix Version/s: 2.5.0
    • Component/s: Java
    • Labels:
    • Environment:
      All

      Description

      Allow the localization of feature parameters. This allows us to provide parameters that can be localized when the gadget definition is processed. In the example below, _MSG_mytest_ will get replaced with "Search" from the bundle. The localized XML inside the CDATA can then be consumed by the container.

      Sample gadget definition:

      <?xml version="1.0" encoding="UTF-8" ?>
      <Module>
      <ModulePrefs title="Hello" description="Message ">
      <Locale messages="messages.xml"/>

      <Require feature="dynamic-height" />
      <Require feature="setprefs" />
      <Optional feature="opensearch">
      <Param name="opensearch-description"><![CDATA[<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
      <ShortName>_MSG_mytest_</ShortName>
      <Description>Realtime Twitter Search</Description>
      <Url type="application/atom+xml" method="get" template="http://search.twitter.com/search.atom?q=

      {searchTerms}

      "/>
      <Image width="16" height="16">http://search.twitter.com/favicon.png</Image>
      <InputEncoding>UTF-8</InputEncoding>
      <SearchForm>http://search.twitter.com/</SearchForm>

      </OpenSearchDescription>]]></Param>
      </Optional>

      </ModulePrefs>

      <Content type="url" href="http://www.example.com/search/index.html" />
      </Module>

      Sample message bundle:
      <?xml version="1.0" encoding="UTF-8"?>
      <messagebundle>
      <msg name="mytest">
      Search
      </msg>
      </messagebundle>

      1. paramloc.txt
        4 kB
        Igor Belakovskiy

        Activity

        Hide
        Igor Belakovskiy added a comment -

        Changes to org.apache.shindig.gadgets.spec.Feature, and accompanying tests. This assumes that parameters are stored as objects, and not as strings. This allows serialized XML objects to be stored as JSON.

        Show
        Igor Belakovskiy added a comment - Changes to org.apache.shindig.gadgets.spec.Feature, and accompanying tests. This assumes that parameters are stored as objects, and not as strings. This allows serialized XML objects to be stored as JSON.
        Hide
        Igor Belakovskiy added a comment -

        Spoke to Ziv Horesh, will be modifying patch to parse XML as string, and pass through as a string to the container, instead of passing it through as a JSON object. Conversion will occur on the container side.

        Show
        Igor Belakovskiy added a comment - Spoke to Ziv Horesh, will be modifying patch to parse XML as string, and pass through as a string to the container, instead of passing it through as a JSON object. Conversion will occur on the container side.
        Hide
        Igor Belakovskiy added a comment -

        Incorporated the latest round of Ziv's comments.

        Show
        Igor Belakovskiy added a comment - Incorporated the latest round of Ziv's comments.
        Hide
        Igor Belakovskiy added a comment -

        Allow localization of feature params. Adds substitution to module prefs and a setter to the feature class.

        Show
        Igor Belakovskiy added a comment - Allow localization of feature params. Adds substitution to module prefs and a setter to the feature class.
        Hide
        Ryan Baxter added a comment -

        Looks like this was already fixed

        Show
        Ryan Baxter added a comment - Looks like this was already fixed

          People

          • Assignee:
            Unassigned
            Reporter:
            Igor Belakovskiy
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development