XOXO 1.0: Extensible Open XHTML Outlines

(Difference between revisions)

Jump to: navigation, search
(Abstract: changed case, orig. page redirected...)
Current revision (05:20, 21 July 2017) (view source)
(remove old links that are dead or don't apply, fix a couple)
 
(36 intermediate revisions not shown.)
Line 1: Line 1:
-
<h1> XOXO 1.0: Extensible Open XHTML Outlines </h1>
+
<entry-title>XOXO 1.0: Extensible Open XHTML Outlines</entry-title>
-
 
+
XOXO is a simple, open outline format written in standard XHTML and suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML. XOXO is one of several [[microformats|microformat]] open standards.  
XOXO is a simple, open outline format written in standard XHTML and suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML. XOXO is one of several [[microformats|microformat]] open standards.  
Line 8: Line 7:
=== Editor ===
=== Editor ===
-
[http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc]
+
[http://tantek.com/ Tantek Çelik]
=== Authors ===
=== Authors ===
-
* [http://epeus.blogspot.com/ Kevin Marks], [http://technorati.com Technorati, Inc]
+
* [http://epeus.blogspot.com/ Kevin Marks]
-
* [http://tantek.com/ Tantek Çelik], [http://technorati.com Technorati, Inc] (formerly of [http://microsoft.com/ Microsoft Corporation])
+
* [http://tantek.com/ Tantek Çelik]
-
* [http://diveintomark.org/ Mark Pilgrim], [http://ibm.com IBM]
+
* Mark Pilgrim
* [http://www.blogologue.com/ Morten W. Petersen]
* [http://www.blogologue.com/ Morten W. Petersen]
=== Copyright ===
=== Copyright ===
{{MicroFormatCopyrightStatement2003}}
{{MicroFormatCopyrightStatement2003}}
 +
* [[User:Tantek|Tantek]]: I release all my contributions to this specification into the public domain and I encourage the other authors to do so as well.
 +
** When all authors/editors have done so, we can remove the MicroFormatCopyrightStatement template reference and replace it with the MicroFormatPublicDomainContributionStatement.
=== Patents ===
=== Patents ===
Line 23: Line 24:
== Preamble ==
== Preamble ==
-
When we were discussing [http://developers.technorati.com/wiki/attentionxml Attention.xml], Tantek pointed out that XHTML has everything necessary for semantically expressing outlines and blogroll-like subscriptions in an XML format that is both interactively renderable by browsers and parsable by strict XML engines. This page is here to discuss this idea.
+
When we were discussing [https://web.archive.org/web/20071017054844/http://developers.technorati.com:80/wiki/attentionxml Attention.xml], Tantek pointed out that XHTML has everything necessary for semantically expressing outlines and blogroll-like subscriptions in an XML format that is both interactively renderable by browsers and parsable by strict XML engines. This page is here to discuss this idea.
=== Name ===
=== Name ===
Line 112: Line 113:
* [http://homepage.mac.com/ctholland/thelab/outlines/ Chris Holland Outline Helper]: tweaked one of above samples, yanked CSS for simplicity, added reference to [http://homepage.mac.com/ctholland/thelab/outlines/outlines.css outlines.css] and [http://homepage.mac.com/ctholland/thelab/outlines/outlines.js outlines.js], pasted a few different combinations of ul/ol/li with the compact attribute.
* [http://homepage.mac.com/ctholland/thelab/outlines/ Chris Holland Outline Helper]: tweaked one of above samples, yanked CSS for simplicity, added reference to [http://homepage.mac.com/ctholland/thelab/outlines/outlines.css outlines.css] and [http://homepage.mac.com/ctholland/thelab/outlines/outlines.js outlines.js], pasted a few different combinations of ul/ol/li with the compact attribute.
** in trying to comply with semantic principles the "compact" attribute to ol and ul elements is what drives the display state. Via scripting, i'm setting classes on containing li element for added styling flexibility, though CSS Gurus might be able to replace "li.expanded" in outlines.css with some other CSS selector that says "select an li node that contains an ol node with a 'compact' attribute set".
** in trying to comply with semantic principles the "compact" attribute to ol and ul elements is what drives the display state. Via scripting, i'm setting classes on containing li element for added styling flexibility, though CSS Gurus might be able to replace "li.expanded" in outlines.css with some other CSS selector that says "select an li node that contains an ol node with a 'compact' attribute set".
 +
*** The CSS selector for "an li node that contains an ol node with a 'compact' attribute set" would be 'li ol[compact="compact"]'.
== Properties of Outline Items ==
== Properties of Outline Items ==
Line 184: Line 186:
Any other properties are simply added to the definition list in the same way as the "description" property.
Any other properties are simply added to the definition list in the same way as the "description" property.
 +
 +
=== Multi-value Properties ===
 +
 +
Properties that have multiple values are added using a list, nested inside of the corresponding <code>dl</code> element:
 +
 +
<pre><nowiki>
 +
<ol class='xoxo'>
 +
  <li>item 1
 +
    <dl>
 +
      <dt>multivalproperty1</dt>
 +
      <dd><ul>
 +
      <li>value-a</li>
 +
      <li>value-b</li>
 +
      </ul></dd>
 +
    </dl>
 +
  </li>
 +
</ol>
 +
</nowiki></pre>
== Publishing XOXO ==
== Publishing XOXO ==
Line 203: Line 223:
<body>
<body>
<ol class="xoxo">
<ol class="xoxo">
-
  <li><a href="URL-one">TEXT-one</a</li>
+
  <li><a href="URL-one">TEXT-one</a></li>
  <li><a href="URL-two">TEXT-two</a></li>
  <li><a href="URL-two">TEXT-two</a></li>
  ...
  ...
Line 209: Line 229:
</body>
</body>
</html>
</html>
-
</nowiki></pre>
 
-
 
-
==== Content-Type ====
 
-
 
-
Valid XHTML XOXO SHOULD be served with this Content-Type header for maximum browser compatibility.
 
-
 
-
<pre><nowiki>
 
-
Content-Type: text/html; charset=utf-8
 
-
</nowiki></pre>
 
-
 
-
It MUST be served with one of these Content-Type headers:
 
-
 
-
<pre><nowiki>
 
-
Content-Type: text/html; charset=utf-8
 
-
Content-Type: application/xhtml+xml; charset=utf-8
 
</nowiki></pre>
</nowiki></pre>
Line 232: Line 237:
<pre><nowiki>
<pre><nowiki>
<ol class="xoxo">
<ol class="xoxo">
-
  <li><a href="URL-one">TEXT-one</a</li>
+
  <li><a href="URL-one">TEXT-one</a></li>
  <li><a href="URL-two">TEXT-two</a></li>
  <li><a href="URL-two">TEXT-two</a></li>
  ...
  ...
Line 238: Line 243:
</nowiki></pre>
</nowiki></pre>
-
==== Content-Type ====
+
=== Content-Type ===
 +
 
 +
Valid or well-formed XHTML XOXO SHOULD be served with this Content-Type header for maximum browser compatibility.
-
Simple well-formed XML XOXO SHOULD be served with this Content-Type header:
 
<pre><nowiki>
<pre><nowiki>
-
Content-Type: text/xml; charset=utf-8
+
Content-Type: text/html; charset=utf-8
</nowiki></pre>
</nowiki></pre>
Line 248: Line 254:
<pre><nowiki>
<pre><nowiki>
-
Content-Type: text/xml; charset=utf-8
+
Content-Type: text/html; charset=utf-8
 +
Content-Type: application/xhtml+xml
Content-Type: application/xml
Content-Type: application/xml
-
Content-Type: application/xml; charset=utf-8
 
</nowiki></pre>
</nowiki></pre>
Line 256: Line 262:
This section is '''informative'''.
This section is '''informative'''.
-
Too numerous to document thoroughly. Nearly every blogroll on the Web can be parsed as XOXO, since they are typically an unordered list of list items of hyperlinks, which is within the XOXO profile.
+
There are many wild examples. Nearly every blogroll on the Web can be parsed as XOXO, since they are typically an unordered list of list items of hyperlinks, which is within the XOXO profile. List examples here, when the list becomes too long we can move to a dedicated page.
 +
 
 +
* [http://api.talis.com/bf/stores/ukbib/services/facet?query=feynman&fields=title%2Csubject&top=10&output=html HTML output from a faceting service for book data]
== Implementations ==
== Implementations ==
This section is '''informative'''.
This section is '''informative'''.
 +
* CVarious [[s5-tools|S5 tools]]
* [http://chneukirchen.org/blog/ Christian Neukirchen] has [http://chneukirchen.org/blog/archive/2006/01/xoxo-rb-0-1-released.html written a xoxo.rb, a XOXO parser and generator for Ruby]
* [http://chneukirchen.org/blog/ Christian Neukirchen] has [http://chneukirchen.org/blog/archive/2006/01/xoxo-rb-0-1-released.html written a xoxo.rb, a XOXO parser and generator for Ruby]
* [http://odeo.com Odeo] publishes users' subscription lists in XOXO. See Ryan King's list [http://odeo.com/profile/RyanKing/xoxo here].
* [http://odeo.com Odeo] publishes users' subscription lists in XOXO. See Ryan King's list [http://odeo.com/profile/RyanKing/xoxo here].
Line 266: Line 275:
* http://homepage.mac.com/ctholland/thelab/outlines/ is a great demonstration of  dynamic interactive XOXO with use of "compact" and DHTML to collapse/expand.
* http://homepage.mac.com/ctholland/thelab/outlines/ is a great demonstration of  dynamic interactive XOXO with use of "compact" and DHTML to collapse/expand.
* http://tool-man.org/examples/sorting.html is a great demonstration of drag and drop sortable XOXO lists with javascript and CSS.
* http://tool-man.org/examples/sorting.html is a great demonstration of drag and drop sortable XOXO lists with javascript and CSS.
-
* http://www.joshpeek.com/projects/opmltoxoxo is an extensible OPML to XOXO converter.
 
* http://www.opendarwin.org/~drernie/xoxo-datatypes.html Mapping XOXO to [http://developer.apple.com/documentation/Cocoa/Conceptual/PropertyLists/Concepts/XMLPListsConcept.html Mac OS X property lists]
* http://www.opendarwin.org/~drernie/xoxo-datatypes.html Mapping XOXO to [http://developer.apple.com/documentation/Cocoa/Conceptual/PropertyLists/Concepts/XMLPListsConcept.html Mac OS X property lists]
-
* [http://techno-weenie.net/blog/main/261/if-i-had-a-tumblelog single line of rails to convert XOXO to HTML]
+
* [http://weblog.techno-weenie.net/2005/9/30/if_i_had_a_tumblelog single line of rails to convert XOXO to HTML]
=== Sample Code ===
=== Sample Code ===
Line 292: Line 300:
=== Informative References ===
=== Informative References ===
This section is '''informative'''.
This section is '''informative'''.
-
* [http://developers.technorati.com/wiki/attentionxml Attention.xml]
+
* [https://web.archive.org/web/20071017054844/http://developers.technorati.com:80/wiki/attentionxml Attention.xml]
* [[VoteLinks]]
* [[VoteLinks]]
* [http://www.w3.org/TR/xhtml11 XHTML 1.1]
* [http://www.w3.org/TR/xhtml11 XHTML 1.1]
* [http://opml.scripting.com/spec OPML 1.0]
* [http://opml.scripting.com/spec OPML 1.0]
-
* Contributed from http://developers.technorati.com/wiki/XOXO
+
* Contributed from <nowiki>http://developers.technorati.com/wiki/XOXO</nowiki>
=== Similar Work ===
=== Similar Work ===
* [http://dannyayers.com/archives/001961.html XHTML Outlines] - DannyAyers independently came up with idea in 2003 October (just a month or two before Kevin and Tantek independently came up with XOXO) to use a simple profile of XHTML to semantically represent outlines using existing building blocks from XHTML.
* [http://dannyayers.com/archives/001961.html XHTML Outlines] - DannyAyers independently came up with idea in 2003 October (just a month or two before Kevin and Tantek independently came up with XOXO) to use a simple profile of XHTML to semantically represent outlines using existing building blocks from XHTML.
* [http://semtext.org/2004-02/ XOW] - making them editable, producing RDF and bookmark lists from them (DannyAyers)
* [http://semtext.org/2004-02/ XOW] - making them editable, producing RDF and bookmark lists from them (DannyAyers)
 +
* [http://en.wikipedia.org/wiki/XBEL XBEL, or the XML Bookmark Exchange Language], an open XML standard for sharing Internet URIs, also known as bookmarks (or favorites in Internet Explorer).
 +
* [http://en.wikipedia.org/wiki/OPML OPML (Outline Processor Markup Language)], an XML format for outlines.
=== Related Reading ===
=== Related Reading ===
* [http://patricklogan.blogspot.com/2005/08/lists-really-can-we-expect-better.html Patrick Logan on why OPML and a Microsoft Lists extension are both unnecessary].
* [http://patricklogan.blogspot.com/2005/08/lists-really-can-we-expect-better.html Patrick Logan on why OPML and a Microsoft Lists extension are both unnecessary].
-
* [http://raybenchen.blogspot.com/2005/11/is-crappy-format-worth-saving.html Dr. Tao Chen on why it is better to use XOXO than OPML going forward]
 
=== Unrelated Reading ===
=== Unrelated Reading ===
Line 310: Line 319:
=== Promotional Materials / Schwag ===
=== Promotional Materials / Schwag ===
-
* There is an entire XOXO clothing and accessories line.  [http://www.xoxo.com/home.php Buy XOXO stuff online].
+
* There is an entire XOXO clothing and accessories line.  [http://www.xoxo.com/ Buy XOXO stuff online].
== Discussions ==
== Discussions ==
Line 316: Line 325:
* See [[xoxo-brainstorming]] for additional thoughts on how to use XOXO for specific uses.
* See [[xoxo-brainstorming]] for additional thoughts on how to use XOXO for specific uses.
-
* See also [http://www.technorati.com/cosmos/referer.html blogs discussing this page].
+
 
-
** [http://blogxoxo.blogspot.com/ XOXO Blog]
+
=== Q&A ===
=== Q&A ===
Line 324: Line 332:
=== Issues ===
=== Issues ===
* Please add any issues with the specification to the separate [[xoxo-issues]] document.
* Please add any issues with the specification to the separate [[xoxo-issues]] document.
 +
 +
[[Category:Specifications]]
 +
[[Category:XOXO]]

Current revision

XOXO is a simple, open outline format written in standard XHTML and suitable for embedding in (X)HTML, Atom, RSS, and arbitrary XML. XOXO is one of several microformat open standards.

Contents


Draft Specification 2004-10-01

Editor

Tantek Çelik

Authors

Copyright

This specification is (C) 2003-2018 by the authors. However, the authors intend to submit (or already have submitted, see details in the spec) this specification to a standards body with a liberal copyright/licensing policy such as the GMPG, IETF, and/or W3C. Anyone wishing to contribute should read their copyright principles, policies and licenses (e.g. the GMPG Principles) and agree to them, including licensing of all contributions under all required licenses (e.g. CC-by 1.0 and later), before contributing.

Patents

This specification is subject to a royalty free patent policy, e.g. per the W3C Patent Policy, and IETF RFC3667 & RFC3668.

Preamble

When we were discussing Attention.xml, Tantek pointed out that XHTML has everything necessary for semantically expressing outlines and blogroll-like subscriptions in an XML format that is both interactively renderable by browsers and parsable by strict XML engines. This page is here to discuss this idea.

Name

XOXO stands for eXtensible Open XHTML Outlines, and is pronounced variously as 'ecks oh ecks oh', 'zho-zho', or 'sho-sho'.

Abstract

XOXO is one of several microformats. This specification defines a new XHTML document type that is based upon the module framework and modules defined in Modularization of XHTML (XHTMLMOD). The purpose of the XOXO document type is to serve as the basis for XHTML friendly outlines for processing by XML engines and for easy interactive rendering by browsers.

The XOXO Document Type

The XOXO document type is made up of the following XHTML modules. The elements, attributes, and minimal content models associated with these modules are defined in "Modularization of XHTML" (XHTMLMOD). The elements are listed here for information purposes, but the definitions in "Modularization of XHTML" should be considered definitive. In the on-line version of this document, the module names in the list below link into the definitions of the modules within the current version of "Modularization of XHTML".

Structure Module

 body, head, html, title

Hypertext Module

 a

List Module

 dl, dt, dd, ol, ul, li

Metainformation Module

 meta

Stylesheet Module

 style element

Style Attribute Module

 style attribute

Link Module

 link

Legacy Module

 Attribute compact on ol and ul

The XOXO Profile

See xoxo-profile for the XMDP profile of XOXO which defines the XOXO values for the class attribute.

Simple XOXO Fragment

Markup

<ol class='xoxo'>
  <li>Subject 1
    <ol>
        <li>subpoint a</li>
        <li>subpoint b</li>
    </ol>
  </li>
  <li>Subject 2
    <ol compact="compact">
        <li>subpoint c</li>
        <li>subpoint d</li>
    </ol>
  </li>
  <li>Subject 3
    <ol>
        <li>subpoint e</li>
    </ol>
  </li>
</ol>

Sample Rendering

   1. Subject 1
      a. subpoint a
      b. subpoint b
   2. Subject 2
   3. Subject 3
      a. subpoint e

Usage of 'compact' attribute

Note the use of the 'compact' attribute to indicate that the subpoints of the headline "Subject 2" are not in an expanded state. The absence of the 'compact' attribute elsewhere indicates that the other headlines are in an expanded state.

Possible Default Style Rules for Sample Rendering

ol.xoxo { list-style:decimal; }
ol.xoxo ol { list-style:lower-latin; }
ol[compact="compact"] { display:none; }


More Simple Examples

MarkP has a set of examples that demonstrates both the simplicity of the markup and the presentational richness that is possible:

Properties of Outline Items

Outlines typically consist of a hierarchy of points and subpoints. Each of those points (outline items) itself may have some properties (AKA attributes or metadata) that need to be represented. Perhaps the most common additional property on outline items in practice is the URL as demonstrated in Mark Pilgrim's examples above. Even the text label/title of an outline item could be considered a common property. A few such common properties:

In general, properties on an outline item <li> are represented by a nested definition list <dl>. Strictly speaking, it is the first <dl> inside the <li> and before any following <ol>, <ul>, or <li>, e.g. here is an item "item 1" with a description property (the subpoints are there purely as a point of reference to an earlier example).

<ol class='xoxo'>
  <li>item 1
    <dl>
      <dt>description</dt>
        <dd>This item represents the main point we're trying to make.</dd>
    </dl>
    <ol>
      <li>subpoint a</li>
      <li>subpoint b</li>
    </ol>
  </li>

Special Properties

There are a handful of special properties which we are able to represent more directly and conveniently with the semantic XHTML building blocks that we have included, instead of terms in a definition list. Mostly taken from the above list of common properties, these are:

If we were to represent them simply as definition terms (including the "description" property from the previous example), they might look something like this:

Example for the sake of discussion only / not a canonical XOXO example:

<ol class='xoxo'>
  <li>
    <dl>
      <dt>text</dt>
        <dd>item 1</dd>
      <dt>description</dt>
        <dd> This item represents the main point we're trying to make.</dd>
      <dt>url</dt>
        <dd>http://example.com/more.xoxo</dd>
      <dt>title</dt>
        <dd>title of item 1</dd>
      <dt>type</dt>
        <dd>text/xml</dd>
      <dt>rel</dt>
        <dd>help</dd>
    </dl>
  </li>

However, by taking advantage of the semantic <a href> element, we are able to dramatically simplify the common cases that utilize these properties. From a parser's perspective, this applies to the first <a href> element directly inside the <li>.

Actual XOXO Example:

<ol class='xoxo'>
  <li><a href="http://example.com/more.xoxo"
         title="title of item 1"
         type="text/xml"
         rel="help">item 1</a> 
<!-- note how the "text" property is simply the contents of the <a> element -->
      <dl>
        <dt>description</dt>
          <dd>This item represents the main point we're trying to make.</dd>
      </dl>
  </li>

Any other properties are simply added to the definition list in the same way as the "description" property.

Multi-value Properties

Properties that have multiple values are added using a list, nested inside of the corresponding dl element:

<ol class='xoxo'>
  <li>item 1
    <dl>
      <dt>multivalproperty1</dt>
      <dd><ul>
       <li>value-a</li>
       <li>value-b</li>
      </ul></dd>
    </dl>
  </li>
</ol>

Publishing XOXO

XOXO may be published in two forms, valid XHTML, and simple well-formed XML.

Valid XHTML XOXO

A valid XHTML XOXO page is a complete XHTML document.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>XOXO page</title>
</head>
<body>
<ol class="xoxo">
 <li><a href="URL-one">TEXT-one</a></li>
 <li><a href="URL-two">TEXT-two</a></li>
 ...
</ol>
</body>
</html>

Simple well-formed XML XOXO

The root element of a simple well-formed XML XOXO page is either an ol or ul with class name of "xoxo". This variant is ideal for syndication and transclusion into (X)HTML pages with AHAH.

<ol class="xoxo">
 <li><a href="URL-one">TEXT-one</a></li>
 <li><a href="URL-two">TEXT-two</a></li>
 ...
</ol>

Content-Type

Valid or well-formed XHTML XOXO SHOULD be served with this Content-Type header for maximum browser compatibility.

Content-Type: text/html; charset=utf-8

It MUST be served with one of these Content-Type headers:

Content-Type: text/html; charset=utf-8
Content-Type: application/xhtml+xml
Content-Type: application/xml

Examples in the Wild

This section is informative.

There are many wild examples. Nearly every blogroll on the Web can be parsed as XOXO, since they are typically an unordered list of list items of hyperlinks, which is within the XOXO profile. List examples here, when the list becomes too long we can move to a dedicated page.

Implementations

This section is informative.

Sample Code

XOXO Schemas

This section is informative.

Note: these may be out of date and require updating to reflect the use of <dl> for annotating XOXO items with arbitrary properties.


References

Normative References

Informative References

This section is informative.

Similar Work

Related Reading

Unrelated Reading

Promotional Materials / Schwag

Discussions

This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. There is a separate document where we are keeping our brainstorms and other explorations relating to XOXO:


Q&A

Issues

Categories

XOXO 1.0: Extensible Open XHTML Outlines was last modified: Friday, July 21st, 2017

Views