OpenAjax Metadata Specification Inclusion

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

Chapter 10: Inclusion

Introduction

This chapter describes the metadata inclusion feature using the <include> element.

Element and attribute collections defined in this chapter

The following is the schema definition for inclusion_elements, which is referenced by other elements defined in other chapters:

inclusion_elements = ( include_element* )

Elements defined in this chapter

<include>

include_element = element include {
  include_content  &  include_attributes  &  foreign_attributes
}
include_content = (
  empty 
)
include_attributes = (
  src
)

The <include> element references an external file whose content that is to be transcluded into the current document.

The referenced document MUST be a well-formed XML file with an <fragment> root element 20080520: Tentative approval on <fragment> element in the Editor: include words that say "in the OpenAjax Metadata namespace" namespace. If the referenced document does not meet the criteria, the reference file MUST be ignored and null content should be used to replace the <include> element.

If the referenced document is satisfactory, then the infoset of the metadata file MUST be modified such that the <include> element is replaced by the set of child nodes of the root <fragment> element from the referenced file.

It is incumbent on metadata authors to ensure that the post-transclusion document is valid against the metadata language schema.is this soft processing model OK?

The src attribute specifies the URI of the file whose content is to be transcluded into this document.

include parse='text' or 'xml' like XInclude? Or perhaps if you want text inclusion, then bracket the content with CDATA?

Need to figure out how best to reference XInclude for some of the details about how to process the content

2008-05-13 Tentatively approved: Will have an <include> element.

<fragment>

fragment_element = element fragment {
  anything
}

The <fragment> element is the root element for files that are referenced by the <include> element.

Personal tools