dtend-problématique

From Microformats Wiki
Jump to navigation Jump to search


Une problématique hCalendar.

résumé

La propriété dtend hCalendar de hCalendar 0.1. requiert que les dates de fin soient marquées comme arrivant un jour complet après ce que les personnes considèrent généralement comme la fin de la date d'un événement.

Par ex. si une conférence démarre le 12 mars 2010 et se termine le 16 mars 2010, alors la dtend doit être marquée avec la valeur de "2010-03-17" - ce qui s'apparente à un jour complet après la fin de la conférence. hCalendar suggère d'obscurcir cette disparité entre la date de fin visible par l'humain et la date machine spécifiée en utilisant la balise <abbr> :

<div class="vevent">
 <span class="summary">une conférence</span>
 démarre le <span class="dtstart">2010-03-12</span>, et 
 se termine le <abbr class="dtend" title="2010-03-17">2010-03-16</abbr>.
</div>

C'est dû au fait que hCalendar a été spécifié initialement avec la même sémantique que iCalendar, ce qui place cette exigence sur la propriété DTEND de l'objet VEVENT.

problèmes

C'est problématique pour plusieurs raisons :

  • Incohérence. Il est étrange que la valeur spécifiée pour la consommation machine soit différente de la valeur spécifiée pour une consommation humaine - sans parler de format/syntaxe - et cela semble incohérent pour quiconque voit l'infobulle, ou voit et copie/colle la source. Cela ressemble à un bug ou une erreur, et en fait cela a été "corrigé" en tant que tel (par ex. même dans la spec hCalendar elle-même)
  • Non intuitif pour la rédaction. Quand les auteurs écrivent la fin de date d'un événement, ils écrivent ce que les humains s'attendent à voir - le dernier jour de l'événement. C'est un saut non intuitif de penser à spécifier +1 jour pour la consommation machine, et une charge cognitive supplémentaire.
  • Abus sémantique de abbr. Un attribut title de abbr fournit une expansion du texte à l'intérieur. En aucun cas ce n'est une date +1, il ressemble plus à une valeur complètement différente.
  • Violation Requise de DRY.Alors que le dtstart dans le code au-dessus n'est spécifié qu'une seule fois, lisible à la fois pour les humaines et les machines, le dtend doit être spécifié deux fois, une fois pour les humains, et une autres fois pour les machines, exigeant par conséquent une violation très mauvaise du principe DRY (Don't Repeat Yourself), que d'exiger à spécifier deux fois la donnée, mais légèrement différente d'une instance à l'autre, accroissant par conséquent les chances de duplication basées sur les erreurs. (parce que la vérification devient plus difficile)
    • Empêche l'utilisation d'un marquage simple Résultat de la violation du DRY, il n'est pas possible d'utiliser un marquage simple comme <span class="dtend">2010-03-16</span> parce que pendant qu'un humain lit qu'un événement se termine le 16, un processeur hCalendar 1.0 lira q'un événement s'est terminé le jour d'avant, le 15.

solutions possibles

Comme noté dans la description du problème sur la page problématiques hCalendar, il y a au moins quelques solutions possibles.

dtend dates incluses

problématique résolue

  • redéfinir dtend hCalendar 1.0.1 pour être incluse pour les dates globales.
    • Avantage : Zéro impact sur le vocabulaire.
    • Avantage : Pas d'augmentation de la complexité à publier hCalendar.
    • Avantage : Reflétera l'usage dominant de dtend dans les exemples dans la jungle, (plus de recherche et citations demandées). En d'autres mots, les auteurs on DEJA utilisé dtend en supposant que ça fonctionne de cette façon (dates de fin incluses), et seront en fait surpris de trouver que ce ne l'est pas. Faire ce changement à la sémantique DtEND peut en fait refléter plus la réalité de publication hCalendar que de conserver la sémantique précise du DTEND iCalendar. Exemples d'usage de dtend incluses dans la jungle :
      • http://barcamp.org/ - BarCamp wiki, dates pour les BarCamps
      • microformats.org/wiki/events/ - plusieurs événements sur plusieurs jours, comme celui récemment de Glenn Jones (qui se décrit lui-même comme un développeur "très" connaisseur et prolifique de microformats) la page événement SXSW 2010 utilise des DTEND incluses, (notamment un élément span qui ne fait PAS de contenu dupliqué).
      • la version draft du livre d'Emily Lewis Microformats Made Simple, utilise dtend pour les dates de fin incluses.
      • La page personnelle de Dan Cederholm SimpleBits connaisseur et expert a un calendrier événements qui utilise des dates incluses dtend.
      • http://upcoming.org (apparemment selon Michael Kaply)
      • ... plus d'instances de l'usage existant de DTEND pour des dates de fin *incluses*.
    • Avantage : Bon nombre d'implémentations traitent les dates DTEND comme *incluses* (techniquement celles-ci violent la spec hCalendar en cours, mais elles peuvent délibérément faire ainsi pour refléter les pratiques de publication hCalendar actuelles). Implémentations :
      • le validateur Rich Snippet de Google. Le validateur Rich Snippet sur microformats.org/wiki/events montre l'événement SXSW comme se finissant le 2010-03-16, ce qui est cohérent avec l'intention de publication.
      • ... plus d'implémentations qui traitent les dates dtend hCalendar comme incluses
    • ... autres avantages ?
    • Inconvénients : Redéfinit DTEND pour être *légèrement* différent de la façon dont il est défini dans iCalendar. Ceci peut mener à des erreurs de la part des développeurs.
      • Mitigation : it may be possible to mitigate this disadvantage by providing both very precise hCalendar to iCalendar processor conformance requirements, and sufficient test cases for hCalendar to iCalendar processors for them to get this correct in their code.
    • Inconvénients : breaking some amount of existing hCalendar content on the web (research needed to determine the extent of the problem)
      • Workarounds: Based on aforementioned research, workarounds may be possible, e.g. heuristics for when abbr is used similar to the example at the top of the page, to detect "off by one" cases and accommodate accordingly). Make it an explicit error for the human visible date to be different than the machine parsed date, and state specific error handling rules for hCalendar processors that "repair" this problem.
    • ... any other disadvantages?
    • Opinions :
      • +1 Based on the fact that this problem just hasn't gone away, and that people (smart knowledgable people!) continue to treat "dtend" end dates *inclusively*, I now think it makes more sense (and is more practical) to change the spec to be consistent with the dominant expectation of web authors, rather than continue attempting to change the expectations of web authors to be consistent with the spec. I think this is the simplest, most effective, and least risky option. Tantek
      • +1 This appears logical and intuitive. We are effectively saying that end dates such as DTEND should parse to YYYY-MM-DDT24:00:00, and not YYYY-MM-DDT00:00:00. Seems simple, and entirely logical from a publishing stand —BenWard 08:18, 27 August 2009 (UTC)
      • +1 The spec should reflect the intuitive publishing behaviour (inclusive end dates). Humans first. —Jeremy Keith
      • +1 Though I'm worried about tools catching up to this change. Ted
      • +1 The natural human way to think about dates is inclusively; if the dtend date and dtstart date are equal, that clearly doesn't imply zero duration. The microformats principle of making things easier for authors rather than parser writers wins here Kevin Marks
      • +1 It is much easier to migrate the limited number of tools and authors who already grok hCalendar 1.0 than to migrate publisher intuition. MatthewLevine
      • +1 I agree with MatthewLevine. Those who follow hCalendar development are likely to make the change to inclusive dates, and those who don't are likely using inclusive dates already. Chris Cressman
      • ... please add your +1/0/-1 opinion here and sign with three tildas (~~~)

Tests de cas avec dtend incluse

Tests de cas qui vérifient l'implémentation de cette résolution de problème :

nouvelle propriété pour dates de fin

  • new hCalendar 1.0.1 property for end dates. As noted in the first resolution of the issue, we could introduce a new property, dtlast (described more in hCalendar brainstorming: dtlast) which authors would use to specify the last day of an event, instead of dtend.
    • Advantage: Maintains iCalendar conceptual compatibility for DTEND values.
    • Advantage: Compatibility with existing hCalendar 1.0 content that just happened to get the end date +1 distinction right.
    • ... any other advantages?
    • Disadvantage: Increased vocabulary. dtlast is a new term, even if it is not new functionality. Essentially this puts additional burden on authors.
    • Disadvantage: Increased complexity/confusion. When to use dtend vs. dtlast? hCalendar authors would now have to remember, use dtend for end *times* and dtlast for end *dates*. More explanation of the additional burden on authors.
    • ... any other disadvantages?
    • Opinions:
      • -1 despite originally proposing this solution, I now think an additional term, and rule for when to use the new term vs. the old term will actually make this problem worse and more confusing to web authors. Tantek
      • ... please add your +1/0/-1 opinion here and sign with three tildas (~~~)

autres

  • ... autres solutions possibles ?


origines

Cette problématique a été soulevée par Tantek presque depuis le tout début où il donné un exemple en 2004, c'est quelque chose qu'il a dû explicitement couvrir et pointer dans chaque présentation qu'il a donné, cela a été soulevé sur la liste de discussion microformats-discuss, et documenté explicitement comme problématique sur la page wiki hcalendar-issues par Andy Mabbett le 2007-01-20.

voir aussi