to-do: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(→‎Tantek: moving to searate page (this one was 64Kb; hope target page name is acceptable))
Line 152: Line 152:


== Tantek ==
== Tantek ==
I'm keeping a few microformats related to-do items here both for my own convenience, and for folks looking to help out with small tasks.  If so, just create a new section with your name, and and maybe copy the item there, and put your name next to the item in my list.  We'll figure this out as we go along.  Thanks,  [http://tantek.com Tantek].
See [[User:Tantek/to-do]]
 
=== overall priority ordering ===
# Protect the community from threats (wiki damage, mailing list pain or noise), repair damage, add measures to reduce future damage
# Help publishers with established microformats: [[hcard|hCard]], [[xfn]], [[rel-tag]], [[hcalendar|hCalendar]], [[hreview|hReview]], [[xfolk|xFolk]]
# Help implementers with established microformats
# Iterate on existing established microformats, resolve issues/feedback etc.
# Wiki cleanup/gardening for existing established microformats
# Site usability of microformats.org top-down as an entry point
# Community dynamics, [[process]] and [[principles]] improvements to help guide new microformats developments
# Emerging in-demand microformats: [[hresume|hResume]], [[hlisting|hListing]], [[citation]], [[media-info]] using abovementioned process and principles improvements.
# New microformat requests
# Document microformats [[history]].
# Other
 
=== protect the community ===
* Analyze [[Special:Recentchanges]] and [http://microformats.org/discuss mailing-lists] and:
** add to [[mailing-lists]] policies/guidelines accordingly.
** redirect and resolve threads accordingly per guidelines
** privately email violaters kindly asking them to improve their behavior
** work with admins on next steps for individuals negatively impacting the community
** recognize noisy/distracting threads on the email list, document responses/answers to such subjects on the appropriate page(s) on the wiki, and reply to those threads with the URLs to the documentation on the wiki. Putting the responses/answers on the wiki helps by hopefully providing preemptive answers to some who might reraise the subjects on the list in the future, and helps the community quickly terminate such threads by using the answers on the wiki.
** remove noise from [[Main_Page|the wiki home page]] by simplifying/shortening it
*** <s>move exploratory discussions to a separate page (think about what to name it)</s>
*** move exploratory discussions which are failing to follow the process to a separate page from that
 
=== help publishers ===
==== social network portability ====
Iterate on:
* [[social-network-portability]]
* [[hcard-supporting-user-profiles]]
* [[hcard-xfn-supporting-friends-lists]]
 
Brainstorm updates to the [[pocket-cheat-sheet]] to better enable [[social-network-portability]], or perhaps design a new '''social network portability pocket cheat sheet''' that specifically documents:
* how to author/publish hCard user profiles - write this up in [[hcard-authoring]] first (see below) and then use that content.
* how to author/publish hCard+XFN friends lists - write this up in [[hcard-xfn-authoring]] (see below) and then use that content.
* how to parse/subscribe to hCard user profiles - write this up by updating: [[hcard-parsing]], and writing [[hcard-supporting-user-profile-parsing]] (collect this into parsing/developers tasks below)
* how to parse/subscribe to hCard+XFN friends lists - write this up by writing: [[xfn-parsing]], [[hcard-xfn-supporting-friends-list-parsing]] (collect these into parsing/developers tasks below)
** notes/thoughts on hCard+XFN supporting friends list parsing captured here for now:
*** do a full rel="me" bidirectional crawling within the domain - some sites' hCard supporting user profiles simply link to their hCard+XFN supporting friends lists with rel="me", and thus you will discover more pages with friends lists.
**** E.g. Flickr's /people/username pages have hCard for the user and link to their /people/username/contacts page with rel="me" (on the "More..." link, though they could also add rel="me" to the number inside "Your contacts (592)"). Need to get them to support hCard+XFN on the contacts themselves.
*** consider parsing within a friends list page, any links that are rel="next" and rel="prev" to iterate over the whole list.
 
==== foldup cheatsheet ====
'''next actions''':
* gather feedback on current foldup [[pocket-cheat-sheet|pocket cheatsheet]]
* document the [[pocket-cheat-sheet-feedback|feedback on the pocket cheatsheet]]
* give feedback to Erin, iterate, print more to have on hand, fold, distribute.
* provide printing recommendations for anyone to download and print their own
** Perhaps [http://www.visibone.com/ Visibone] can be of some use? I can recommend their current products. --[[User:Gazza|Gazza]] 06:41, 7 Apr 2007 (PDT)
 
==== *-authoring microformats wiki pages ====
* [[hcard-authoring]] - '''next-actions''': add tips/instructions noted below.
** instructions for each property that is in [http://microformats.org/code/hcard/creator hCard creator] to begin with
** instructions for all other hCard properties
** a tutorial on creating an hCard for your site
*** specific instructions for common blogging platforms
** reference [[hcard-examples]] for more specific uses, and add to them accordingly
*** add an extended example to [[hcard-examples#Authors_of_Pages_and_Posts|contact info for a page]] with postal address, phone numbers, email address.
* [[hcard-xfn-authoring]] - '''next-action''': draft by starting from hCard+XFN instructions in [[hcard-examples]].
* [[hreview-authoring]] - '''next-action''': create a first draft minimal tutorial on how to author hReviews (e.g. at least for common properties) to blog reviews so that they'll be aggregated.
* [[hcalendar-authoring]] - '''next-action''': add tips/instructions for each property that is in [http://microformats.org/code/hcalendar/creator hCalendar creator].
* *-authoring for other reasonably well established microformats:
** [[xfolk-authoring]], [[hatom-authoring]]
 
==== help with microformat examples in the wild ====
Using the above updated [[authoring]] pages, get the community to help go over all "common" pages (both logged out and logged in states) of the following sites which have some microformats already, and verify each page is as microformatted as it can be with high fidelity [[hcalendar|hCalendar]] and [[hcard|hCard]] etc.  Document full support of each implementation's microformats on the implementations page (perhaps create a separate page for each implementation, e.g. [[flickr]], [[upcoming]], [[eventful]] etc.) Document any exceptions as needed.  In no particular order:
* Flickr.com (3.5m hCards)
* Upcoming.org (100k hCalendar events, 100k hCard venues)
** home page
* Eventful.com (100k hCalendar events, 100k hCard venues)
* Yahoo! Tech (300k products with hReviews)
* JudysBook.com (???k hReviews)
* ... lots more, get from "Implementations" and "Examples in the Wild" sections of specs.
 
==== advocacy for obvious sites ====
* [[advocacy]] - add pages/sites that obviously (no pun intended) could use microformats, update them with sample markup, find contacts for those pages to get them updated, and send requests to update their sites with microformats including sample markup. '''next-actions''': markup both twitter.com sample pages and dodgeball.com sample pages, post the changes publicly, and see which one is able to update first ;)
** dodgeball.com (hCard + XFN + hAtom for profiles, hCard + hReview for venues)
** write essay on [[open-data-more-important-than-open-source]] - and a shorthand URL too.
*** obviously doing both is ideal, however, open data is a higher priority and given limited resources, open data should be implemented before open source.
*** open data &gt; open source
*** "open information" vs "open source"
*** i.e. please focus first on open data rather than open source, e.g. start with [[hcard|hCards]] for all organizations returned from http://wiserearth.org/organization
*** if the data is open you can always export it and consume it in any number of open source systems
*** that's why open data is MUCH more important than open source
*** adding open data (e.g. microformats) can be done by any HTML author (yes, you), whereas open sourcing requires programming expertise, resouces, support. do the simpler easier thing first (open data thru microformats) that will benefit more people sooner.
*** if the data was open, anyone could rebuild an accessible version
*** faqs / misconceptions:
**** eschipul: @tantek - creating microformats is easier. consuming microformats is unfortunately not easier.
***** A: If you think consuming microformats is not easier or hard etc., it may just be that you don't know how to do so easily, don't assume that you are an expert in something that you think is hard.  Rather, if you think something is hard, then assume others may know easier methods, and ''ask''  the community how one can do it more easily.  parsing in particular is something which is becoming easier and easier thanks to open source libraries like [[hkit|hKit]].
** write essay on [[open-data-more-important-than-open-apis]] - and a shorthand URL too
*** obviously doing both is ideal, however, open data is a higher priority and given limited resources, open data should be implemented before open APIs.
*** publishing/providing open data (e.g. microformats) can be done by any HTML author (yes, you), whereas providing/publishing open APIs requires programming expertise, resouces, and support. do the simpler easier thing first (open data thru microformats) that will benefit more people sooner.
 
=== help implementers ===
* wordpress improvements
** WP admin for new profiles
*** should simply read blog URL - '''next-action''': make sure a bug/feature request is filed with wordpress.org
*** look for hcards and parse them
 
* [http://gmpg.org/xfn/creator XFN Creator] localizations
** Get someone to verify the [http://gmpg.org/xfn/creator-ru XFN Creator Russian localization].
** Add it to the [http://gmpg.org/xfn/tools XFN Tools] page.
** Add rel="alternate" href="creator-ru" &lt;link&gt;s to the other XFN Creators.
 
* Conference Schedule Creator
** '''next-actions''': Review Dmitry Baranovskiy's [http://dmitry.baranovskiy.com/work/csc/ Conference Schedule Creator] and give him feedback per how well it:
*** Makes it *trivial* for conference organizers to build/edit/publish an [[hcalendar|hCalendar]] schedule for their conference, including auto-generated "Subscribe..." link which produces the proper "webcal:..." link with X2V.  Note: see the "axis" and "header" attributes in HTML4, specifically in the section on Tables.
 
=== iterate on current microformats ===
==== in general ====
===== plain language intros =====
For [[hcard|hCard]], [[hcalendar|hCalendar]], [[hreview|hReview]], [[xoxo|XOXO]] to start with, write up:
* brief plain-language intro at the top (say for example, something that a non-technical person like a member of the general media/press could read and understand), similar to or better than plain language intros on W3C specs.
* followed by links to more plain-language resources, e.g. *-intro pages.
In particular for [[xoxo|XOXO]], Angus McIntyre suggested:
* As well as a syntactic example, examples of use would be useful.
* when I might want to use XOXO.
* Some simple examples right upfront would probably do a lot to help users figure out whether a particular microformat is for them or not.
These suggestions could be incorporated into the other specs as well.
===== exploratory discussions =====
* update [[exploratory-discussions]] with critical microformats as "active"
===== CSS enhancements for =====
Analyze existing microformats for opportunities to enhance CSS and propose to W3C.
* e.g. CSS datetime presentation (need to add links to my earlier work in CSS working group)
* brainstorm additional possibilities for better presentation of content using existing microformats.
===== update affiliations =====
* Start a minimal draft/spec style guide using outline of most readable/accessible spec so far
* Reference http://www.w3.org/2001/06/manual/#Editors for how to manage affiliations
* Update affiliations on [[hcard]], [[hcalendar]], [[hreview]], etc. per http://www.w3.org/2001/06/manual/#Editors
===== profile URLs =====
* write-up and document [[profile-uris|profile URLs]] for all established microformats and perhaps for some drafts as well
 
==== [[hcard|hCard]] ====
Combined next-actions for iteration on [[hcard|hCard]], and derived/subsetted microformats [[adr]] and [[geo]]
* [[hcard|hCard spec]] '''next-actions''':
** continue updated the spec per the inline comment about property references
** add a brief descriptive sentence for each property, similar to what [[hreview|hReview]] has. just enough so that the casual reader can avoid having to reference and read the respective sections in [[RFC2426]].
* [[hcard-profile]] '''next-actions''':
** update property definitions with more detail using semantics from [[RFC2426]]
** link from brief sentence descriptions for each property in [[hCard]] to the respective more detailed definition in the [[hcard-profile]].
** link from definitions in the [[hcard-profile]] to the specific sections in the vCard spec
* [[hcard-examples]] '''next-actions''': update with examples described below
** add examples of [[hcard|hCard]]s with work telephone, mailing address etc.
** add examples of marking up an organization vs. a person, then link to it from [http://microformats.org/wiki/hcard#Organization_Contact_Info hCard spec section on Organization Contact Info].
** add example of organization-name and organization-unit usage.
* [[hcard-issues]] and [[hcard-feedback]].  '''next-actions''': resolve all issues and incorporate all feedback.
* [[hcard-brainstorming]] '''next-actions''': determine which brainstorms proposals to resolve in April, and which later
** need property for gender (see [[hcard-faq#How_is_gender_represented|proposal in hCard FAQ]] and discussion in [[hcard-issues]]) - use tags for now, add to hCard creator
** solve [[hcard-brainstorming#Auto-Discovery|autodiscovery]] of more canonical/thorough hCard
* [[hcard-examples-in-wild]]
** help dglazkov markup: http://glazkov.com/blog/archive/2003/12/17/147.aspx
* analyze [[hcard-cheatsheet]], [[adr-cheatsheet]], [[geo-cheatsheet]] for any assertions above and beyond what the specification itself says, take into account [[hcard-brainstorming]] along similar lines, and incorporate into the spec or remove as necessary and sync-up as a result.  add clarification on the cheatsheets that they are '''informative''' and reference the specification for normative requirements.
 
==== [[hcalendar|hCalendar]] ====
'''Next-actions''':
* itemize a complete property list similar to the [[hcard#Property_List|hCard property list]], drawing upon hCalendar experience, iCal-BASIC draft(s), ietf-calsify mailing list and other sources to derive the precise list.  Separate common properties up front.
* formally document [http://microformats.org/wiki/hcalendar- brainstorming#Tabular_event_calendars]
* [[hcalendar-examples]]
** make sure all hCalendar examples that reference whole days use best international/accessible date format of YYYY-MM-DD
** add examples like [[hcard-examples]]
** flesh out and do a once over on markup/presentation of what RFC2445 examples would look like
** add explicit explanation and examples for LOCATION [[hcard|hCards]] and ATTENDEE [[hcard|hCards]], perhaps on a separate [[hcalendar-examples]] page.
* need spec details and then [[hcalendar-examples]] of multi-instance [[hcalendar|hCalendar]] events
* need spec details and then [[hcalendar-examples]] of repeating events
* need to resolve all outstanding [[hcalendar-issues]] to-do items.
* create [[hcalendar-profile]] and have folks verify it. Note that it will likely need reconciliation with the [[hcard-profile]], especially since [[hcalendar|hCalendar]] normatively depends on [[hcard|hCard]].  Probably makes sense to have a combined profile which hCalendar would use.
* analyze [[hcalendar-cheatsheet]] for any assertions above and beyond what the specification itself says, take into account [[hcalendar-brainstorming]] along similar lines, and incorporate into the spec or remove as necessary and sync-up as a result.  add clarification on the cheatsheets that they are '''informative''' and reference the specification for normative requirements.
 
==== [[hreview|hReview]] ====
'''Next-actions''':
* Write hReview 0.3 XMDP profile, and reconcile with [[hcalendar-profile]] and [[hcard-profile]].  Makes sense to have a combined profile of all three for hReview, since hReview normatively depends on hCard and hCalendar.
* Resolve all outstanding [[hreview-issues]] and [[hreview-feedback]] to-do items.
 
==== [[rel-tag]] ====
'''Next-actions''':
* Write [[rel-tag]] XMDP profile ([[rel-tag-profile]]) and send to [http://dbaron.org/ David Baron].
* Resolve all outstanding [[rel-tag-issues]] and [[rel-tag-feedback]] to-do items.
 
==== [[rel-me]] ====
'''Next-actions''':
* update rel-me examples on gmpg specifically document with examples the rel-me implict subdir rule
 
==== [[hatom|hAtom]] ====
'''Next-actions''':
* Clarify that "published" property values may omit seconds, and that converters to Atom are expected to imply ":00" seconds.
 
==== summary Examples in the Wild page ====
* need to create a summary / overall [[examples-in-the-wild]] page
** parallel the summary/overall [[implementations]] page.
** use newly reoganized content from the above "reoganizing Examples in the Wild" task
 
==== parsing ====
'''Next-actions''':
* Update [[semantic-xhtml]] with lists of semantic [http://www.w3.org/TR/html401/index/elements.html elements] and [http://www.w3.org/TR/html401/index/attributes.html attributes].
* Update [[hcard-brainstorming]] on element specific parsing rules
* Update X2V, hKit accordingly
* Write test cases accordingly
* Update [[hcard-parsing]] accordingly
* Draft [[hcalendar-parsing]] accordingly
* Write [[compound-parsing]] by abstracting commonalities between [[hcard-parsing]] and [[hcalendar-parsing]].
* Draft *-parsing for all reasonably well adopted microformats: [[hcalendar-parsing]], [[hreview-parsing]], [[xfolk-parsing]], [[hatom-parsing]]
 
=== wiki cleanup ===
==== for all microformat specs ====
'''Next-actions''':
* modularize any specs which are > 30K in order to avoid loss/corruption like [http://microformats.org/wiki?title=Special:Contributions&target=Evan Evan's 14 June edits] to [[hcard|hCard]], [[rel-tag]], and [[xoxo|XOXO]].
** [[hcard|hCard]] -
*** [[hcard-examples-in-the-wild]] group/sort by individuals,  organizations, and hosting sites. Consider moving largest subsection to its own page as well.
** [[rel-tag]]
** [[xoxo]]
 
==== update specification section organization ====
'''Next-action''': work with Ryan, Ernie, Erin, and others who have made concrete helpful suggestions for reorganizing the information architecture / content-order / layout of specs for greater approachability/readability by a broader audience, to design an interative update to spec organizations, in particular, the introduction/boilerplate/headers.  See below notes on hResume experiment in progress.
 
[[hresume|hResume]] has an experimental abbreviated intro/headers section, and links to more details further below, based on some ideas that Ryan King and I had for improving the readability of the microformats specifications. [[hreview|hReview]] has some similar improvements, but different.  We need to:
# Figure out if the new intro/headers structure in [[hresume|hResume]] and/or [[hreview|hReview]] is an improvement, and if it could be better.  Perhaps figure out the requirements for an intro/header section
#* Shorter tends to be better
#* Must be comprehensive enough to "print and read"
#* Must detail authorship/editorship
#* Must detail copyright/patent statements
# Write up a template - make it self-documenting per the requirements
# Update existing specifications with the new intro/headers structure.
## [[hcard|hCard]]
## [[hcalendar|hCalendar]]
## [[hreview|hReview]]
 
==== reorganizing Implementations sections ====
* sort implementations by authoring/creating/publishing, browsing/viewing, converting/importing, indexing/searching.
 
Hmmm... I like: '''A'''uthoring, '''B'''rowsing, '''C'''onverting, '''I'''ndexing, '''L'''ibraries (for developers), and '''P'''otential (for open source projects we want to add support to).  Anybody have alternative suggestions for this vocabulary?  I don't have a particularly strong preference so I'm going to go with these four until I find examples that don't fit, or someone suggests something better.
 
See: [http://microformats.org/wiki/hcalendar#Implementations hCalendar Implementations] for a first attempt at this.  Assuming folks like that, we can go ahead with categorizing the implementations sections of other microformats specifications.
 
'''Next-actions''':
* [[hcard-implementations]] - re-organize by same subsections as [[hcalendar-implementations]].
* [[hreview-implementations]] - re-organize by same subsections as [[hcalendar-implementations]].
* [[hatom-implementations]] - re-organize by same subsections as [[hcalendar-implementations]].
* [[xfolk-implementations]] - re-organize by same subsections as [[hcalendar-implementations]].
 
==== reorg Examples in the Wild sections ====
Work with community to:
* include more *key* details per example, e.g. precise or estimates of counts for services
* collate/sort examples in the wild by
** hosting services - where users/people actively contribute to the growth (e.g. Flickr profile hCards)
** publishing services - where lots of data is published from some datasource/database (e.g. Yahoo! Local)
** companies/groups/organizations member pages (and their own) - pages for a group's site where they list members or employees (e.g. Technorati staff page)
** individiual companies/organizations contact info pages
** individual people's contact info pages
* of course at some point this won't scale, but that will be a very good problem to have, and by then I'm sure we'll have services to point to that provide queries and search results for all this data.
 
=== site usability ===
* figure out how to get wordpress to autopost blog posts to the microformats-announce list
** ideally use the from address of the author of the blog post
** maybe photomatt knows how to do this.
 
=== introduction / community ===
 
* microformats-discuss *
** introductory email template for new subscribers needs to direct people to [[process]] and [[how-to-play]]
* Need to add more to the [[naming-principles]], to cover in particular:
** avoid using the same name to mean two things
** avoid using two names to mean the same thing
** seek to keep the microformats vocabulary minimal, memorable, and usable.
* update and add details/simplifications to [[process]] given the past several months of experience. in particular:
** clarify requirement (MUST rather than SHOULD) of *-examples, *-formats, before any *-brainstorming. 
** Add details of encouragement to experiment with simple semantic class names from *-brainstorming proposals to gain real world experience with real world content.
** note SHOULD prerequisite of use of all relevant microformats on real world web pages, along with documenting such use in respective "Examples in the Wild" sections, before proposing any new microformats.
 
==== posh improvement ====
* Create a page to answer the question "[[how-should-i-markup]]"
* consider creating a process/encouragement for collecting individual [[posh]] practices and examples, like a folksonomy of semantic HTML and semantic class names.
 
==== principles and process ====
Create the following pages and document/fill them with content from other pages, email lists, and [[presentations]].
* [[principles]] - mostly [[microformats#the_microformats_principles|documented in the microformats]] page.
* clearer statement of both copyright and patents both in specific specs and in general
* resolve [[process-issues]]
 
==== profiles ====
* update [[XMDP]] with new required features:
** ability for one profile to include/import another (rel="import" ?)
** ability to reference an XMDP via rel="profile" (similar to XHTML2 rel value by same name)
*** add rel="profile" to the [[xmdp-profile]].
** ability/suggestion to reference an XMDP using &lt;a href&gt; in addition to &lt;link&gt;
 
==== community mark ====
* Can we make "microformat" and "microformats" into [http://factoryjoe.com/blog/2006/01/14/the-case-for-community-marks/ Community Marks]?
 
==== document issue resolutions ====
* Prefixing has already been considered and rejected for microformats in general.  Note [[naming-conventions]], limited vocabulary, and exceptions made for [[hatom|hAtom]] and how we went about doing so.
 
=== emerging microformats ===
* [[directions]]
* [[citation]]
* [[hlisting|hListing]]
* [[media-info]]
* [[licensing]]
'''Next-actions''' for each emerging microformat (one at a time)
* review all microformats-email on the new microformat
* determine where new microformats is "stuck" in the process
* brainstorm about how to improve process (or documentation thereof) to get the effort unstuck
* work with community to move the microformat forward through the process, iterating/clarifying the [[process]] as necessary
 
=== new microformat requests ===
* expense reports (really just a list of "expense" items), [http://flickr.com/photos/edyson/56774178/ requested by ED], should look at UBL as a pre-existing format
* photo-notes microformat
** clean up Subethaedit notes from working session with Greg Elin, Ryan King, Kevin Marks, Suw Charman and email to folks and figure out next steps
** iterate on [[photo-note-examples]] and start [[photo-note-formats]] and [[photo-note-brainstorming]].
 
=== document microformats history ===
Document microformats [[history]], including:
* dates and origins of microformats, names, terms
* examples and formats for established microformats like [[hcard|hCard]], [[hcalendar|hCalendar]], [[xfn]], [[rel-license]], [[xoxo]]
 
=== other ===
* Add XPath equivalents where appropriate in [[hcard-parsing]]


==Ryan==
==Ryan==

Revision as of 20:38, 9 January 2008

To Do

This page is for posting microformats related shared to do items. If you want to use this page for your microformats related to-do items, create a section with your name on it. The reason we are keeping these all on the same page is to make it easier to tell when people are working on similar things, and to make it more obvious when people help out with other people's tasks. In theory this probably won't scale, but let's first see how it does in practice. :) - Tantek

Lazyweb

Just some nice things, feel free to do any of these.

for all microformats

  • We have recently added a new mailing list called microformats-new. There may be some confusion surrounding this change, so it would be helpful to:
    • Draft a message to be added to the confirm message sent when someone subscribes to any list including a welcome message, ground rules, topic for the subscribed list, and the topics for nearby lists.
    • Add a faq entry somewhere on why the new list was created.
    • Double check the wiki pages to make sure advice on mailing lists is accurate.
  • quick and easy "how to" pages for each microformat. get-started is a good overall start.
  • brief summary statements for each microformat that explain why it matters, what does it accomplish for the publisher.
  • write up mailing-list questions and answers in the appropriate faq pages.
  • validators. See the hReview section below as there has been a request for an hReview validator in particular. See Norman Walsh's blog post "Validating microformats" for some valuable analysis and validation pseudo-code (prose description), which are useful steps towards building microformat validators.
  • Add OpenID to Microformats Blog.
  • Submit definitions of "microformat", and individual examples, to the Free On-line Dictionary of Computing, acording to the Free On-line Dictionary of Computing guidelines
  • it would be nice to replace the -in-the-wild pages with a form that accepted URL entries that would both register the site and look for valid microformatted content and for those pages with problems, would set them aside in a queue to be reviewed by the community. Having such an interface would likely be more efficient for implementors looking to have their work reviewed, and would also add to a ready-database of microformats in the wild -- which would be a great way to feed pingerati.com. User:Chris_Messina Chris Messina on 2007 Aug 31.
  • If it's not being done already, the microformats wiki should really start using Akismet or some other form of automated spam fighting solutions. The admins are wasting far too much time reverting abuse compared with the amount of time creating or pruning good content.
    • I could not find an Akismet extension as of today, but Recaptcha is a useful screen for spambots, for MediaWiki (1.7+). See instructions here. Note that this can be configured to display a "captcha" screen on account creation, which would likely stop the current attacks on microformats.org. --jeffmcneill 00:44, 5 Oct 2007 (PDT)

hCard

hCalendar

Add support to open source calendar projects

These are open source projects that could be potentially enhanced to support hCalendar.

hReview

  • hReview support in Ecto (hey Adriaan!), requested by Andy Smith
  • an hReview validator.
  • a semantic, clean css star rating picker (e.g. a UI widget to rate from 1-5 stars)

hCalendar/hCard/hReview editor

  • onblur in the URL field (e.g. on hCalendar), goes out and tries to retrieve an object of same time (e.g. an hCalendar vevent) from that URL and uses it to autofill the form, same thing if the creator is loaded with that URL prefilled (e.g. due to a ?url=http://example.com/ in the URL that loads the creator).

hAtom

  • hatom-issues needs sections for closed issues, resolved issues, and open issues sorted by year, similar to hcard-issues.

WordPress patches for microformats

  • submit patches for WordPress code/templates for microformats improvement
  • Wordpress plugin for microformats, specifically hReview and hCalendar

Yahoo Open Source Library Patches

Several of these could very much be improved with a little microformats markup. Do we just make patches and submit them? Contact Nate Koechley at Yahoo (see Tantek for contact info) to follow-up.

Drupal patches for microformats

  • Microformat Module for Drupal A group discussing ways to implement microformats in Drupal. Currently looking to support hAtom, hCard and hCalendar to start with. Contact digitalspaghetti at gmail dot com if you are interested in contributing to the project.

Adding Microformats to Existing Pages

rel-tagging on Wikipedia

Somebody familiar with the "rel-tag" microformat might want to add details, and a link to the relevant page on this Wiki, to the Wikipedia page on tagging. Andy Mabbett 14:07, 3 Jan 2007 (PST)

wiki gardening

  • Find orphaned pages, and add links to them.
  • Add keywords to the foot of pages (see vcard-suggestions for examples), so that they can be converted to tags, once this wiki allows the use of "rel" attributes. Keywords can also include synonyms to aid searching.

Spelling

For English-language pages only: Find British spellings of words and replace them with the US spellings per en-US. Mark such edits as "minor" with the comment: [[en-US]]

Here is a table of searches for some of the British-English spellings that have crept into English-language microformats wiki pages, along with their respective US-English spellings. If you find other British spellings, please feel free to add them to this table, with their US equivalent.

en-GB en-US
behaviour behavior
behaviours behaviors
centre center
colour color
colours colors
flavour flavor
flavours flavors
flavoured flavored

More American and British English spelling differences

Admins

This section is for any admins to keep track of current to-do items for admins and/or for folks to suggest to-do items for admins, in particular, having to do with suggestions for improvements to microformats.org infrastructure such as the wiki. If you do add an item to this list, please sign your username with four tildes: ~~~~.

Website Improvements

  • OpenID login, on behalf of a request a while ago from User:Chris_Messina (especially for comments in WordPress). User:Chris_Messina 16:50, 31 Aug 2007 (PDT)
  • Pibb integration for the #microformats IRC channel. It is relatively simple to embed the Pibb chat widget into a webpage that bridges to the #microformats IRC channel. This would allow for greater access and transparency to the IRC discussions as well as allow people to participate using only their web browser. User:Chris_Messina 16:50, 31 Aug 2007 (PDT)

Wiki improvements

  • Upgrade the wiki!
    • Listed first since most of the other items on this list (such as OpenID integration) target later versions or will at least be more easily implementable in the case of new development.
    • Since the server hosting this wiki is already running PHP 5, advise upgrading to the highest released version (1.11 at the time of this writing).
    • As a consequence of upgrading, any existing core hacks will have to be removed. Progressing further, advise not hacking the core as it hinders future upgrades (for reference, Wikipedia runs the HEAD revision from SVN, updated every few days).
    • There are many improvements to the core with each release. Since 1.4 there have been significant improvements to the templating engine including optional parameters, parameter default values, proper parsing of nested template calls, conditional blocks (such as <noincldue>, <includeonly>, and <onlyinclude>) --JimboJW 13:38, 25 Sep 2007 (PDT)
  • "Standard" Extensions
    • There are a number of "standard" extensions that are applicable to most documentation wikis. See Wikipedia's Version Page for a list of currently installed extensions on the English Wikipedia.
    • I'd personally advise getting Cite, ParserFunctions and SyntaxHighlight. --JimboJW 13:38, 25 Sep 2007 (PDT)
  • OpenID login, on behalf of a request a while ago from User:DanC. Tantek 20:50, 20 Jul 2007 (PDT)
  • Install creation template extension(s)(see: http://meta.wikimedia.org/wiki/Inputbox or http://www.mediawiki.org/wiki/Extension:CreateBox or http://www.mediawiki.org/wiki/Extension:CreateArticle) User:RobManson 14:00, 20 Jul 2007 (AEST)
  • Encourage new users to use the preview feature to prevent a deluge of edit notifications from interrupting IRC discussions. SignpostMarv 09:28, 12 Aug 2007 (PDT)
  • Some kind of anti-spam (captcha? recaptcha? reverse turing tests? Spam Karma?) ~ WilleRaab 09:43, 12 Aug 2007 (PDT)
  • Add the necessary styling per W3C Manual of Style guidelines for RFC 2119 (perhaps in a w3cstyleguide.css file) to our MediaWiki install's CSS, in order to enable removal of in-line styles from our RFC 2119 Templates:

.RFC2119 {

 text-transform: lowercase;
 font-style: italic;

}

  • Add an address element, with a class=author hCard, to the footer of every page, to facilitate the use of hAtom and to "include" in other microformats, based on:
<address class="author vcard">The <span class="fn org">Microformat community</span></address>
  • add a class, noprint to the site's CSS, so that sections (such as "related pages" footers) can be made non- printing.

Deletions

Tantek

See User:Tantek/to-do

Ryan

wiki cleanup

  • possibly move dead proposals off of homepage?

hCalendar/hCard/hReview creator improvements

  • get all creators working in IE/Win, IE/Mac, Safari/OSX.3

other

rel-payment

  • update rel-payment to reference the IANA registry [1]

hcalendar

  • make sure we explicitly disallow 'vjournal'

Dimitri Glazkov

  • Figure out REST/Microformats thing
  • Work on result set idea
  • Implement h-creators using Web Forms 2.0

Chris Messina

General

  • Work on a microformat for play-lists (is it just a XOXO ordererd list of play-items?)
  • Work on a microformat for play-item (take a look at media-info-examples)
  • Work on microformats tutorial for designers
  • Add support for OpenID to micformats wiki
  • Add support for OpenID to the microformats blog.
  • Read GTD (at least the first two chapters).

Campaigns

  • Get Blogger to support hAtom and hCard
  • Get LinkedIn to support hCard, hResume, hCalendar and XFN
  • Get XING to support hCard, hCalendar, hResume and XFN
  • Get Digg to support microformats (still need XFN).

Wishlist

  • Microformat for "buyable items" (see listing-examples and related documents)
  • Location MF -- right click "map this" (see geo and adr)
  • Better hCard support in the browser -- right click "IM this person...", "Add to contacts" (see Flocktails)
  • Better hCal support -- support many views of same hCal data on one page using XSLT
  • We need something that a designer/web programmer can come to and leave w/ 2 examples of each microformat that they can apply right away... a "microformats styleguide for designers", if you will.
  • invoicing microformat
  • better microformats wiki theme
  • Define flow for OpenID + XFN + hcard (see DiSo Project)

Robert Bachmann

Robert Bachmann

XSLTs

  • Test scripts
  • hAtom2Atom
    • Join all hfeed's inside a page (or a fragment thereof) into one feed using atom:source semantics.
    • Extraction of atom:content, atom:summary and atom:title:
      • atom:content and atom:summary as HTML
      • atom:content and atom:summary as plain-text
      • atom:title as XHTML
      • atom:title as HTML
    • Support for other XSLT engines:
      • .Net System.Xml
      • hAtom2Atom written using XSL 2.0?
        • Do you think this would be useful? I have created a barebones version, doesn't yet take in all the parsing rules yet, but I'd be happy to share. Moving to XSL 2.0 does make things a bit cleaner and more efficient. - Matt Dertinger.
    • Support for other output formats: (hAtom2xyz.xsl)
      • RSS 2.0 (meanwhile use hAtom2Atom.xsl and atom2rss.xsl) -- +1 Matt Dertinger
      • RSS 1.0 (meanwhile use hAtom2Atom.xsl and atom2rss.xslt) -- +1 Matt Dertinger
        • My opinion at the moment, I neither want to produce nor to consume RSS. Atom is nicer (and should be supported by most good feed readers available today), RSS should fade away. -- Robert Bachmann
      • AtomOWL (meanwhile use hAtom2Atom.xsl and atom2rdfxml.xsl)-- +1 Matt Dertinger
        • Having the possibility of GRDDL-ing hAtom to AtomOWL seems definitly interessting. I realy should implement this some day. - Robert Bachmann
      • JSON?
        • Does it make sense to consider a canonical representation of microformats (either case by case, or in general) in JSON? E.g. so that a JSON API that returned contact information could return an hCard-equivalent chunk of JSON. - Tantek.
          • This could enable some nice JavaScript hacks. I should give hAtom2JSON a try. - Robert Bachmann

    (singpolyma 01:02, 9 May 2006 (PDT) -- Not XSLT, but see http://xoxotools.ning.com/hatom2rss.php for hatom to RSS2.0 conversion)

Brian Suda

Citation Microformats

  • Add all my notes to the Wiki
  • Start the process of naming the properties using existing names

X2V

Make changes and update site (almost stable) Get ATTENDEE and other strange attributes working

WARNINGS and ERROR

work on the warnings and error output for the pre-check in X2V

FAQ

  • clean-up the MF FAQs
  • clean-up FAQs from the major microformats
  • pull Questions from the mailing list and document them to the FAQs and example

Microformats History

additions to the wiki

  • better explain why NOT infinitely scaling is a good thing
  • better explain why microformats do NOT use namespacing

Mark Rickerby

Current Tasks

Wishlist

  • hmmm

Ernest Prabhakar

Wiki-Thon Proposal

Set aside several hours (probably a Friday night US PST) for focused work on the Wiki, including both physical (e.g., a room in the Bay Area) and virtual (IRC/iChat) participants.

Goals

  1. Improve understanding of what needs to be done for Wiki
    • IMHO - this should be done here, in to-do incrementally. -Tantek
  2. Tackle larger projects (~1-2 hours) than people usually have time for
    • I'd like to see these projects *documented* first on to-do before we spend 1-2 hours of a bunch of folk's collective time to go through them. -Tantek
  3. Motivate community to have fun with otherwise tedious "housecleaning" chores

Agenda (Wishlist)

In parallel:

  • Coalesce/prioritize existing To-Do items (above)
  • Review/revise desired pathways for:
    • New users learning about microformats
      • e.g., intro, about, explore, tutorials, etc.
      • cf. Rails front page
        • Get Excited (Why, background, motivation)
        • Get Started (What, downloads, getting started)
        • Get Better (How, tutorials, )
        • Get Involved (Who)
    • Microformat lifecycle
  • Review existing specs for completeness and consistency
  • Identify areas of 'bitrot' or 'hole-filling'
  • Do it!

Dan Connolly

DanC hopes to sync up on these tasks in irc roughly weekly, during Wednesday afternoon (Chicago time) "office hours". See also my esw todo list and someday pile.

  • from WWW2006
    • follow up on GRDDL as escape valve for microformats proposals, much like CSS was an escape valve for HTML tag proposals.

DanC 15:39, 31 May 2006 (PDT)

Chris Casciano

ChrisCasciano

  • get around to updating hatom-issues with some multi feed rules/exceptions.
  • Update textpattern plugin with simple hreview support and get a new release out
  • Redesign placenamehere.com and include hatom
  • Follow up with technorati folks on pingerati reviews getting lost (note: this will require publishing more reviews and theen watching them through the update process)
  • prototype a NetNewsWire microformat extractor (CSS+AppleScript)

Drew McLellan

DrewMcLellan

  • Build an hReview profile for hKit and test
  • Update the Dreamweaver extensions to mirror recent changes in the online builders
  • Publish an hCard to JSON service on tools.microformatic.com using hKit.
  • Further develop blog comment form hCard collection ideas.
  • Version of hReview creator using hKit to import business details from an hCard

Christophe Ducamp (french localization)

Christophe Ducamp

  • seed "microformateurs group" and invite them to update http://microformateurs.org
    • write a process for newbies in order to make them write CHIC posts on a public blog-governed-by-wiki ([2]) before publication.
    • find experts for peer-reviewing
    • find french CSS gurus to setup a nice Sandbox-CSS template on Wordpress
  • translating the wiki
    • translate red links on Main_Page-fr and synchronize
    • find out microformateurs at ease on "the-wiki-way-translation", and ready to help on semi-anonymous-synchro
  • community-marketing -> pinko-marketing
    • public-relations towards french journalists and complete advocacy (especially hcard-advocacy-fr towards organizations.
    • help to build events, workshops like barcamps and explorcamps
    • update French-wikipedia:Microformats and subpages via cowriting on discussion page (directly originated from the english article) + french examples to be found + local resources.
    • open discussion with french wikipediens about implementing some of the english existing templates
    • small gifts: accessories and free gifts ? t-shirts, localized cheat-sheet, id-hcard-openid-providing, etc.
      • create hCard, hCalendar... and all red link pages on french wikipedia
  • localize species-fr and related pages
  • move all contents remaining on elanceur.org -> microformateurs.org
  • wiki and uf:
    • write and talk with "aboutus.org" to invite them to make experiences with uf -> talk with Mark Dilley
    • maintain/update http://www.communitywiki.org/MicroFormats and talk with LionKimbro
    • XWiki : awaiting beta-test of new platform
      • Follow-up LudovicDubost et LaurentLunati
  • setup real-life links with european governance members ;) may be joining dconstruct-microformats-workshop - find solution (registering fees and travel expenses -> talk with Arnaud Fontaine or search french sponsors)

Frances Berriman

Frances Berriman

  • Work on styles for zen-garden project.
  • Style HTML cheatsheet to match Brian Suda's PDF.
  • Write simplified help/implementation documents (how tos) for all finalised Microformats.
  • Re-organise general FAQ and simplify
    • (Feel free to add suggested tasks to my list below:)
      • Help converge on organization efforts ~bewest :-)

Ben West (bewest)

bewest

  • fight spam
  • help tend wiki
  • documentation of semantic authoring techniques
  • researching the social problems relating to authorship and publishing on the web
  • development of new microformats in response to failing to meet the needs of the second with the first.

Expore Microformat Deployment Issues

How does who determine the status of work going through some stage of the process? When does a format move from draft to "full spec"? Who decides? What are the qualitative and quantitative features that characterize work in different stages, especially as a spec nears deployment as "full spec". What makes this pronouncement more than a mythical blessing? What quantitative analyses can be provided to validate deployment? Today, we have powerful agents capable of processing huge amounts of information on the web. Should we be using these to measure published marketshare? What role should tools and test suites play in deploying microformats?

Vocabulary

A lot of knowledge work is about maintaining sets of vocabulary. Now that the vocabulary is emerging, it may be time start making sure everyone is "on the same page," especially since some of the language is highly symbolic. Terms:

  • "boil the ocean" A huge task. "A phrase used in the industry to describe an attempt at something that is way too ambitious. For example, "They're trying to get their site launched by COMDEX. They could easier boil the ocean." from <http://www.netlingo.com/right.cfm?term=boil%20the%20ocean>
  • microformats: more than one microformat
  • microformat: see my definition on http://microformats.org/wiki/what-are-microformats#BenWest
  • data fidelity: the extent to which a data format might be considered lossy. eg HTML is often seen as a lossy format because the information parsed out of a resource may not fully match the information orginally encoded. Non-lossy formats have a very high data fidelity, while lossy formats have low data fidelity. Microformats seek to increase data fidelity of html.
  • market: the locus of economic forces
See glossary. Andy Mabbett 13:57, 7 Dec 2006 (PST)

Creators

_Concession_: my plans involve reuse of code, which would involve non-compatible changes with the current inline model. This is a nice feature, so maybe I should be branching instead.

  • Start hatom creator. http://dichotomize.com/uf/hatom/creator.html
  • Code Reuse. These creators are downright handy, and I’ve reimplemented the vcard one on my own site. Instead, let’s make these widgetized. Let’s decide on a more or less canonical html structure and create some javascript that will create the desired microformat. Something as easy to use as new Microformat.hCard($('mycontainer')); would be awesome. Right now, if someone makes an improvement to the hCard creator, the other creators don’t get the benefit. Spec this out!
  • About Section. Is there an official creator page? If so, let’s point to that. The about paragraph is getting longer and longer with phrases like “which is based on…” repeated over and over.
  • Default all dates to “right now”. Provide an easy to use calendar type widget to change dates.
  • hAtom creator: Add multiple. It’d be nice to add an arbitrary number of entries.
  • hAtom creator: Optional feed enclosure. Check box to wrap the entry/entries in an hfeed.
  • Edit URI: Allow someone to enter a URI and edit whatever microformat is found on the page.
  • Optionals. If the format requires, say, a vcard, the creator can defer to an external URI or can trust the user to fill it in later.
  • Common stylesheet. I suppose this goes with the reuseable code idea… we have many great coders, we should be reusing eachothers’ work.
  • Use Amazon's ECS to pull in information about products when there is an ASIN in the item URI.

Information Architecture

Help Welcomed! Please leave your name Add complaints to wiki-feedback! Helping to make the wiki easier to use. I'd like to see the main page more towards a format like http://simile.mit.edu/solvent/ with the big questions right out front:

  • What Is This?
  • What can I do here?
  • Is there a demo?
  • Where can I learn more?

I'd like to change the front page to this kind of design.

Support Pages

There are several categories of things in the wiki. Can we enumerate them?

  • About the Community
    • Where to find information.
    • Who are the stake holders?
    • FAQs
  • Web/Architectural Philosophy
    • Community Principles
    • Why are we doing this?
    • XML and Namespaces
    • Semantic XHTML
    • Common Misconceptions
    • Concession and Disposition of Criticism
    • FAQs
  • Specs
    • Examples
    • Discussion
    • Exploration
    • Use Cases
    • Implementations
    • The spec itself.
  • Tips and Tricks for Authoring (BenWest 15:00, 9 Dec 2006 (PST))
    • how to author semantic html
    • choosing class names
    • using HTML's general extension mechanisms
    • advocating use
    • collaborating/reusing HTML
    • debugging HTML: use pastebin, separate out the relevant bits.
    • getting help from the community
    • applying Microformats.

Can others agree and or refine this list? Should I take it to the -discuss list? How do we create consensus on how the wiki should be organized in order to make it more usable? And how can we turn that consensus into actionable changes?

The wiki should also capture wisdom that stems from discussions that don't produce microformats. For example, Chris Messina suggests a "Best Of" page suitable for capturing this kind of wisdom. I think we can think of a given microformat as being at a place in a spectrum that ranges from "not yet thought of", to "interesting but needs work," or even "rejected", and of course including all the stages familiar to the microformats processes (eg examples, brainstorming, etc...). If there were such a page would it:

  • Belong to a microformat? (eg hcard-bestof)
  • or to the global namespace? (eg /wiki/wisdom/foobar-format)

(I think Chris Messina suggests that it belongs to a given microformat, but then how do we collect wisdom from non-microformats?)

Considering that the wiki page named with the microformat (i.e. /wiki/hcard) is the one that people will mostly likely look to first for learning about a particular format, I'd think it'd make more sense and create a more welcoming feel to convert these pages to an intro page introducing the format for the beginner and linking to resources like tutorials and creators. Spec pages would then be relocated to wiki/*-spec -- Cgriego 13:25, 16 Oct 2006 (PDT)

Mike Schinkel's Comments

My suggestion on the list was for us to use a convention that the entry page (i.e. http://microformats.org/wiki/hcard) would be an index into a list of (psuedo) standardized sub pages so that it would be very people to find what is important to them. For example, is a list of potential sub pages:

  • Microformat
    • Specification
    • Tutorial
    • Examples
    • Use cases
    • Reference
    • Discussion
    • Brainstorming (might be combined w/Discussion)
    • Implementations
    • Related Pages
    • Further Reading
    • All (Uses Mediawiki's "includes" to create a page including all sub pages; very useful for printing & reading offline)

These pages would be located respectively at

Please note I am suggesting an architecture not a specific list of sub pages. The list of sub pages should be defined by both reviewing existing information during site reorganization, and then via discussion on the list in an attempt to discover and extract which sub pages are needed for most/all microformats.

NOTE: This differs from above in that the spec if not viewed as a top level structure but instead the microformat itself and the spec would be under the microformat. In this context "microformat" is a more abstract concept and "spec" is a more concrete thing. Another way to think about it would be that each microformat would have it's own mini home page and then things like "spec" are the pages listed on its home page.

Matt Dertinger (Thewhoo)

User:Thewhoo

hAtom2Atom

  • Support for other XSLT engines:
    • hAtom2Atom written using XSL 2.0
  • Support for other output formats: (hAtom2xyz.xsl)

Microformats Proposals

  • rel="disclaimer":
    • Purpose: to create a semantic linkage (relationship) between a foot-note or end-note marker and the actual location of the text that the marker refers to.
  • rel="external":
    • Purpose: to formalize what is already in existence in the wild. The use of rel="external" to refer to a document that is external or outside of the current domain.

Henri Bergius

Henri Bergius

  • Add hKit support for automatically populating contact details into OpenPsa Contacts CRM
  • Implement Tail scripts for adding things into Midgard

Justin Thorp

  • Start researching examples for a To-do microformat

Mark Lentczner

  • Get Second Life's event web pages to have proper event microformats data
  • Start pinging pingerati.net/ping/$url when pages are updated
  • Collaborate on designing how to integrate microformats, metadata and objects in Second Life.

Derrick Pallas

microformat proposal: dependancy

  • looking for examples of directed graphs on the web
  • applications in
    • software engineering
      • automatically build library dependency trees
      • distribute security alerts to people that link to your code
    • any directed, acyclic graph
      • getting dressed in the morning
      • cooking
  • orthogonal to xfn
    • people don't have versions
      • libfoo requires libbar-2.0 or later
    • people don't have optional relationships
      • ex: at build time, compile in SSL support if present
    • people don't have exclusive-or relationships
      • ex: in Gentoo, syslog, syslog-ng, and metalog satisfy virtual/syslog
      • ex: the Ruby library RMagick requires ImageMagick xor GraphicsMagick

Paul Downey

  • building a generic Javascript parser
  • bundling parser as a TidlyWiki plugin for hCards
  • documenting how best to microformat TiddlyWiki pages

Rob Manson

Clay Newton

  • Work on getting others involved in trade-examples
    • Need examples from major online banking sites
    • Need examples from major ecommerce sites
  • Continue working on: trade-brainstorming