h2vx: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
(resolve user agent string feedback, add documentation accordingly, no longer a stub)
Line 1: Line 1:
<entry-title>H2VX</entry-title>
<entry-title>H2VX</entry-title>
__TOC__
__TOC__
{{stub}}
<dfn>[http://h2vx.com H2VX]</dfn> is a production deployment of the [[X2V]] hCard and hCalendar conversion transforms.
<dfn>[http://h2vx.com H2VX]</dfn> is a production deployment of the [[X2V]] hCard and hCalendar conversion transforms.


It converts [[hCard]] contacts and [[hCalendar]] events on web pages to .vcf and .ics respectively for use in desktop and other client software applications.
It converts [[hCard]] contacts and [[hCalendar]] events on web pages to .vcf and .ics respectively for use in desktop and other client software applications.
== documentation ==
H2VX is built from:
* [[X2V]] XSLTs by [[User:Brian|Brian Suda]]
* PHP get-contact.php get-cal.php originally written by Brian, updated/factored by [[User:Tantek|Tantek Çelik]] with various improvements. [[to-do]]: open source these.
* PHP common.php (and Javascript common.js) by Tantek which incorporate CASSISv0 open source from http://cassisproject.com/
* HTML+CSS+JS front-end design/interface by Tantek (view source of h2vx.com in your browser for more).
=== user agent strings ===
H2VX uses two user agent strings, when retrieving hCards and hCalendars respectively:
* <samp><nowiki>H2VX contacts proxy (http://h2vx.com/vcf/)</nowiki></samp>
* <samp><nowiki>H2VX events proxy (http://h2vx.com/ics/)</nowiki></samp>
You may see occurrences of these in your web server logs when users of H2VX convert hCards and hCalendar events on your pages.


== feedback ==
== feedback ==
Have feedback on H2VX? Feel free to add to the top of this list and use <nowiki>~~~~</nowiki> to sign your name and date your comment. If this grows too big we can move it to [[h2vx-feedback]]
Have feedback on H2VX? Feel free to add to the top of this list and use <nowiki>~~~~</nowiki> to sign your name and date your comment. If this grows too big we can move it to [[h2vx-feedback]]


* We were using the Technorati hosted service. Surprised to see it redirected to H2XV, took a minute to realize what was going on. Thanks for picking up the service! Both the hosting provider and the new user agent are blocked by default on our side to prevent scraping. To be more transparent, maybe you could change the UA similar to the old one: from <nowiki>"Technorati contacts proxy (http://technorati.com/contacts/)"</nowiki> to <nowiki>"H2VX contacts proxy (http://h2vx.com/vcf/)"</nowiki> [[User:DineMonkey|DineMonkey]] 15:47, 11 November 2009 (UTC)
* As a Web page author I find the H2XV site a bit awkward to use -- it's difficult to find the URLs to use in my Web page. As an end-user it fine to have the H2VX bookmarklets in my toolbar, but as a page author I can't be sure everyone has the bookmarklets or Operator installed. [[User:Bob Jonkman|Bob Jonkman]] 00:56, 10 November 2009 (UTC)
* As a Web page author I find the H2XV site a bit awkward to use -- it's difficult to find the URLs to use in my Web page. As an end-user it fine to have the H2VX bookmarklets in my toolbar, but as a page author I can't be sure everyone has the bookmarklets or Operator installed. [[User:Bob Jonkman|Bob Jonkman]] 00:56, 10 November 2009 (UTC)
* "Also, a short 'about' page would be worthwhile IMO, especially for adding to the homepage." - Norm on microformats-discuss.
* "Also, a short 'about' page would be worthwhile IMO, especially for adding to the homepage." - Norm on microformats-discuss.
Line 21: Line 31:


* &lt;i class="term"> should be made into &lt;em>'s for semantic reasons. ;) [[User:Andr3|Andr3]]
* &lt;i class="term"> should be made into &lt;em>'s for semantic reasons. ;) [[User:Andr3|Andr3]]
 
** Note that the <code>&lt;i></code> element is used deliberately for "instance" of a term - this is an [[HTML5]] semantic, and is more accurate in this instance than "em"phasis. — [[User:Tantek|Tantek]] 18:29, 11 November 2009 (UTC)




Line 27: Line 37:
Resolved issues are moved to this section. If this grows too big we can move it to [[h2vx-issues-resolved]]
Resolved issues are moved to this section. If this grows too big we can move it to [[h2vx-issues-resolved]]
* ...
* ...
* 2009-11-11 We were using the Technorati hosted service. Surprised to see it redirected to H2XV, took a minute to realize what was going on. Thanks for picking up the service! Both the hosting provider and the new user agent are blocked by default on our side to prevent scraping. To be more transparent, maybe you could change the UA similar to the old one: from <nowiki>"Technorati contacts proxy (http://technorati.com/contacts/)"</nowiki> to <nowiki>"H2VX contacts proxy (http://h2vx.com/vcf/)"</nowiki> [[User:DineMonkey|DineMonkey]] 15:47, 11 November 2009 (UTC)
** I've updated the user agent strings per your recommendation and documented them above as well. [[User:Tantek|Tantek]] 18:29, 11 November 2009 (UTC)
*** <nowiki>H2VX contacts proxy (http://h2vx.com/vcf/)</nowiki>
*** <nowiki>H2VX events proxy (http://h2vx.com/ics/)</nowiki>


=== closed ===
=== closed ===
Once a resolved issue has no further actions (and ideally is verified by the issue reporter), it can be closed and moved to this section. If this grows too big we can move it to [[h2vx-issues-closed]]
Once a resolved issue has no further actions (and ideally is verified by the issue reporter), it can be closed and moved to this section. If this grows too big we can move it to [[h2vx-issues-closed]]
* It would be good to have the option to pass "referer" instead of a URL. [[User:Adactio|Adactio]] 10:47, 4 November 2009 (UTC)
* 2009-11-04 It would be good to have the option to pass "referer" instead of a URL. [[User:Adactio|Adactio]] 10:47, 4 November 2009 (UTC)
** http://h2vx.com/vcf/referrer and http://h2vx.com/ics/referrer are now up and running. Example of /vcf/referrer is live on http://tantek.com/ and the alternate spelling /vcf/referer is used live on http://clearleft.com/ - as such, closing this issue. [[User:Tantek|Tantek]] 20:25, 5 November 2009 (UTC)
** http://h2vx.com/vcf/referrer and http://h2vx.com/ics/referrer are now up and running. Example of /vcf/referrer is live on http://tantek.com/ and the alternate spelling /vcf/referer is used live on http://clearleft.com/ - as such, closing this issue. [[User:Tantek|Tantek]] 20:25, 5 November 2009 (UTC)
* ...
* ...


== see also ==
== see also ==

Revision as of 18:29, 11 November 2009

<entry-title>H2VX</entry-title>

H2VX is a production deployment of the X2V hCard and hCalendar conversion transforms.

It converts hCard contacts and hCalendar events on web pages to .vcf and .ics respectively for use in desktop and other client software applications.

documentation

H2VX is built from:

  • X2V XSLTs by Brian Suda
  • PHP get-contact.php get-cal.php originally written by Brian, updated/factored by Tantek Çelik with various improvements. to-do: open source these.
  • PHP common.php (and Javascript common.js) by Tantek which incorporate CASSISv0 open source from http://cassisproject.com/
  • HTML+CSS+JS front-end design/interface by Tantek (view source of h2vx.com in your browser for more).

user agent strings

H2VX uses two user agent strings, when retrieving hCards and hCalendars respectively:

  • H2VX contacts proxy (http://h2vx.com/vcf/)
  • H2VX events proxy (http://h2vx.com/ics/)

You may see occurrences of these in your web server logs when users of H2VX convert hCards and hCalendar events on your pages.

feedback

Have feedback on H2VX? Feel free to add to the top of this list and use ~~~~ to sign your name and date your comment. If this grows too big we can move it to h2vx-feedback

  • As a Web page author I find the H2XV site a bit awkward to use -- it's difficult to find the URLs to use in my Web page. As an end-user it fine to have the H2VX bookmarklets in my toolbar, but as a page author I can't be sure everyone has the bookmarklets or Operator installed. Bob Jonkman 00:56, 10 November 2009 (UTC)
  • "Also, a short 'about' page would be worthwhile IMO, especially for adding to the homepage." - Norm on microformats-discuss.
  • ...

issues

Found a problem with H2VX? Please note it here at the top of this list and use ~~~~ to sign your name and date your comment. If this grows too big we can move it to h2vx-issues

  • The "what are microformats?" style descriptions only appear on mouse-over of the trigger terms (those with class="term"). It does not appear at all when keyboard navigation is used, making it somewhat inaccessible. The problem here is that the trigger elements are the ones that should receive focus, but not being links they are not in the tabbing order so do not, hence the helper text never appears for keyboard users. Norm 10:39, 6 November 2009 (UTC)
    • Quick fix: remove visibility:hidden from .term .info. Andr3
  • <i class="term"> should be made into <em>'s for semantic reasons. ;) Andr3
    • Note that the <i> element is used deliberately for "instance" of a term - this is an HTML5 semantic, and is more accurate in this instance than "em"phasis. — Tantek 18:29, 11 November 2009 (UTC)


resolved

Resolved issues are moved to this section. If this grows too big we can move it to h2vx-issues-resolved

  • ...
  • 2009-11-11 We were using the Technorati hosted service. Surprised to see it redirected to H2XV, took a minute to realize what was going on. Thanks for picking up the service! Both the hosting provider and the new user agent are blocked by default on our side to prevent scraping. To be more transparent, maybe you could change the UA similar to the old one: from "Technorati contacts proxy (http://technorati.com/contacts/)" to "H2VX contacts proxy (http://h2vx.com/vcf/)" DineMonkey 15:47, 11 November 2009 (UTC)
    • I've updated the user agent strings per your recommendation and documented them above as well. Tantek 18:29, 11 November 2009 (UTC)
      • H2VX contacts proxy (http://h2vx.com/vcf/)
      • H2VX events proxy (http://h2vx.com/ics/)

closed

Once a resolved issue has no further actions (and ideally is verified by the issue reporter), it can be closed and moved to this section. If this grows too big we can move it to h2vx-issues-closed


see also