Module:Ficha/doc

Uso
Este módulo permite crear fichas específicas como, por ejemplo, las o la.

Para ello, el módulo puede llamarse desde una ficha que utilice la plantilla, la cual llama a este módulo, por ejemplo:

, la cual a su vez hace:

o que llame a otro módulo Lua, por ejemplo, el módulo:ficha de persona que llame a su vez a este módulo. Para ello en la ficha de persona:

Después en el módulo correspondiente hay que escribir algo de la forma:

Parámetros
Lo que sigue es una descripción de los parámetros utilizados cuando se llama al módulo directamente desde otro módulo utilizando las ventajas que dan las tablas de Lua. Para los parámetros cuando se llama al módulo desde una plantilla que utiliza la plantilla de Ficha véase.

Título y subtítulos
Se recomienda siempre establecer título a la ficha. También se pueden establecer subtítulos a la ficha.
 *  : Título que aparecerá en la cabecera.
 *  : Subtítulos de la ficha.
 *  : Fila de la parte superior.


 * Configuración
 *  : Color del fondo de la cabecera.
 *  : Color del texto de la cabecera.
 *  : Tipo de imagen que aparecerá de fondo en la cabecera.

Imágenes
Todas las imágenes son centradas de manera predeterminada. Solo debe especificarse el nombre de las imágenes. Por ejemplo: « example.png ». Si el valor no coincide con una imagen existente por ejemplo si se emplea una plantilla se mostrará solo el valor literal.
 *  : Imágenes de la ficha. Tiene número ilimitado y se comprueba si la imagen existe y de lo contrario devuelve el valor literal (pensado para se puedan usar plantillas).
 *  / : Aprecerán una junto a la otra centrado el conjunto de ambas si se dan las dos o centrada una sola imagen si se da solo una.
 *  : Imagen que apaecerá al pie de la ficha.


 * Todos tiene los siguiente parámetros adicionales:
 *  : Tamaño de imagen. (si se pone número solo afectará a esa imagen)
 *  : Tamaño de la imagen izquierda.
 *  : Tamaño de la imagen derecha.
 *  : Tamaño de la imagen de pie de tabla.
 *  : Pie de imagen (si se pone número solo afectará a esa imagen).
 *  : Pie de la imagen derecha.
 *  : Pie de la imagen izquierda. (si se pone número solo afectará a esa imagen)
 *  : Pie de la imagen de pie de tabla.

Estilos CSS
Estos parámetros son usados para agregar código CSS en el atributo «style» de los elementos de la plantilla; son los que permiten cambiar la apariencia de estos elementos. Por lo tanto, deberán ser usados con sutileza para mantener un aspecto general estético y atractivo.
 *  : Clase (class) de toda la ficha.
 *  : Estilo de toda la ficha
 *  : Clase de todas las filas
 *  : Clase de la cabecera. Establece la imagen de la cabecera. Para usar cabecera mediana añadir.

Filas
Para añadir una fila basta añadir una tabla de la forma:

donde el primer parámetro es la etiqueta y el segundo parámetro son los datos. La fila solo se mostrará si está informado el parámetro para los datos. Por ejemplo:

Secciones
Para incluir una sección basta incluir una tabla Lua del tipo "sección":

donde:
 *  : título de la sección. La sección solo se mostrará si alguna de las filas se muestra no debiendo a diferencia de lo que ocurre cuando se utiliza la plantilla Ficha de validarlo espresamente.
 *  : estilo CSS del título de la sección

Sucesiones
Para añadir una sucesión habrá que añadir una table del tipo "sucesión":

La lista completa de los parámetros son:

Otros campos

 *  : Pie de la ficha. Generalmente este espacio se reserva para notas.
 *  : Nombre de la plantilla que enlazará en la barra de navegación.

Ejemplo
debería producir: