Plantilla de subpágina de propiedades de API

Nota: Elimina toda esta nota explicativa antes de publicarla.

Metadatos de la página:

Los campos en la parte superior de la página se utiliza para definir "metadatos de página". Los valores deben actualizarse adecuadamente para la propiedad en particular.

md
---
title: NameOfTheParentInterface.NameOfTheProperty
slug: Web/API/NameOfTheParentInterface/NameOfTheProperty
page-type: web-api-instance-property O web-api-static-property
status:
  - experimental
  - deprecated
  - non-standard
browser-compat: path.to.feature.NameOfTheProperty
---
title

Título que se muestra en la parte superior de la página. Formatear como NameOfTheParentInterface.NameOfTheProperty. Por ejemplo, la propiedad capabilities (en-US) de la interfaz VRDisplay (en-US) su title es VRDisplay.capabilities.

slug

El final de la ruta de la URL después de https://developer.mozilla.org/es/docs/. Esto se formateará como Web/API/NameOfTheParentInterface/NameOfTheProperty.

Si la propiedad es estática, entonces el slug debe tener un sufijo _static, como: Web/API/NameOfTheParentInterface/NameOfTheProperty_static. Esto nos permite admitir propiedades de instancia y estáticas que tienen el mismo nombre.

page-type

La clave page-type para las propiedades Web/API es web-api-instance-property (por ejemplo, propiedades) o web-api-static-property (para propiedades estáticas).

status

Incluye claves de estado de tecnología (apropiadas): experimental, obsoleto, no estándar (si no está en una pista de estándares).

browser-compat

Reemplace el valor de marcador de posición path.to.feature.NameOfTheProperty con la cadena de consulta para la propiedad en el repositorio de datos de compatibilidad con los navegadores. La cadena de herramientas utiliza automáticamente la clave para rellenar las secciones de compatibilidad y especificación (reemplazando las macros {{Compat}} y {{Specifications}}).

Tenga en cuenta que es posible que primero deba crear/actualizar una entrada para la propiedad de la API en nuestro repositorio de datos de compatibilidad con los navegadores, y la entrada para la API deberá incluir información de especificación. Consulta nuestra guía sobre cómo hacerlo.

Macros al inicio de la página

Varias llamadas de macro aparecen en la parte superior de la sección de contenido (inmediatamente debajo de los metadatos). Debes actualizarlos o eliminarlos de acuerdo con los siguientes consejos:

  • {{SeeCompatTable}} — esto genera un banner de tecnología experimental que indica que la tecnología es experimental. Si la tecnología que está documentando no es experimental, debe eliminarla. Si es experimental y la tecnología está oculta detrás de un pref en Firefox, también debes completar una entrada para ello en la página Funciones experimentales en Firefox.
  • {{Deprecated_Header}} — esto genera un banner de Desaprobado que indica que el uso de la tecnología está desaprobada. Si no lo es, puede eliminar la llamada de macro.
  • {{SecureContext_Header}} — esto genera un banner de contexto seguro que indica que la tecnología solo está disponible en un contexto seguro (en-US). Si no lo es, puede eliminar la llamada de macro. Si es así, también debe completar una entrada para ello en la página Funciones restringidas a contextos seguros (en-US).
  • {{APIRef ("GroupDataName")}} — esto genera la barra lateral de referencia de la izquierda que muestra enlaces de referencia rápida relacionados con la página actual. Por ejemplo, todas las páginas de la API de WebVR tienen la misma barra lateral, que apunta a las otras páginas de la API. Para generar la barra lateral correcta para tu API, debes añadir una entrada GroupData a nuestro repositorio de GitHub e incluir el nombre de la entrada dentro de la llamada a la macro en lugar de GroupDataName. Consulta nuestra guía de barras laterales de referencia de API para obtener información sobre cómo hacerlo. Recuerde eliminar la macro {{MDNSidebar}} cuando copie esta página.

Las muestras de los banners Experimental, Contexto seguro y Desaprobado se muestran justo después de este bloque de notas.

Recuerde eliminar toda esta nota explicativa antes de publicarla.

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

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

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.

Comience el contenido de la página con un párrafo introductorio: comience por nombrar la propiedad, decir de qué interfaz forma parte y qué hace. Idealmente, esto debería ser una o dos oraciones cortas. Podrías copiar la mayor parte de esto del resumen de la propiedad en la página de referencia de la API correspondiente. Incluya si es de solo lectura o no.

Valor

Incluya una descripción del valor de la propiedad, incluido el tipo de datos y lo que representa.

Ejemplos

Tenga en cuenta que usamos el plural "Ejemplos" incluso si la página solo contiene un ejemplo.

Un encabezado descriptivo

Cada ejemplo debe tener un encabezado H3 (###) que nombre el ejemplo. El encabezado debe ser descriptivo de lo que está haciendo el ejemplo. Por ejemplo, "Un ejemplo simple" no dice nada sobre el ejemplo y, por lo tanto, no es un buen encabezado. El encabezado debe ser conciso. Para una descripción más larga, use el párrafo después del encabezado.

Consulta nuestra guía sobre cómo añadir ejemplos de código para obtener más información.

Nota: A veces querrás enlazar a ejemplos dados en otra página.

Escenario 1: Si tiene algunos ejemplos en esta página y algunos ejemplos más en otra página:

Incluya un encabezado H3 (###) para cada ejemplo en esta página y luego un encabezado H3 final (###) con el texto "Más ejemplos", bajo el cual puede vincular los ejemplos en otras páginas. Por ejemplo:

md
## Ejemplos

### Uso de la API fetch

Ejemplo de Fetch

### Más ejemplos

Enlaces a más ejemplos en otras páginas

Escenario 2: Si solo tienes ejemplos en otra página y ninguno en esta página:

No añada ningún encabezado H3; solo añada los enlaces directamente debajo del encabezado H2 "Ejemplos". Por ejemplo:

md
## Ejemplos

Para ver ejemplos de esta API, consulte [la página en fetch()](https://example.org).

Especificaciones

{{Specifications}}

Para usar esta macro, elimine las comillas invertidas y la barra invertida en el archivo de markdown.

Compatibilidad con los navegadores

{{Compat}}

Para usar esta macro, elimine las comillas invertidas y la barra invertida en el archivo de markdown.

Veáse también

Incluya enlaces a páginas de referencia y guías relacionadas con la API actual. Para obtener más pautas, consulta la sección Véase también en la Guía de estilo.

  • enlace1
  • enlace2
  • enlace_externo (año)