OpenAjax Metadata Specification Library Metadata

From MemberWiki

Jump to: navigation, search

Notes:

Here is the proposed way for the IDE WG to edit this specification:

  • All textual content that has normal text properties (i.e., black) and has no colored status text (e.g., does not say Tentatively approved or Approved) represents preliminary proposed text that requires further review and discussion.
  • Members of OpenAjax Alliance are encourage to place inline comments into this document, preferably by identifying your name or initials before your comment, such as "Mary: This bullet should be moved above previous bullet".
  • When an item has been deemed complete by the WG chair due to committee consensus, then the annotation Approved will be placed at the end of an approved block of text (e.g., paragraph or bullet). Note that during the development phase of this specification, the group can change its mind and "un-approve" text that was previously approved.
  • When an item has been deemed near complete by the WG chair due to committee consensus, but further review is necessary (e.g., review final wording), then the annotation Tentatively approved will be placed at the end of given block of text (e.g., paragraph or bullet).
<--previous       contents--^       next-->


[edit]

4 Library Metadata

(under construction)

This would be a simple XML file that typically exists in the root folder of an Ajax library distribution and provides a small amount of general metadata about the given library, such as its prefix, namespaceURI, and version, all of which are expected to align with entries in the OpenAjax Registry and the parameters that are passed to OpenAjax.hub.registerLibrary().

For example: 

<library xmlns="http://openajax.org/metadata"
  prefix=""
  namespaceURI=""
  version="" 
  ...probably other things such as pointers to the website...

  <!-- 2008-04-03 DRAFT CONSENSUS -->
  <eventHandlersPatterns>
    <addEventHandlerPattern pattern="...string with variables..." />
    <removeEventHandlerPattern pattern="...string with variables..." />
  </eventHandlersPatterns>
/>

2008-04-03 DRAFT CONSENSUS: <class>/<events>/<event>/<parameters>/<parameter> (for proprietary event systems within each toolkit) and <topics>/<topic> (for OpenAjax Hub events). <topics> can be a child of <widget> or <class>. Also, <eventHandlersPatterns</{<addEventHandlerPattern>,<removeEventHandlerPattern>} where these elements are a child of <library> and identify pattern naming conventions for the add/remove subscriber methods, such as '{token} = OpenAjax.hub.subscribe({name}, {handler})'.

[edit]

The <library> element 

library_element = element library {
  library_content  &  library_attributes  &  foreign_nodes
}
library_content = (
  eventHandlerPatterns_element*  & 
  descriptive_elements 
)
library_attributes = (
  prefix?  &  namespaceURI?  &  version?
  # FIXME: Probably other things, copied from Registry
)

Need to add sections for eventHandlersPatterns, addEventHandlerPattern and removeEventHandlerPattern

Retrieved from "http://www.openajaxalliance.org/member/wiki/OpenAjax_Metadata_Specification_Library_Metadata"
Personal tools