Additional Widget Properties

From MemberWiki

Jump to: navigation, search

The Gadgets TF recently reviewed the OpenAjax Metadata Specification Widget Metadata and created the list of additional attributes that would be helpful when translating between widget systems.

Contents

Translation

A processing engine MUST apply localization transformation to <content>, <javascript>, <description>, <title>, <remarks>, <example>, <license>, <author>. The <include> element references an external file whose content is to be transcluded into the current document; therefore included content MUST also be processed following the same localization transformations.

Additional Widget Attributes & Subelements

  • 'name' and title on <widget> - (Detailed note) If either is missing, then tools SHOULD default to the other one
  • directoryTitle - Optional string that provides the title that should be displayed for your gadget in the content directory.
  • singleton - Optional boolean that specifies whether users can add a gadget multiple times from a directory. The default is false, meaning that by default, gadgets can be added more than once. Directories can handle this attribute however they choose. For example, the content directory handles singleton="true" by graying out and displaying the text "Added" for gadgets that have already been added. Note that changes to this attribute may not be picked up by directories right away. This attribute doesn't prevent users from adding gadgets multiple times through the developer gadget or Add by URL. Consequently, you still need to write your gadget to support multiple instances.

Additional Author Element Attributes & Subelements

  • location - A subelement of author tag which specifies the location of the author (e.g. Massachusetts)
  • photo - URL to a photo (70x100 PNG format preferred, but JPG/GIF are also supported).
  • aboutMe - A subelement of author which is a statement about yourself (try to keep to ~500 characters).
  • quote - A subelement of author which is a quote you'd like to include (try to keep to ~300 characters)

Additional Icon Element Attributes & Subelements

  • screenshot, thumbnail - introduce a 'role' attribute in the icon metadata [1] that specifies one of the following:
    • screenshot
    • thumbnail

Additional Content Element Attributes & Subelements

  • mode - Previously IDE WG approved support for view vs edit vs help, but haven't yet agreed on markup. Gadgets TF proposes mode="view|edit|help" on <content> element

Additional Property Element Attributes & Subelements

NOTE: The support for URL based widgets has been removed from the widget metadata specification, without that support the urlparam does not have significance. JON: My memory is failing. Why was it removed? Perhaps it was removed temporarily until Gadgets TF made an explicit proposal? URL based widgets are an absolute requirement for mashups. It is a key feature of Google Gadgets, implemented in our open source, included in QED, and various categories of widgets can only be accomplished with URL based widgets

Stew: The Gadgets TF Proposal is located here: /member/wiki/IBM_Widgets_proposal#Widget_Content

  • urlparam - parameter name for content type="url"
Personal tools