UserPreferences

PaceInsignificantUpdate


Abstract

Add app:significant to pub:control.

Status

Open

Rationale

The definition of <atom:updated> really only works if there's some way in the protocol to distinguish between those updates that are considered significant and those that are not.

Proposal

Add a new child element to the pub:control element, phrased as a revision of PaceCollectionControl

X.1 The Atom Publishing Protocol Namespace

The namespace name for the Atom Publishing Protocol's XML markup vocabulary is http://example.net/appns/. For the purposes of this document, we will assume the use of the prefix "pub".

X.2 The "pub:control" Element

  pubControl =
   element pub:control {
     atomCommonAttributes,
     pubDraft?
     & pubSignificant?
     & extensionElement
   }

 pubDraft =
   element pub:draft { "yes" | "no" }

 pubSignificant? = 
   element pub:significant { "yes" | "no" }

The "pub:control" element MAY appear as a child of an "atom:entry" which is being created or updated via the Atom Publishing Protocol. The "pub:control" element, if it does appear in an entry, MUST only appear at most one time.

The "pub:control" element and it's children elements MAY be included in Atom Feed or Entry Documents. The "pub:control" element is considered "foreign markup" as defined in Section 6 of the Atom Syndication Format.

The "pub:control" element MAY contain exactly one pub:draft element, MAY contain exactly one pub:significant element, and MAY contain zero or more extension elements as outlined in the Atom Syndication Format, Section 6. Both clients and servers MUST ignore foreign markup present in the pub:control element that they do not know.

X.2.1 The "pub:draft" Element

The number of "pub:draft" elements in "pub:control" MUST be zero or one. Its value MUST be one of "yes" or "no". A value of "no" means that the entry may be made publicly visible. If the "pub:draft" element is missing then the value is understood to be "no". That is, if the "pub:draft" element is missing from an entry then the entry is considered not a draft and can be made publicly visible.

X.2.2 The "pub:significant" Element

The number of "pub:significant" elements in "pub:control" MUST be zero or one. Its value MUST be one of "yes" or "no". A value of "no" means that the entry is to be considered signficant in the sense of [AtomFormat] section 4.2.15. If the "pub:significant" element is missing then the value is understood to be "yes". That is, if the "pub:significant" element is missing from an entry then the entry is considered to be significant.

Example

<entry>
 <title>Lorem Ipsum</title>
 <link href="http://example.org/lorem" />
 <updated>2003-12-13T18:30:02Z</updated>
 <summary>Lorem ipsum dolor sit amet, consectetur adipisicing elit...</summary>
 <control xmlns="http://example.net/appns/">
  <draft>yes</draft>
  <significant>no</significant>
 </control>
</entry>

Impacts

Notes


CategoryProposals