OpenAjax Metadata Specification Topics

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-->


Contents

7 Topics

Introduction

This chapter describes the various elements and attributes that describe publishing and subscribing behavior, in a manner that is compatible with the OpenAjax Hub.

There are two options within OpenAjax Metadata for specifying publishing and subscribing behavior:

  • The <topic> element, with its name, publish and subscribe attributes
  • The <property> elements, with its publish, subscribe and topic attributes

Conformant software tools MUST take the union of the topic metadata from all of the <topic> and < property> elements within the metadata.

Subsequent sections describe the relevant attributes and elements.

Elements defined in this chapter

<topic> 

topic_element = element topic {
  topic_content  &  topic_attributes  &  foreign_nodes
}
topic_content = (
  parameter_element*  &  parameters_element*  &  property_element*  &  properties_element*  &  
  returnType_element*  &  returnTypes_element*  &  
  descriptive_elements  &  compatibility_elements
)
topic_attributes = (
  datatype?  &  name  &  
  pubsub_attributes
  # FIXME: Maybe 'host' for Comet is added to Hub 1.1?
)

The <topic> element describes not yet written, but meant for OAHub topics.

Need to include attribute descriptions

2008-??-??: Tentatively approved: Sometime in April/May we approved <topic name= publish= subscribe= datatype=

<topics> 

topics_element = element topics {
    topics_content  &  topics_attributes  &  foreign_nodes
}
topics_content = (
  descriptive_elements  &  
  topic_element*
)
topics_attributes = (
  name?
)

The <topics> element holds zero or more <topic> child elements. (Note: See the section titled "Plural and singular elements" in the Introduction chapter for a discussion of plural elements such as <topics>.)

The optional name attribute is meant to allow for providing a unique name for this particular <topics> element in case multiple <topics> are specified.

Retrieved from "http://www.openajax.org/member/wiki/OpenAjax_Metadata_Specification_Topics"
Personal tools