1. El proyecto MDN
  2. Pautas de redacción
  3. Estructuras de página
  4. Uso de macros
  5. Macros de uso común

Esta página ha sido traducida del inglés por la comunidad. Aprende más y únete a la comunidad de MDN Web Docs.

View in English Always switch to English

Macros de uso común

Esta página enumera muchas de las macros de propósito general que el sistema de compilación de MDN, rari, proporciona para su uso en MDN. Para obtener información general sobre cómo usarlas en el contenido de MDN, consulta Uso de macros.

Enlaces

MDN ofrece una serie de macros de enlace para facilitar la creación de vínculos a entradas del glosario, páginas de referencia y otros temas.

Se recomiendan las macros de enlace en lugar de los enlaces normales de Markdown porque son concisas y fáciles de traducir. Por ejemplo, un enlace de glosario o de referencia creado con una macro no necesita ser traducido: en otros idiomas se vinculará automáticamente a la versión correcta del archivo.

Estas macros también se describen con más detalle en la página de Macros de enlace.

Enlaces a términos del glosario

La macro Glossary crea un enlace a la página del término indicado en el Glosario de MDN. Esta macro acepta un parámetro obligatorio y uno opcional.

  • El término es un parámetro obligatorio. Por ejemplo, para enlazar a la página del glosario de "HTML", la macro será {{Glossary("HTML")}}, y esto generará el enlace HTML.
  • El texto a mostrar es un parámetro opcional. Por ejemplo, puedes escribir el enlace del ejemplo anterior como {{Glossary("HTML", "HyperText Markup Language")}}, lo que generará el enlace HyperText Markup Language.

Enlaces a páginas de referencia

Existen macros para enlazar de forma independiente del idioma a páginas en áreas de referencia específicas de MDN, como HTML, CSS, JavaScript, SVG y HTTP.

Las macros son fáciles de usar. Lo único que tienes que hacer es especificar el nombre del elemento al que quieres enlazar en el primer parámetro. Al igual que la macro del glosario, la mayoría de las macros de referencia también aceptan un segundo parámetro para cambiar el texto que se muestra.

Consulta los archivos fuente enlazados en la primera columna de la siguiente tabla para obtener más detalles.

Macro Enlaza a páginas bajo Ejemplo
CSSxRef Referencia CSS (/Web/CSS/Reference) {{CSSxRef("cursor")}} da como resultado cursor.
{{CSSxRef(":hover")}} da como resultado :hover.
{{CSSxRef("@media")}} da como resultado @media.
{{CSSxRef("pow")}} da como resultado pow().

Consulta los detalles en Uso de cssxref con la referencia CSS
DOMxRef Referencia DOM (/Web/API) {{DOMxRef("document")}} da como resultado Document.
{{DOMxRef("document.getElementsByName()")}} da como resultado document.getElementsByName().
{{DOMxRef("Node")}} da como resultado Node.
HTMLElement Referencia de elementos HTML (/Web/HTML/Reference/Elements) {{HTMLElement("select")}} da como resultado <select>.
JSxRef Referencia JavaScript (/Web/JavaScript/Reference) {{JSxRef("Promise")}} da como resultado Promise.
SVGAttr Referencia de atributos SVG (/Web/SVG/Reference/Attribute) {{SVGAttr("d")}} da como resultado d.
SVGElement Referencia de elementos SVG (/Web/SVG/Reference/Element) {{SVGElement("view")}} da como resultado <view>.
HTTPHeader Cabeceras HTTP (/Web/HTTP/Reference/Headers) {{HTTPHeader("ACCEPT")}} da como resultado ACCEPT.
HTTPMethod Métodos de petición HTTP (/Web/HTTP/Reference/Methods) {{HTTPMethod("HEAD")}} da como resultado HEAD.
HTTPStatus Códigos de estado de respuesta HTTP (/Web/HTTP/Reference/Status) {{HTTPStatus("404")}} da como resultado 404.

Añadir ayudas de navegación para guías multipágina

Las macros Previous, Next y PreviousNext ofrecen controles de navegación para artículos que forman parte de una secuencia. Para las plantillas unidireccionales, el único parámetro necesario es el slug del artículo anterior o siguiente en la secuencia. La macro PreviousNext requiere dos parámetros: el primero es el slug del artículo anterior y el segundo es el slug del artículo siguiente.

Generar ejemplos de código

Ejemplos en vivo

Añadir formato de propósito general

Añadir indicadores en línea para la documentación de la API

Optional_Inline y ReadOnlyInline se usan en la documentación de la API, generalmente al describir la lista de propiedades de un objeto o los parámetros de una función.

Uso: {{Optional_Inline}} o {{ReadOnlyInline}}. Ejemplo:

isCustomObject Read only

Indica, si es true, que el objeto es personalizado.

parameterX Opcional

Indica…

Añadir indicadores de estado y compatibilidad

Añadir indicadores en línea sin parámetros adicionales

No estándar

Non-standard_Inline inserta una marca en línea que indica que la API no ha sido estandarizada y no está en vías de estandarización.

Sintaxis

{{Non-standard_Inline}}

Ejemplos
  • Icono:

Experimental

Experimental_Inline inserta una marca en línea que indica que la API no está ampliamente implementada y puede cambiar en el futuro. Para obtener más información sobre la definición de experimental, consulta la documentación sobre Experimental, obsoleto y en desuso.

Sintaxis

{{Experimental_Inline}}

Ejemplos
  • Icono:

Añadir indicadores en línea que permiten especificar la tecnología

Obsoleto

Deprecated_Inline inserta una marca de obsoleto en línea () para desalentar el uso de una API que está oficialmente obsoleta (o que ha sido eliminada). Para obtener más información sobre la definición de obsoleto, consulta la documentación sobre Experimental, obsoleto y en desuso.

Sintaxis

{{Deprecated_Inline}}

Ejemplos
  • Icono:

Indicadores de encabezado de página o sección

Estas plantillas tienen la misma semántica que sus equivalentes en línea descritas anteriormente. Debes colocar las plantillas directamente debajo del título principal de la página (o de la ruta de navegación, si está disponible) en la página de referencia. También puedes usarlas para marcar una sección en una página.

  • Non-standard_Header: {{Non-standard_Header}}

    No estándar: Esta función no está estandarizada. No recomendamos usar funciones no estándar en producción, ya que tienen un soporte limitado en los navegadores y pueden cambiar o eliminarse. Sin embargo, pueden ser una alternativa adecuada en casos específicos donde no exista una opción estándar.

  • SeeCompatTable se usa en páginas que documentan características experimentales. Ejemplo: {{SeeCompatTable}}

    Experimental: Esta es una tecnología experimental
    Comprueba la Tabla de compabilidad de navegadores cuidadosamente antes de usarla en producción.

  • Deprecated_Header: {{Deprecated_Header}}

    Obsoleto: Esta característica ya no se recomienda. Aunque es posible que algunos navegadores aún lo admitan, probablemente ya se ha eliminado de los estándares web relevantes, está en proceso de eliminación o solo se conserva por motivos de compatibilidad. Evite usarlo y actualice el código existente si es posible; consulte la tabla de compatibilidad en la parte inferior de esta página para orientar su decisión. Tenga en cuenta que esta característica puede dejar de funcionar en cualquier momento.

  • SecureContext_Header. Debe usarse en páginas principales, como páginas de interfaz, páginas de descripción general de la API y puntos de entrada de la API (por ejemplo, navigator.xyz), pero normalmente no en subpáginas como páginas de métodos y propiedades. Ejemplo: {{SecureContext_Header}}

    Contexto seguro: Esta función está disponible solo en contextos seguros (HTTPS), en algunos o todos los navegadores que lo soportan.

Indicar que una característica está disponible en web workers

La macro AvailableInWorkers inserta un cuadro de nota localizado que indica que una característica está disponible en un contexto de worker. También puedes pasar algunos argumentos para indicar que la característica funciona en un contexto de worker específico.

Sintaxis
{{AvailableInWorkers}}
{{AvailableInWorkers("window_and_worker_except_service")}}
Ejemplos

Nota: This feature is available in Web Workers, except for Service Workers.

Nota: Esta característica está disponible en Web Workers.

Enlaces a la compatibilidad con navegadores y especificaciones

Las siguientes macros se incluyen en todas las páginas de referencia, pero también son compatibles con todos los tipos de página:

{{Compat}}

Genera una tabla de compatibilidad para las características definidas por browser-compat en el frontmatter.

{{Specifications}}

Incluye una tabla de especificaciones para las características definidas por spec-urls en el frontmatter, si está presente, o a partir de la especificación incluida en los datos de compatibilidad con navegadores definidos por browser-compat en el frontmatter.

Véase también

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.

View this page on GitHub • Report a problem with this content