Plantilla de página de propiedad global de JavaScript
Nota: Elimina toda esta nota explicativa antes de publicar
Front matter de la página:
El front matter que aparece en la parte superior de la página se usa para definir los "metadatos de la página". Debes actualizar los valores según corresponda para la propiedad en cuestión.
---
title: nameOfTheProperty
slug: Web/JavaScript/Reference/Global_Objects/nameOfTheProperty
page-type: javascript-global-property
status:
- deprecated
- experimental
- non-standard
browser-compat: javascript.builtins.nameOfTheProperty
sidebar: jssidebar
---
- title
-
Encabezado del título que se muestra en la parte superior de la página. Formatéalo como
nameOfTheProperty. - slug
-
El final de la ruta de la URL después de
https://developer.mozilla.org/es/docs/. Esto se formateará comoWeb/JavaScript/Reference/Global_Objects/nameOfTheProperty. - page-type
-
La clave
page-typepara las páginas de propiedades globales de JavaScript esjavascript-global-property. - status
-
Marcadores que describen el estado de esta característica. Un array que puede contener uno o más de los siguientes valores:
experimental,deprecated,non-standard. Esta clave no debe establecerse manualmente: se establece automáticamente en función de los valores de los datos de compatibilidad con navegadores de la característica. Consulta "Cómo se agregan o actualizan los estados de las características". - browser-compat
-
Reemplaza el valor de marcador de posición
javascript.builtins.nameOfThePropertycon la cadena de consulta de la propiedad en el repositorio de datos de compatibilidad con los navegadores. La cadena de herramientas utiliza automáticamente esta clave para rellenar las secciones de compatibilidad y especificación (reemplazando las macros{{Compat}}y{{Specifications}}).Ten en cuenta que es posible que primero debas crear o actualizar una entrada para la propiedad en nuestro repositorio de datos de compatibilidad con los navegadores, y que la entrada de la API deberá incluir información de especificación. Consulta nuestra guía sobre cómo hacerlo.
-
Es
jssidebarpara las páginas de propiedades globales de JavaScript. Consulta Estructuras de página: barras laterales para obtener más detalles.
Macros al inicio de la página
Varias llamadas a macros aparecen en la parte superior de la sección de contenido (justo debajo del front matter de la página).
Estas macros las añade automáticamente la cadena de herramientas (no es necesario añadirlas ni eliminarlas):
{{SeeCompatTable}}— esto genera un banner de Esta es una tecnología experimental que indica que la tecnología es experimental. Si es experimental y la tecnología está oculta tras una preferencia en Firefox, también debes completar una entrada para ella en la página Funciones experimentales en Firefox.{{Non-standard_Header}}— esto genera un banner de No estándar que indica que la característica no forma parte de ninguna especificación.
No proporciones las macros de encabezado de estado manualmente. Consulta la sección Cómo se agregan o actualizan los estados de las características para añadir estos estados a la página.
A continuación de este bloque de notas se muestran ejemplos de los banners Experimental y No estándar.
Recuerda eliminar toda esta nota explicativa antes de publicar.
Nota: Recuerda el principio más importante para escribir páginas de referencia de JavaScript coherentes: ¡fíjate en lo que ya existe! Muchas páginas relacionadas tienen estructuras coherentes que van más allá de lo que exige esta plantilla. Por ejemplo, todos los manejadores de proxy, la mayoría de los métodos de array, etc. Empieza por buscar documentación existente de API similares y copia su estructura.
Experimental: Esta es una tecnología experimental
Comprueba la Tabla de compabilidad de navegadores cuidadosamente antes de usarla en producción.
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.
La propiedad global nameOfTheProperty representa algo. Idealmente, esto debería ser una o dos oraciones cortas.
Valor
Incluye una descripción del valor de la propiedad, con su tipo de dato y lo que representa.
{{js_property_attributes(1, 0, 0)}}
Los tres números que se pasan a js_property_attributes representan los atributos configurable, enumerable y writable, respectivamente. Lee la especificación o haz pruebas. Si hay varias combinaciones de atributos posibles según cómo se cree el objeto, o si la propiedad solo está presente en ciertas condiciones, añade una nota.
Descripción
La mayor parte de la descripción de la propiedad debe ir aquí. Sé lo más exhaustivo posible.
Quien lea debe poder entender la API por completo con esta sección, sin leer la sección de ejemplos de abajo. Los ejemplos que se presenten en esta sección, si hacen falta, deben ser concisos y no tienen que ser casos del mundo real.
Ejemplos
Ten 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 lo identifique. El encabezado debe describir lo que hace 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, usa el párrafo después del encabezado. El primer ejemplo puede llamarse "Uso de nameOfTheProperty".
Consulta nuestra guía sobre cómo añadir ejemplos de código para obtener más información.
Especificaciones
{{Specifications}}
Para usar esta macro, elimina las comillas invertidas y la barra invertida en el archivo de markdown.
Compatibilidad con navegadores
{{Compat}}
Para usar esta macro, elimina las comillas invertidas y la barra invertida en el archivo de markdown.
Véase también
Incluye enlaces a páginas de referencia y guías relacionadas con la propiedad actual. Para obtener más pautas, consulta la sección Véase también en la Guía de estilo de redacción.
- Polyfill de
nameOfThePropertyencore-js - Polyfill de
nameOfThePropertyde es-shims - enlace1
- enlace2
- enlace_externo (año)