task-formats: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
No edit summary
 
(moved task effort to more appropriate page, explicitly note that Toby's hCalendar 1.1 is a fork)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Task Formats =
= Task Formats =


This page will display an model task format type. The idea is to put forward the most important properties for creating a task microformat.
This page will look at existing examples of task (to-do) formats and assess a model task format type. The idea is to put forward the most important properties for creating a task microformat.


== Comparison chart ==
== Previous Formats ==
The following chart maps the terms from one implementation to another. This is important because if all the properties are introduced to this microformat, then it's possible to map them to a number of different formats. Each column has all the properties and their equivalent in each format. If there is no corresponding property, the cell is grey. At the bottom of the list are the unique terms to each format. Dublin Core has basic terms and terms that extend the basic ones.  
The Task Microformat may be based loosely on elements found in the VTODO spec. [http://en.wikipedia.org/wiki/ICalendar#To-do_.28VTODO.29 VTODO] is part of the [http://www.ietf.org/rfc/rfc2445.txt RFC2445 iCalendar spec] used for describing task items. VTODO is fairly straight-forward, as it doesn't contain any nested entities, and has a fairly small list of properties.  Most of these it shares with VEVENT, suggesting a Task Microformat be modeled on hevent in [[hcalendar]], and the ground assumption is that htodo should work just like hevent with respect to these properties.  The shared properties in this case might include:
 
''class, created, description, dtstamp, dtstart, geo, last-mod, location, organizer, priority, recurid, seq, statusm summary, uid, url, duration, attach, attendee, categories, comment, contact, exdate, exrule, rstatus, related, resources, rdate, rrule, x-prop''
 
The unique properties of the existing VTODO format are:
 
* '''completed''' The date/time the todo was completed
* '''due''' The date/time this todo is due
* '''percent''' Integer from 0-100, completion status
 
As the data types for '''completed''' and '''due''' are the same as, e.g., '''dtstart''', then the usage should be the same.  For example,
 
<abbr class="due" title="2007-01-01T13:10:05.0Z">January 1, 2007</abbr>
 
== Comparison table ==
The following table maps the terms from existing hCal and hCard implementations to proposed Task values. This is important because if all the properties are introduced to this microformat, then it's possible to map them to a number of different formats. Each column has all the properties and their equivalent in each format. If there is no corresponding property, I have proposed a new property. At the bottom of the list are the unique terms to each format. Dublin Core has basic terms and terms that extend the basic ones.  


THIS IS NOT DEFINITIVE, any errors should be corrected. More formats will be added to the list as they are mapped.
THIS IS NOT DEFINITIVE, any errors should be corrected. More formats will be added to the list as they are mapped.


<table border="1">
<table cellspacing="0" cellpadding="0" border="1">
<tr>
  <tr height="13">
<td>
    <td width="75" height="13"><strong>Section</strong></td>
TBD
    <td width="98"><strong>Name</strong></td>
</td?
    <td width="126"><strong>Class</strong></td>
</tr>
    <td width="139"><strong>Values</strong></td>
  </tr>
  <tr height="12">
    <td height="12"><strong>Date/Time</strong></td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Timezone</td>
    <td>tzid</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Created</td>
    <td>dtstart</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Modified</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Accepted</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Reviewed</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Duration</td>
    <td>duration</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Due</td>
    <td>dtend</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Multiple dates</td>
    <td>rdate</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Recurrence Rule</td>
    <td>rrule</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Frequency</td>
    <td>freq</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Recurrence Date</td>
    <td>rdate</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Reminder</td>
    <td>dtrem</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12"><strong>People</strong></td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Originator</td>
    <td>uid</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Assignee</td>
    <td>fn n</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Informee</td>
    <td>cc</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Group</td>
    <td>org</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12"><strong>Status</strong></td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Status</td>
    <td>status</td>
    <td>active, disabled, completed</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Progress</td>
    <td>&nbsp;</td>
    <td>%</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Priority</td>
    <td>priority</td>
    <td>high, medium, low</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Notes</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Privacy</td>
    <td>privacy</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12"><strong>Details</strong></td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Title</td>
    <td>description</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Summary</td>
    <td>summary</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Category</td>
    <td>category</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Tags</td>
    <td>meta</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Parent</td>
    <td>rel=&quot;par&quot;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Dependency</td>
    <td>rel=&quot;dep</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Links</td>
    <td>rel=&quot;url&quot;</td>
    <td>&nbsp;</td>
  </tr>
  <tr height="12">
    <td height="12">&nbsp;</td>
    <td>Attachment</td>
    <td>rel=&quot;enclosure&quot;</td>
    <td>&nbsp;</td>
  </tr>
</table>
</table>
= Toby's hCalendar 1.1 fork =
[[User:TobyInk|TobyInk]]'s [[User:TobyInk/hcalendar-1.1|hCalendar 1.1 fork]] documents a VTODO component.
= See Also  =
* [[task|Task Effort]]
* [[task-examples|Task Examples]]
* [[task-brainstorming|Task Brainstorming]]
* [[task-faq|Task FAQ]]

Latest revision as of 17:18, 10 March 2010

Task Formats

This page will look at existing examples of task (to-do) formats and assess a model task format type. The idea is to put forward the most important properties for creating a task microformat.

Previous Formats

The Task Microformat may be based loosely on elements found in the VTODO spec. VTODO is part of the RFC2445 iCalendar spec used for describing task items. VTODO is fairly straight-forward, as it doesn't contain any nested entities, and has a fairly small list of properties. Most of these it shares with VEVENT, suggesting a Task Microformat be modeled on hevent in hcalendar, and the ground assumption is that htodo should work just like hevent with respect to these properties. The shared properties in this case might include:

class, created, description, dtstamp, dtstart, geo, last-mod, location, organizer, priority, recurid, seq, statusm summary, uid, url, duration, attach, attendee, categories, comment, contact, exdate, exrule, rstatus, related, resources, rdate, rrule, x-prop

The unique properties of the existing VTODO format are:

  • completed The date/time the todo was completed
  • due The date/time this todo is due
  • percent Integer from 0-100, completion status

As the data types for completed and due are the same as, e.g., dtstart, then the usage should be the same. For example,

<abbr class="due" title="2007-01-01T13:10:05.0Z">January 1, 2007</abbr>

Comparison table

The following table maps the terms from existing hCal and hCard implementations to proposed Task values. This is important because if all the properties are introduced to this microformat, then it's possible to map them to a number of different formats. Each column has all the properties and their equivalent in each format. If there is no corresponding property, I have proposed a new property. At the bottom of the list are the unique terms to each format. Dublin Core has basic terms and terms that extend the basic ones.

THIS IS NOT DEFINITIVE, any errors should be corrected. More formats will be added to the list as they are mapped.

Section Name Class Values
Date/Time      
  Timezone tzid  
  Created dtstart  
  Modified    
  Accepted    
  Reviewed    
  Duration duration  
  Due dtend  
  Multiple dates rdate  
  Recurrence Rule rrule  
  Frequency freq  
  Recurrence Date rdate  
  Reminder dtrem  
       
       
People      
  Originator uid  
  Assignee fn n  
  Informee cc  
  Group org  
Status      
  Status status active, disabled, completed
  Progress   %
  Priority priority high, medium, low
  Notes    
  Privacy privacy  
Details      
  Title description  
  Summary summary  
  Category category  
  Tags meta  
  Parent rel="par"  
  Dependency rel="dep  
  Links rel="url"  
  Attachment rel="enclosure"  

Toby's hCalendar 1.1 fork

TobyInk's hCalendar 1.1 fork documents a VTODO component.

See Also