representative hCard parsing

(Difference between revisions)

Jump to: navigation, search
m (Using jQuery library)
Current revision (22:41, 6 October 2014) (view source)
(Linked to updated version)
 
(11 intermediate revisions not shown.)
Line 1: Line 1:
-
<h1>representative hCard parsing</h1>
+
<entry-title>representative hCard parsing</entry-title>
 +
 
 +
{{latest|representative-h-card-parsing}}
Assuming you are already using code that properly implements [[hcard-parsing]], this page documents how to determine a [[representative hCard]] for a page using the current [[representative-hcard-brainstorming]] proposal.
Assuming you are already using code that properly implements [[hcard-parsing]], this page documents how to determine a [[representative hCard]] for a page using the current [[representative-hcard-brainstorming]] proposal.
-
== url uid source ==
+
== representative hCard algorithm ==
-
After parsing the hCard(s) on a page, if there is one which has a "url" property whose value is the url of the page (source) and is also a "uid" property for the hCard, then that is the representative hCard for the page.
+
After [[microformats2-parsing|parsing]] the page:
 +
# '''url uid source.''' The first hCard found which has a "url" property whose value is the url of the page (source) and is also a "uid" property for the hCard, is the representative hCard for the page.
 +
# '''url and rel me.''' If the previous step didn't find a representative hCard, then the first hCard with a "url" property that also has the <code>rel="me"</code> relation is the representative hCard for the page.
-
== url and rel me ==
+
== Issues ==
-
If the aforementioned "url uid source" didn't find a representative hCard, then look for an hCard with a "url" property that also has the <code>rel="me"</code> relation. If you find such an hCard then you have found a representative hCard for the page.
+
* In the first step, how should URLs be matched? Resolving relative URLs is a given, but there are other cases. E.g. if the h-card has a URL of 'http://aaronparecki.com/', should 'http://aaronparecki.com' match? What about 'https://aaronparecki.com/'? --[[User:Barnabywalters|bw]] 14:47, 6 October 2014 (UTC)
 +
** Per https://url.spec.whatwg.org/ : [[User:Tantek|Tantek]] 22:18, 6 October 2014 (UTC)
 +
*** Parse the URLs
 +
*** Compare the serialization
 +
*** If all the components match, the two URLs match.
 +
*** (background/discussion: [http://krijnhoetmer.nl/irc-logs/whatwg/20141006#l-843])
 +
* Why is u-uid required in addition to u-url in the first step but not the second step? In what case has an h-card had a u-url property matching the URL of the page it’s on, but *not* been the representative h-card? --[[User:Barnabywalters|bw]] 14:47, 6 October 2014 (UTC)
 +
** Let's try a third step: if there is only one hCard with url == page URL then use that hCard, else there is no representative hCard [[User:Tantek|Tantek]] 22:18, 6 October 2014 (UTC)
-
== Draft hKit (PHP5) code ==
+
== open source implementations ==
 +
The below open source implementations of '''representative hCard parsing''' have been contributed inline and are thus in the public domain per [[Microformats_Wiki:Copyrights]].
 +
 
 +
=== Draft hKit (PHP5) code ===
I - ([[User:TomMorris|Tom]]) - have been working on implementing represenative hCard parsing in PHP so that a user can simply type in a URL pointing to a page with an hCard on it, and have their name and some details automatically filled in the form. The code below implements the following:
I - ([[User:TomMorris|Tom]]) - have been working on implementing represenative hCard parsing in PHP so that a user can simply type in a URL pointing to a page with an hCard on it, and have their name and some details automatically filled in the form. The code below implements the following:
# If there is only one hCard on a page, it uses that.
# If there is only one hCard on a page, it uses that.
Line 18: Line 32:
<source lang="php">
<source lang="php">
<?php
<?php
-
 
// example hKit code to extract a representative hCard
// example hKit code to extract a representative hCard
// tom morris <http://tommorris.org>
// tom morris <http://tommorris.org>
// public domain 2007
// public domain 2007
-
include("hkit/hkit.class.php5");
+
// An hCard could have more than one url, so we use a multi-dimensional array search. - Sarven Capadisli
 +
 
 +
// From http://nl2.php.net/manual/en/function.array-search.php#80692
 +
function multidimArrayLocate($array, $text){
 +
  foreach($array as $key => $arrayValue){
 +
    if (is_array($arrayValue)){
 +
      if ($key == $text) $arrayResult[$key] = $arrayValue;
 +
      $temp[$key] = multidimArrayLocate($arrayValue, $text);
 +
      if ($temp[$key]) $arrayResult[$key] = $temp[$key];
 +
    }
 +
    else{
 +
      if ($key == $text) $arrayResult[$key] = $arrayValue;
 +
    }
 +
  }
 +
  return $arrayResult;
 +
}
 +
 
 +
include("hkit.class.php");
$hkit = new hKit;
$hkit = new hKit;
$result = $hkit->getByURL('hcard', $HTTP_GET_VARS['url']);
$result = $hkit->getByURL('hcard', $HTTP_GET_VARS['url']);
Line 31: Line 61:
   } else {
   } else {
     foreach ($result as $card) {
     foreach ($result as $card) {
-
       if (array_search($HTTP_GET_VARS['url'], $card) == true || $card['uid'] == $HTTP_GET_VARS['url']) {
+
       if (multidimArrayLocate($card, $HTTP_GET_VARS['url']) == true || $card['uid'] == $HTTP_GET_VARS['url']) {
         $repcard = $card;
         $repcard = $card;
       }
       }
Line 40: Line 70:
?></source>
?></source>
-
 
+
=== jQuery (JavaScript) code ===
-
== jQuery (JavaScript) code ==
+
The following JavaScript code follows the [[representative-hcard-brainstorming#current_proposal|current proposal for finding a representative hCard]]. It requires the [http://jquery.com/ jQuery] library, however, it can be easily switched over to another library.
The following JavaScript code follows the [[representative-hcard-brainstorming#current_proposal|current proposal for finding a representative hCard]]. It requires the [http://jquery.com/ jQuery] library, however, it can be easily switched over to another library.
Line 58: Line 87:
var rep_hCard = new Array();
var rep_hCard = new Array();
-
function rep_hCard_urluidsource() {
+
function rep_hCard_uidurlsource() {
-
     var hCard_url_sourceURI = $('.vcard .url[href='+sourceURI+']');
+
     $('.vcard .uid[href='+sourceURI+']').each(function() {
-
    hCard_url_sourceURI.each(function() {
+
         $(this).each(function() {
         $(this).each(function() {
-
             if ($(this).closest('.vcard').find('.uid[href='+sourceURI+']').length > 0) {
+
             if ($(this).closest('.vcard').find('.url[href='+sourceURI+']').length > 0) {
                 rep_hCard.push($(this).closest('.vcard')[0]);
                 rep_hCard.push($(this).closest('.vcard')[0]);
             }
             }
Line 71: Line 99:
function rep_hCard_urlme() {
function rep_hCard_urlme() {
-
     var hCard_urlme = $('.vcard .url[rel=me]');
+
     $('.vcard .url[rel=me]').each(function() {
-
    hCard_urlme.each(function() {
+
         rep_hCard.push($(this).closest('.vcard')[0]);
         rep_hCard.push($(this).closest('.vcard')[0]);
     });
     });
Line 78: Line 105:
}
}
-
if (rep_hCard_urluidsource() || rep_hCard_urlme()) {
+
if (rep_hCard_uidurlsource() || rep_hCard_urlme()) {
     rep_hCard = $($(rep_hCard)[0]);  
     rep_hCard = $($(rep_hCard)[0]);  
     rep_hCard_url = (rep_hCard.find('.uid').length > 0) ? rep_hCard.find('.uid')[0].href : rep_hCard.find('.url[rel=me]')[0].href;
     rep_hCard_url = (rep_hCard.find('.uid').length > 0) ? rep_hCard.find('.uid')[0].href : rep_hCard.find('.url[rel=me]')[0].href;

Current revision


See latest version: representative-h-card-parsing

Assuming you are already using code that properly implements hcard-parsing, this page documents how to determine a representative hCard for a page using the current representative-hcard-brainstorming proposal.

Contents

representative hCard algorithm

After parsing the page:

  1. url uid source. The first hCard found which has a "url" property whose value is the url of the page (source) and is also a "uid" property for the hCard, is the representative hCard for the page.
  2. url and rel me. If the previous step didn't find a representative hCard, then the first hCard with a "url" property that also has the rel="me" relation is the representative hCard for the page.

Issues

open source implementations

The below open source implementations of representative hCard parsing have been contributed inline and are thus in the public domain per Microformats_Wiki:Copyrights.

Draft hKit (PHP5) code

I - (Tom) - have been working on implementing represenative hCard parsing in PHP so that a user can simply type in a URL pointing to a page with an hCard on it, and have their name and some details automatically filled in the form. The code below implements the following:

  1. If there is only one hCard on a page, it uses that.
  2. If there is more than one hCard on a page, it looks through to see if any of the cards have UID or URL fields that match the URL it searches, then selects that one if one exists.

It's experimental and quite 'alpha', so I'd suggest you test it and make adjustments as necessary.

<?php
// example hKit code to extract a representative hCard
// tom morris <http://tommorris.org>
// public domain 2007
 
// An hCard could have more than one url, so we use a multi-dimensional array search. - Sarven Capadisli
 
// From http://nl2.php.net/manual/en/function.array-search.php#80692
function multidimArrayLocate($array, $text){
  foreach($array as $key => $arrayValue){
    if (is_array($arrayValue)){
      if ($key == $text) $arrayResult[$key] = $arrayValue;
      $temp[$key] = multidimArrayLocate($arrayValue, $text);
      if ($temp[$key]) $arrayResult[$key] = $temp[$key];
    }
    else{
      if ($key == $text) $arrayResult[$key] = $arrayValue;
    }
  }
  return $arrayResult;
}
 
include("hkit.class.php");
$hkit = new hKit;
$result = $hkit->getByURL('hcard', $HTTP_GET_VARS['url']);
if (count($result) != 0) {
  if (count($result) == 1) {
    $repcard = $result[0];
  } else {
    foreach ($result as $card) {
      if (multidimArrayLocate($card, $HTTP_GET_VARS['url']) == true || $card['uid'] == $HTTP_GET_VARS['url']) {
        $repcard = $card;
      }
    }
  }
}
print_r($repcard);
?>

jQuery (JavaScript) code

The following JavaScript code follows the current proposal for finding a representative hCard. It requires the jQuery library, however, it can be easily switched over to another library.

/***
    Note: Extracts representative hCard
    Author: Sarven Capadisli http://csarven.ca/
    License: Public Domain 2009-06-04
*/
var sourceURI = window.location.href;
var rep_hCard = new Array();
 
function rep_hCard_uidurlsource() {
    $('.vcard .uid[href='+sourceURI+']').each(function() {
        $(this).each(function() {
            if ($(this).closest('.vcard').find('.url[href='+sourceURI+']').length > 0) {
                rep_hCard.push($(this).closest('.vcard')[0]);
            }
        });
    });
    return (rep_hCard.length > 0) ? true : false;
}
 
function rep_hCard_urlme() {
    $('.vcard .url[rel=me]').each(function() {
        rep_hCard.push($(this).closest('.vcard')[0]);
    });
    return (rep_hCard.length > 0) ? true : false;
}
 
if (rep_hCard_uidurlsource() || rep_hCard_urlme()) {
    rep_hCard = $($(rep_hCard)[0]); 
    rep_hCard_url = (rep_hCard.find('.uid').length > 0) ? rep_hCard.find('.uid')[0].href : rep_hCard.find('.url[rel=me]')[0].href;
    hCard_fn = $('.fn', rep_hCard).text();
    hCard_photo_src = ($('.photo', rep_hCard).length > 0) ? $('.photo', rep_hCard)[0].src : '';
}
else {
    //no representative hCard
}

--Sarven Capadisli 04:24, 4 June 2009 (UTC)

see also

representative hCard parsing was last modified: Monday, October 6th, 2014

Views