Módulo:LigazónFicheiro/uso

Este módulo emprégase para construír ligazóns wiki cara a ficheiros. Resulta principalmente útil para modelos e outros módulos que usan unha lóxica complexa para facer ligazóns a ficheiros. As ligazóns sinxelas a ficheiros deben facerse directamente con texto wiki para aforrar a chamada a este módulo.

Dende o texto wiki, este módulo debe chamarse dende un modelo. A sintaxe é: {{#invoke:LigazónFicheiro|main|argumentos}}.

Primeiro hai que importar o módulo:

local mLigaFicheiro = require('Módulo:LigazónFicheiro')

Despois pódense facer as ligazóns a ficheiros usando a función _main

mLigaFicheiro._main(argumentos)

argumentos é unha táboa de argumentos que pode conter as seguintes chaves:

• file - Nome do ficheiro. (requirido)
• format - Formato do ficheiro, por exemplo 'miniatura', 'thumbnail', 'frame', 'framed', ou 'frameless'.
• formatfile - Nome de ficheiro a especificar coa opción de formato 'thumbnail'.
• border - Cando se lle asigna o valor "si" engade un bordo á imaxe.
• location - Aliñamento orizontal do ficheiro, por exemplo 'dereita', 'esquerda', 'centro', ou 'none'.
• alignment - Aliñamento vertical do ficheiro, por exemplo 'baseline', 'middle', 'sub', 'super', 'text-top', 'text-bottom', 'top', ou 'bottom'.
• size - Tamaño do ficheiro, por exemplo '100px', 'x100px' ou '100x100px'.
• upright - Para definir o tamaño de imaxes altas e estreitas.
• link - Páxina coa que vail ligar o ficheiro. Usa unha cadea en branco para que non se amose esta ligazón.
• alt - Texto alternativo da imaxe. Usa unha cadea en branco para que non se amose este texto.
• caption - Pé da imaxe.
• page - Número de páxina para ficheiros con máis dunha páxina, coma PDFs.
• class - Engade un parámetro class a ligazón da imaxe. O software MediaWiki engade este parámetro ao atributo class="..." do elemento de imaxe <img /> ao renderizar a páxina en HTML.
• lang - Engade un atributo de lingua para especificar en que lingua renderizar a imaxe.
• start - Especifica un tempo de comezo para os ficheiros de son e vídeo.
• end - Especifica un tempo de fin para os ficheiros de son e vídeo.
• thumbtime - Especifica o tempo para xerar a vista en miniaura nos ficheiros de vídeo.

Só co ficheiro

mLigaFicheiro.main{file = 'Exemplo.png'}
-- Da o resultado [[Ficheiro:Exemplo.png]]

Con formato, tamaño, ligazón e texto

mLigaFicheiro.main{
	file = 'Exemplo.png',
	format = 'miniatura',
	size = '220px',
	link = 'Wikipedia:Axuda',
	caption = 'Un exemplo.'
}
-- Da o resultado [[Ficheiro:Exemplo.png|miniatura|220px|link=Wikipedia:Axuda|Un exemplo.]]

Con formato, tamaño e bordo

mLigaFicheiro.main{
	file = 'Exemplo.png',
	format = 'frameless',
	size = '220px',
	border = true
}
-- Da o resultado [[Ficheiro:Exemplo.png|frameless|border|220px]]