xoxo-fr

XOXO 1.0 : Extensible Open XHTML Outlines

XOXO est un simple format ouvert d'outline écrit en XHTML standard et adaptable pour embarquement dans (X)HTML, Atom, RSS, et le XML arbitraire. XOXO est l'un des nombreux standards ouverts microformat.

Spécification Brouillon du 01-Octobre-2004

Editeur

Tantek Çelik, Technorati, Inc

Auteurs

• Kevin Marks, Technorati, Inc
• Tantek Çelik, Technorati, Inc (formerly of Microsoft Corporation)
• Mark Pilgrim, IBM
• Morten W. Petersen

Traducteur(s)

• Christophe Ducamp

Copyright

Cette spécification est (C) 2003-2024 par les auteurs. Néanmoins, les auteurs ont pour but de soumettre cette spécification à un corps de standards avec une politique libérale de copyright/licence telle que GMPG, IETF, et/ou W3C. Quiconque souhaite contribuer devrait lire avant de contribuer leurs principes de copyright, politiques et licences (par ex. les Principes GMPG) et être d'accord avec eux, y compris le fait de licencier toutes les contributions sous les licences nécessaires (par ex. CC-by 1.0 et suivantes).

Brevets

Cette spécification est sujette à une politique de brevets libres de droits, par ex. pour la Politique de Brevet du W3C, IETF RFC3667 et RFC3668.

Préambule

Quand nous avons discuté d'Attention.xml, Tantek faisait remarquer que XHTML a tout ce qui est nécessaire pour exprimer sémantiquement des outlines et des abonnements comme des blogrolls dans un format XML qui est à la fois restituable interactivement par des navigateurs et parsable par des moteurs XML strict. Cette page est ici pour disctuer de cette idée.

Nom

XOXO veut dire eXtensible Open XHTML Outlines, et se prononce selon 'icks oh icks oh', 'zho-zho', ou 'cho-cho'.

Abstract

XOXO est l'un des nombreux microformats. Cette spécification définit un nouveau type de document XHTML qui est basé sur le squelette module et modules défini dans Modularisation du XHTML (XHTMLMOD). Le but du type de document XOXO est de servir de base pour des outlines XHTML faciles qui puissent être traités par les moteurs XML et pour une restitution interactive facile par les navigateurs.

Le type de Document XOXO

Le type de document XOXO est construit sur les modules suivants XHTML. Les éléments, attributs et modèles de contenu minimal associés avec ces modules sont définis dans "Modularization of XHTML" (XHTMLMOD). Les éléments sont listés ici à des fins d'information, mais les définitions dans "Modularization of XHTML" devraient être considérées comme définitives. Dans la version en ligne de ce document, les noms de modules dans la liste en-dessous pointent dans les définitions des modules dans la version actuelle de "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

Le Profil XOXO

Voir xoxo-profile pour le profil XMDP de XOXO qui définit les valeurs XOXO pour l'attribut class.

Fragment Simple XOXO

Balisage

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

Restitution Echantillon

   1. Sujet 1
      a. souspoint a
      b. souspoint b
   2. Sujet 2
   3. Sujet 3
      a. souspoint e

Usage de l'attribut 'compact'

Notez l'utilisation de l'attribut 'compact' pour indiquer que les sous-points du titre "Sujet 2" ne sont pas dans un état déployé. L'absence de l'attribut 'compact' ailleurs indique que les autres titres sont en état déployé.

Règles de Style par Défaut pour une Restitution Echantillon

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

Plus d'Exemples Simples

MarkP a un ensemble d'exemples qui démontrent à la fois la simplicité du balisage et la richesse de présentation qui est possible :

• fichier simple XO qui peut être directement embarqué à l'intérieur d'une page XHTML
• XO avec groupes imbriqués, aussi directement embarquable dans le XHTML
• XO comme page XHTML autonome (XHTML valide)
• XO comme page XHTML autonome, mise en forme avec CSS (aussi valide XHTML)
• Chris Holland Outline Helper : tordu l'un des exemples au-dessus, yanked CSS pour la simplicity, ajouté référence vers outlines.css et outlines.js, copié quelques combinaisons différentes de ul/ol/li avec l'attribut compact.
  • en essayant de rester compatible avec les principes de l'attribut "compact" pour les élément ol et ul est ce qui conduit à l'état d'affichage.

Via la programmation, je sis en train d'installer des classes sur l'élément conteneur li pour une flexibilité ajouté de style, même si les gourous CSS pourraient être capables de remplacer "li.expanded" dans outlines.css avec quelque autre sélecteur CSS qui sise "sélectionnez un noeud li qui contient un noeud ol avvec un réglage d'attribut sur 'compact' ".

Propriétés des Items Outline

Outlines consiste généralement en une hiérarchie de points et sous-points. Chacun de ces points (items outlines) peut avoir lui-même quelques propriétés (comme des attributs ou des méta-données) qui ont besoin d'être représentés. Peut-être que la propriété supplémentaire la plus commune sur les items d'outline est en pratique l'URL comme cela est démontré dans les exemples de Mark Pilgrim au-dessus. Même le texte label/title d'un item outline pourrait être considéré comme une propriété commmune. Quelques propriétés communes :

• text
• description
• url (souvent appelé xmlurl ou htmlurl ; parfois appelé permalink)
• title
• type (truc du MIME type de la ressource indiqué par l'URL)

En général, les propriétés d'un item outline <li> sont représentées par une liste de définition imbriquée <dl>. A strictement parler, c'est le premier <dl> à l'intérieur du <li> et avnt tout <ol>, <ul>, ou <li> suivant, par ex. voici un item "item 1" avec une propriété de description (les sous-points sont là purement comme un point de référence vers un exemple antérieur).

<ol class='xoxo'>
  <li>item 1
    <dl>
      <dt>description</dt>
        <dd>cet item représente le point principal que nous essayons de produire.</dd>
    </dl>
    <ol>
      <li>souspoint a</li>
      <li>souspoint b</li>
    </ol>
  </li>

Propriétés Spéciales

Il existe une poignée de propriétés spéciales que nous pouvons représenter plus directement et de façon commode avec les blocs de construction du XHTML sémantique que nous avons inclus, au lieu de termes dans une liste de définition. La plupart sont extraits de la liste au-dessus des propriétés communes, ce sont :

• text, url, title, type, et rel (raccourci de relationship)

Si nous devions les représenter simplement comme des termes de définition (y compris la propriété "description" tirée du précédent exemple), cela pourrait ressembler à quelque chose comme ça :

Exemple pour recherche de discussion seulement / pas un exemple canonique XOXO :

<ol class='xoxo'>
  <li>
    <dl>
      <dt>text</dt>
        <dd>item 1</dd>
      <dt>description</dt>
        <dd> Cet item représente le point principal que nous essayons de produire.</dd>
      <dt>url</dt>
        <dd>http://exemple.com/plus.xoxo</dd>
      <dt>title</dt>
        <dd>titre de item 1</dd>
      <dt>type</dt>
        <dd>text/xml</dd>
      <dt>rel</dt>
        <dd>aide</dd>
    </dl>
  </li>

Néanmoins, en tirant profit de l'élément sémantique <a href>, nous pouvons dramatiquement simplifier les cases communes qui utilisent ces propriétés. Du point de vue d'un parseur, ceci s'applique au premier élément <a href> diretement dans le <li>.

Exemple véritable XOXO :

<ol class='xoxo'>
  <li><a href="http://exemple.com/more.xoxo"
         title="titre item 1"
         type="text/xml"
         rel="help">item 1</a> 
<!-- notez comme la propriété "text" est simplement les contenus de l'élément <a> -->
      <dl>
        <dt>description</dt>
          <dd>Cet item présente le point principal que nous essayons de produire.</dd>
      </dl>
  </li>

Toutes les autres propriétés sont simplement ajoutées à la liste de définition de la même façon que la propriété "description".

Publier XOXO

XOXO peut être pubié sous deux formes, XHTML valide, et XML simple et bien formé.

XOXO XHTML Valide

Une page XOXO XHTML Valide est un document XHTML complet.

<!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-un">TEXT-un</a</li>
 <li><a href="URL-deux">TEXT-deux</a></li>
 ...
</ol>
</body>
</html>

Content-Type

Le XOXO XHTML Valide DEVRAIT être servi avec cet en-tête Content-Type pour une compatibilité navigateur maximale.

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

Il DOIT être servi avec l'un de ces en-têtes de Content-Type :

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

XOXO XML Simple bien-formé

L'élément racine d'une page XOXO XML simple bien formé est soit un ol ou ul avec le nom de classe de "xoxo". Cette variante est idéale pour la syndication et la transclusion à l'intérieur de pages (X)HTML avec AHAH.

<ol class="xoxo">
 <li><a href="URL-un">TEXT-un</a</li>
 <li><a href="URL-deux">TEXT-deux</a></li>
 ...
</ol>

Content-Type

Le XML Simple bien formé XOXO DEVRAIT être sevi avec cet en-tête Content-Type :

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

Il DOIT être servi avec l'un de ces en-têtes Content-Type :

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

Exemples "in the Wild"

Cette section est informative.

Trop nombreux pour documenter exhaustivement. Presque chaque blogroll sur le web peut être parsée sous XOXO, parce qu'elles sont généralement sous formes de listes non triées d'items de listes d'hyperliens, ce qui est dans le profil XOXO.

Implémentations

Cette section est informative.

• Christian Neukirchen a écrit un xoxo.rb, un parseur XOXO et un générateur pour Ruby
• Odeo publie les liste d'abonnements utilisateurs dans XOXO. Voir la liste de Ryan King ici.
• Les Orchard a écrit un bel éditeur XOXO en javascript.
• http://homepage.mac.com/ctholland/thelab/outlines/ est une démonstration géniale du XOXO dynamique et interactif avec l'utilisation de "compact" et du DHTML pour déployer/replier.
• http://tool-man.org/examples/sorting.html est une démonstration géniale de listes XOXO "glisser déposer" triables avec javascript and CSS.
• http://www.joshpeek.com/projects/opmltoxoxo est un convertisseur extensible de OPML vers XOXO.
• http://www.opendarwin.org/~drernie/xoxo-datatypes.html Mapper XOXO en listes de propriétés Mac OS X
• ligne unique de rails pour convertir XOXO en HTML

Code échantillon

• Voir la page xoxo-sample-code pour un code échantillon open source afin de lire et écrire des fichiers XOXO.
• Voir aussi la page xoxo-compact-sample avec la source pour le CSS et JS qui altère le "look and feel" de quelque XOXO pur pour avoir des triangles dépliables pour les listes imbriquées qui respectent aussi l'attribut compact.

Schémas XOXO

Cette section est "informative".

Note : ces liens peuvent être démodés et ont besoin d'être mis à jour pour refléter l'utilisation de <dl> pour l'annotation d'items XOXO avec des propriétés arbitraires.

• DTDs
• Schemas (Relax NG and DTDs)

Références

Références "Normatives"

• XHTML 1.0
• XHTMLMOD
• XMDP
• XFN

Références "Informative"

Cette section est informative.

• Attention.xml
• VoteLinks
• XHTML 1.1
• OPML 1.0
• Contribution provenant de http://developers.technorati.com/wiki/XOXO

Travaux similaires

• XHTML Outlines - DannyAyers a sorti indépendamment l'idée en octobre 2003 (juste un mois ou deux avant que Kevin et Tantek se sortent indépendamment XOXO) d'utiliser un simple profil XHTML

pour représenter sémantiquement les outlines en utilisant des blocs de constrution existant provenant du XHTML.

• XOW - les rend éditables, produisant des listes de RDF et bookmark à partir d'eux (DannyAyers)

Lecture en Rapport

• Patrick Logan sur pourquoi OPML et une extension Microsoft Lists sont tous deux non nécessaires.
• Dr. Tao Chen sur pourquoi il est mieux d'utiliser XOXO que de continuer à avancer sur OPML

Lecture sans aucun rapport

• Questionable Content comic #493 - apparemment le personnage Faye est un fan of XOXO.

Contenus Promotionnels / Schwag

• Il existe toute une ligne de vêtements et d'accessoires en ligne. Buy XOXO stuff online.

Discussions

Cette spécification est un chantier en cours. Au fur et à mesure que des aspects supplémentaires sont discutés, compris et écrits, ils seront ajoutés. Il existe un document séparé où nous gardons traces de nos brainstorms et autres explorations en rapport avec XOXO :

• Voir xoxo-brainstorming-fr pour des idées supplémentaires sur la façon d'utiliser XOXO pour des usages spécifiques.
• Voir aussi les blogs qui discutent de cette page.
  • XOXO Blog

Q&R

• Si vous avez quelque question à propos de XOXO, regardez les xoxo-faq-fr,

et si vous ne trouvez pas de réponses, ajoutez vos questions !

Problématiques

• ajoutez svp toute problématique sur la spécification à la page document séparée problématiques xoxo.