publication hCalendar

From Microformats Wiki
Jump to navigation Jump to search


Cette page contient quelques trucs et instructions utiles pour savoir comment publier des événements hCalendar soit à partir de rien, ou en ajoutant du balisage à un contenu existant.

But : Le but de ce document est de fournir quelques instructions intuitives qui devraient faire qu'il soit aussi facile et aussi rapide que possible pour n'importe quel auteur web de créer des événements hCalendar ou d'ajouter du balisage hCalendar à un contenu existant.

Audience : auteurs web et designers. Ce document est écrit pour une consommation et une compréhension facile par n'importe quel designer web qui connaît au moins assez (X)HTML et CSS pour utiliser les noms de classe HTML sur les éléments et écrire des sélecteurs CSS qui appliquent des styles à ces noms de classes. SVP aidez à clarifier / simplifier ce document.


Auteur(s) : Tantek Çelik

(traduction Christophe Ducamp)

Créer des nouveaux événements hCalendar

Commencez avec le hCalendar creator, et pour les champs additionnels (par ex. contact, participants, etc.), voir la page exemples hCalendar tout comme le reste de cette page.

Ajouter du balisage hCalendar à du contenu existant

Changements minimaux de syntaxe

La chose importante à garder en tête au moment d'ajouter des microformats à du contenu existant, est le fait que les microformats sont conçus de telle manière qu'ils peuvent être ajoutés avec des changements minimaux (presque toujours aucun) à la présentation existante de la page. De ce fait, gardez ça en tête : changez aussi peu de balisage que possible. Si vous voulez aussi préparer différentes pages pour qu'elles soient valides XHTML, c'est un très joli but et hautement encouragé.

Trouver les Événements

Commencez par regarder toutes les mentions des événements sur une page, telle qu'une liste d'"Evénements à Venir" ou d'"Évènements Récents". Ce sont tous des 'events' potentiels hCalendar. Même plus s'ils sont liés vers leurs URLs respectives (par ex. les pages d'un événement unique avec plus de détails).

Si un évènement est mentionné plusieurs fois sur une page, considérez de baliser la mention qui est la plus pertinente, détaillée, définitive, ou autrement complète comme un évènement hCalendar. Idéalement, vous pourriez vouloir baliser toutes les instances d'un événement avec hCalendar, mais à ce stade, faites simple et balisez l'instance la plus représentative. (Peut-être que l'instance la plus "définitive", qui pourrait être ensuite balisée avec un élément <dfn> autour du 'summary/title' de l'évènement pour le bien d'un XHTML sémantique additionnel.)

Déterminer l'Élément enveloppant pour Chacun

Pour chaque évènement que vous voulez ajouter à hCalendar, trouvez le plus petit élément qui contient toute l'information à propos de cet événement, sans chevauchement avec tout autre événement sur la page.

Ajoutez le nom de classe "vevent" à cet élément.

Si un tel élément n'existe pas (peut-être que l'élément enveloppant le plus proche contient plus d'un évènement), alors ajoutez un <span class="vevent">...</span> ou <div class="vevent">...</div> qui enveloppe l'information à propos de cet évènement et rien que cet évènement.

Le reste de la syntaxe pour cet 'event' hCalendar DOIT aller dans cet élément-là avec le nom de classe "vevent".

Dans tous le cas, où ça dit d'ajouter un élément avec le nom de classe de "xyz", si vous pouvez trouver un élément existant qui entoure le contenu nécessaire, alors ré-utilisez cet-élément là et ajoutez-lui simplement le nom de classe "xyz" (en l'ajoutant à l'attribut de classe sur l'élément existant, ou en ajoutant un nouvel attribut de classe class="xyz" aux éléments sans attribut de classe).

Par exemple, en imaginant que vous ayez la syntaxe suivante : 

    <div class="someFoo">
       <p> Ceci est mon merveilleux balisage, il contient quelque information d'événement nichée à l'intérieur</p>
       <h6>Un Evènement Merveilleux</h6>
       <p> De la part des personnes qui vont apporté des Moments Géniaux et de l'Amusement, 
           voilà Quelque Evènement Merveilleux au Stade de Sport Local. 
           Venez à <b>Une Heure Spécifiée</b>, et amusez-vous ! </p>
    </div>

Si vous avez besoin d'ajouter un élément avec la classe de "vevent" autour du contenu de votre évènement, vous pourriez réutiliser l'élément div existant et y ajouter la classe "vevent" comme suit : 

    <div class="quelqueFoo vevent">

De la même manière, si vous décidez de ne pas réutiliser un conteneur existant, vous pouvez juste emballer le contenu autour d'un nouveau bloc : 

    <div class="quelqueFoo">
      <div class="vevent">
         <p> Ceci est mon merveilleux...
         ...
         ... et amusez-vous ! </p>
      </div>
    </div>

L'Importance du Temps et du Sujet

Plusieurs propriétés sont requises dans hCalendar. Au minimum, un événement à besoin d'un "summary" (comme un titre) et "dtstart" (date et heure de démarrage), tout comme soit un "dtend" (date et heure de fin) ou une "duration" (durée). De ce fait, soyez sûr de baliser le nom/résumé/titre de l'événement avec le nom de classe "summary". Par ex. : 

<div class="vevent">
 <span class="summary">Un Evènement A Part, New York City, NY</span>,
 <abbr class="dtstart" title="2006-07-10">10</abbr>-<abbr class="dtend" title="2006-07-11">11 juillet 2006</abbr>
</div>

Cet évènement pourrait être présenté comme :

Un Évènement A Part, New York City, NY, 10-11 juillet 2006

Note : l'utilisation de l'attribut du titre de l'élément abbr pour baliser un "datetime" absolu lisible par une machine en plus du texte lisible par l'humain.

Separate dates and times

Souvent les pages affichent la date d'un événement et ses horaires séparément, peut-être pour des raisons de style ou mise en forme, par exemple le Calendrier des événement SPHCM place la date dans un titre stylisé (devrait probablement être un h3), et les horaires comme suit : 

<div class="eventdate">October 2</div>
<div class="eventtime">3:30 pm - 4:50 pm</div>

Dans de tels cas, plutôt que d'avoir à refaire le marquage (qui peut être servi à d'autre fins) pour combiner la date et l'heure dans un seul élément unique, utilisez une div enveloppante pour marquer la date et l'heure de démarrage avec dtstart et un span juste pour l'horaire de fin avec dtend, par ex.: (espace blanc ajouté pour la lisibilité) 

<div class="dtstart">
 <div class="eventdate"><abbr class="value" title="2007-10-02">2 octobre</abbr></div>
 <div class="eventtime">
  <span class="value">15h30</span> - 
  <span class="dtend">16h50</span>
 </div>
</div>

Cet exemple utilise la technique du modèle de classe value, spécifiquement à la fois les techniques de séparation de date et de l'horaire et de la [dtend implicite].


Éliminer le Souligné Pointillé par Défaut

Quelques navigateurs (Camino, Firefox, Mozilla) placent un souligné pointillé ou une bordure sur chaque abbr. Vous pouvez utiliser la règle suivante dans votre feuille de style pour éliminer cette présentation par défaut. 

.vevent abbr{border:0}

Dans l'exemple ci-dessus "Un Événement A Part", ceci devrait avoir l'effet suivant (qui peut ne pas quelque différence pour quelques lecteurs) :

Un Évènement A Part, New York City, NY, 10-11 juillet 2006

URLs représentatives

L'un des modèles les plus communs pour les évènements sur le web est de les lier vers leurs sites web préférés/qui font autorité.

Les "Event Rolls" sont un bon exemple de cela (voir aussi XOXO pour une liste sémantique propre et un balisage de structure.)

Parce l'attribut de classe prend un ensemble séparé de noms de classe, on peut souvent baliser l'URL sur le même élément, par ex. en remplaçant le premier <span> dans l'exemple au-dessus avec un hyperlien <a href> : 

<div class="vevent">
 <a href="http://aneventapart.com/events/2006/nyc/" class="summary url">Un Évènément A Part, New York City, NY</a>,
 <abbr class="dtstart" title="20060710">10</abbr>-<abbr class="dtend" title="2006-07-11">11 juillet 2006</abbr>
</div>

Cet évènement pourrait être présenté comme :

Un Evènement A Part, New York City, NY, 10-11 juillet 2006

Location Location Location

Comme dans l'immobilier, l'emplacement d'un évènement est tout à fait pertinent, et important pour un balisage propre. Au minimum, identifiez l'information apparentée au lieu dans l'"event" et balisez-la avec le nom de classe "location", par ex. en continuant avec les exemples suivants : 

<div class="vevent">
 <a href="http://aneventapart.com/events/2006/nyc/" class="summary url">Un Évènement A Part, 
  <span class="location">New York City, NY</span></a>, 
 <abbr class="dtstart" title="2006-07-10">10</abbr>-<abbr class="dtend" title="2006-07-11">11 juillet 2006</abbr>
</div>

Ceci est bien, mais peut même être produit encore mieux avec l'ajout du microformat adr pour identifier explicitement la ville et l'état : 

<div class="vevent">
 <a href="http://aneventapart.com/events/2006/nyc/" class="summary url">Un Évènement A Part, 
  <span class="location adr"><span class="locality">New York City</span>, <span class="region">NY</span></span></a>, 
 <abbr class="dtstart" title="2006-07-10">10</abbr>-<abbr class="dtend" title="20060711">11 juillet 2006</abbr>
</div>

Même encore mieux, si l'endroit a un nom, tel qu'un commerce ou une société, transformer le lieu en une hCard complète plutôt qu'un simple adr : 

<div class="vevent">
 <a href="http://aneventapart.com/events/2006/nyc/" class="summary url">Un Évènement A Part, 
  <span class="location vcard">
   <span class="fn org">Scandinavia House</span>,
   <span class="adr"><span class="locality">New York City</span>, <span class="region">NY</span></span>
  </span></a>,
 <abbr class="dtstart" title="2006-07-10">10</abbr>-<abbr class="dtend" title="2006-07-11">11 juillet 2006</abbr>
</div>

Plus de trucs et d'instructions

Sentez-vous libre d'ajouter plus de trucs que l'expérience vous a enseignée au moment de baliser les évènements avec hCalendar, même si tout ce que vous ajoutez n'est qu'une brève "catch phrase" qui vous revient en tête.

  • Comment baliser le contact et l'organisateur
  • Comment baliser les participants (y compris les conférenciers)
  • ...


Ajouter un lien d'abonnement à des événements

Quand vous mettez à jour vos événements pour y inclure un marquage hCalendar, vous pouvez aussi y inclure des liens comme "Ajouter les Événéments à votre Agenda" et/ou "Abonnez-vous aux Événements" pour faciliter le travail de vos utilisateurs.

Voici quelques exemples de tels liens : 

<a href="http://h2vx.com/ics/http://microformats.org/wiki/events">
Ajouter les Événéments à votre Agenda
</a>

<a href="webcal://h2vx.com/ics/http://microformats.org/wiki/events">
Abonnez-vous aux Événements
</a>

Substituez simplement le lien vers vos événements hCalendar pour l'URL http://microformats.org/wiki/events URL ci-dessus.

Si vous voulez, vous pouvez aussi utiliser le service X2V hébergé de Brian Suda ou même télécharger et installer vous-même le XSLT X2V et le faire fonctionner sur votre propre serveur au lieu d'utiliser un service de conversion en ligne hCalendar vers iCalendar (.ics).


Pages en rapport

Cette spécification est un chantier en cours. Au fur et à mesure que les aspects additionnels sont discutés, compris et écrits, ils seront ajoutés. Ces idées et questions sont maintenues sur des pages séparées.

Retrieved from "http://microformats.org/wiki/index.php?title=hcalendar-authoring-fr&oldid=69803"