Utilisation de microformats

  • Raccourci de la révision : Utilisation_de_microformats
  • Titre de la révision : Utilisation de microformats
  • ID de la révision : 166691
  • Créé :
  • Créateur : BenoitL
  • Version actuelle ? Non
  • Commentaire Début de traduction

Contenu de la révision

{{template.Fx_minversion_header(3)}} {{template.Traduction_en_cours("Using microformats")}} {{template.Draft()}} 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.

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

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.

Méthodes

add()

Ajoute un nouveau microformat au module des microformats.

{{template.Note("Si un microformat du nom spécifié existe déjà, il sera remplacé par le nouveau.")}}

add(nom, définition);
Paramètres
<tt>nom</tt>
Le nom du microformat à ajouter au module des microformats.
<tt>définition</tt>
Une structure JavaScript décrivant le microformat. Consultez Description de microformats en JavaScript pour plus de détails.

count()

Compte le nombre de microformats dans un document qui correspondent à des critères spécifiés.

nbMicroformats = Microformats.count(nom, élémentRacine, recurseFrames);
Paramètres
<tt>nom</tt>
Le nom du microformat à compter.
<tt>élémentRacine</tt>
Optionnel. L'élément DOM où doit commencer la recherche. Par défaut, il s'agit de content.document (en d'autres mots, le document entier).
<tt>recurseFrames</tt>
Optionnel. Si ce paramètre vaut true, les cadres enfants font partie de la recherche. La valeur par défaut est true.
Valeur de retour

Une valeur entière indiquant le nombre de microformats correspondant aux critères spécifiés.

debug()

Returns a string that describes a microformat object.

{{template.Note("You can simply call <code>debug()</code> on a microformat object: <code>microformatObject.debug()</code> instead of using this method if you prefer.")}}

dumpString = debug(microformatObject)
Parameters
<tt>microformatObject</tt>
The microformat object to dump.
Return value

A string that describes the contents of the specified microformat object.

get()

Returns an array of microformat objects corresponding to the microformats found that match specified criteria.

microformatsArray = Microformats.get(name, rootElement, options, targetArray);
Parameters
<tt>name</tt>
The name of the microformat to find.
<tt>rootElement</tt>
The DOM element at which to begin the search.
<tt>options</tt>
Optional. If provided, this is a JavaScript object that contains zero or more of the following flags:
<tt>recurseFrames</tt>
If true, child frames are included in the search. The default is true.
<tt>showHidden</tt>
If true, hidden microformats are added; otherwise they're left out. The default is false.
<tt>debug</tt>
Specify true if debug mode is in use; otherwise, specify false. The default is false.
<tt>targetArray</tt>
Optional. If provided, this is an array of microformat objects to which the search results are added.
Return value

A new array of microformat objects matching the search criteria, or the array specified by <tt>microformats</tt> with the newly found microformat objects added.

getNamesFromNode()

Returns a space-delineated list of microformat names that correspond to the specified microformat node.

nameList = Microformats.getNamesFromNode(node);
Parameters
<tt>node</tt>
The node for which to retrieve a list of microformat names.
Return value

If the specified <tt>node</tt> is a microformat, the result is a space-delineated string listing all the microformat names that correspond to the node. If the node isn't a microformat, nothing is returned.

getParent()

Returns the parent node of the specified microformat or child of a microformat.

parentNode = Microformats.getParent(node);
Parameters
<tt>node</tt>
The node whose parent you wish to retrieve.
Return value

The parent of the specified node. Returns nothing if the specified <tt>node</tt> isn't a microformat or the child of a microformat.

isMicroformat()

Determines whether or not the specified DOM node is a microformat.

flag = Microformats.isMicroformat(node);
Parameters
<tt>node</tt>
The DOM node to check to see if it's a microformat.
Return value

true if the node is a microformat, otherwise false.

{{template.Note("This method does <i>not</i> return <code>true</code> if the node is a child of a microformat.")}}

{{ wiki.languages( { "en": "en/Using_microformats" } ) }}

Source de la révision

<p>{{template.Fx_minversion_header(3)}}
{{template.Traduction_en_cours("Using microformats")}}
{{template.Draft()}}
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 <code>Microformats</code> permettant d'accéder aux microformats. Cet objet et l'API associée facilitent la recherche et la lecture de microformats.
</p>
<h3 name="Chargement_de_l.27API_des_microformats"> Chargement de l'API des microformats </h3>
<p>L'objet <code>Microformats</code> est créé à l'aide du nouveau chargeur de scripts JavaScript ajouté à Firefox 3. Pour utiliser l'API, il faut d'abord charger cet objet :
</p>
<pre class="eval"><span class="plain">Components.utils.import("resource://gre/modules/Microformats.js");</span>
</pre>
<p>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 <a href="fr/Analyse_de_microformats_en_JavaScript">Analyse de microformats en JavaScript</a>
</p>
<h3 name="Microformats_pr.C3.A9d.C3.A9finis"> Microformats prédéfinis </h3>
<p>Firefox 3 fournit des définitions implémentant divers microformats répandus :
</p>
<dl><dt><code><a href="fr/Le_microformat_adr">adr</a></code>
</dt><dd>Représente une adresse (comme une adresse de destination ou une adresse postale).
</dd><dt><code><a href="fr/Le_microformat_geo">geo</a></code>
</dt><dd>Représente un emplacement géographique en utilisant sa latitude et sa longitude.
</dd><dt><code><a href="fr/Le_microformat_hCard">hCard</a></code>
</dt><dd>Représente les informations de contact d'une personne.
</dd><dt><code><a href="fr/Le_microformat_hCalendar">hCalendar</a></code>
</dt><dd>Représente une entrée de rendez-vous d'un agenda.
</dd><dt><code><a href="fr/Le_microformat_tag">tag</a></code>
</dt><dd>Utilisé pour ajouter des balises à d'autres microformats.
</dd></dl>
<h3 name="M.C3.A9thodes"> Méthodes </h3>
<h4 name="add.28.29"> add() </h4>
<p>Ajoute un nouveau microformat au module des microformats.
</p><p>{{template.Note("Si un microformat du nom spécifié existe déjà, il sera remplacé par le nouveau.")}}
</p>
<pre class="eval">add(nom, définition);
</pre>
<h6 name="Param.C3.A8tres">Paramètres</h6>
<dl><dt><tt>nom</tt>
</dt><dd>Le nom du microformat à ajouter au module des microformats.
</dd><dt><tt>définition</tt>
</dt><dd>Une structure JavaScript décrivant le microformat. Consultez <a href="fr/Description_de_microformats_en_JavaScript">Description de microformats en JavaScript</a> pour plus de détails.
</dd></dl>
<h4 name="count.28.29"> count() </h4>
<p>Compte le nombre de microformats dans un document qui correspondent à des critères spécifiés.
</p>
<pre class="eval">nbMicroformats = Microformats.count(nom, élémentRacine, recurseFrames);
</pre>
<h6 name="Param.C3.A8tres_2">Paramètres</h6>
<dl><dt><tt>nom</tt>
</dt><dd>Le nom du microformat à compter.
</dd><dt><tt>élémentRacine</tt>
</dt><dd>Optionnel. L'élément DOM où doit commencer la recherche. Par défaut, il s'agit de <code>content.document</code> (en d'autres mots, le document entier).
</dd><dt><tt>recurseFrames</tt>
</dt><dd>Optionnel. Si ce paramètre vaut <code>true</code>, les cadres enfants font partie de la recherche. La valeur par défaut est <code>true</code>.
</dd></dl>
<h6 name="Valeur_de_retour">Valeur de retour</h6>
<p>Une valeur entière indiquant le nombre de microformats correspondant aux critères spécifiés.
</p>
<h4 name="debug.28.29"> debug() </h4>
<p>Returns a string that describes a microformat object.
</p><p>{{template.Note("You can simply call &lt;code&gt;debug()&lt;/code&gt; on a microformat object: &lt;code&gt;microformatObject.debug()&lt;/code&gt; instead of using this method if you prefer.")}}
</p>
<pre class="eval">dumpString = debug(microformatObject)
</pre>
<h6 name="Parameters">Parameters</h6>
<dl><dt><tt>microformatObject</tt>
</dt><dd>The microformat object to dump.
</dd></dl>
<h6 name="Return_value">Return value</h6>
<p>A string that describes the contents of the specified microformat object.
</p>
<h4 name="get.28.29"> get() </h4>
<p>Returns an array of microformat objects corresponding to the microformats found that match specified criteria.
</p>
<pre class="eval">microformatsArray = Microformats.get(name, rootElement, options, targetArray);
</pre>
<h6 name="Parameters_2">Parameters</h6>
<dl><dt><tt>name</tt>
</dt><dd>The name of the microformat to find.
</dd><dt><tt>rootElement</tt>
</dt><dd>The DOM element at which to begin the search.
</dd><dt><tt>options</tt>
</dt><dd>Optional.  If provided, this is a JavaScript object that contains zero or more of the following flags:
</dd></dl>
<blockquote>
<dl><dt><tt>recurseFrames</tt>
</dt><dd>If <code>true</code>, child frames are included in the search.  The default is <code>true</code>.
</dd><dt><tt>showHidden</tt>
</dt><dd>If <code>true</code>, hidden microformats are added; otherwise they're left out.  The default is <code>false</code>.
</dd><dt><tt>debug</tt>
</dt><dd>Specify <code>true</code> if debug mode is in use; otherwise, specify <code>false</code>.  The default is <code>false</code>.</dd></dl></blockquote>


<dl><dt><tt>targetArray</tt>
</dt><dd>Optional.  If provided, this is an array of microformat objects to which the search results are added.
</dd></dl>

<h6 name="Return_value_2">Return value</h6>
<p>A new array of microformat objects matching the search criteria, or the array specified by <tt>microformats</tt> with the newly found microformat objects added.
</p>
<h4 name="getNamesFromNode.28.29"> getNamesFromNode() </h4>
<p>Returns a space-delineated list of microformat names that correspond to the specified microformat node.
</p>
<pre class="eval">nameList = Microformats.getNamesFromNode(node);
</pre>
<h6 name="Parameters_3">Parameters</h6>
<dl><dt><tt>node</tt>
</dt><dd>The node for which to retrieve a list of microformat names.
</dd></dl>
<h6 name="Return_value_3">Return value</h6>
<p>If the specified <tt>node</tt> is a microformat, the result is a space-delineated string listing all the microformat names that correspond to the node.  If the node isn't a microformat, nothing is returned.
</p>
<h4 name="getParent.28.29"> getParent() </h4>
<p>Returns the parent node of the specified microformat or child of a microformat.
</p>
<pre class="eval">parentNode = Microformats.getParent(node);
</pre>
<h6 name="Parameters_4">Parameters</h6>
<dl><dt><tt>node</tt>
</dt><dd>The node whose parent you wish to retrieve.
</dd></dl>
<h6 name="Return_value_4">Return value</h6>
<p>The parent of the specified node.  Returns nothing if the specified <tt>node</tt> isn't a microformat or the child of a microformat.
</p>
<h4 name="isMicroformat.28.29"> isMicroformat() </h4>
<p>Determines whether or not the specified DOM node is a microformat.
</p>
<pre class="eval">flag = Microformats.isMicroformat(node);
</pre>
<h6 name="Parameters_5">Parameters</h6>
<dl><dt><tt>node</tt>
</dt><dd>The DOM node to check to see if it's a microformat.
</dd></dl>
<h6 name="Return_value_5">Return value</h6>
<p><code>true</code> if the node is a microformat, otherwise <code>false</code>.
</p><p>{{template.Note("This method does &lt;i&gt;not&lt;/i&gt; return &lt;code&gt;true&lt;/code&gt; if the node is a child of a microformat.")}}
</p>{{ wiki.languages( { "en": "en/Using_microformats" } ) }}
Revenir à cette révision