Macros usadas comunmente

En general, no es necesario utilizar macros para crear enlaces arbitrarios. Utiliza el botón Enlace en la interfaz del editor para crear enlaces.

• La macro Glossary crea un vínculo a la entrada de un término específico en el glosario de MDN. Esta macro acepta un parámetro obligatorio y dos opcionales:

  Ejemplos:

  1. El nombre del término (tal como "HTML").
  2. El texto que se mostrará en el artículo en lugar del nombre del término (esto se debe usar con poca frecuencia).Opcional
  3. Si se especifica este parámetro y no es cero, no se aplica el estilo personalizado que normalmente se aplica a los enlaces del glosario.Opcional
  • {{Glossary("HTML")}} produce HTML
  • {{Glossary("CSS", "Hojas de estilo en cascada")}} produce Hojas de estilo en cascada
  • {{Glossary("HTML", "", 1)}} produce

Hay varias macros para vincular páginas en áreas de referencia específicas de MDN.

• cssxref links to a page in the CSS Reference. Ejemplo: {{CSSxRef("cursor")}}, da como resultado: cursor.
• DOMxRef enlaces a páginas en la referencia DOM; si incluyes paréntesis al final, la plantilla sabe que debe mostrar el enlace para que aparezca el nombre de una función. Por ejemplo, {{DOMxRef("document.getElementsByName()")}} da como resultado: document.getElementsByName() mientras que {{DOMxRef("Node")}} da como resultado: Node.
• HTMLElement enlaza a un elemento HTML en la Referencia HTML.
• jsxref enlaza a una página en la Referencia de JavaScript.
• SVGAttr enlaza a un atributo SVG específico. Por ejemplo, {{SVGAttr("d")}} crea este enlace: d.
• SVGElement enlaza a un elemento SVG en la Referencia SVG.
• httpheader enlaza a un header de HTTP.
• HTTPMethod enlaza a un método de solicitud HTTP.
• HTTPStatus enlaces a un código de estado de respuesta HTTP.

Previous, Next y PreviousNext proporcionan controles de navegación para artículos que forman parte de secuencias. Para las plantillas unidireccionales, el único parámetro necesario es la ubicación wiki del artículo anterior o siguiente de la secuencia. Para PreviousNext, los dos parámetros necesarios son las ubicaciones wiki de los artículos correspondientes. El primer parámetro es para el artículo anterior y el segundo es para el artículo siguiente.

• EmbedLiveSample te permite insertar la salida de un ejemplo de código en una página, como se describe en Ejemplos en vivo.
• LiveSampleLink crea un vínculo a una página que contiene el resultado de un ejemplo de código en una página, como se describe en Ejemplos en vivo.

Hay plantillas para casi todas las grandes colecciones de páginas. Por lo general, enlazan a la página principal de reference/guide/tutorial (esto, a menudo es necesario porque nuestras rutas de navegación a veces no lo pueden hacer) y colocan el artículo en la categoría apropiada.

• CSSRef genera la barra lateral para las páginas de referencia CSS.
• HTMLSidebar genera la barra lateral para las páginas de referencia HTML.
• APIRef genera la barra lateral para las páginas de referencia de la API web.

optional_inline y ReadOnlyInline se utilizan en la documentación de la API, normalmente cuando se describe la lista de propiedades de un objeto o parámetros de una función.

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

• isCustomObjectRead only
  • Indica, si es true, que el objeto es personalizado.
• parameterXOpcional
  • : Blah blah blah...

Non-standard

Non-standard_Inline inserta una marca en línea que indica que la API no se ha estandarizado y no está en un seguimiento de estándares.

Sintaxis

{{Non-standard_Inline}}

Ejemplos

• Icono: No estándar

Experimental

experimental_inline inserta una marca en línea que indica que la API no está ampliamente implementada y puede cambiar en el futuro.

Sintaxis

{{Experimental_Inline}}

Ejemplos

• Icon: Experimental

En estas macros, el parámetro (cuando se especifica) debe ser una de las cadenas "html", "js", "css" o "gecko", seguida del número de versión.

Desaprobado

Deprecated_Inline inserta una marca desaprobado en línea (Deprecated_Inline) para desalentar el uso de una API que oficialmente está en desuso. Nota: "Desaprobado" significa que el elemento ya no se debe utilizar, pero sigue funcionando. Si quieres decir que ya no funciona, utiliza el término "obsoleto".

No utilices el parámetro en ningún área independiente del navegador (HTML, API, JS, CSS, …).

Sintaxis

{{Deprecated_Inline}}

Ejemplo

• Icon: Obsoleto

Estas macros se utilizan principalmente en la página WebAPI. Consulta Creación de nuevas insignias para obtener información sobre cómo crear una nueva insignia (Badge).

Estas plantillas tienen la misma semántica que sus contrapartes en línea descritas anteriormente. Las plantillas se deben colocar directamente debajo del título de la página principal (o la ruta de navegación si está disponible) en la página de referencia. También se pueden utilizar para marcar una sección en una página.

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

  No estándar: Esta característica no es parte de los estándares. No la uses en sitios Web en producción: no funcionará para todos los usuarios. Podrían haber también incompatibilidades considerables entre distintas implementaciones y el comportamiento podría cambiar en el futuro.

• SeeCompatTable se debe usar 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.

• Deprecated_Header con parámetro: {{Deprecated_Header("gecko5")}}

  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.

  No utilices el parámetro en ninguna área de diagnóstico del navegador (HTML, APIs, JS, CSS, …).
• secureContext_header: {{SecureContext_Header}}

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

La macro AvailableInWorkers inserta un cuadro de nota localizado que indica que una función está disponible en el contexto de workers web.