Difference between revisions of "hcalendar-issues"

From Microformats Wiki
hcalendar-issues
Jump to navigation Jump to search
m (→‎2008: fix link)
Line 280: Line 280:
 
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2008-01-17</span> raised by <span class="fn">[[User:Guillaume Lebleu|Guillaume]]</span></span>
 
* {{OpenIssue}} <span class="summary vcard"><span class="dtstart">2008-01-17</span> raised by <span class="fn">[[User:Guillaume Lebleu|Guillaume]]</span></span>
 
<div class="description">
 
<div class="description">
*# In some instances, see [http://biz.yahoo.com/c/e.html|Yahoo Economic Calendar], the content in dtstart is split into two td (same issue for summary), which requires to either tag the date as dtstart or the time as dstart. The reason is that due to the structure of HTML tables, it is not possible to mark up each part of the dtstart as value and wrap them all in an element of class dstart.  
+
*# In some instances, see [http://biz.yahoo.com/c/e.html Yahoo Economic Calendar], the content in dtstart is split into two td (same issue for summary), which requires to either tag the date as dtstart or the time as dstart. The reason is that due to the structure of HTML tables, it is not possible to mark up each part of the dtstart as value and wrap them all in an element of class dstart.  
 
</div>
 
</div>
 
</div>
 
</div>

Revision as of 17:44, 17 January 2008

hCalendar issues

These are externally raised issues about hCalendar with broadly varying degrees of merit. Thus some issues are REJECTED for a number of obvious reasons (but still documented here in case they are re-raised), and others contain longer discussions. Some issues may be ACCEPTED and perhaps cause changes or improved explanations in the spec.

IMPORTANT: Please read the hCalendar FAQ before giving any feedback or raising any issues as your feedback/issues may already be resolved/answered.

Submitted issues may (and probably will) be edited and rewritten for better terseness, clarity, calmness, rationality, and as neutral a point of view as possible. Write your issues well. — Tantek

See related hCard issues.

Closed Issues

Resolved issues that have no further actions to take. These will likely be moved to a separate page like hCalendar closed issues.

  • 2006-01-04 raised by CGranade
    1. Interactions with strong namespacing. So far, it seems that hCalendar cannot be embedded into non-XHTML schemas that are also strongly namespaced (e.g.: RDF, Atom) without a resultant validation error, as the class attribute is not portable across schemas.
      • REJECTED. The class attribute is used on XHTML elements, which are XML, which can be embedded in any other XML. The issue as raised doesn't make sense.
  • 2005-02-18 raised by Matt Raymond on the whatwg list:
    1. There is no way for some reading the markup to tell if a class name is the name of an attribute or simply the name of a class used for styling.
      • REJECTED (strawman, poor assumption). There is no need to differentiate in the general case. In the specific case, a vocabulary is defined within a context.
    2. As a result of the above, user agents would not be able to reliably allow users to access extension properties such as "x-mozilla-alarm-default-length" (which is an actual extension used in Sunbird).
      • REJECTED (out of scope). Extension properties are outside the current scope of hCalendar.
    3. The use of for dates is incorrect. "August 5th, 2004" is not the abbreviation of 2004-09-05. In fact, the opposite is closer to the truth.
    4. You have to create a complex set of rules for all possible uses of legacy markup within which can easily be implemented incorrectly.
      • REJECTED (false statements, strawman). There is no legacy markup. There is no need to create rules for all possible uses of legacy markup. There is no need to create a complex set of rules.
    5. There are styling and tooltip issues that are unresolved.
      • REJECTED (empty statements). See the hCalendar FAQ for answers to specific styling and tooltip questions. Otherwise, please raise specific issues here with clear valid examples.
    6. hCalendar/hCard is more complicated for webmasters to read and understand and more complicated for developers to implement.
      • REJECTED (empty statements, invalid comparator). Please state specific examples which show the perceived complexity. The comparison "more complicated" requires two items, no second item was provided.


Resolved Issues

Issues that are resolved but may have outstanding To Do items.

  • 2006-02-17 raised by Mark Mansour - notes are summarized here
    1. Should vcalendar be a class? Section 4.4 of RFC2445 says: "The Calendaring and Scheduling Core Object is a collection of calendaring and scheduling information. Typically, this information will consist of a single iCalendar object. However, multiple iCalendar objects can be sequentially grouped together." Also the vcalendar class would allow properties on the calendar itself such as METHOD and CALSCALE (I don't think VERSION and PRODID are particularly relevant).
      • ACCEPTED SPECUPDATE/FAQ. Is this a case of fixing something that isn't broken? Note that "iCalendar object" != "vcalendar". This is a bit confusing so read RFC 2445 carefully in that regard. In addition, the hCalendar spec should say *precisely* how to generate VCALENDAR properties in their absence.
    2. How are axis and headers going to be handled?
      • ACCEPTED. This is documented in hCalendar Brainstorming but MUST be moved to hCalendar proper as the editors and implementers have all agreed on it (months ago). Add this as a To Do for Tantek.
    3. There has been talk that table axis and headers should be used to capture calendar information in a more compact format, but no example are available. Does anyone have examples or should we try to invent some?
    4. Should embeded components be allowed? User:RyanKing has already noted that vJournal overlaps blog-posts (although not yet accepted), but should the components to-do, free/busy, timezone, alarms be allowed? They all considered as just as relevant by the ical spec as events are (my interpretation).
      • ACCEPTED SPECUPDATE/FAQ. Another To Do for Tantek. Explicitly specify which additional iCalendar objects (in addition to VEVENT) are permitted in hCalendar. Current additional candidates: VTODO (many examples of this info on the web), VFREEBUSY (already at least one site publishing this info), VALARM (maybe, seems harmless enough, but without a compelling real world use case we should probably omit it). Currently dropping: VTIMEZONE (terrible construct), VJOURNAL (obsoleted by hAtom).
    5. Validation of the hCalendar tests. The hCalendar tests have been available for a while now, but only Brian Suda and I have made contributions to their content. Does anyone else have thoughts and should we try to make these the beginning of 'official' hCalendar tests?
      • ACCEPT PARTIAL. We probably need an hCalendar validator before we can declare any set of tests to be official.
    6. The use of fragments is unclear. Fragment interpretation seems to be agent dependant. Fragments usually denote a heading or marker, like a goto statement for HTML. Unfortunately it may jump in the middle of elements (rather to the beginning of an element). How should this be handled. i.e.
<a name="myfrag">heading</a>
<div class="vevent">
  <div class="description">A nice event</div>
  <abbr class="dtstart" title="2005-10-05">October 5</abbr>
</div>
      • ACCEPTED. We should clarify to converters how to interpret a fragement id. The interpretations are all consistent. It points to the element that is to be converted. If that element is empty then so is the conversion. There is no issue here other than a need for more documentation.
  • 2006-02-01 raised by User:RyanKing
    1. Issue 1: Given that now, or soon will have hAtom, should we disallow vJournal, so that we don't have 2 blog-post formats?
      • ACCEPTED. Yes, we should expliclty DROP "vjournal" from hCalendar.
  • 2006-01-04 raised by CGranade
    1. ...
    2. All examples in XHTML. XHTML should not be the only host to microformats, and thus it should not be the only example host language. Rather, examples in Atom, RSS, RDF, etc. should also be provided.
      • ACCEPTED. This is definitely something to be added to *-examples pages for each microformat.
  • 2005-10-14 raised by MarkoMrdjenovic
    1. UID has to be present in iCal events if they want to be used in Microsoft Outlook. [Suggestion:] it should probably be added to the vevent tag as html attribute id. There is also the problem of converters - x2v has UID commented out. RFC recommends use of addr format for uids which is problematic in html id (does not validate). HenriBergius pointed out some calendaring software crashes when @ is in the UID, so some other form of identification should be used - along the lines of dtstart-dtend-hash(title,summary)-sample-org.
      • ACCEPTED-PARTIAL. Yes, it appears RFC2445 requires UID. However, typical mentions of events by web authors do not provide anything equivalent to a UID, nor should we require authors to do so. Thus we must come up with an algorithm for implied UID, similar to some of the other properties. We REJECT the use of the html 'id' attributre as a substitute for UID as they are of different scopes and thus such a translation will likely be problematic. As part of this algorithm, we MUST disallow "@" signs since the issue points out that such UIDs crash some calendaring software.
    2. DTSTAMP also has to be present in iCal event for Microsoft Outlook. I think DTSTAMP should be user visible information so implementation with class="dtstamp" is fine. x2v already supports it so it should just be added to the standard and examples. The converters might also think of a way to force (create) dtstamp if it's not present. [Suggestion:] why not set DTSTAMP to DTSTART if not explicitly defined? -- User:DimitriGlazkov
      • ACCEPTED. We should come up with a way to encourage/synthesize/imply DTSTAMP property values.
    3. Here is an example from Midgard CMS (which will be easy to change according to bergie on irc):
  <li class="vevent" id="2678c3f94af4a49f9ccbb69b92a82aba-midgardGuid">
    <abbr class="dtstart" title="2005-10-20T14:34:45Z">Torstai 20. Lokakuu 17:34</abbr> -
    <abbr class="dtend" title="2005-10-20T15:33:56Z">18:33</abbr>
    <a class="url" href="/bergie/another-calendar/82457028ba83407451edd8aaeaa40622.html">
        <span class="summary">From the other cal</span>
    </a>
    <abbr class="dtstamp" title="2005-10-14T12:16:45Z">Torstai 14. Lokakuu 12:16</abbr>
  </li>
  • 2005-09-29 raised by RyanKing
    1. How does one use ATTENDEE?
      • ACCEPTED. Another To Do for Tantek - document how to use ATTENDEE with hCard.
  • 2005-06-21 raised by Hixie
    1. Issue H-1: This specification is lacking a user agent conformance section. There's basically nothing that says how hCalendars must be parsed, how to handle errors, and so forth. Is it defined in terms of the DOM? Is it defined in terms of a serialisation? How do you handle unexpected content or missing content?
  • 2005-02-22 raised by Matt Raymond on the whatwg list:
    1. There is no copyright statement and no patent statement.
      • ACCEPTED. I have updated hCalendar 1.0 (and hCard 1.0, and all other MicroFormats) with a standard copyright statement and patent statement.
  • 2005-02-18 raised by Matt Raymond on the whatwg list:
    1. ...
    2. ...
    3. ...
    4. ...
    5. ...
    6. ...
    7. I dislike the entire system of using class names as markup. Class names should be reserved for user-defined semantics.
      • ACCEPT-PARTIAL. When specific elements are available, they should be used instead of class names, but even then class names work well to "subclass" specific elements. This is thoroughly discussed in the essay A Touch of Class. And yes, class names can and should be used for user-defined semantics. hCalendar is one such user, and it is reasonable for users to use each others class names.
      • Would it be more in the spirit of HTML to define these classes in a metadata profile, so that "User agents may... perform some activity based on known conventions for that profile"? Should this be a part of microformats specifications in general? (If not, why not?)
        • ACCEPTED. Yes, all microformats that introduce new classnames SHOULD include an XMDP profile (which itself is a microformat for defining HTML metadata profiles) that defines those classnames.
          • Ok, but in order to refer to a profile, it needs a URI. Tantek writes in a message of Jul 21 "This is precisely the reason that GMPG was founded and created, to provide permanent URLs/homes for microformat profiles." How does one cause GMPG to issue a profile URL?
            • ACCEPTED. See profile-uris; this is moving from Tantek's To Do list, to both provide profiles and URLs (probably at gmpg.org) for those profiles for hCalendar etc.

Issues

Please add new issues to the bottom of the list. Please follow-up to resolved/rejected issues with new information rather than resubmitting such issues. Duplicate issue additions will be reverted.

2005

  • 2005-07-11 raised by Kragen
    1. The specification of class="url" as <a href="..."> should be a "should", not a "must". Other ways of referencing the event URL, such as <iframe src="..."> and <embed src="...">, shoul be mentioned. At present X2V doesn't appear to handle them. This came up in a discussion about xFolk.
      • REJECTED. Lack of use case. We should not add additional "ways of referencing the event URL" unless you can show a concrete real world example on the Web which requires it.
  • 2005-07-21 raised by Neil Jensen
    1. should we create a vfreebusy class for HTML representations of freebusy data? Discussion on hCalendar brainstorming. Additional background: here.
  • 2005-07-27 raised by Paolo Massa
    1. I tried to add a hcalendar event in my blog but it rendered orribly. The problem was I already have a 'class="summary' in my normal HTML (it is the title of the posts) and my CSS displays it bigger and bold. In this way the summary of the event was as big as the titles of the posts, destroying readability. The problem is Overloading of class attributes, it might be the case that a blogger already use, for example, class="summary" for different purposes. What can be a solution? Providing in every microformat wiki page a CSS file that users can download and insert in their blog as additional CSS. This CSS file will "shield" attribute "inside" microformats from being interpreted as "normal" attributes. For example for the hCalendar microformats the relative CSS could be something like:

.vevent .summary {

//remove all the previously set properties, for example:

text-decoration: none;

font-size: 100%;

...

}

Since the hCalendar microformat is the following,

<a class="url" href="http://www.web2con.com/">

Web 2.0 Conference:

...

I hope to have been clear but I'm not so sure ;-)


2006

    1. I'd love to see a Property List, similar to what is seen in the hCard spec, that lists all the available properties and sub-properties in a nice, compact list. This saves a lot of time and is really useful for quickly and easily getting acquainted with the possibilities of vCalendar.
    1. When someone looks at the hCalendar pages, one sees no collection of real-world publishing of event data nor discussion of the properties implied by such examples, I think it's far too easy to infer that microformats come from other formats more than actual behavior. There's nothing on the The microformats process nor the hCalendar pages explaining this discrepancy. I would argue that there should be an explanation, probably in both places.
  • open issue! 2006-04-13 raised by Tantek
    1. Need to add a section on "Property Exceptions" like that in hCard to document how to publish / handle the METHOD property and potentially others. I.e. typically publishers may omit the METHOD property, however, converters whose function is to convert hCalendar to iCalendar for consumption/subscription by a calendar aggregator, should probably insert a default METHOD:PUBLISH on the VCALENDAR object in the resultant .ics stream.
    1. Although ISO 8601 allows both basic (sans delimiters) and extended formats, the extended format (where hyphens and colons are explicitly added) is broadly preferred for the web. While RFC 2445 specifies that the basic form be used in in iCalendar date / time fields, the W3C has published a technical note (submitted by Reuters), which recommends that the extended (delimited) format be used, and the HTML 4.0 spec uses the extended format. Further, RFC 3339 defines a ISO 8601 profile for dates and time representations on the internet that future specs SHOULD use; recommending a fully delimited representation (see sec. 5.6). Lastly, it should be noted that the xsd:date and xsd:dateTime types are specified as being the ISO 8601 extended format. So, given that hCalendar is based on iCalendar, it is understandable that it allows both formats, however this is clearly a case in which it would be very reasonable to require users to upconvert the format into the least ambiguous and most easily parsed/ validated representation. Think of the children.
    1. How are Julian dates to be displayed? So far as I am aware, ISO8601 has no facility for marking up Julian dates, so should the form
      <abbr class="dtstart" title="[Gregorian date]">[Julian date]</abbr> 
      be used? If so, that should be indicated, via an example.

2007

  • open issue! 2007-01-07 raised by Webf
    1. Looking for a mechanism for specifying a dtstart without using <abbr>. Would be used where there are a number of events (as in the Webfeet events lists) where you do not want to have the visible date repeated
      • abbr is the correct - and only - element to use, unless you wish to display the raw ISO-formatted date-time to the user. Use it with the include-pattern, thus:


	<dt id="D20070120">
		<abbr class="dtstart" title="20070120">
		Saturday, 20 January 2007
		</abbr>
	</dt>
	<dd>
		<span class="vevent">
		<object class="include" data="#D20070120"></object>
		[Details of first event]
		</span>

		<span class="vevent">
		<object class="include" data="#D20070120"></object>
		[Details of second event]
		</span>
	</dd>

but please note that you should validate your HTML - it has over 3,000 errors! The high number of hCalendar microformats (>500) is causing parsers such as Firefox's Tails and Operator to respond very slowly. You should use CSS, not non-breaking spaces and multiple line-breaks, to layout your page - this will reduce it's size and enable parsers to work more quickly. You will need to style object .include to display:none Andy Mabbett 04:10, 16 Jan 2007 (PST)
Thanks Andy!
  • This use of object is a proposal at this stage? It does not seem to be mentioned in the hCalendar 1.0 page and only marked 'under consideration' in Include Pattern
  • Re: '>500 entries', I would think that User Agents should be able to deal with this. The linked page displays a collection of events (not all pages will have so many :-) however I would expect a User Agent to worry mainly about the events visible on the screen (really, a small part of the whole page).
    • Brainstorming a little, I would hope that the UA could track an event I've inserted ino my calendar and notice any changes, such as the event being postponed/cancelled, pick up this info and update my calendar. Worth thinking what implications this might bring to the markup.
    • I'm thinking though that the primary effort with a UA would be making sure the 99.99% pages which do not include hCalendar markup are not slowed down!
  • Re: abbr as the only way, I can see abbr used within the hCalendar 1.0 page and, yes, it looks a exceptionally neat way of rolling up some markup but I don't see it defined as a mandatory for marking up an event.
    • Am I missing some rationale? Why is abbr the only option?
    • Should the spec be written up more formally? should hCalendar be more relaxed? My take is that abbr is OK but it would be wrong for it to be mandatory. Think that screen readers may be reading the expanded content (as with <abbr title="Web Accessibility Initiative">WAI</abbr>). The underlying issue is that hCalendar 1.0 seems to want abbr to disambiguate a displayed date and this is not really the same as an abbreviation. UA's should be liberal when looking for a class="dtstart", after all they do know that they are within an event markup as they have met the class="vevent"....
  • Feel free to move the above thoughts to a brainstorming area. I might come back to the other points later - but maybe better in a talk page. :-) Webf 13:23, 21 Jan 2007 (PST)


Where DTEND is a date, and not a date-time, it is required to be the day after the end of the event, thus: <abbr class="dtend" title="2007-04-30">29 April 2007</abbr>. However, "29 April 2007" is not an abbreviation of 2007-04-30; it is an abbreviation of 2007-04-29. The markup as shown is semantically incorrect and likely to cause problems for users and user-agents which read the title attribute, and not the text value, of the abbr element.
Webf2 23:23, 11 May 2007 (PDT)
  • The ISO date 2007-04-30 is directly equivalent to 2007-04-30 00:00:00, which is why it's used as the end time of an event occuring on 2007-04-29. In this fuller context then you can view it as an abbreviation of 'the end of 29 April 2007'. Authors uncomfortable with this could use <abbr class="dtend" title="2007-04-29 23:59:59">29 April 2007</abbr>, or be more specific with their times.
Ciaran McNulty 09:21, 12 May 2007 [GMT]
  • The ISO standard has 2007-04-29 24:00:00 expressly to mark the end of the day 2007-04-29 rather than the start of the day 2007-04-30. This seems far preferable to 23:59:59. Matthew 15:22, 17 Jul 2007 (PDT)
  • This certainly risks confusion. The abbr title includes different information than the content; different when read by a 'normal' user who does not know about the exclusive-end-date.
  • The trouble is going to be with dates (rather than date-times). User expectation is different if you are talking about "3 o'clock", which really is a point-in-time, and "29th April", something lasting 24 hours. No problem saying an end time is 'exclusive', but an end-date can be either and is typically inclusive.
  • Using a more precise dtend is just a workround, you might not really want to say to the second when an event ends (as in 2007-04-29 23:59:59). You might easily want to say it runs from the Wednesday to Friday without committing to precise times - or that the event is sometime on that Friday but you don't know when.
Possible options could be:
  • Include a note in the standard that contradictory markup such as
<abbr class="dtend" title="2007-04-30">29 April 2007</abbr>
is bad practice and should be avoided
  • Make a break with the ical usage that end dates are exclusive.
  • Make the meaning clear:
<abbr class="dtend" title="value=date:value=inclusive:2007-04-29">29 April 2007</abbr>
<abbr class="dtend" title="value=exclusive:2007-04-30">29 April 2007</abbr>
or maybe
<abbr class="dtend;value=date:value=inclusive" title="2007-04-29">29 April 2007</abbr>
Webf2 00:25, 13 May 2007 (PDT)
    1. Here is the first issue I have.
    2. Here is the second issue I have.
  • open issue! 2007-05-12 raised by Anon
    1. A pertinent point from the 22 Feb 2007 version of hcalendar issues. Worth keeping and addressing.

2008


    1. In some instances, see Yahoo Economic Calendar, the content in dtstart is split into two td (same issue for summary), which requires to either tag the date as dtstart or the time as dstart. The reason is that due to the structure of HTML tables, it is not possible to mark up each part of the dtstart as value and wrap them all in an element of class dstart.

Template

Consider using this format (copy and paste this to the end of the list to add your issues; replace ~~~ with an external link if preferred) to report issues or feedback, so that issues can show up in hAtom subscriptions of this issues page. If open issues lack this markup, please add it.

Please post one issue per entry, to make them easier to manage. Avoid combining multiple issues into single reports, as this can confuse or muddle feedback, and puts a burden of separating the discrete issues onto someone else who 1. may not have the time, and 2. may not understand the issue in the same way as the original reporter.

<div class="hentry">
{{OpenIssue}} 
<span class="entry-summary author vcard">
 <span class="published">2011-MM-DD</span> 
 raised by <span class="fn">~~~</span>
</span>
<div class="entry-content discussion issues">
* <strong class="entry-title">«Short title of issue»</strong>. «Description of Issue»
** Follow-up comment #1
** Follow-up comment #2
</div>
</div>

Related Pages

This specification is a work in progress. As additional aspects are discussed, understood, and written, they will be added. These thoughts, issues, and questions are kept in separate pages.