xFolk RC1

Jump to: navigation, search

This document represents a draft microformat specification. Although drafts are somewhat mature in the development process, the stability of this document cannot be guaranteed, and implementers should be prepared to keep abreast of future developments and changes. Watch this wiki page, or follow discussions on the #microformats Freenode IRC channel to stay up-to-date.

xFolk (de "xFolksonomie) est un format simple et ouvert pour publier des collections de signets. Il permet aux services de mieux améliorer l'expérience utilisateur et de partager des données dans un logiciel de signets basé sur le web. xFolk peut être embarqué dans HTML ou XHTML, Atom, RSS et le XML arbitraire. C'est l'un des nombreux microformats standards ouverts.

Contents

Spécification Brouillon

Editeur/Auteur

Bud Gibson, (The Community Engine)

(traduction Christophe Ducamp)

Copyright

Cette spécification est (C) 2005-2014 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.

Inspiration et Reconnaissances

Merci à : David Plaut qui m'a présenté l'idée que les items peuvent appartenir partiellement à beaucoup de catégories en une fois. Plus récemment, merci à : Tantek Çelik, Kevin Marks, Steve Mallet, Brian DelVecchio et François Hodierne qui ont contribué au développement de xFolk avec des critiques sensées et des implémentations.

Introduction

Les services de signets sociaux laissent les utilisateurs sauvegarder et taguer leurs signets pour les partager avec d'autres utilisateurs. Durant la dernière année, le nombre de ces services a poussé comme des champignons (plus de 20, avec des exemples comprenant : del.icio.us, furl, de.lirio.us, jots et blogmarks.

Le manque d'un standard ouvert et interopérable de données est une problématique majeure pour utiliser les services de signets sociaux. Un standard ouvert ferait qu'il soit possible de collecter facilement des données signets et de les remixer pour inventer de nouveaux services du moteur expérimental de recherche de signets gataga. Un standard ouvert ferait qu'il serait aussi possible d'écrire des javascripts qui fonctionnent transversalement sur les services comme le font certains actuellement pour del.icio.us, permettant des améliorations en expérience utilisateur.

xFolk est un standard ouvert de signet social qui a pour but de parvenir à tous ces avantages. Les services de signets sociaux qui adoptent xFolk continueront à se différencier eux-mêmes des services de données. Mais, la donnée en elle-même sera facile à manipuler par des scripts tiers et sera facile à partager. En tant que résultat, les services de signets pourront offrir à leurs utilisateurs un ensemble plus large d'options à un moindre coût, et se concentrer sur ce qui les différencie vraiment. Les individus ou les groupes opérant seul des répertoires de signets auront accès à un plus large ensemble de fonctionnalités que celles qu'ils pourraient produire seuls.

Principes de Design XHTML Sémantique

Note : les Principes de Design XHTML Sémantique ont été écrits initialement dans le contexte de développement de hCard et hCalendar, par conséquent il peut être plus facile de comprendre ces principes dans le contexte de la méthodologie de design hCard (ce qui veut dire, lisez ça d'abord). Tantek

XHTML est construit sur du XML, et par conséquent les formats fondés sur XHTML peuvent être utilisés non seulement pour une présentation d'affichage pratique, mais aussi à des fins d'échanges de données. A bien des façons, les formats fondés sur XHTML illustrent le meilleur des mondes tant du HTML que du XML. Néanmoins au moment de construire des formats basés sur XHTML, cela aide d'avoir un ensemble de principes directeurs.

  1. Réutilisez autant que possible le schéma (noms, objets, propriétés, valeurs, types, hiérarchies, contraintes) à partir des standards de référence établis et bien supportés. Evitez de redéclarer les contraintes exprimées dans le standard source. Des mentions à titre d'information peuvent passer.
    1. Pour les types avec plusieurs composants, utilisez des éléments imbriqués avec des noms de classe équivalents aux noms des composants.
    2. Les composants pluriels sont produits au singulier, et par conséquent plusieurs éléments imbriqués sont utilisés pour représenter plusieurs valeurs de texte qui sont délimitées par des virgules.
  2. Utilisez la sémantique XHTML la plus précise pour construire des blocs pour chaque objet, etc.
  3. Autrement utilisez un élément générique structurel (par ex. <span> ou <div>), ou l'élément contextuel approprié (par ex. un <li> dans un <ul> ou <ol>).
  4. Utilisez des noms de classes basés sur des noms extraits du schéma original, à moins que le XHTML sémantique de construction de bloc ne représente précisément cette partie du schéma original. Si les noms dans le schéma original ne sont pas sensibles la casse, alors mettez tout dans un équivalent en bas de casse. Les noms de composants implicites en prose (plutôt qu'explicites dans le schéma défini) devraient aussi utiliser les équivalents bas de casse pour une facilité d'utilisation. Les espaces dans les noms des composants deviennent des caractères tiret '-'.
  5. Pour finir, si le format de la donnée selon le schéma original est trop long et/ou non amical sur le plan humain, utilisez <abbr> au lieu d'un élément générique structurel, et placez les données littérales dans l'attribut 'title' (là où vont les expansions abbr), et l'équivalent le plus bref et le plus lisible humainement dans l'élément lui-même. De plus amples explications de cet usage de <abbr> : Human vs. ISO8601 dates problem solved

Format

Une analyse extensive des services de signets sociaux et des linkblogs, déposée ailleurs, révèle que les données publiées par tous les services de signets et beaucoup de linkblogs différents sont décrites par le schéma implicite suivant :

Comme démontré dans les premières itérations du standard xFolk, ce schéma général peut être traduit en balisage par :

  1. créer un élément conteneur pour chaque entrée de la classe xfolkentry,
  2. utiliser un élément <a> pour le lien bookmarké ou tagué de la classe taggedlink,
  3. utiliser l'attribut title pour l'élément lien tagué <a>, s'il existe, comme l'entry title, autrement utiliser la valeur de l'élément,
  4. utiliser RelTag pour les tags, et
  5. utiliser un élément conteneur de classe description, tel que <p>, pour toute autre description étendue ou résumé.

Une entrée donnée xFolk contiendra toujours un lien tagué comprenant un 'title' avec d'autres éléments optionnels. Les entrées peuvent avoir plus d'un tag tout comme plus d'un élément de classe description. Plusieurs éléments de classe description sont triés par l'ordre du document par défaut. Les éléments sémantiques dans les entrées xFolk peuvent être imbriqués à des profondeurs abritraires.

Beaucoup de systèmes de signets sociaux existent, chacun d'eux avec se propres conventions de balisage. En outre, beaucoup de personnes publient déjà des blogs de liens. xFolk est conçu en priorité pour faciliter l'adoption de ces pratiques actuelles. Par conséquent, peu d'hypothèses ont été produites comme les types exacts des éléments utilisés pour une entrée xFolk. Le travail de définir la sémantique est entièrement laissé à la casse et aux valeurs d'attribut rel (dans le cas de reltag).

Il est attendu que les développeurs utiliseront XPath ou une syntaxe équivalente en accédant à des éléments d'entrée xFolk. Une exigence pour xPath est que le document HTML soit bien formé mais pas nécessairement valide. Par conséquent, bien que non désirable, il est possible d'utiliser xFolk dans un document HTML qui ne valide pas.

XMDP Profile

Voir le xFolk profile pour le profil XMDP de xFolk.

Exemple

Voilà un signet échantillon comme affiché dans la syntaxe standard de del.icio.us. Les lignes où les attributs de classe d'éléments doivent changer pour se conformer à xFolk sont marquées avec un commentaire à la fin.

<div class="post"> <!--changera-->
  <div>
    <a class="delLink" href="http://www.sifry.com/alerts/archives/000306.html"> <!--changera-->
      Sifry's Alerts: Technorati launches Related Tags
    </a> 
  </div>
  <div class="extended"> <!--will change-->
    Ever wanted to see what posts are related to other posts, what tags 
    are related to others? Now you can! Just check under the Tag 
    description on most tag pages, like this one, or this one, and you'll
    see the patterns. Can you smell the emergence?
  </div>
  <div class="meta">
    to
    <a class="delNav" href="/fpgibson/folksonomy">folksonomy</a> <!--changera-->
    <a class="delNav" href="/fpgibson/technorati">technorati</a> <!--changera-->
    ... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
    and 1 other person
    </a>
    ... on 2005-04-09
  </div>
</div>

L'équivalent dans xFolk se fait comme suit. Les commentaires sont placés à la fin des lines où les modifiations d'attribut de classe sont requises

<div class="xfolkentry"> <!-- changé -->
  <div>
    <a class="taggedlink" href="http://www.sifry.com/alerts/archives/000306.html"> <!-- changé -->
      Sifry's Alerts: Technorati launches Related Tags
    </a> 
  </div>
  <div class="description"> <!-- changed -->
    Ever wanted to see what posts are related to other posts, what tags 
    are related to others? Now you can! Just check under the Tag 
    description on most tag pages, like this one, or this one, and you'll
    see the patterns. Can you smell the emergence?
  </div>
  <div class="meta">
    to
    <a rel="tag" href="/fpgibson/folksonomy">folksonomy</a> <!-- changé -->
    <a rel="tag" href="/fpgibson/technorati">technorati</a> <!-- changé -->
    ... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
    and 1 other person
    </a>
    ... on 2005-04-09
  </div>
</div>


Convertir le balisage pour être conforme à xFolk est presque toujours aussi facile. L'avantage de xFolk est que cela fournit un ensemble d'attributs de classe qui peuvent être réutilisés sur tous les services et blogs de liens, presque toujours sans aucune perte de granularité. La prochaine section présentera plusieurs autres exemples pour illustrer ce point.

Un autre exemple simple (utilisant le marquage listes) :

<ul><!--xfolk traite de *collections* de bookmarks-->
  <li>
    <ul class="xfolkentry"> 
      <li><a class="taggedlink" href="http://microformats.org/wiki/Main_Page-fr">microformats wiki</a></li>
      <li class="description">L'endroit principal pour comprendre les microformats et jouer avec...</li>
      <li class="description">Wiki piloté par une communauté</li>
      <li class="meta">
	Tags :
	<a rel="tag" href="http://del.icio.us/tag/microformats">microformats</a>
	<a rel="tag" href="http://del.icio.us/tag/websocial">websocial</a>
	<a rel="tag" href="http://del.icio.us/tag/semantics">semantics</a>
      </li>
    </ul>
  </li>
 
  <li>
   <!--Une autre xfolkentry comme ci-dessus, et ainsi de suite ...-->
  </li>
 
</ul>

Beaucoup plus d'exemples

Nous avons de nombreux exemples pour aider les développeurs à incorporer xFolk dans leurs sites.

Dans la jungle

Ce sont de vrais exemples de systèmes qui fonctionnent et qui publient les signets dans xFolk. Ceci est une endroit idéal pour commencer à regarder des exemples "dans la jungle" pour essayer de parser, indexer, organiser, etc. Si vous publiez en utilisant xFolk, sentez-vous à l'aise pour ajouter en haut de cette liste. Une fois que la liste sera trop grosse, nous ferons une page wiki séparée.

Services de signets sociaux supplémentaires

Cet exemple illustre comment xFolk peut être appliqué à un service additionnel :

Blogs de liens

Les services de signets sociaux sont seulement les exemples les plus récents de personnes publiant des liens. Les blogs de liens ont presque toujours existé depuis le début du blogging. Ils représentent en quelque sorte plus qu'un défi pour xFolk parce que leurs balisages tendent à être moins sémantiques qu'au début. Les exemples suivants illustrent quelques défis particuliers et comment ils peuvent être surmontés.

Spam

Quelques spammers sont en train d'ajouter des tags xFolk à leurs fermes à liens. (C'est probablement une mauvaise idée de lier vers ces sites). Par exemple :

Implémentations

Les implémentations suivantes ont été développées et elles génèrent ou utilisent xFolk. Si vous avez une implémentation xFolk, sentez-vous à l'aise pour l'ajouter en haut de cette liste. Une fois que la liste sera trop grosse, nous ferons une page wiki séparée.

Références

Références Normatives

Références Informatives

Travaux similaires

Chantier en cours

Bien que cette spécification ait récemment commencé à se stabiliser comme indiqué par la version RC1, c'est encore un chantier en cours. Si garantie, je suis prêt à aller vers plusieurs versions candidates pour parvenir à l'objectif de produire des entrées de signets plus généralement accessibles avec un format aussi léger que possible. Tous les changements depuis la dernière itération ont été motivés par l'expérience d'implémentations des développeurs tentant de parvenir à cet objectif. Des changements plus en profondeur seront aussi probablement motivés par les problèmes d'implémentation. Voir "directions futures" ci-dessous pour des possibilités supplémetaires de microformat.

Changements depuis xFolk 0.4

La valeur de l'attribut de classe extended a été dépréciée en faveur de description pour mieux se conformer à d'autres usages de microformats et quelques requêtes durant l'implémentation. L'autre changement a été de permettre l'utilisation de plusieurs éléments de classe extended basés sur quelque cas d'utilisation découverts dans l'implémentation.

Directions futures

Il y a plusieurs extenstion qu'on pourrait imaginer pour xFolk. Fréquemment, ces extensions sont mieux abouties en combinant xFolk avec un autre microformat. Par exemple, on pourrait vouloir indiquer son évaluation de l'item mis en signet. Ceci pourrait être réalisé en utilisant Vote Links ou hReview avec xFolk.

On peut aussi imaginer d'étendre xFolk pour fournir des données conformes avec plusieurs APIs de services de signets sociaux, par exemple pour fournir tous les signets par tag. Ces APIs sont actuellement trop fluides pour la spécification de quelque type de standard. Les APIs et la fonctionnalité qu'elles fournissent représentent un moyen dont les services de signets sociaux et les méta-services peuvent eux-mêmes se différencier.

Un format compagnon appelé "xFolk definition" est en développement. "xFolk definition" fournira un moyen de définir explicitement les tags utilisés dans les signets sociaux.

Brainstorming

Discussions

Q&R

Problématiques

Pages apparentées

Categories

xFolk RC1 was last modified: Wednesday, September 2nd, 2009

Views