Diferencia entre revisiones de «Módulo:Ficha/doc»

De Hispanopedia
imported>Rosarino
Sin resumen de edición
imported>Juan Mayordomo
Explico cómo llamarse desde un módulo Lua
Línea 1: Línea 1:
=== Uso ===
=== Uso ===
Este módulo es para crear una ficha genérica para ser usado por otros módulos o plantillas para crear fichas específica.
Este módulo permite crear fichas específicas como, por ejemplo, las {{ep|ficha de persona}} o la {{ep|ficha de embalse}}.
Los argumentos de este módulo está traducidos al español con los mismos nombres que en la [[plantilla:Ficha]] de forma que pueden usarse directamente como párametros.
 
Para ello, el módulo puede llamarse desde una ficha que utilice la plantilla {{ep|ficha}}, la cual llama a este módulo, por ejemplo:
:<code><nowiki>{{Ficha
|titulo          =
}}
</nowiki></code>
 
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:
<code><nowiki>{{#invoke:Ficha de persona|Ficha}}</nowiki></code>
 
Después en el módulo correspondiente hay que escribir algo de la forma:
<syntaxhighlight lang="Lua">
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
</syntaxhighlight>


Para invocarlo en plantillas <code><nowiki>{{#invoke:Ficha|Infovox}}</nowiki></code>
=== Parámetros ===
=== Parámetros ===
'''Notas:'''  
'''Notas:'''  

Revisión del 19:38 15 oct 2017

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 = }}

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

Notas:

  • Los parámetros que incluyan <número>, indican que se debe escribir al final del parámetro un número del 1 al ∞. Por ejemplo, el código «|estilosección65 = font-style: italic;» establecería el estilo de fuente de la sección 65 en cursiva.
  • Si se define una sección, no se debe usar el mismo número de la sección en los campos de etiquetas o datos, si se hace, no se mostrará el contenido de estos campos.


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<número>: Sin número clase de todas las filas, con número clase de esa fila.
  • 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
  • estiloetiqueta<número>
  • estilodatos<número>

Campos

Una fila con una etiqueta pero sin un campo de datos no se muestra. Esto facilita la creación de filas opcionales. Para hacer una fila opcional se tiene que incluir un parámetro que predetermine el contenido de esta a una cadena vacía:

  • datosup<número>: Filas que aparecerán entre Imagenizquierda/derecha e imagen.
  • seccion<número>
  • etiqueta<número>
  • datos<número>

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.