UserPreferences

PacePubControl


Abstract

First, define an XML Namespace for use by the Atom Publishing Protocol. Second, define a new element <control> in this namespace, to be included in <atom:entry> when POSTing or PUTting it. This element contains directives to the publishing system (e.g. publish/draft status, comments allowed) and is not expected to be included in the feed by the publishing system.

Status

Open

Related and Conflicting Proposals

Rationale

As pointed out [WWW]recently by Brent Simmons, there are a number of features shared by most weblog publishing systems. The Atom Publishing Protocol needs to allow for authoring clients to use those features.

Proposal

Add a new top-level section X to the protocol-04 draft:

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

The "pub:control" element MAY appear as a child of an "atom:entry" which is being created or updated via the Atom Publishing Protocol. It contains information to control publishing options. Publishing systems SHOULD interpret and apply the contents of "pub:control" to the extent that the they implement features matching the control information.

Publishing systems MAY include the "pub:control" element or its contents in Atom Feed or Entry Documents.

"pub:control" may contain zero or more of the subelements in the Atom Publishing Control namespace described in this section. It may also contain any number of child elements from other namespaces, which it may process if it is so equipped, and ignore otherwise.

X.2.1 Control element values

Some of the following control elements have a set of predefined values ...

[Text equivalent to the format spec, section 4.2.7.2]

X.2.2 The "pub:status" Element

The number of "pub:status" elements in "pub:control" MUST be zero or one. The predefined values are "draft", meaning that the entry is not ready for publication, and "published", meaning that the entry may be made publicly visible.

X.2.3 The "pub:comments" Element

The number of "pub:comments" elements in "pub:control" MUST be zero or one. The predefined values are "yes" and "no", indicating whether or not commenting is to allowed on this entry.

X.2.4 The "pub:trackback-in" Element

The number of "pub:trackback-in" elements in "pub:control" MUST be zero or one. The predefined values are "yes" and "no"; a value of "yes" requests the publishing system to generate a trackback URI for this entry.

X.2.5 The "pub:trackback-out" Element

Any number of "pub:trackback-out" elements MAY appear in "pub:control".

The content of "pub:trackback-out" MUST be a URI to which a trackback is to be sent upon the publication of this entry.

X.2.6 The "pub:text-format" Element

The number of "pub:text-format" elements in "pub:control" MUST be zero or one.

The predefined values are "plain", "markdown", and "wiki-words".

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/">
  <status>published</status>
  <comments>no</comments>
  <text-format>markdown</text-format>
  <trackback-in>yes</trackback-in>
  <trackback-out>http://example.com/31875</trackback-out>
  <trackback-out>http://example.com/39871</trackback-out>
 </control>
</entry>

Notes

CategoryProposals