[Search] [txt|pdf|bibtex] [Tracker] [Email] [Nits]

Versions: 00 01                                                         
Network Working Group                                           R. Sayre
Internet-Draft                                          October 25, 2005
Expires: April 28, 2006


                           APP Outline Format
              draft-sayre-atompub-protocol-outline-00.txt

Status of this Memo

   By submitting this Internet-Draft, each author represents that any
   applicable patent or other IPR claims of which he or she is aware
   have been or will be disclosed, and any of which he or she becomes
   aware will be disclosed, in accordance with Section 6 of BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF), its areas, and its working groups.  Note that
   other groups may also distribute working documents as Internet-
   Drafts.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   The list of current Internet-Drafts can be accessed at
   http://www.ietf.org/ietf/1id-abstracts.txt.

   The list of Internet-Draft Shadow Directories can be accessed at
   http://www.ietf.org/shadow.html.

   This Internet-Draft will expire on April 28, 2006.

Copyright Notice

   Copyright (C) The Internet Society (2005).

Abstract

   This memo presents an XML outline format.  The format is geared
   towards describing resource layout on Atom Publishing Protocol
   servers.

Editorial Note

   To provide feedback on this Internet-Draft, join the atom-protocol
   mailing list <http://www.imc.org/atom-protocol/index.html>.




Sayre                    Expires April 28, 2006                 [Page 1]


Internet-Draft             APP Outline Format               October 2005


Table of Contents

   1.   Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
   2.   Notational Conventions . . . . . . . . . . . . . . . . . . . . 3
   3.   APP Outline Documents  . . . . . . . . . . . . . . . . . . . . 3
   4.   User Agent Conformance . . . . . . . . . . . . . . . . . . . . 4
   5.   Relax NG Schema  . . . . . . . . . . . . . . . . . . . . . . . 5
   6.   Sample APP Outline Documents . . . . . . . . . . . . . . . . . 5
   7.   Security Considerations  . . . . . . . . . . . . . . . . . . . 6
   8.   IANA Considerations  . . . . . . . . . . . . . . . . . . . . . 6
   9.   Normative References . . . . . . . . . . . . . . . . . . . . . 6
        Author's Address . . . . . . . . . . . . . . . . . . . . . . . 7
        Intellectual Property and Copyright Statements . . . . . . . . 8






































Sayre                    Expires April 28, 2006                 [Page 2]


Internet-Draft             APP Outline Format               October 2005


1.  Introduction

   Many applications require an outline of resources.  XML [W3C.REC-xml-
   20040204] documents are organized hierarchically, but XML does not
   differentiate between elements serving as structural divisions and
   elements serving as structural properties.  This specification
   defines two elements which serve as structural divisions, provides an
   associated XML document structure, and defines minimal user agent
   conformance rules.

   Example APP Outline Document:

   <app>
     <outline text="A Server" href="http://example.com">
       <outline text="xyzzy" href="http://example.org"/>
       <outline text="thud" href="http://example.net"/>
     </outline>
     <outline class="special details" text="Some details...">
       <outline text="xyzzy" href="http://example.org/details"/>
       <outline text="thud" href="http://example.net/details"/>
     </outline>
   </app>

2.  Notational Conventions

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in BCP 14, [RFC2119], as
   scoped to those conformance targets.

   This specification includes a normative RELAX NG Compact schema
   [RELAX-NG].

   The terms 'URI' and 'IRI' are shorthand for the identifiers specified
   in [RFC3986] and [RFC3987].

3.  APP Outline Documents

   APP Outline Documents MUST be well-formed XML [W3C.REC-xml-20040204].

   The root element of an APP Outline Document is "<app>".  This
   specification does not define any attributes of the <app> element,
   but the element MAY have any number of attributes.

   Zero or more <outline> elements MAY appear as child elements of
   <app>.  Also, <outline> elements MAY contain zero or more <outline>
   elements.  This specification defines three attributes of the
   <outline> element. <outline> elements MUST contain at least one of



Sayre                    Expires April 28, 2006                 [Page 3]


Internet-Draft             APP Outline Format               October 2005


   those attributes.  Outline properties that are too large to
   efficiently include in attribute values MAY appear as child elements
   of the outline element.

3.1  The 'text' Attribute

   The 'text' attribute contains a short string describing the outline
   element.  Entities such as "&amp;" and "&lt;" represent their
   corresponding characters ("&" and "<" respectively), not markup.

3.2  The 'href' Attribute

   The 'href' attribute contains an IRI reference interpreted relative
   to the in-scope base IRI [RFC3987].  Most protocols require URIs
   [RFC3986], so IRIs usually need to be converted to URIs before being
   dereferenced.

3.3  The 'class' Attribute

   The 'class' attribute contains a space-separated list of strings used
   to classify the outline element.

   <app> elements MAY contain any number of elements that are not
   <outline> elements, and <outline> elements MAY contain any number of
   elements that are not <outline> elements.

4.  User Agent Conformance

   Foreign markup is markup not defined by this specification.

   Software consuming APP Outline Documents MUST NOT not halt processing
   when any foreign markup is encountered.  Software MAY ignore the
   markup and process any content of foreign elements as though the
   surrounding markup were not present.  For example, software may
   process

       <app>
         <group>
            <outline text="hmm" href="http://example.com"/>
         </group>
       </app>

   as though the <group> element was not present.

   Software conforming to this specification MAY halt processing when
   documents that do not conform to the schema below are encountered.





Sayre                    Expires April 28, 2006                 [Page 4]


Internet-Draft             APP Outline Format               October 2005


5.  Relax NG Schema

   This schema is normative.

   start = app

   app = element app {
     anyAttribute*,
     (outline* & anyElement*)
   }

   outline = element outline {
     (textAtt | classAtt | hrefAtt), anyAttribute*,
     (outline* & anyElement*)
   }

   textAtt = attribute text { text }

   hrefAtt = attribute href { text }

   classAtt = attribute class { text }

   anyElement = element * { (anyAttribute | text | anyElement)* }

   anyAttribute = attribute * { text }

6.  Sample APP Outline Documents

   Simple APP Outline Document:

   <app>
     <outline text="baz">
       <outline href="http://example.org"/>
       <outline text="thud" href="http://example.net"/>
     </outline>
   </app>

   Valid APP Outline Document with extensions:

   <app foo="bar">
     <some-extension>hmm</some-extension>
     <outline text="baz" quux="quuux" href="http://example.com">
       <outline class="garply" text="xyzzy" href="http://example.org"/>
       <outline class="foo bar" text="thud" href="http://example.net"/>
       <some-other-extension>hmm</some-other-extension>
     </outline>
   </app>




Sayre                    Expires April 28, 2006                 [Page 5]


Internet-Draft             APP Outline Format               October 2005


7.  Security Considerations

   TBD.

8.  IANA Considerations

   An APP Outline Document can be identified with the following media
   type:

   MIME media type name: application
   MIME subtype name: outline+xml
   Mandatory parameters: None.
   Optional parameters:
      "charset": This parameter has identical semantics to the charset
         parameter of the "application/xml" media type as specified in
         [RFC3023].
   Encoding considerations: Identical to those of "application/xml" as
      described in [RFC3023], section 3.2.
   Security considerations: As defined in this specification.
      In addition, as this media type uses the "+xml" convention, it
      shares the same security considerations as described in [RFC3023],
      section 10.
   Interoperability considerations: There are no known interoperability
      issues.
   Published specification: This specification.
   Applications that use this media type: No known applications
      currently use this media type.

   Additional information:

   Magic number(s): As specified for "application/xml" in [RFC3023],
      section 3.2.
   File extension: .ao
   Fragment identifiers: As specified for "application/xml" in
      [RFC3023], section 5.
   Base URI: As specified in [RFC3023], section 6.
   Macintosh File Type code: TEXT
   Person and email address to contact for further information: Robert
      Sayre <rfsayre@boswijck.com>
   Intended usage: COMMON
   Author/Change controller: IESG

9.  Normative References

   [RELAX-NG]
              Clark, J., "RELAX NG Compact Syntax", December 2001.

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate



Sayre                    Expires April 28, 2006                 [Page 6]


Internet-Draft             APP Outline Format               October 2005


              Requirement Levels", BCP 14, RFC 2119, March 1997.

   [RFC3023]  Murata, M., St. Laurent, S., and D. Kohn, "XML Media
              Types", RFC 3023, January 2001.

   [RFC3986]  Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
              Resource Identifier (URI): Generic Syntax", STD 66,
              RFC 3986, January 2005.

   [RFC3987]  Duerst, M. and M. Suignard, "Internationalized Resource
              Identifiers (IRIs)", RFC 3987, January 2005.

   [W3C.REC-xml-20040204]
              Yergeau, F., Paoli, J., Sperberg-McQueen, C., Bray, T.,
              and E. Maler, "Extensible Markup Language (XML) 1.0 (Third
              Edition)", W3C REC REC-xml-20040204, February 2004.


Author's Address

   Robert Sayre

   Email: rfsayre@boswijck.com
   URI:   http://boswijck.com



























Sayre                    Expires April 28, 2006                 [Page 7]


Internet-Draft             APP Outline Format               October 2005


Intellectual Property Statement

   The IETF takes no position regarding the validity or scope of any
   Intellectual Property Rights or other rights that might be claimed to
   pertain to the implementation or use of the technology described in
   this document or the extent to which any license under such rights
   might or might not be available; nor does it represent that it has
   made any independent effort to identify any such rights.  Information
   on the procedures with respect to rights in RFC documents can be
   found in BCP 78 and BCP 79.

   Copies of IPR disclosures made to the IETF Secretariat and any
   assurances of licenses to be made available, or the result of an
   attempt made to obtain a general license or permission for the use of
   such proprietary rights by implementers or users of this
   specification can be obtained from the IETF on-line IPR repository at
   http://www.ietf.org/ipr.

   The IETF invites any interested party to bring to its attention any
   copyrights, patents or patent applications, or other proprietary
   rights that may cover technology that may be required to implement
   this standard.  Please address the information to the IETF at
   ietf-ipr@ietf.org.

   The IETF has been notified of intellectual property rights claimed in
   regard to some or all of the specification contained in this
   document.  For more information consult the online list of claimed
   rights.


Disclaimer of Validity

   This document and the information contained herein are provided on an
   "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
   OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
   ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
   INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
   INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
   WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.


Copyright Statement

   Copyright (C) The Internet Society (2005).  This document is subject
   to the rights, licenses and restrictions contained in BCP 78, and
   except as set forth therein, the authors retain all their rights.





Sayre                    Expires April 28, 2006                 [Page 8]


Internet-Draft             APP Outline Format               October 2005


Acknowledgment

   Funding for the RFC Editor function is currently provided by the
   Internet Society.















































Sayre                    Expires April 28, 2006                 [Page 9]