El uso de microformatos

  • Enlace amigable (slug) de la revisión: El_uso_de_microformatos
  • Título de la revisión: El uso de microformatos
  • Id de la revisión: 165656
  • Creada:
  • Creador: HenryGR
  • ¿Es la revisión actual? No
  • Comentario /* debug() */

Contenido de la revisión

{{wiki.template('Traducción', [ "inglés", "Using_microformats", "en" ])}}


{{template.Fx_minversion_header(3)}} Los icroformatos permiten a un sitio web ofrecer datos semánticos a los navegadores de forma que sea posible presentar resúmenes de la información en una página sin que sea necesario saber cómo analizar el documento en si mismo. Firefox 3 implementa un objeto global Microformats que permite el acceso a estos microformatos. Este objeto y su API hacen de la búsqueda y lectura de microformatos, algo fácil.

Cargar el API de Microformatos

El objeto Microformats se crea usando el nuevo cargador de JavaScript integrado en Firefox 3. Para usar este API, primero necesitas cargar el objeto:

Components.utils.import("resource://gre/modules/Microformats.js");

Una vez cargado del API de Microformatos, puedes manejar los Microformatos usando los métodos que aquí listamos. Para información sobre cómo analizar los Microformatos, lee: Parsing microformats in JavaScript.

Microformatos predefinidos

Firefox 3 ofrece varios Microformatos integrados:

adr
Representa una dirección (como una calle o una dirección postal).
geo
Representa una localización geográfica usando coordenadas de latitud y longitud.
hCard
Representa la información de contacto de una persona.
hCalendar
Representa una entrada en un calendario o la cita en una agenda.
tag
Se usa para añadir pestañas a otros Microformatos.

Métodos

add()

Añade un nuevo Microformato al módulo de Microformatos.

{{template.Nota("Si ya existe un microformato con el mismo nombre, será reemplazado por el nuevo.")}}

add(name, definition);
Parámetros
<tt>name</tt>
El nombre del microformato a añadir al módulo.
<tt>definición</tt>
Una estructura JavaScript que describe el microformato. Ver Describing microformats in JavaScript para más detalles.

count()

Cuenta el número de microformatos que hay en un documento que cumple con determinado criterio.

numMicroformats = Microformats.count(name, rootElement, options);
Parámetros
<tt>name</tt>
El nombre del microformato que queremos contar.
<tt>rootElement</tt>
Requerido. El elemento DOM en dónde empezar la búsqueda. Si deseas buscar en el documento entero, especifica content.document.
<tt>options</tt>
Opcional. Cuando se especifica, este es un objeto JavaScript que contiene cero o más de los siguientes flag:
<tt>recurseExternalFrames</tt>
Si es true, se incluyen los marcos (frames) hijos en la búsqueda. Por defecto es true.
<tt>showHidden</tt>
Si es true, se añaden microformatos ocultos, en caso contrario, se ignoran. Por defecto es false.
<tt>debug</tt>
Se especifica a true cuando se usa el modo de "debug", en caso contrario es false. Por defecto es false.
Valor devuelto

Un valor entero que indica el número de microformatos que cumplen el criterio especificado.

debug()

Devuelve una cadena que describe un objeto microformato.

{{template.Nota("Pueds simplemente llamar a <code>debug()</code> en un objeto microformato: <code>microformatObject.debug()</code> en lugar de usar este método, si lo prefieres.")}}

dumpString = debug(microformatObject)
Parámetros
<tt>microformatObject</tt>
El objeto microformato a descargar.
Valor devuelto

Una cadena que describe el contenido del objeto microformato especificado.

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>
Required. The DOM element at which to begin the search. If you want to search the entire document, specify content.document.
<tt>options</tt>
Optional. If provided, this is a JavaScript object that contains zero or more of the following flags:
<tt>recurseExternalFrames</tt>
If true, child frames that reference external content 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( { "fr": "fr/Utilisation_de_microformats", "ja": "ja/Using_microformats", "pl": "pl/Zastosowanie_mikroformat\u00f3w", "ko": "ko/Using_microformats", "en": "en/Using_microformats" } ) }}

Fuente de la revisión

<p>{{wiki.template('Traducción', [ "inglés", "Using_microformats", "en" ])}}
</p><p><br>
{{template.Fx_minversion_header(3)}}
Los icroformatos permiten a un sitio web ofrecer datos semánticos a los navegadores de forma que sea posible presentar resúmenes de la información en una página sin que sea necesario saber cómo analizar el documento en si mismo. Firefox 3 implementa un objeto global <code>Microformats</code> que permite el acceso a estos microformatos. Este objeto y su API hacen de la búsqueda y lectura de microformatos, algo fácil. 
</p>
<h2 name="Cargar_el_API_de_Microformatos">Cargar el API de Microformatos</h2>
<p>El objeto <code>Microformats</code> se crea usando el nuevo cargador de JavaScript integrado en Firefox 3. Para usar este API, primero necesitas cargar el objeto:
</p>
<pre class="eval"><span class="plain">Components.utils.import("resource://gre/modules/Microformats.js");</span>
</pre>
<p>Una vez cargado del API de Microformatos, puedes manejar los Microformatos usando los métodos que aquí listamos. Para información sobre cómo analizar los Microformatos, lee: <a href="es/Parsing_microformats_in_JavaScript">Parsing microformats in JavaScript</a>.
</p>
<h2 name="Microformatos_predefinidos">Microformatos predefinidos</h2>
<p>Firefox 3 ofrece varios Microformatos integrados:
</p>
<dl><dt><code><a href="es/El_Microformato_adr">adr</a></code>
</dt><dd>Representa una dirección (como una calle o una dirección postal).
</dd><dt><code><a href="es/El_Microformato_geo">geo</a></code>
</dt><dd>Representa una localización geográfica usando coordenadas de latitud y longitud.
</dd><dt><code><a href="es/El_Microformato_hCard">hCard</a></code>
</dt><dd>Representa la información de contacto de una persona.
</dd><dt><code><a href="es/El_Microformato_hCalendar">hCalendar</a></code>
</dt><dd>Representa una entrada en un calendario o la cita en una agenda.
</dd><dt><code><a href="es/El_Microformato_tag">tag</a></code>
</dt><dd>Se usa para añadir pestañas a otros Microformatos.
</dd></dl>
<h2 name="M.C3.A9todos">Métodos</h2>
<h3 name="add.28.29">add()</h3>
<p>Añade un nuevo Microformato al módulo de Microformatos.
</p><p>{{template.Nota("Si ya existe un microformato con el mismo nombre, será reemplazado por el nuevo.")}}
</p>
<pre class="eval">add(name, definition);
</pre>
<h6 name="Par.C3.A1metros">Parámetros</h6>
<dl><dt><tt>name</tt>
</dt><dd>El nombre del microformato a añadir al módulo.
</dd><dt><tt>definición</tt>
</dt><dd>Una estructura JavaScript que describe el microformato. Ver <a href="es/Describing_microformats_in_JavaScript">Describing microformats in JavaScript</a> para más detalles.
</dd></dl>
<h3 name="count.28.29">count()</h3>
<p>Cuenta el número de microformatos que hay en un documento que cumple con determinado criterio.
</p>
<pre class="eval">numMicroformats = Microformats.count(name, rootElement, options);
</pre>
<h6 name="Par.C3.A1metros_2">Parámetros</h6>
<dl><dt><tt>name</tt>
</dt><dd>El nombre del microformato que queremos contar.
</dd><dt><tt>rootElement</tt>
</dt><dd>Requerido. El elemento DOM en dónde empezar la búsqueda. Si deseas buscar en el documento entero, especifica <code>content.document</code>.
</dd><dt><tt>options</tt>
</dt><dd>Opcional. Cuando se especifica, este es un objeto JavaScript que contiene cero o más de los siguientes flag:
</dd></dl>
<blockquote>
<dl><dt><tt>recurseExternalFrames</tt>
</dt><dd>Si es <code>true</code>, se incluyen los marcos (frames) hijos en la búsqueda. Por defecto es <code>true</code>.
</dd><dt><tt>showHidden</tt>
</dt><dd>Si es <code>true</code>, se añaden microformatos ocultos, en caso contrario, se ignoran. Por defecto es <code>false</code>.
</dd><dt><tt>debug</tt>
</dt><dd>Se especifica a <code>true</code> cuando se usa el modo de "debug", en caso contrario es <code>false</code>.  Por defecto es  <code>false</code>.</dd></dl></blockquote>


<h6 name="Valor_devuelto">Valor devuelto</h6>
<p>Un valor entero que indica el número de microformatos que cumplen el criterio especificado.
</p>
<h3 name="debug.28.29">debug()</h3>
<p>Devuelve una cadena que describe un objeto microformato.
</p><p>{{template.Nota("Pueds simplemente llamar a &lt;code&gt;debug()&lt;/code&gt; en un objeto microformato: &lt;code&gt;microformatObject.debug()&lt;/code&gt; en lugar de usar este método, si lo prefieres.")}}
</p>
<pre class="eval">dumpString = debug(microformatObject)
</pre>
<h6 name="Par.C3.A1metros_3">Parámetros</h6>
<dl><dt><tt>microformatObject</tt>
</dt><dd>El objeto microformato a descargar.
</dd></dl>
<h6 name="Valor_devuelto_2">Valor devuelto</h6>
<p>Una cadena que describe el contenido del objeto microformato especificado.
</p>
<h3 name="get.28.29">get()</h3>
<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">Parameters</h6>
<dl><dt><tt>name</tt>
</dt><dd>The name of the microformat to find.
</dd><dt><tt>rootElement</tt>
</dt><dd>Required.  The DOM element at which to begin the search.  If you want to search the entire document, specify <code>content.document</code>.
</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>recurseExternalFrames</tt>
</dt><dd>If <code>true</code>, child frames that reference external content 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">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>
<h3 name="getNamesFromNode.28.29">getNamesFromNode()</h3>
<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_2">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_2">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>
<h3 name="getParent.28.29">getParent()</h3>
<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_3">Parameters</h6>
<dl><dt><tt>node</tt>
</dt><dd>The node whose parent you wish to retrieve.
</dd></dl>
<h6 name="Return_value_3">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>
<h3 name="isMicroformat.28.29">isMicroformat()</h3>
<p>Determines whether or not the specified DOM node is a microformat.
</p>
<pre class="eval">flag = Microformats.isMicroformat(node);
</pre>
<h6 name="Parameters_4">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_4">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><p><br>
</p>
<div class="noinclude">
</div>
<div class="noinclude">
</div>
{{ wiki.languages( { "fr": "fr/Utilisation_de_microformats", "ja": "ja/Using_microformats", "pl": "pl/Zastosowanie_mikroformat\u00f3w", "ko": "ko/Using_microformats", "en": "en/Using_microformats" } ) }}
Revertir a esta revisión