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: 165660
  • Creada:
  • Creador: HenryGR
  • ¿Es la revisión actual? No
  • Comentario /* getParent() */

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()

Devuelve una matriz de objetos microformato encontrados, que cumplen con el criterio especificado.

microformatsArray = Microformats.get(name, rootElement, options, targetArray);
Parámetros
<tt>name</tt>
El nombre del microformato a encontrar.
<tt>rootElement</tt>
Requerido. El elemento DOM donde debe comenzar la búsqueda. Si quieres buscar el documento entero, especifica content.document.
<tt>options</tt>
Opcional. Si se especifica, es un objeto JavaScript que contiene cero o más de los siguientes flag:
<tt>recurseExternalFrames</tt>
Si es true, se incluyen los marcos hijo que hagan referencia a contenido externo, en la búsqueda. Por defecto es true.
<tt>showHidden</tt>
Si es true, se incluyen los microformatos ocultos, en caso contrario se ignoran. Por defecto es false.
<tt>debug</tt>
Especifica true si se está en modo "debug", en caso contrario es false. Por defecto es false.
<tt>targetArray</tt>
Opcional. Cuando se especifica, es una matriz de objetos microformatos en donde se añaden lso objetos microformato resultantes de la búsqueda.
Valor devuelto

Una nueva matriz de objetos microformato que cumplen con el criterio de búsqueda, o la matriz especificada por <tt>microformats</tt> con los nuevos microformatos encontrados añadidos.

getNamesFromNode()

Devuelve una lista, delimitada por espacios, de nombres de microformatos que corresponde al nodo especificado.

nameList = Microformats.getNamesFromNode(node);
Parámetros
<tt>node</tt>
El nodo en el cual leer una lista de nombres de microformatos.
Valor devuelto

Si el <tt>node</tt> especificado es un microformato, el resultado es una cadena conteniendo, delimitados por especios, los nombres de todos los microformatos que corresponden al nodo. Si el nodo no es un microformato, no se devuelve nada.

getParent()

Devuelve el nodo padre del microformato especificado o hijo de un microformato.

parentNode = Microformats.getParent(node);
Parámetros
<tt>node</tt>
El nodo cuyo padre quieres obtener.
Valor devuelto

El padre del nodo especificado. No devuelve nada si el <tt>node</tt> especificado no es un microformato o el hijo de un microformato.

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>Devuelve una matriz de objetos microformato encontrados, que cumplen con el criterio especificado.
</p>
<pre class="eval">microformatsArray = Microformats.get(name, rootElement, options, targetArray);
</pre>
<h6 name="Par.C3.A1metros_4">Parámetros</h6>
<dl><dt><tt>name</tt>
</dt><dd>El nombre del microformato a encontrar.
</dd><dt><tt>rootElement</tt>
</dt><dd>Requerido. El elemento DOM donde debe comenzar la búsqueda. Si quieres buscar el documento entero, especifica <code>content.document</code>.
</dd><dt><tt>options</tt>
</dt><dd>Opcional. Si se especifica, 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 hijo que hagan referencia a contenido externo, en la búsqueda. Por defecto es <code>true</code>.
</dd><dt><tt>showHidden</tt>
</dt><dd>Si es <code>true</code>, se incluyen los microformatos ocultos, en caso contrario se ignoran. Por defecto es <code>false</code>.
</dd><dt><tt>debug</tt>
</dt><dd>Especifica <code>true</code> si se está en modo "debug", en caso contrario es <code>false</code>.  Por defecto es <code>false</code>.</dd></dl></blockquote>


<dl><dt><tt>targetArray</tt>
</dt><dd>Opcional. Cuando se especifica, es una matriz de objetos microformatos en donde se añaden lso objetos microformato resultantes de la búsqueda.
</dd></dl>

<h6 name="Valor_devuelto_3">Valor devuelto</h6>
<p>Una nueva matriz de objetos microformato que cumplen con el criterio de búsqueda, o la matriz especificada por <tt>microformats</tt> con los nuevos microformatos encontrados añadidos.
</p>
<h3 name="getNamesFromNode.28.29">getNamesFromNode()</h3>
<p>Devuelve una lista, delimitada por espacios, de nombres de microformatos que corresponde al nodo especificado.
</p>
<pre class="eval">nameList = Microformats.getNamesFromNode(node);
</pre>
<h6 name="Par.C3.A1metros_5">Parámetros</h6>
<dl><dt><tt>node</tt>
</dt><dd>El nodo en el cual leer una lista de nombres de microformatos.
</dd></dl>
<h6 name="Valor_devuelto_4">Valor devuelto</h6>
<p>Si el <tt>node</tt> especificado es un microformato, el resultado es una cadena conteniendo, delimitados por especios, los nombres de todos los microformatos que corresponden al nodo. Si el nodo no es un microformato, no se devuelve nada.
</p>
<h3 name="getParent.28.29">getParent()</h3>
<p>Devuelve el nodo padre del microformato especificado o hijo de un microformato.
</p>
<pre class="eval">parentNode = Microformats.getParent(node);
</pre>
<h6 name="Par.C3.A1metros_6">Parámetros</h6>
<dl><dt><tt>node</tt>
</dt><dd>El nodo cuyo padre quieres obtener.
</dd></dl>
<h6 name="Valor_devuelto_5">Valor devuelto</h6>
<p>El padre del nodo especificado. No devuelve nada si el <tt>node</tt> especificado no es un microformato o el hijo de un microformato.
</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">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">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