About Opentopia
Opentopia Directory Encyclopedia Tools

OPML

Encyclopedia : O : OP : OPM : OPML

 

OPML (Outline Processor Markup Language) is an XML format for outlines. Originally developed by Radio UserLand as a native file format for an outliner application, it has since been adopted for other uses, the most common being to exchange lists of RSS feeds between RSS aggregators.

The OPML specification defines an outline as a hierarchical, ordered list of arbitrary elements. The specification is fairly open which makes it suitable for many types of list data.

Contents

XML format

The XML elements in an OPML document are:

<opml version="1.0">
This is the root element. It must contain the version attribute and one head and one body element.
<head>
Contains metadata. May include any of these optional elements
<body>
Contains the content of the outline. Must have one or more outline elements.
<outline>
Represents a line in the outline. May contain any number of arbitrary attributes. Common attributes include text and type. The outline element may contain any number of outline sub-elements.

Shortcomings of OPML

  1. OPML stores data in XML attributes, which violates a common XML design principle.
  2. * [Generally, it is better to store data in elements]
  3. * [Principles of XML design: When to use elements versus attributes]
  4. Information about OPML items cannot itself be hierarchically marked up (ironically), due to the use of attributes to store that information.
  5. The RFC 822 date format is considered obsolete, and amongst other things permits the representation of years as two digits. (RFC 822 has been superseded by RFC 2822) In general, date and time formats should be represented according to RFC 3339.
  6. Because "expansionState" is recorded independently of the outline elements:
  7. * The expansion state of the children of collapsed nodes can not be stored
  8. * When an outline element is expanded, collapsed, added, deleted or moved, the expansion state of all elements below it must be recalculated
  9. Due to the arbitrary nature of the "type" attribute, and the acceptance of arbitrary attributes on "outline" elements, interoperability of OPML documents relies almost entirely on the undocumented conventions of content producers.
  10. MIME types aren't clear; text/xml usually merely identifies the document as having some kind of vague XML content, while text/x-opml doesn't specify the document is, additionally, in fact XML, since it lacks the +xml suffix (see XML and MIME).

Validating OPML

Dave Winer has made a request for comments on a [proposal for validating OPML], and released a beta [OPML validator].

Example OPML documents

Alternative specifications

OPML is being used more widely because of its ties to RSS. It has also been incorporated into PIM applications.

Alternative specifications have been proposed. One such specification is OML. While very similar to OPML, OML forces a separation between data presentation and content; it also treats textual content as an XML element. OPML, by contrast, treats textual content as an XML attribute, which limits its extensibility and precludes the possibility of nested XML elements within textual content, but makes OPML somewhat simpler to code by hand in a text editor.

Another specification that has been proposed is XOXO. XOXO treats textual content as an XML element rather than an XML "attribute". XOXO is easier than OPML to code by hand in a text editor, since it can be easily previewed in any web browser.

See also

External links

Software support

 

From Wikipedia, the Free Encyclopedia. Original article here. Support Wikipedia by contributing or donating.
All text is available under the terms of the GNU Free Documentation License See Wikipedia Copyrights for details.

Search Titles
0123456789
ABCDEFGHIJ
KLMNOPQRST
UVWXYZ?

E-mail this article to:

Personal Message: