Plantilla de página de propiedad CSS
Nota: Elimina este bloque de notas antes de publicar.
Front matter de la página:
El front matter en la parte superior de la página se utiliza para definir los "metadatos de la página". Los valores deben actualizarse adecuadamente para la propiedad en particular.
---
title: name-of-the-property
slug: Web/CSS/Reference/Properties/name-of-the-property
page-type: css-property O css-shorthand-property
status:
- deprecated
- experimental
- non-standard
browser-compat: css.properties.name-of-the-property
sidebar: cssref
---
- title
-
El valor de
titlese muestra en la parte superior de la página. El formato del título es nombre-de-la-propiedad. Por ejemplo, la propiedadbackground-colortiene el título background-color. - slug
-
El valor de
sluges el final de la ruta de la URL después dehttps://developer.mozilla.org/en-US/docs/. Esto tendrá el formatoWeb/CSS/Reference/Properties/nombre-de-la-propiedad. Por ejemplo, el slug para la propiedadbackground-coloresWeb/CSS/Reference/Properties/background-color. Para un componente de varias palabras comoGetting_starteden un slug, este debe usar un guion bajo, como en/en-US/docs/Learn_web_development/Core/Structuring_content. - page-type
-
El valor de
page-typepara las propiedades CSS escss-property. Para una propiedad CSS abreviada (shorthand), el valor escss-shorthand-property. Por ejemplo, el valor depage-typepara la propiedad animation escss-shorthand-propertyporque es una propiedad abreviada, mientras que el valor depage-typepara la propiedad animation-delay escss-property. - status
-
Etiquetas (flags) que describen el estado de esta característica. Es un arreglo (array) que puede contener uno o más de los siguientes valores:
experimental,deprecated,non-standard. Esta clave no debe configurarse manualmente: se establece automáticamente según los valores en los datos de compatibilidad del navegador para la característica. Consulta "Cómo se añaden o actualizan los estados de las características". - browser-compat
-
Reemplaza el valor de marcador de posición
css.properties.NameOfThePropertycon la cadena de consulta (query string) para la propiedad en el repositorio de datos de compatibilidad de navegadores (Browser compat data repo). Revisa la sección Otras macros en la página de este bloque de notas para ver cómo se utiliza este par clave-valor para generar contenido para las secciones Especificaciones y Compatibilidad con navegadores. -
Esto es
cssrefpara todas las páginas de guía y referencia de CSS. Consulta Estructuras de página: Barras laterales para más detalles.
Macros de la parte superior de la página
Varias llamadas a macros aparecen en la parte superior de la sección de contenido (inmediatamente debajo del front matter de la página). El conjunto de herramientas (toolchain) añade automáticamente estas macros (no es necesario añadirlas ni eliminarlas):
{{SeeCompatTable}}: Esta macro genera un banner de Experimental, que indica que la tecnología es experimental. Si la tecnología es experimental y está oculta detrás de una preferencia en Firefox, también debes completar una entrada para ella en la página Características experimentales en Firefox.{{Deprecated_Header}}: Esta macro genera un banner de Obsoleto (Deprecated), que indica que el uso de la tecnología está desaconsejado.{{Non-standard_Header}}— esto genera un banner de No estándar (Non-standard) que indica que la característica no forma parte de ninguna especificación.
Debes actualizar o eliminar las siguientes macros de acuerdo con los consejos a continuación:
No proporciones macros de encabezado de estado manualmente. Consulta la sección "Cómo se añaden o actualizan los estados de las características" para añadir estos estados a la página.
Justo después de este bloque de notas se muestran ejemplos de los banners Experimental, Obsoleto y No estándar.
Otras macros en la página
Sección de sintaxis formal: El contenido para la sección Sintaxis formal se genera utilizando la macro
{{CSSSyntax}}. Esta macro obtiene datos de las especificaciones utilizando el paquete npm @webref/css.Sección de definición formal: El contenido para la sección Definición formal se genera utilizando la macro
{{CSSInfo}}. Para que esta sección tenga datos, debes asegurarte de que se haya completado una entrada adecuada para la propiedad correspondiente en el archivo de datos properties.json en el repositoriomdn/data. Consulta la página de Propiedades para obtener más información.Secciones de Especificaciones y Compatibilidad con navegadores: La herramienta de compilación utiliza automáticamente el par clave-valor
browser-compatdel front matter de la página para insertar datos en las secciones Especificaciones y Compatibilidad con navegadores (reemplazando las macros{{Specifications}}y{{Compat}}en esas secciones, respectivamente).Ten en cuenta que es posible que primero debas crear o actualizar una entrada para la propiedad y su especificación en nuestro repositorio de datos de compatibilidad de navegadores. Consulta nuestra guía de tablas de compatibilidad para obtener información sobre cómo añadir o editar entradas.
Recuerda eliminar este bloque de notas antes de publicar.
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.
Comienza el contenido de la página con un párrafo introductorio que nombre la propiedad y explique qué hace. Idealmente, debería ser una o dos frases cortas.
Pruébalo
Esta sección es generada por la macro InteractiveExample. Incluye el título de la sección "Try it" y el editor de código. Consulta la sección de Ejemplos interactivos en nuestras Directrices de escritura para más información.
Propiedades constituyentes
Añade esta sección solo para propiedades abreviadas (shorthand), como animation, para enumerar todas las propiedades completas (longhand) relacionadas.
Sintaxis
Incluye los casos de uso comunes como un bloque de código y describe los subvalores de los componentes que forman un valor completo.
/* Inserta el bloque de código que muestra los casos de uso comunes */
/* o categorías de valores */
Valores
Incluye un término y una definición para cada subvalor.
subvalor1-
Incluye una descripción del subvalor, su tipo de datos y qué representa.
subvalor2-
Incluye una descripción del subvalor, su tipo de datos y qué representa.
Advertencia: No añadas macros de estado en línea en las páginas de CSS.
Descripción
Esta es una sección opcional para incluir una descripción de la propiedad y explicar cómo funciona. Usa esta sección para explicar términos relacionados y añadir casos de uso para la propiedad.
Definición formal
{{CSSInfo}}
Para usar esta macro, elimina las comillas invertidas y la barra invertida en el archivo markdown.
Sintaxis formal
{{CSSSyntax}}
Para usar esta macro, elimina las comillas invertidas y la barra invertida en el archivo markdown.
Accesibilidad
Esta es una sección opcional. Incluye pautas de accesibilidad, mejores prácticas y posibles preocupaciones que los desarrolladores deben tener en cuenta al usar esta propiedad. También puedes incluir alternativas o soluciones cuando corresponda.
Ejemplos
Ten en cuenta que usamos el plural "Ejemplos" incluso si la página solo contiene un ejemplo.
Añade un encabezado descriptivo
Cada ejemplo debe tener un encabezado H3 (###) que nombre el ejemplo. El encabezado debe ser descriptivo de 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.
Consulta nuestra guía sobre cómo añadir ejemplos de código para más información.
Nota: A veces querrás enlazar a ejemplos dados en otra página.
Escenario 1: Si tienes algunos ejemplos en esta página y algunos más en otra página:
Incluye 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 puedes enlazar a los ejemplos en otras páginas. Por ejemplo:
## 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:
No añadas encabezados H3; simplemente añade los enlaces directamente bajo el encabezado H2 "Ejemplos". Por ejemplo:
## Ejemplos
Para ver ejemplos de esta API, consulta [la página sobre fetch()](https://example.org/).
Especificaciones
{{Specifications}}
Para usar esta macro, elimina las comillas invertidas y la barra invertida en el archivo markdown.
Compatibilidad con navegadores
{{Compat}}
Para usar esta macro, elimina las comillas invertidas y la barra invertida en el archivo markdown.
Véase también
Incluye enlaces a páginas de referencia y guías relacionadas con la propiedad actual. Para más pautas, consulta la sección Véase también en la Guía de estilo de escritura.
- enlace1
- enlace2
- enlace_externo (año)