Microformats Wiki - User contributions [en]

xfolk-fr

2008-06-25T14:37:16Z

Ashaszin: /* Exemple */

<h1> xFolk (RC1) </h1>

'''xFolk''' 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 signet basé sur le web. xFolk peut être embarqué dans (X)HTML, Atom, RSS et du XML arbitraire. C'est l'un des nombreux [[microformats-fr|microformats]] standards ouverts.

__TOC__

== Spécification Brouillon ==

=== Editeur/Auteur ===
[http://thecommunityengine.com/ Bud Gibson], [http://thecommunityengine.com The Community Engine]

(traduction [[Christophe Ducamp]])

=== Copyright ===
{{MicroFormatCopyrightStatement2005-fr}}

=== Brevets ===
{{MicroFormatPatentStatement-fr}}

=== Inspiration et Reconnaissances ===
Merci à : [http://www.cnbc.cmu.edu/~plaut/ 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 à : [http://tantek.com/ Tantek Çelik], [http://epeus.blogspot.com/ Kevin Marks], [http://steve.osdir.com/ Steve Mallet], [http://hybernaut.com/ Brian DelVecchio] et [http://blogmarks.net 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 [http://en.wikipedia.org/wiki/Social_bookmarking 20], avec des exemples comprenant : [http://del.icio.us del.icio.us], [http://furl.net furl], [http://de.lirio.us de.lirio.us], [http://jots.com jots] et [http://blogmarks.net blogmarks].

Le manque d'un standard ouvert et interopérable de données est une problématique majeure à 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 le long de la ligne du moteur expérimental de recherche de signets [http://gataga.com gataga]. Un standard ouvert ferait qu'il serait aussi possible d'écrire des javascripts qui fonctionnent transversalement sur les services [http://johnvey.com/features/deliciousdirector/ 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 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 ==
{{semantic-xhtml-design-principles-fr}}

== Format ==
Une analyse extensive des services de signets sociaux et des linkblogs, déposée [http://thecommunityengine.com/home/archives/xfolk 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 :

* Un lien bookmarké ou tagué.
* Un titre pour l'entrée.
* Les tags pour le lien.
* Une description étendue ou un résumé du lien.

Comme démontré dans les premières itérations du standard xFolk, ce schéma général peut être traduit en balisage par :
# créer un élément conteneur pour chaque entrée de la classe <code>xfolkentry</code>,
# utiliser un élément <a> pour le lien bookmarké ou tagué de la classe <code>taggedlink</code>,
# utiliser l'attribut title pour l'élément lien tagué <a>, s'il existe, comme l'entrée title, autrement utiliser la valeur de l'élément,
# utiliser [[rel-tag-fr|RelTag]] pour les tags, et
# utiliser un élément conteneur de classe <code>description</code>, 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 <code>description</code>. Plusieurs éléments de classe <code>description</code> 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 [[rel-tag-fr|reltag]]).

Il est attendu que les développeurs utiliseront [http://www.w3.org/TR/xpath XPath] ou une syntaxe équivalente en accédant à des éléments d'entrée xFolk. Une exigence pour xPath est que le document (X)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 (X)HTML qui ne valide pas.

=== XMDP Profile ===

Voir le [[xfolk-profile-fr|xFolk profile]] pour le profil [http://gmpg.org/xmdp XMDP] de xFolk.

== Exemple ==
Voilà un signet échantillon comme affiché dans la syntaxe standard de [http://del.icio.us 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.
<pre><div class="post"> 
<div>
<a class="delLink" href="http://www.sifry.com/alerts/archives/000306.html"> 
Sifry's Alerts: Technorati launches Related Tags
</a>
</div>
<div class="extended"> 
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> 
<a class="delNav" href="/fpgibson/technorati">technorati</a> 
... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
and 1 other person
</a>
... on 2005-04-09
</div>
</div></pre>

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
<pre><nowiki>
<div class="xfolkentry"> 
<div>
<a class="taggedlink" href="http://www.sifry.com/alerts/archives/000306.html"> 
Sifry's Alerts: Technorati launches Related Tags
</a>
</div>
<div class="description"> 
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> 
<a rel="tag" href="/fpgibson/technorati">technorati</a> 
... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
and 1 other person
</a>
... on 2005-04-09
</div>
</div>
</nowiki></pre>

Un autre exemple simple, basé sur un balisage de listes non-ordonnées :
<pre>
<nowiki>
<ul>
<li>
<ul class="xfolkentry">
<li><a class="taggedlink" href="http://microformats.org/wiki/Main_Page-fr">Le wiki du projet microformats</a></li>
<li class="description">Un bon lieu de départ pour découvrir et jouer avec les microformats</li>
<li class="description">Site wiki communautaire</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/semantique">semantique</a>
</li>
</ul>
</li>

<li>

</li>

</ul>
</nowiki>
</pre>

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.

== 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.
* [http://waferbaby.com/hussy waferbaby's Hussy] publie actuellement les liens en utilisant xFolk.
* [http://unalog.com unalog] publie actuellement tous les liens partagés (y compris les résultats de recherche) en utilisant xFolk.
* [http://smarking.com/ Smarking] publie actuellement tous les liens partagés (y compris les résultats de recherche) en utilisant xFolk.
* [http://de.lirio.us de.lirio.us] publie actuellement ses signets en utilisant xFolk (avec l'attribut de classe déprécié <code>extended</code> a lieu de <code>description</code>, voir [[xfolk-profile-fr| le XMDP]]).
* [http://dev.blogmarks.net/wiki/BlogSync blogmarks] exporte actuellement les signets vers les blogs en xFolk (défilez plus bas pour voir l'exemple d'export sur la page ; l'attribut de classe déprécié <code>extended</code> est utilisé au lieu de <code>description</code>, voir [[xfolk-profile-fr| le XMDP]]).
* [http://thecommunityengine.com The Community Engine] utilise xFolk (avec l'attribut de classe déprécié <code>extended</code> utilisé au lieu de <code>description</code>, voir [[xfolk-profile-fr| le XMDP]]) pour ses [http://thecommunityengine.com/home entrées principales] et pour ses [http://thecommunityengine.com/webcites signets republiés].
* [http://groovymother.com/links/ Groovy Links] est un blog de liens qui est balisé avec xFolk.

=== Services de signets sociaux supplémentaires ===

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

* [[xfolk-scuttle-fr| scuttle]]

=== 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.

* [[xfolk-kottke | kottke]]
* [[xfolk-pollas | pollas]]
* [[xfolk-jacobian | jacobian]]
* [[xfolk-julian-bez | julian-bez]]

=== 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 :
* phontron.info

== 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.
* [http://buzka.com Buzka], un service de signet social supporte maintenant xFolk
* [http://blip.tv Blip.tv], un site d'hébergement vidéo [http://blog.blip.tv/blog/2006/08/19/blip-supports-xfolk/ supporte maintenant xFolk].
* [http://www.s9y.org/ Serendipity], une application de Blogging/CMS motorisée par PHP a maintenant un [http://www.numblog.de/archives/241-Social-Bookmarks-Plugin-for-Serendipity.html plugin de signets sociaux] qui supporte xFolk.
* [http://claimid.com claimID] a implémenté xFolk pour les liens vers les personnes.
* [http://ma.gnolia.com ma.gnolia] supporte maintenant xFolk.
* [http://smarking.com/ Smarking.com] (un service de signet social) balise ses liens tagués avec xFolk ! truc : [http://3spots.blogspot.com/2006/05/social-bookmarking-smarking.html 3spots: Social + bookMARKING = Smarking] qui lui-même est un [[hreview-fr|hReview]].
* [http://blog.codeeg.com/2006/03/20/flock-tails-flocktails/ Flocktails] - port de l'extension Tails pour Flock 0.5.12 qui cherche les hCards, hCalendar, xFolk et hReview et les porte dans une barre supérieure à portée de main.
* [http://blog.codeeg.com/tails-firefox-extension/ Tails est une Extension Firefox] qui affiche la présence de microformats ([[hcard-fr|hCard]], [[hcalendar-fr|hCalendar]], [[hreview-fr|hReview]], [[xfolk-fr|xFolk]]) sur une page web.
* Bud Gibson et Mike Migurski [http://thecommunityengine.com/home/archives/2005/09/vegomatic_an_al.html ont écrit] [http://thecommunityengine.com/veg-o-matic veg-o-matic], un outil et service xFolk de reblogging.
* [http://inside.glnetworks.de/ Martin Rehfeld] a mis à jour le travail de [http://blogmatrix.blogmatrix.com/ David Janes] et produit un [http://inside.glnetworks.de/2006/06/05/microformats-have-arrived-in-firefox-15-greasemonkey-06/ script] [[Greasemonkey-fr|GreaseMonkey]] qui trouve beaucoup d'éléments microformats, y compris xFolk et [http://blog.davidjanes.com/mtarchives/2005_08.html#003379 fournit un menu en popup d'actions]. ''Ceci fonctionnera maintenant avec FireFox 1.5+/GreaseMonkey 0.6.4+.''
* [http://www.midgard-project.org/midcom-permalink-6416db7e1f0e297b4cf3dcc285702a8d net.nemein.bookmarks], le gestionnaire de signets dans [http://www.midgard-project.org/ Midgard CMS] utilise xFolk comme le format natif de production, avec un ajout <code>abbr class=posted</code> pour la date de publication et <code>abbr class=poster</code> pour l'utilisateur qui a ajouté le signet. Vor l'[http://bergie.iki.fi/links/ exemple]
* [http://de.lirio.us de.lirio.us] publie actuellement ses signets en utilisant xFolk 0.4 (l'attribut de classe <code>extended</code> est utilisé au lieu de <code>description</code>).
* [http://dev.blogmarks.net/wiki/BlogSync blogmarks] exporte actuellement les signets vers les blogs en xFolk 0.4 (scrollez vers le bas pour voir l'exemple d'exportation sur la page ; l'attribut de classe <code>extended</code> est utilisé au lieu de <code>description</code>).
* [http://pokkari.com/microformat/javadoc/ Sivitols] est une librairie Java pour les microformats. Actuellement seul le standard xFolk RC1 est implémenté mais le support microformat additionnel est planifié. (adapté à partir de [http://blog.blip.tv/blog/microformats/])

== Références ==
=== Références Normatives ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [[rel-tag-fr|rel-tag]]

=== Références Informatives ===
* [http://thecommunityengine.com/home/archives/xfolk articles about xFolk]
* [http://thecommunityengine.com/home/archives/tags/microformats articles about the business value of microformats]
* [http://gataga.com gataga social bookmark search engine]
* [http://johnvey.com/features/deliciousdirector/ an ajax based interface for del.icio.us]
* [http://en.wikipedia.org/wiki/Social_bookmarking social bookmarking defined at wikipedia]

=== Travaux similaires ===
* [[hreview-fr| hReview]]

== 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 <code>extended</code> a été dépréciée en faveur de <code>description</code> 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 <code>extended</code> 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-fr| Vote Links]] ou [[hreview-fr | 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 ===
* [[xfolk-brainstorming-fr|xFolk brainstorming]]

== Discussions ==

=== Q&R ===
* Si vous avez quelque question à propos d'xFolk, regardez les [[xfolk-faq-fr|FAQ xFolk]], et si vous ne trouvez pas de réponses, ajoutez vos questions !

=== Problématiques ===
* SVP, ajoutez toute problématique avec la spécification au document séparé [[xfolk-issues-fr| xFolk issues]].

==Pages apparentées==
{{template:xfolk-related-pages-fr}}

xfolk

2008-06-25T14:27:19Z

Ashaszin: /* Example */

<h1> xFolk (RC1) </h1>

'''xFolk''' (from "xFolksomony") is a simple and open format for publishing collections of bookmarks. It better enables services for improving user experience and sharing data in web-based bookmarking software. xFolk may be embedded in HTML or XHTML, Atom, RSS, and arbitrary XML. It is one of several open [[microformats|microformat]] standards.

__TOC__

== Draft Specification ==

=== Editor/Author ===
[http://thecommunityengine.com/ Bud Gibson] ([http://thecommunityengine.com The Community Engine])

=== Copyright ===
{{MicroFormatCopyrightStatement2005}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== Inspiration and Acknowledgments ===
Thanks to: [http://www.cnbc.cmu.edu/~plaut/ David Plaut] who introduced me to the idea that items may partially belong to many categories at once. More recently, thanks to: [http://tantek.com/ Tantek Çelik], [http://epeus.blogspot.com/ Kevin Marks], [http://steve.osdir.com/ Steve Mallet], [http://hybernaut.com/ Brian DelVecchio], and [http://blogmarks.net François Hodierne] who have contributed to the development of xFolk with thoughtful critiques and implementations.

== Introduction ==
Social bookmarking services let users save and tag bookmarks to share with other users. Over the past year, the number of these services has mushroomed to [http://en.wikipedia.org/wiki/Social_bookmarking over 20], with popular examples including: [http://del.icio.us del.icio.us], [http://furl.net furl], [http://de.lirio.us de.lirio.us], [http://jots.com jots], and [http://blogmarks.net blogmarks].

Lack of an open, interoperable data standard is a major issue in using social bookmarking services. An open standard would make it possible to easily collect social bookmark data and remix it to invent new services along the lines of [http://gataga.com gataga]'s experimental bookmark search engine. An open standard would also make it possible to write javascripts that work across services [http://johnvey.com/features/deliciousdirector/ as some currently do for del.icio.us], enabling across-the-board improvements in user experience.

xFolk is an open social bookmarking standard that aims to achieve both benefits. Social bookmarking services that adopt xFolk will continue to differentiate themselves with data services. But, the data itself will be easy to manipulate by third party scripts and easy to share. As a result, bookmarking services will be able to offer a wider array of options to their users at low cost and focus on what truly differentiates them. Individuals or groups operating standalone bookmark repositories will have access to a wider array of functionality than they can produce on their own.

== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}

== Format ==
Extensive analysis of social bookmarking services and linkblogs, reported on [http://thecommunityengine.com/home/archives/xfolk elsewhere], reveals that the data published by both bookmarking services and '''many''' different linkblogs are described by the following implied schema:

* A bookmarked or tagged link.
* A title for the entry.
* Tags for the link.
* An extended description or summary of the link.

As demonstrated in early iterations of the xFolk standard, this general schema can be translated into markup by:

# creating a container element for each entry of class <code>xfolkentry</code>,
# using an <a> element for the bookmarked or tagged link of class <code>taggedlink</code>,
# using title attribute for the tagged link <a> element, if it exists, as the entry title, otherwise using the element value,
# using [[rel-tag]] for the tags, and
# using a container element of class <code>description</code>, such as <p>, for any extended description or summary.

A given xFolk entry will always contain a tagged link including a title with all other elements optional. Entries may have more than one tag as well as more than one element of class <code>description</code>. Multiple elements of class <code>description</code> are ordered by default document order. Semantic elements within xFolk entries may be nested at arbitray depths.

Many social bookmarking systems exist, each with its own markup conventions. Further, many people are already publishing personal link blogs. xFolk is designed with ease of adapting to these current practices as a primary goal. Therefore, few assumptions are made as to the exact kinds of elements used for an xFolk entry. Rather, the work of defining semantics is left entirely to the class and rel (in the case of [[rel-tag]]) attribute values.

It is expected that developers will use [http://www.w3.org/TR/xpath XPath] or equivalent syntax in accessing xFolk entry elements. a requirement for XPath is that the HTML document be well-formed but not necessarily valid. Thus, while not optimal, it is possible to serviceably use xFolk in an HTML document that does not validate.

=== XMDP Profile ===

See the [[xfolk-profile|xFolk profile]] for the [http://gmpg.org/xmdp XMDP] profile of xFolk.

== Example ==
Here is a sample bookmark as displayed in [http://del.icio.us del.icio.us]'s standard markup. Lines where the value of elements' class attributes must change to conform to xFolk are marked with a comment at the end.
<pre><div class="post"> 
<div>
<a class="delLink" href="http://www.sifry.com/alerts/archives/000306.html"> 
Sifry's Alerts: Technorati launches Related Tags
</a>
</div>
<div class="extended"> 
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> 
<a class="delNav" href="/fpgibson/technorati">technorati</a> 
... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
and 1 other person
</a>
... on 2005-04-09
</div>
</div></pre>

The equivalent in xFolk is as follows. Comments are placed at the end of lines where class attribute changes were required.
<pre><nowiki>
<div class="xfolkentry"> 
<div>
<a class="taggedlink" href="http://www.sifry.com/alerts/archives/000306.html"> 
Sifry's Alerts: Technorati launches Related Tags
</a>
</div>
<div class="description"> 
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> 
<a rel="tag" href="/fpgibson/technorati">technorati</a> 
... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
and 1 other person
</a>
... on 2005-04-09
</div>
</div>
</nowiki></pre>

Converting markup to be conformant with xFolk is almost always this easy. The advantage of xFolk is that it provides one set of class attributes that can be reused across all services and link blogs, almost always with no loss of granularity. The next section presents several more examples to illustrate this point.

Another simple example (using lists markup) :
<pre>
<nowiki>
<ul>
<li>
<ul class="xfolkentry">
<li><a class="taggedlink" href="http://microformats.org/wiki/Main_Page">microformats wiki</a></li>
<li class="description">The main place for understanding microformats and playing with...</li>
<li class="description">Community driven wiki</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>

</li>

</ul>
</nowiki>
</pre>

== Many more examples ==

We have numerous examples to help developers incorporate xFolk into their sites.

=== In the wild ===

These are real live examples of functioning systems that publish bookmarks in xFolk. These are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If you publish using xFolk, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

* [http://ashaszin.lautre.net/ Ashaszin] - Small blog running with [http://spip.net SPIP] : del.icio.us links and web feeds tagged with xFolk .
* [http://www.rolandinsh.lv/blog/ Rolands Umbrovskis - blog] all blog posts are marked up with xFolk.
* [http://www.bbc.co.uk/worldservice/bangladeshboat BBC World Service Bangladesh River Journey] a social network mashup, uses basic xFolk for bookmarking hAtom entries. See [http://dharmafly.com/blog/bangladeshboat Dharmafly blog discussion].
* [http://waferbaby.com/hussy waferbaby's Hussy] currently publishes links using xFolk.
* [http://smarking.com/ Smarking] currently publishes all shared links (including search results) using xFolk.
* [http://unalog.com unalog] currently publishes all shared links (including search results) using xFolk.
* [http://de.lirio.us de.lirio.us] currently publishes its bookmarks using xFolk (with the deprecated class attribute <code>extended</code> in place of <code>description</code>, see [[xfolk-profile | the XMDP]]).
* [http://dev.blogmarks.net/wiki/BlogSync blogmarks] currently exports bookmarks to blogs in xFolk (scroll down to the export example on the page; the deprecated class attribute <code>extended</code> is used in place of <code>description</code>, see [[xfolk-profile | the XMDP]]).
* [http://thecommunityengine.com The Community Engine] uses xFolk (with the deprecated class attribute <code>extended</code> in place of <code>description</code>, see [[xfolk-profile | the XMDP]]) for its [http://thecommunityengine.com/home main entries] and for its [http://thecommunityengine.com/webcites republished bookmarks].
* [http://groovymother.com/links/ Groovy Links] is a link blog which is marked up with xFolk.
* [http://tommorris.org/blog/ Tom Morris] - daily del.icio.us links are marked up with xFolk, [[hCard]] and [[vote-links]].

=== Additional social bookmarking services ===

This example illustrates how xFolk may be applied to one additional service:

* [[xfolk-scuttle | scuttle]]

=== Link blogs ===

Social bookmarking services are only the most recent examples of people publishing links. Link blogs have been around almost since the beginning of blogging. They represent somewhat more of a challenge for xFolk because their markup tends to be less semantic from the outset. The following examples illustrate some particular challenges and how they can be overcome.

* [[xfolk-kottke | kottke]]
* [[xfolk-pollas | pollas]]
* [[xfolk-jacobian | jacobian]]
* [[xfolk-julian-bez | julian-bez]]

=== Spam ===
Some spammers are adding xFolk tags to their link farms. (It's probably a bad idea to actually link to these sites.) For example,
* phontron.info

== Implementations ==

The following implementations have been developed which generate or use xFolk. If you have an xFolk implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

* [http://buzka.com Buzka], a social bookmarking service, now supports xFolk
* [http://blip.tv Blip.tv], a video hosting site, now [http://blog.blip.tv/blog/2006/08/19/blip-supports-xfolk/ supports xFolk].
* [http://www.s9y.org/ Serendipity], a PHP-powered, flexible Blogging/CMS application, now has a [http://www.numblog.de/archives/241-Social-Bookmarks-Plugin-for-Serendipity.html social bookmarks plugin] that supports xFolk.
* [http://claimid.com claimID] has implemented xFolk for people's links.
* [http://ma.gnolia.com ma.gnolia] now supports xFolk.
* [http://smarking.com/ Smarking.com] (a social bookmarking service) marks up their tagged links with xFolk! Hat tip: [http://3spots.blogspot.com/2006/05/social-bookmarking-smarking.html 3spots: Social + bookMARKING = Smarking] which itself is an [[hreview|hReview]].
* [http://blog.codeeg.com/2006/03/20/flock-tails-flocktails/ Flocktails] - port of Tails extension for Flock 0.5.12 that looks for hCards, hCalendar, xFolk and hReview and tosses them into a handy topbar
* [http://blog.codeeg.com/tails-firefox-extension/ Tails is a Firefox Extension] that will display the presence of microformats ([[hcard|hCard]], [[hcalendar|hCalendar]], [[hreview|hReview]], [[xfolk|xFolk]]) on a webpage.
* Bud Gibson and Mike Migurski [http://thecommunityengine.com/home/archives/2005/09/vegomatic_an_al.html have written] [http://thecommunityengine.com/veg-o-matic veg-o-matic], an xFolk reblogging tool and service.
* [http://inside.glnetworks.de/ Martin Rehfeld] has updated the work of [http://blogmatrix.blogmatrix.com/ David Janes] and produced a [[Greasemonkey]] [http://inside.glnetworks.de/2006/06/05/microformats-have-arrived-in-firefox-15-greasemonkey-06/ script] that finds many microformat elements, including xFolk and [http://blog.davidjanes.com/mtarchives/2005_08.html#003379 provides a popup menu of actions]. ''This will work with FireFox 1.5+/GreaseMonkey 0.6.4+ now.''
* [http://www.midgard-project.org/midcom-permalink-6416db7e1f0e297b4cf3dcc285702a8d net.nemein.bookmarks], the bookmark manager in [http://www.midgard-project.org/ Midgard CMS] uses xFolk as the native output format, with added <code>abbr class=posted</code> for publication date and <code>abbr class=poster</code> for user who added the bookmark. See [http://bergie.iki.fi/links/ example]
* [http://de.lirio.us de.lirio.us] currently publishes its bookmarks using xFolk 0.4 (the class attribute <code>extended</code> is used in place of description).
* [http://dev.blogmarks.net/wiki/BlogSync blogmarks] currently exports bookmarks to blogs in xFolk 0.4 (scroll down to the export example on the page; the class attribute <code>extended</code> is used in place of <code>description</code>).
* [http://pokkari.com/microformat/javadoc/ Sivitols] is a Java library for microformats. Currently only the xFolk RC1 standard is implemented, but additional microformat support is planned. (adapted from [http://blog.blip.tv/blog/microformats/])
* [http://bildu.net Bildu] a social bookmarking service in Basque that supports xFolk (an also rel-tag).
* [http://bookmarks.excite.co.uk/ Excite Bookmarks] a social bookmarking service that supports xFolk and rel-tag.

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [[rel-tag]]

=== Informative References ===
* [http://thecommunityengine.com/home/archives/xfolk articles about xFolk]
* [http://thecommunityengine.com/home/archives/tags/microformats articles about the business value of microformats]
* [http://gataga.com gataga social bookmark search engine]
* [http://johnvey.com/features/deliciousdirector/ an ajax based interface for del.icio.us]
* [http://en.wikipedia.org/wiki/Social_bookmarking social bookmarking defined at wikipedia]

=== Similar Work ===
* [[hreview | hReview]]

== Work in progress ==
Although this specification has recently begun to stabilize as indicated by the version RC1, it is still a work in progress. If warranted, I am prepared to go through multiple release candidates to achieve the narrow purpose of making bookmark entries more genrally accessible with as with as light weight a format as possible. All changes since the last iteration have been motivated by the implementation experience of developers attempting to achieve this narrow aim. Further changes will also most likely be motivated by implementation concerns. See "future directions" below for additional microformat possibilities.

=== Changes since xFolk 0.4 ===
The class attribute value <code>extended</code> was deprecated in favor <code>description</code> to better conform with other microformat usage and some requests during implementation. The other change has been to allow use of multiple elements of class <code>extended</code> based on some use cases discovered in implementation.

=== Future directions ===
There are several extensions one might imagine for xFolk. Frequently, these extensions are best achieved by combining xFolk with another microformat. For instance, one might want to indicate his or her evaluation of the bookmarked item. This might be achieved by using [[vote-links | Vote Links]] or [[hreview | hReview]] with xFolk.

One can also imagine extending xFolk to provide data conformant with various social bookmarking service APIs, for instance to provide all bookmarks by tag. These APIs are currently too fluid for specification in any kind of standard. The APIs and the functionality they provide represent one way social bookmarking services and meta services can differentiate themselves.

A companion format called "xFolk definition" is under development. xFolk definition will provide a means of explicitly defining the tags used in social bookmarks.

=== Brainstorming ===
* [[xfolk-brainstorming|xFolk brainstorming]]

== Discussions ==

=== Q&A ===
* If you have any questions about xFolk, check the [[xfolk-faq|xFolk FAQ]], and if you don't find answers, add your questions!

=== Issues ===
* Please add any issues with the specification to the separate [[xfolk-issues|xFolk issues]] document.

==Related pages==
{{template:xfolk-related-pages}}

xfolk

2008-06-23T17:56:06Z

Ashaszin: /* In the wild */

<h1> xFolk (RC1) </h1>

'''xFolk''' (from "xFolksomony") is a simple and open format for publishing collections of bookmarks. It better enables services for improving user experience and sharing data in web-based bookmarking software. xFolk may be embedded in HTML or XHTML, Atom, RSS, and arbitrary XML. It is one of several open [[microformats|microformat]] standards.

__TOC__

== Draft Specification ==

=== Editor/Author ===
[http://thecommunityengine.com/ Bud Gibson] ([http://thecommunityengine.com The Community Engine])

=== Copyright ===
{{MicroFormatCopyrightStatement2005}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== Inspiration and Acknowledgments ===
Thanks to: [http://www.cnbc.cmu.edu/~plaut/ David Plaut] who introduced me to the idea that items may partially belong to many categories at once. More recently, thanks to: [http://tantek.com/ Tantek Çelik], [http://epeus.blogspot.com/ Kevin Marks], [http://steve.osdir.com/ Steve Mallet], [http://hybernaut.com/ Brian DelVecchio], and [http://blogmarks.net François Hodierne] who have contributed to the development of xFolk with thoughtful critiques and implementations.

== Introduction ==
Social bookmarking services let users save and tag bookmarks to share with other users. Over the past year, the number of these services has mushroomed to [http://en.wikipedia.org/wiki/Social_bookmarking over 20], with popular examples including: [http://del.icio.us del.icio.us], [http://furl.net furl], [http://de.lirio.us de.lirio.us], [http://jots.com jots], and [http://blogmarks.net blogmarks].

Lack of an open, interoperable data standard is a major issue in using social bookmarking services. An open standard would make it possible to easily collect social bookmark data and remix it to invent new services along the lines of [http://gataga.com gataga]'s experimental bookmark search engine. An open standard would also make it possible to write javascripts that work across services [http://johnvey.com/features/deliciousdirector/ as some currently do for del.icio.us], enabling across-the-board improvements in user experience.

xFolk is an open social bookmarking standard that aims to achieve both benefits. Social bookmarking services that adopt xFolk will continue to differentiate themselves with data services. But, the data itself will be easy to manipulate by third party scripts and easy to share. As a result, bookmarking services will be able to offer a wider array of options to their users at low cost and focus on what truly differentiates them. Individuals or groups operating standalone bookmark repositories will have access to a wider array of functionality than they can produce on their own.

== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}

== Format ==
Extensive analysis of social bookmarking services and linkblogs, reported on [http://thecommunityengine.com/home/archives/xfolk elsewhere], reveals that the data published by both bookmarking services and '''many''' different linkblogs are described by the following implied schema:

* A bookmarked or tagged link.
* A title for the entry.
* Tags for the link.
* An extended description or summary of the link.

As demonstrated in early iterations of the xFolk standard, this general schema can be translated into markup by:

# creating a container element for each entry of class <code>xfolkentry</code>,
# using an <a> element for the bookmarked or tagged link of class <code>taggedlink</code>,
# using title attribute for the tagged link <a> element, if it exists, as the entry title, otherwise using the element value,
# using [[rel-tag]] for the tags, and
# using a container element of class <code>description</code>, such as <p>, for any extended description or summary.

A given xFolk entry will always contain a tagged link including a title with all other elements optional. Entries may have more than one tag as well as more than one element of class <code>description</code>. Multiple elements of class <code>description</code> are ordered by default document order. Semantic elements within xFolk entries may be nested at arbitray depths.

Many social bookmarking systems exist, each with its own markup conventions. Further, many people are already publishing personal link blogs. xFolk is designed with ease of adapting to these current practices as a primary goal. Therefore, few assumptions are made as to the exact kinds of elements used for an xFolk entry. Rather, the work of defining semantics is left entirely to the class and rel (in the case of [[rel-tag]]) attribute values.

It is expected that developers will use [http://www.w3.org/TR/xpath XPath] or equivalent syntax in accessing xFolk entry elements. a requirement for XPath is that the HTML document be well-formed but not necessarily valid. Thus, while not optimal, it is possible to serviceably use xFolk in an HTML document that does not validate.

=== XMDP Profile ===

See the [[xfolk-profile|xFolk profile]] for the [http://gmpg.org/xmdp XMDP] profile of xFolk.

== Example ==
Here is a sample bookmark as displayed in [http://del.icio.us del.icio.us]'s standard markup. Lines where the value of elements' class attributes must change to conform to xFolk are marked with a comment at the end.
<pre><div class="post"> 
<div>
<a class="delLink" href="http://www.sifry.com/alerts/archives/000306.html"> 
Sifry's Alerts: Technorati launches Related Tags
</a>
</div>
<div class="extended"> 
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> 
<a class="delNav" href="/fpgibson/technorati">technorati</a> 
... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
and 1 other person
</a>
... on 2005-04-09
</div>
</div></pre>

The equivalent in xFolk is as follows. Comments are placed at the end of lines where class attribute changes were required.
<pre><nowiki>
<div class="xfolkentry"> 
<div>
<a class="taggedlink" href="http://www.sifry.com/alerts/archives/000306.html"> 
Sifry's Alerts: Technorati launches Related Tags
</a>
</div>
<div class="description"> 
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> 
<a rel="tag" href="/fpgibson/technorati">technorati</a> 
... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
and 1 other person
</a>
... on 2005-04-09
</div>
</div>
</nowiki></pre>

Converting markup to be conformant with xFolk is almost always this easy. The advantage of xFolk is that it provides one set of class attributes that can be reused across all services and link blogs, almost always with no loss of granularity. The next section presents several more examples to illustrate this point.

== Many more examples ==

We have numerous examples to help developers incorporate xFolk into their sites.

=== In the wild ===

These are real live examples of functioning systems that publish bookmarks in xFolk. These are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If you publish using xFolk, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

* [http://ashaszin.lautre.net/ Ashaszin] - Small blog running with [http://spip.net SPIP] : del.icio.us links and web feeds tagged with xFolk .
* [http://www.rolandinsh.lv/blog/ Rolands Umbrovskis - blog] all blog posts are marked up with xFolk.
* [http://www.bbc.co.uk/worldservice/bangladeshboat BBC World Service Bangladesh River Journey] a social network mashup, uses basic xFolk for bookmarking hAtom entries. See [http://dharmafly.com/blog/bangladeshboat Dharmafly blog discussion].
* [http://waferbaby.com/hussy waferbaby's Hussy] currently publishes links using xFolk.
* [http://smarking.com/ Smarking] currently publishes all shared links (including search results) using xFolk.
* [http://unalog.com unalog] currently publishes all shared links (including search results) using xFolk.
* [http://de.lirio.us de.lirio.us] currently publishes its bookmarks using xFolk (with the deprecated class attribute <code>extended</code> in place of <code>description</code>, see [[xfolk-profile | the XMDP]]).
* [http://dev.blogmarks.net/wiki/BlogSync blogmarks] currently exports bookmarks to blogs in xFolk (scroll down to the export example on the page; the deprecated class attribute <code>extended</code> is used in place of <code>description</code>, see [[xfolk-profile | the XMDP]]).
* [http://thecommunityengine.com The Community Engine] uses xFolk (with the deprecated class attribute <code>extended</code> in place of <code>description</code>, see [[xfolk-profile | the XMDP]]) for its [http://thecommunityengine.com/home main entries] and for its [http://thecommunityengine.com/webcites republished bookmarks].
* [http://groovymother.com/links/ Groovy Links] is a link blog which is marked up with xFolk.
* [http://tommorris.org/blog/ Tom Morris] - daily del.icio.us links are marked up with xFolk, [[hCard]] and [[vote-links]].

=== Additional social bookmarking services ===

This example illustrates how xFolk may be applied to one additional service:

* [[xfolk-scuttle | scuttle]]

=== Link blogs ===

Social bookmarking services are only the most recent examples of people publishing links. Link blogs have been around almost since the beginning of blogging. They represent somewhat more of a challenge for xFolk because their markup tends to be less semantic from the outset. The following examples illustrate some particular challenges and how they can be overcome.

* [[xfolk-kottke | kottke]]
* [[xfolk-pollas | pollas]]
* [[xfolk-jacobian | jacobian]]
* [[xfolk-julian-bez | julian-bez]]

=== Spam ===
Some spammers are adding xFolk tags to their link farms. (It's probably a bad idea to actually link to these sites.) For example,
* phontron.info

== Implementations ==

The following implementations have been developed which generate or use xFolk. If you have an xFolk implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

* [http://buzka.com Buzka], a social bookmarking service, now supports xFolk
* [http://blip.tv Blip.tv], a video hosting site, now [http://blog.blip.tv/blog/2006/08/19/blip-supports-xfolk/ supports xFolk].
* [http://www.s9y.org/ Serendipity], a PHP-powered, flexible Blogging/CMS application, now has a [http://www.numblog.de/archives/241-Social-Bookmarks-Plugin-for-Serendipity.html social bookmarks plugin] that supports xFolk.
* [http://claimid.com claimID] has implemented xFolk for people's links.
* [http://ma.gnolia.com ma.gnolia] now supports xFolk.
* [http://smarking.com/ Smarking.com] (a social bookmarking service) marks up their tagged links with xFolk! Hat tip: [http://3spots.blogspot.com/2006/05/social-bookmarking-smarking.html 3spots: Social + bookMARKING = Smarking] which itself is an [[hreview|hReview]].
* [http://blog.codeeg.com/2006/03/20/flock-tails-flocktails/ Flocktails] - port of Tails extension for Flock 0.5.12 that looks for hCards, hCalendar, xFolk and hReview and tosses them into a handy topbar
* [http://blog.codeeg.com/tails-firefox-extension/ Tails is a Firefox Extension] that will display the presence of microformats ([[hcard|hCard]], [[hcalendar|hCalendar]], [[hreview|hReview]], [[xfolk|xFolk]]) on a webpage.
* Bud Gibson and Mike Migurski [http://thecommunityengine.com/home/archives/2005/09/vegomatic_an_al.html have written] [http://thecommunityengine.com/veg-o-matic veg-o-matic], an xFolk reblogging tool and service.
* [http://inside.glnetworks.de/ Martin Rehfeld] has updated the work of [http://blogmatrix.blogmatrix.com/ David Janes] and produced a [[Greasemonkey]] [http://inside.glnetworks.de/2006/06/05/microformats-have-arrived-in-firefox-15-greasemonkey-06/ script] that finds many microformat elements, including xFolk and [http://blog.davidjanes.com/mtarchives/2005_08.html#003379 provides a popup menu of actions]. ''This will work with FireFox 1.5+/GreaseMonkey 0.6.4+ now.''
* [http://www.midgard-project.org/midcom-permalink-6416db7e1f0e297b4cf3dcc285702a8d net.nemein.bookmarks], the bookmark manager in [http://www.midgard-project.org/ Midgard CMS] uses xFolk as the native output format, with added <code>abbr class=posted</code> for publication date and <code>abbr class=poster</code> for user who added the bookmark. See [http://bergie.iki.fi/links/ example]
* [http://de.lirio.us de.lirio.us] currently publishes its bookmarks using xFolk 0.4 (the class attribute <code>extended</code> is used in place of description).
* [http://dev.blogmarks.net/wiki/BlogSync blogmarks] currently exports bookmarks to blogs in xFolk 0.4 (scroll down to the export example on the page; the class attribute <code>extended</code> is used in place of <code>description</code>).
* [http://pokkari.com/microformat/javadoc/ Sivitols] is a Java library for microformats. Currently only the xFolk RC1 standard is implemented, but additional microformat support is planned. (adapted from [http://blog.blip.tv/blog/microformats/])
* [http://bildu.net Bildu] a social bookmarking service in Basque that supports xFolk (an also rel-tag).
* [http://bookmarks.excite.co.uk/ Excite Bookmarks] a social bookmarking service that supports xFolk and rel-tag.

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [[rel-tag]]

=== Informative References ===
* [http://thecommunityengine.com/home/archives/xfolk articles about xFolk]
* [http://thecommunityengine.com/home/archives/tags/microformats articles about the business value of microformats]
* [http://gataga.com gataga social bookmark search engine]
* [http://johnvey.com/features/deliciousdirector/ an ajax based interface for del.icio.us]
* [http://en.wikipedia.org/wiki/Social_bookmarking social bookmarking defined at wikipedia]

=== Similar Work ===
* [[hreview | hReview]]

== Work in progress ==
Although this specification has recently begun to stabilize as indicated by the version RC1, it is still a work in progress. If warranted, I am prepared to go through multiple release candidates to achieve the narrow purpose of making bookmark entries more genrally accessible with as with as light weight a format as possible. All changes since the last iteration have been motivated by the implementation experience of developers attempting to achieve this narrow aim. Further changes will also most likely be motivated by implementation concerns. See "future directions" below for additional microformat possibilities.

=== Changes since xFolk 0.4 ===
The class attribute value <code>extended</code> was deprecated in favor <code>description</code> to better conform with other microformat usage and some requests during implementation. The other change has been to allow use of multiple elements of class <code>extended</code> based on some use cases discovered in implementation.

=== Future directions ===
There are several extensions one might imagine for xFolk. Frequently, these extensions are best achieved by combining xFolk with another microformat. For instance, one might want to indicate his or her evaluation of the bookmarked item. This might be achieved by using [[vote-links | Vote Links]] or [[hreview | hReview]] with xFolk.

One can also imagine extending xFolk to provide data conformant with various social bookmarking service APIs, for instance to provide all bookmarks by tag. These APIs are currently too fluid for specification in any kind of standard. The APIs and the functionality they provide represent one way social bookmarking services and meta services can differentiate themselves.

A companion format called "xFolk definition" is under development. xFolk definition will provide a means of explicitly defining the tags used in social bookmarks.

=== Brainstorming ===
* [[xfolk-brainstorming|xFolk brainstorming]]

== Discussions ==

=== Q&A ===
* If you have any questions about xFolk, check the [[xfolk-faq|xFolk FAQ]], and if you don't find answers, add your questions!

=== Issues ===
* Please add any issues with the specification to the separate [[xfolk-issues|xFolk issues]] document.

==Related pages==
{{template:xfolk-related-pages}}

xfolk

2008-06-23T17:52:54Z

Ashaszin: /* Many more examples */

<h1> xFolk (RC1) </h1>

'''xFolk''' (from "xFolksomony") is a simple and open format for publishing collections of bookmarks. It better enables services for improving user experience and sharing data in web-based bookmarking software. xFolk may be embedded in HTML or XHTML, Atom, RSS, and arbitrary XML. It is one of several open [[microformats|microformat]] standards.

__TOC__

== Draft Specification ==

=== Editor/Author ===
[http://thecommunityengine.com/ Bud Gibson] ([http://thecommunityengine.com The Community Engine])

=== Copyright ===
{{MicroFormatCopyrightStatement2005}}

=== Patents ===
{{MicroFormatPatentStatement}}

=== Inspiration and Acknowledgments ===
Thanks to: [http://www.cnbc.cmu.edu/~plaut/ David Plaut] who introduced me to the idea that items may partially belong to many categories at once. More recently, thanks to: [http://tantek.com/ Tantek Çelik], [http://epeus.blogspot.com/ Kevin Marks], [http://steve.osdir.com/ Steve Mallet], [http://hybernaut.com/ Brian DelVecchio], and [http://blogmarks.net François Hodierne] who have contributed to the development of xFolk with thoughtful critiques and implementations.

== Introduction ==
Social bookmarking services let users save and tag bookmarks to share with other users. Over the past year, the number of these services has mushroomed to [http://en.wikipedia.org/wiki/Social_bookmarking over 20], with popular examples including: [http://del.icio.us del.icio.us], [http://furl.net furl], [http://de.lirio.us de.lirio.us], [http://jots.com jots], and [http://blogmarks.net blogmarks].

Lack of an open, interoperable data standard is a major issue in using social bookmarking services. An open standard would make it possible to easily collect social bookmark data and remix it to invent new services along the lines of [http://gataga.com gataga]'s experimental bookmark search engine. An open standard would also make it possible to write javascripts that work across services [http://johnvey.com/features/deliciousdirector/ as some currently do for del.icio.us], enabling across-the-board improvements in user experience.

xFolk is an open social bookmarking standard that aims to achieve both benefits. Social bookmarking services that adopt xFolk will continue to differentiate themselves with data services. But, the data itself will be easy to manipulate by third party scripts and easy to share. As a result, bookmarking services will be able to offer a wider array of options to their users at low cost and focus on what truly differentiates them. Individuals or groups operating standalone bookmark repositories will have access to a wider array of functionality than they can produce on their own.

== Semantic XHTML Design Principles ==
{{semantic-xhtml-design-principles}}

== Format ==
Extensive analysis of social bookmarking services and linkblogs, reported on [http://thecommunityengine.com/home/archives/xfolk elsewhere], reveals that the data published by both bookmarking services and '''many''' different linkblogs are described by the following implied schema:

* A bookmarked or tagged link.
* A title for the entry.
* Tags for the link.
* An extended description or summary of the link.

As demonstrated in early iterations of the xFolk standard, this general schema can be translated into markup by:

# creating a container element for each entry of class <code>xfolkentry</code>,
# using an <a> element for the bookmarked or tagged link of class <code>taggedlink</code>,
# using title attribute for the tagged link <a> element, if it exists, as the entry title, otherwise using the element value,
# using [[rel-tag]] for the tags, and
# using a container element of class <code>description</code>, such as <p>, for any extended description or summary.

A given xFolk entry will always contain a tagged link including a title with all other elements optional. Entries may have more than one tag as well as more than one element of class <code>description</code>. Multiple elements of class <code>description</code> are ordered by default document order. Semantic elements within xFolk entries may be nested at arbitray depths.

Many social bookmarking systems exist, each with its own markup conventions. Further, many people are already publishing personal link blogs. xFolk is designed with ease of adapting to these current practices as a primary goal. Therefore, few assumptions are made as to the exact kinds of elements used for an xFolk entry. Rather, the work of defining semantics is left entirely to the class and rel (in the case of [[rel-tag]]) attribute values.

It is expected that developers will use [http://www.w3.org/TR/xpath XPath] or equivalent syntax in accessing xFolk entry elements. a requirement for XPath is that the HTML document be well-formed but not necessarily valid. Thus, while not optimal, it is possible to serviceably use xFolk in an HTML document that does not validate.

=== XMDP Profile ===

See the [[xfolk-profile|xFolk profile]] for the [http://gmpg.org/xmdp XMDP] profile of xFolk.

== Example ==
Here is a sample bookmark as displayed in [http://del.icio.us del.icio.us]'s standard markup. Lines where the value of elements' class attributes must change to conform to xFolk are marked with a comment at the end.
<pre><div class="post"> 
<div>
<a class="delLink" href="http://www.sifry.com/alerts/archives/000306.html"> 
Sifry's Alerts: Technorati launches Related Tags
</a>
</div>
<div class="extended"> 
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> 
<a class="delNav" href="/fpgibson/technorati">technorati</a> 
... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
and 1 other person
</a>
... on 2005-04-09
</div>
</div></pre>

The equivalent in xFolk is as follows. Comments are placed at the end of lines where class attribute changes were required.
<pre><nowiki>
<div class="xfolkentry"> 
<div>
<a class="taggedlink" href="http://www.sifry.com/alerts/archives/000306.html"> 
Sifry's Alerts: Technorati launches Related Tags
</a>
</div>
<div class="description"> 
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> 
<a rel="tag" href="/fpgibson/technorati">technorati</a> 
... <a class="delNav" href="/url/cbcabf7de070fdb46598ee679367be49">
and 1 other person
</a>
... on 2005-04-09
</div>
</div>
</nowiki></pre>

Converting markup to be conformant with xFolk is almost always this easy. The advantage of xFolk is that it provides one set of class attributes that can be reused across all services and link blogs, almost always with no loss of granularity. The next section presents several more examples to illustrate this point.

== Many more examples ==

We have numerous examples to help developers incorporate xFolk into their sites.

=== In the wild ===

These are real live examples of functioning systems that publish bookmarks in xFolk. These are a great place to start for anyone looking for examples "in the wild" to try parsing, indexing, organizing etc. If you publish using xFolk, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

* [http://www.rolandinsh.lv/blog/ Rolands Umbrovskis - blog] all blog posts are marked up with xFolk.
* [http://www.bbc.co.uk/worldservice/bangladeshboat BBC World Service Bangladesh River Journey] a social network mashup, uses basic xFolk for bookmarking hAtom entries. See [http://dharmafly.com/blog/bangladeshboat Dharmafly blog discussion].
* [http://waferbaby.com/hussy waferbaby's Hussy] currently publishes links using xFolk.
* [http://smarking.com/ Smarking] currently publishes all shared links (including search results) using xFolk.
* [http://unalog.com unalog] currently publishes all shared links (including search results) using xFolk.
* [http://de.lirio.us de.lirio.us] currently publishes its bookmarks using xFolk (with the deprecated class attribute <code>extended</code> in place of <code>description</code>, see [[xfolk-profile | the XMDP]]).
* [http://dev.blogmarks.net/wiki/BlogSync blogmarks] currently exports bookmarks to blogs in xFolk (scroll down to the export example on the page; the deprecated class attribute <code>extended</code> is used in place of <code>description</code>, see [[xfolk-profile | the XMDP]]).
* [http://thecommunityengine.com The Community Engine] uses xFolk (with the deprecated class attribute <code>extended</code> in place of <code>description</code>, see [[xfolk-profile | the XMDP]]) for its [http://thecommunityengine.com/home main entries] and for its [http://thecommunityengine.com/webcites republished bookmarks].
* [http://groovymother.com/links/ Groovy Links] is a link blog which is marked up with xFolk.
* [http://tommorris.org/blog/ Tom Morris] - daily del.icio.us links are marked up with xFolk, [[hCard]] and [[vote-links]].
* [http://ashaszin.lautre.net/ Ashaszin] - Blog : del.icio.us links and web feeds tagged with xFolk .

=== Additional social bookmarking services ===

This example illustrates how xFolk may be applied to one additional service:

* [[xfolk-scuttle | scuttle]]

=== Link blogs ===

Social bookmarking services are only the most recent examples of people publishing links. Link blogs have been around almost since the beginning of blogging. They represent somewhat more of a challenge for xFolk because their markup tends to be less semantic from the outset. The following examples illustrate some particular challenges and how they can be overcome.

* [[xfolk-kottke | kottke]]
* [[xfolk-pollas | pollas]]
* [[xfolk-jacobian | jacobian]]
* [[xfolk-julian-bez | julian-bez]]

=== Spam ===
Some spammers are adding xFolk tags to their link farms. (It's probably a bad idea to actually link to these sites.) For example,
* phontron.info

== Implementations ==

The following implementations have been developed which generate or use xFolk. If you have an xFolk implementation, feel free to add it to the top of this list. Once the list grows too big, we'll make a separate wiki page.

* [http://buzka.com Buzka], a social bookmarking service, now supports xFolk
* [http://blip.tv Blip.tv], a video hosting site, now [http://blog.blip.tv/blog/2006/08/19/blip-supports-xfolk/ supports xFolk].
* [http://www.s9y.org/ Serendipity], a PHP-powered, flexible Blogging/CMS application, now has a [http://www.numblog.de/archives/241-Social-Bookmarks-Plugin-for-Serendipity.html social bookmarks plugin] that supports xFolk.
* [http://claimid.com claimID] has implemented xFolk for people's links.
* [http://ma.gnolia.com ma.gnolia] now supports xFolk.
* [http://smarking.com/ Smarking.com] (a social bookmarking service) marks up their tagged links with xFolk! Hat tip: [http://3spots.blogspot.com/2006/05/social-bookmarking-smarking.html 3spots: Social + bookMARKING = Smarking] which itself is an [[hreview|hReview]].
* [http://blog.codeeg.com/2006/03/20/flock-tails-flocktails/ Flocktails] - port of Tails extension for Flock 0.5.12 that looks for hCards, hCalendar, xFolk and hReview and tosses them into a handy topbar
* [http://blog.codeeg.com/tails-firefox-extension/ Tails is a Firefox Extension] that will display the presence of microformats ([[hcard|hCard]], [[hcalendar|hCalendar]], [[hreview|hReview]], [[xfolk|xFolk]]) on a webpage.
* Bud Gibson and Mike Migurski [http://thecommunityengine.com/home/archives/2005/09/vegomatic_an_al.html have written] [http://thecommunityengine.com/veg-o-matic veg-o-matic], an xFolk reblogging tool and service.
* [http://inside.glnetworks.de/ Martin Rehfeld] has updated the work of [http://blogmatrix.blogmatrix.com/ David Janes] and produced a [[Greasemonkey]] [http://inside.glnetworks.de/2006/06/05/microformats-have-arrived-in-firefox-15-greasemonkey-06/ script] that finds many microformat elements, including xFolk and [http://blog.davidjanes.com/mtarchives/2005_08.html#003379 provides a popup menu of actions]. ''This will work with FireFox 1.5+/GreaseMonkey 0.6.4+ now.''
* [http://www.midgard-project.org/midcom-permalink-6416db7e1f0e297b4cf3dcc285702a8d net.nemein.bookmarks], the bookmark manager in [http://www.midgard-project.org/ Midgard CMS] uses xFolk as the native output format, with added <code>abbr class=posted</code> for publication date and <code>abbr class=poster</code> for user who added the bookmark. See [http://bergie.iki.fi/links/ example]
* [http://de.lirio.us de.lirio.us] currently publishes its bookmarks using xFolk 0.4 (the class attribute <code>extended</code> is used in place of description).
* [http://dev.blogmarks.net/wiki/BlogSync blogmarks] currently exports bookmarks to blogs in xFolk 0.4 (scroll down to the export example on the page; the class attribute <code>extended</code> is used in place of <code>description</code>).
* [http://pokkari.com/microformat/javadoc/ Sivitols] is a Java library for microformats. Currently only the xFolk RC1 standard is implemented, but additional microformat support is planned. (adapted from [http://blog.blip.tv/blog/microformats/])
* [http://bildu.net Bildu] a social bookmarking service in Basque that supports xFolk (an also rel-tag).
* [http://bookmarks.excite.co.uk/ Excite Bookmarks] a social bookmarking service that supports xFolk and rel-tag.

== References ==
=== Normative References ===
* [http://www.w3.org/TR/2002/REC-xhtml1-20020801/ XHTML 1.0 SE]
* [[rel-tag]]

=== Informative References ===
* [http://thecommunityengine.com/home/archives/xfolk articles about xFolk]
* [http://thecommunityengine.com/home/archives/tags/microformats articles about the business value of microformats]
* [http://gataga.com gataga social bookmark search engine]
* [http://johnvey.com/features/deliciousdirector/ an ajax based interface for del.icio.us]
* [http://en.wikipedia.org/wiki/Social_bookmarking social bookmarking defined at wikipedia]

=== Similar Work ===
* [[hreview | hReview]]

== Work in progress ==
Although this specification has recently begun to stabilize as indicated by the version RC1, it is still a work in progress. If warranted, I am prepared to go through multiple release candidates to achieve the narrow purpose of making bookmark entries more genrally accessible with as with as light weight a format as possible. All changes since the last iteration have been motivated by the implementation experience of developers attempting to achieve this narrow aim. Further changes will also most likely be motivated by implementation concerns. See "future directions" below for additional microformat possibilities.

=== Changes since xFolk 0.4 ===
The class attribute value <code>extended</code> was deprecated in favor <code>description</code> to better conform with other microformat usage and some requests during implementation. The other change has been to allow use of multiple elements of class <code>extended</code> based on some use cases discovered in implementation.

=== Future directions ===
There are several extensions one might imagine for xFolk. Frequently, these extensions are best achieved by combining xFolk with another microformat. For instance, one might want to indicate his or her evaluation of the bookmarked item. This might be achieved by using [[vote-links | Vote Links]] or [[hreview | hReview]] with xFolk.

One can also imagine extending xFolk to provide data conformant with various social bookmarking service APIs, for instance to provide all bookmarks by tag. These APIs are currently too fluid for specification in any kind of standard. The APIs and the functionality they provide represent one way social bookmarking services and meta services can differentiate themselves.

A companion format called "xFolk definition" is under development. xFolk definition will provide a means of explicitly defining the tags used in social bookmarks.

=== Brainstorming ===
* [[xfolk-brainstorming|xFolk brainstorming]]

== Discussions ==

=== Q&A ===
* If you have any questions about xFolk, check the [[xfolk-faq|xFolk FAQ]], and if you don't find answers, add your questions!

=== Issues ===
* Please add any issues with the specification to the separate [[xfolk-issues|xFolk issues]] document.

==Related pages==
{{template:xfolk-related-pages}}