Plantilla:dsc tclass

Esta es una de la familia de plantillas utilizadas para la creación de una lista de descripción. Estas plantillas deben usarse para diseñar listas de funciones, variables o tipos.

{{dsc begin}}

inicia la lista de descripción

{{dsc end}}

finaliza la lista de descripción

{{dsc h1| encabezado}}

agrega encabezado a la lista de descripción (nivel h3)

{{dsc h2| encabezado}}

agrega un subencabezado a la lista de descripción (nivel h5)

{{dsc header}}

agrega una explicación de qué encabezado provienen las características

{{dsc namespace}}

agrega una explicación en qué espacio de nombres se encuentran las características

{{dsc sep}}

agrega un separador

{{dsc| nombre| explicación}}

agrega un elemento genérico a la lista de descripción. Si se omite la explicación, el elemento abarca ambas columnas.

{{dsc hitem| nombre| explicación}}

agrega un elemento resaltado a la lista de descripción. Si se omite la explicación, el elemento abarca ambas columnas.

{{dsc inc| ubicación| param1 (opcional)| param2 (opcional) ...}}

Establece dsc-list-template-name variable en ubicación, incluye la plantilla de ubicación y desestablece la variable. Utiliza esta plantilla siempre que copies elementos dsc de una plantilla; esto les agregará un enlace de edición. Los parámetros sin nombre param1, param2, ... se pasan a la plantilla.

{{dsc break}}

rompe las columnas. El ancho de las columnas de arriba no depende del contenido de abajo y viceversa.

{{dsc todo| razón}}

agrega una tarea pendiente (similar a {{todo}})

Plantillas especializadas

Ya existen plantillas especializadas para la mayoría de los casos de uso.

Clases

{{dsc class| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una clase.

{{dsc tclass| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una plantilla de clase.

{{dsc talias| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una plantilla de alias.

{{dsc ptclass| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una especialización de plantilla de clase.

{{dsc mem class| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una clase miembro.

Funciones

{{dsc fun| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una función.

{{dsc tfun| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una plantilla de función.

{{dsc mem fun| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una función miembro pública.

{{dsc prot mem fun| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una función miembro protegida.

{{dsc mem ctor| link| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un constructor público.

{{dsc prot mem ctor| link| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un constructor protegido.

{{dsc mem dtor| link| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un destructor público.

{{dsc prot mem dtor| link| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un destructor protegido.

{{dsc mem vdtor| link| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un destructor público virtual.

{{dsc prot mem vdtor| link| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un destructor protegido virtual.

{{dsc mem sfun| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una función miembro estática.

{{dsc mem vfun| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una plantilla de función miembro pública virtual.

{{dsc prot mem vfun| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una plantilla de función miembro protegida virtual.

{{dsc macro fun| link| title=link title(opcional)| notes=link notes(opcional)| explanation}} - agrega un elemento que enlaza a una descripción de una macro de función.

Constantes

{{dsc macro const| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una constante de macro.

{{dsc const| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una variable global constante.

{{dsc mem const| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una variable miembro constante.

{{dsc mem sconst| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una variable miembro constante estática.

Objetos

{{dsc mem obj| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un objeto miembro.

{{dsc prot mem obj| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un objeto miembro protegido.

{{dsc priv mem obj| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un objeto miembro privado.

Misceláneos

{{dsc typedef| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una definición de tipo.

{{dsc enum| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una enumeración o clase enumeración.

{{dsc concept| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un concepto.

{{dsc named req| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de un requerimiento denominado.

{{dsc macro opr| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una macro de operador.

{{dsc macro keyword| link| title=link title(opcional)| notes=link notes(opcional)| explanation}}

agrega un elemento que enlaza a una descripción de una macro de palabra clave.

Parámetros

link

este parámetro controla el destino del enlace.

title=link title

este parámetro anula el título del enlace

notes=link notes

este parámetro agrega texto además del enlace que no es parte del enlace

explanation

la explicación de la característica.

Todas las plantillas aceptan el parámetro nolink=true. En ese caso no se realiza ningún enlace, el formato es el mismo.

Las plantillas para objetos miembro aceptan el parámetro inlinemem=true. Esto debe usarse si la funcionalidad se describe en línea en la página de la clase.

Véase también las plantillas

Usado en las listas véase también.

{{dsc see cpp| location| nomono=true_if_serif (opcional)| title1(opcional)| title2(opcional) ...}}

agrega un enlace a la documentación C++ de una característica.

{{dsc see c| location| nomono=true_if_serif (opcional)| title1(opcional)| title2(opcional) ...}}

agrega un enlace a la documentación C de una característica.

Parámetros

location

este parámetro controla el destino del enlace.

nomono

true si se debe utilizar fuente serif para el título

title1, title2, ...

este parámetro anula el título (por defecto, el título se adivina a partir de ubicación). Se colocan comas entre los títulos si se proporcionan varios de ellos.

Ejemplo

 
  {{dsc begin}}
  {{dsc h1 | Criaturas mágicas}}
  {{dsc h2 | Dragón}}
  {{dsc header | dragon.h}}
  {{dsc fun | cpp/dragon/call_dragon | Llama al dragón.}}
  {{dsc fun | cpp/dragon/receive_fire | Recibe fuego.}}
  {{dsc end}}
  

Lo anterior resulta en lo siguiente:

Plantillas utilizadas en la implementación

{{dsc member}}

{{dsc member| page| title (opcional)| nolink=true_if_nolink (opcional)| nobold=true_if_nobold (opcional)| notes=notes (opcional)}}

El título por defecto del enlace es page. El título personalizado se puede proporcionar mediante el segundo parámetro sin nombre o el parámetro title. Si nolink es "true", no se produce ningún enlace.

La fuente predeterminada del enlace es negrita monoespaciada. Si nobold es "true", la fuente es serif normal.

Las notas adicionales que se colocarán a la derecha del enlace se pueden pasar a través del parámetro notes.

Tanto title como notes puede aceptar etiquetas <br> sin romper la distribución.

{{dsc mark mem}}

{{dsc mark mem| link| mark_class| nomem=true_if_nomem (opcional)| inlinemem=true_if_inlinemem (opcional)}}

Genera {{mark mark_class}} potencialmente agregando una descripción adicional de la clase de la que es miembro la función o clase.

Específicamente, la plantilla verifica si el padre de la página vinculada por link es el padre de la página en la que se utiliza la plantilla (es decir, son hermanos). Por ejemplo, considera link = a/b/c y page la página en la que se utiliza la plantilla. Entonces la plantilla agregaría la descripción adicional si page es igual a z/z/z, o a/z, o a/b/z/z, pero no si página es a/b/z o a/b.

Si nomem es "true", nunca se agrega una descripción adicional.

La plantilla obtiene información sobre el nombre de la clase padre de la página a/b/title.

Si inlinemem es "true", entonces el nombre de la clase principal se obtiene de la plantilla "a/b/c/title". Esto se utiliza cuando una clase incluye descripciones de sus miembros en línea.

{{dsc editlink}}

{{dsc editlink}}

Genera un texto [edit] con un enlace que apunta a una página para editar la plantilla cuyo nombre está definido en la variable dsc-list-template-name. Se debe pasar al menos un parámetro ficticio a esta plantilla, ya que el software Mediawiki emplea algunas optimizaciones que interrumpen la implementación.