Docparam

¿Nombre?

¿Descripción?

[ver · editar · purgar]

Documentación de plantilla (para la plantilla mostrada arriba, a veces oculta o invisible)

Plantilla para el formato estandarizado de parámetros de plantillas en la documentación de plantillas.

Uso

{{Docparam|nombre=parámetro|req=sí|desc=descripción}}

Parámetros

<sin nombre 1> o nombre

Nombre del o los parámetros. Ciertas cadenas se traducen automáticamente para permitir la especificación de opciones alternativas o rangos de parámetros.

Cadenas traducidas (todas ellas deben estar encerradas por espacios):

• >> se convierte en un guión con espacios alrededor de él (" - "); Utilizado para indicar intervalos de parámetros (por ejemplo, "juego1 - juego4").
• // se convierte en "o"; Se utiliza para opciones alternativas (por ejemplo, "<sin nombre 1> o título").
• ++ se convierte en una coma con un espacio al final (", "); Utilizado para enumerar los parámetros que están separados pero funcionan igual (por ejemplo, "contenidoA1, contenidoB1").

default, default2

El valor predeterminado del parámetro.

desc

Descripción del parámetro.

(por defecto: "sí")

req

Especifica si este parámetro es necesario para que funcione la plantilla.

Opciones Disponibles:

• no: Completamente opcional.
• semi: El parámetro es necesario en ciertas circunstancias pero es opcional en otras.
• sí: Siempre es requerido.

Ejemplos

Simple

{{Docparam|nombre=parámetro|req=sí|default=|desc=
Descripción
}}

resulta en:

parámetro

Descripción

Avanzado

{{Docparam|nombre=parámetro // alternativo ++ similar1 >> similar3|req=no|default=configuración predeterminada|desc=
Descripción
}}

resulta en:

(por defecto: "configuración predeterminada")

parámetro o alternativo, similar1 hasta similar3

Descripción

Copiar/pegar

{{Docparam|nombre=|req=|default=|desc=

}}

Documentación transcludida de Plantilla:Docparam/doc.