Módulo:Ficha/doc

Uso

Este módulo permite crear fichas específicas como, por ejemplo, las {{ficha de persona}} o la {{ficha de embalse}}.

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

{{Ficha |titulo = }}

, la cual a su vez hace: {{#invoke:Ficha|infobox}}

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: {{#invoke:Ficha de persona|Ficha}}

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

 
local z = {}

-- Módulos y funciones externas
local moduloArgumentos = require('Módulo:Argumentos')
local moduloFicha      = require('Módulo:Ficha')

function z.Ficha(frame)
    --Obtener una copia de los argumentos eliminando los argumentos sin valor
    local args = moduloArgumentos.obtenerArgumentosConValor(frame)

    local fichaXXX = {
        titulo          = args.titulo,
        resto de parámetros
        ...
    }
    return moduloFicha.infobox(fichaXXX)
end

return z

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 {{ficha}}.

Título y subtítulos

Se recomienda siempre establecer título a la ficha. También se pueden establecer subtítulos a la ficha.

• titulo: Título que aparecerá en la cabecera.
• subtitulo<número>: Subtítulos de la ficha.
• arriba: Fila de la parte superior.

Configuración

• colorfondo: Color del fondo de la cabecera.
• colortexto: Color del texto de la cabecera.
• tipocabecera: 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.

• imagen<número>: 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).
• imagenizquierda/imagenderecha: 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.
• imageninferior: Imagen que apaecerá al pie de la ficha.

Todos tiene los siguiente parámetros adicionales

• tamañoimagen<numero>: Tamaño de imagen. (si se pone número solo afectará a esa imagen)
• tamañoimagenizquierda: Tamaño de la imagen izquierda.
• tamañoimagenderecha: Tamaño de la imagen derecha.
• tamañoimageninferior: Tamaño de la imagen de pie de tabla.
• pie<número>: Pie de imagen (si se pone número solo afectará a esa imagen).
• piederecho: Pie de la imagen derecha.
• pieizquierdo: Pie de la imagen izquierda. (si se pone número solo afectará a esa imagen)
• pieimageninferior: 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: Clase (class) de toda la ficha.
• estilo: Estilo de toda la ficha
• clasefila: Clase de todas las filas
• clasetitulo: Clase de la cabecera. Establece la imagen de la cabecera. Para usar cabecera mediana añadir Media=si.
• estilotitulo:
• clasesubtitulo<número>
• estilosubtitulo<número>
• claseimagen
• estiloimagen

Filas

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

 
{..., ..., estiloetiqueta=..., estilodatos=..., clase=..., clasefila=...},

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:

 
{'Residencia', arg['residencia'], estiloetiqueta='width:33%;', clase='plainlist'},

Secciones

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

 
{tipo='sección', titulo=..., estilotitulo=..., lista de filas separadas por coma},

donde:

• titulo: 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.
• estilotitulo: 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":

 
{tipo='sucesión', anterior=..., ...},

La lista completa de los parámetros son:

• anterior:
• actual:
• siguiente:
• año anterior:
• año:
• año siguiente:
• estilo fuente:
• color:

Otros campos

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

Ejemplo

local z = {}

-- Módulos y funciones externas
local moduloArgumentos = require('Módulo:Argumentos')
local moduloFicha      = require('Módulo:Ficha')

function z.Ficha(frame)
    --Obtener una copia de los argumentos eliminando los argumentos sin valor
    local args = moduloArgumentos.obtenerArgumentosConValor(frame)

    local fichaEjemplo = {
        titulo           = 'Título de prueba',
        estilo           = 'background-color:#e0ffff; width:20em;',
        tipocabecera     = 'comunicación',
        colorfondotitulo = '#ff0000',
        estiloetiqueta   = 'width:33%;',
        {'Etiqueta1', 'Datos1'},
        {'Etiqueta2', 'Datos2'},
        {'', 'Datos3'},
        {tipo='sección', 
        	titulo='Sección de prueba',
        	{'Etiqueta4', 'Datos4'},
        },
        {tipo='sección', 
        	titulo       = 'Cronología de [[J. R. R. Tolkien]]',
        	estilotitulo = 'background-color:#ff0000;',
        	{tipo='sucesión',
				['anterior']      = '[[Egidio, el granjero de Ham]]',
        		['año anterior']  = '1949',
        		['actual']        = '[[El Señor de los Anillos]]',
        		['año']           = '1954',
        		['siguiente']     = '[[Las aventuras de Tom Bombadil y otros poemas de El Libro Rojo]]',
        		['año siguiente'] = '1962',
        		['estilo fuente'] = 'italic',
        	},
        },        
        piedetabla = 'Pie de tabla',
    }
    return moduloFicha.infobox(fichaEjemplo)
end

return z

debería producir:

Título de prueba
Etiqueta 1	Datos 1
Etiqueta 2	Datos 2
Datos 3
Sección de prueba
Etiqueta 4	Datos 4
Cronología de J. R. R. Tolkien Egidio, el granjero de Ham (1949) El Señor de los Anillos (1954) Las aventuras de Tom Bombadil y otros poemas de El Libro Rojo (1962)
Pie de tabla