Utilisation de microformats
Un article de MDC.
Cet article traite de fonctionnalités introduites dans Firefox 3
Les microformats permettent aux sites Web de fournir des données sémantiques au navigateur afin que celui-ci puisse présenter un résumé des informations présentes sur une page sans avoir à connaître de manière particulière d'analyser son contenu. Firefox 3 implémente un objet global Microformats permettant d'accéder aux microformats. Cet objet et l'API associée facilitent la recherche et la lecture de microformats.
Sommaire |
[modifier] Chargement de l'API des microformats
L'objet Microformats est créé à l'aide du nouveau chargeur de scripts JavaScript ajouté à Firefox 3. Pour utiliser l'API, il faut d'abord charger cet objet :
Components.utils.import("resource://gre/modules/Microformats.js");
Une fois l'API des microformats chargée, il est possible de gérer des microformats à l'aide des méthodes listées ici. Pour plus d'information sur l'analyse de microformats, consultez Analyse de microformats en JavaScript.
[modifier] Microformats prédéfinis
Firefox 3 fournit des définitions implémentant divers microformats répandus :
adr- Représente une adresse (comme une adresse de destination ou une adresse postale).
geo- Représente un emplacement géographique en utilisant sa latitude et sa longitude.
hCard- Représente les informations de contact d'une personne.
hCalendar- Représente une entrée de rendez-vous d'un agenda.
tag- Utilisé pour ajouter des balises à d'autres microformats.
[modifier] Méthodes
[modifier] add()
Ajoute un nouveau microformat au module des microformats.
add(nom, définition);
[modifier] Paramètres
- nom
- Le nom du microformat à ajouter au module des microformats.
- définition
- Une structure JavaScript décrivant le microformat. Consultez Description de microformats en JavaScript pour plus de détails.
[modifier] count()
Compte le nombre de microformats dans un document qui correspondent à des critères spécifiés.
nbMicroformats = Microformats.count(nom, élémentRacine, options);
[modifier] Paramètres
- nom
- Le nom du microformat à compter.
- élémentRacine
- Obligatoire. L'élément DOM où doit commencer la recherche. Pour rechercher dans le document entier, utiliser
content.document. - options
- Facultatif. Si ce paramètre est fourni, il s'agit d'un objet JavaScript contenant une série de drapeaux parmi les suivants :
- recurseExternalFrames
- Si à
true, les cadres enfants font partie de la recherche. La valeur par défaut esttrue.- showHidden
- Si à
true, les microformats cachés seront ajoutés ; autrement ils sont ignorés. La valeur par défaut estfalse.- debug
- Spécifiez
truesi le mode debug est utilisé ; sinon indiquezfalse. La valeur par défaut estfalse.
[modifier] Valeur de retour
Une valeur entière indiquant le nombre de microformats correspondant aux critères spécifiés.
[modifier] debug()
Renvoie une chaîne qui décrit un objet de microformat.
debug() sur un objet de microformat : objetMicroformat.debug() au lieu d'utiliser cette méthode, si cela vous convient mieux.dumpString = debug(objetMicroformat);
[modifier] Paramètres
- objetMicroformat
- L'objet de microformat à afficher.
[modifier] Valeur de retour
Une chaîne décrivant le contenu de l'objet de microformat spécifié.
[modifier] get()
Renvoie un tableau d'objets de microformat correspondant aux critères spécifiés.
microformats = Microformats.get(nom, élémentRacine, options, tableauCible);
[modifier] Paramètres
- nom
- Le nom du microformat recherché.
- élémentRacine
- Obligatoire. L'élément DOM d'où sera lancée la recherche. Pour rechercher dans le document entier, indiquer
content.document. - options
- Facultatif. Si fourni, il s'agit d'un objet JavaScript contenant une série éventuellement vide des drapeaux suivants :
- recurseExternalFrames
- Si défini à
true, les cadres enfants référençant du contenu externe feront partie de la recherche. La valeur par défaut esttrue.- showHidden
- Si défini à
true, les microformats masqués seront ajoutés ; dans le cas contraire ils seront ignorés. La valeur par défaut estfalse.- debug
- Indique d'utiliser le mode debug si à
true. La valeur par défaut estfalse.
- tableauCible
- Facultatif. Si fourni, il s'agir d'un tableau d'objets microformat auquel ajouter les résultats de la recherche.
[modifier] Valeur de retour
Un nouveau tableau d'objets microformat correspondant aux critères de recherche, ou le tableau spécifié par le paramètre microformats auquel les nouveaux objets microformat trouvés auront été ajoutés.
[modifier] getNamesFromNode()
Renvoie une liste de noms de microformats séparés par des espaces qui correspondent au nœud de microformat spécifié.
liste = Microformats.getNamesFromNode(nœud);
[modifier] Paramètres
- nœud
- Le nœud pour lequel une liste de noms de microformats doit être obtenue.
[modifier] Valeur de retour
Si le nœud spécifié est un microformat, le résultat est une chaîne listant tous les noms de microformats, séparés par des espaces, qui correspondent à ce nœud. Si le nœud n'est pas un microformat, rien ne sera renvoyé.
[modifier] getParent()
Renvoie le nœud parent du microformat ou enfant de microformat spécifié.
nœudParent = Microformats.getParent(nœud);
[modifier] Paramètres
- nœud
- Le nœud dont le parent doit être retrouvé.
[modifier] Valeur de retour
Le parent du nœud spécifié. Ne renvoie rien si le nœud spécifié n'est pas un microformat ou l'enfant d'un microformat.
[modifier] isMicroformat()
Détermine si le nœud DOM spécifié est un microformat.
valeur = Microformats.isMicroformat(nœud);
[modifier] Paramètres
- nœud
- Le nœud DOM dont on veut savoir s'il est un microformat.
[modifier] Valeur de retour
true si le nœud est un microformat, false sinon.
true si le nœud est l'enfant d'un microformat.