Módulo:Testes/Gkiyoshinishimoto/File link/doc

Este módulo é usado para construir ligações de texto wiki para arquivos. Ele é útil principalmente para predefinições e módulos que usam lógica complicada para fazer ligações de arquivos. Ligações de arquivos simples devem ser feitas diretamente com marcação de texto wiki, pois usa menos recursos do que chamar este módulo. Para obter ajuda com marcação de arquivo de texto wiki, consulte a documentação em mediawiki.org.

Uso a partir de texto wiki

A partir de texto wiki, este módulo deve ser chamado a partir de uma predefinição, geralmente {{Teste/Gkiyoshinishimoto/File link}}. Consulte a página da predefinição para obter a documentação. No entanto, também pode ser chamado usando a sintaxe {{#invoke:Testes/Gkiyoshinishimoto/File link|main|argumentos}}.

Uso a partir de Lua

Primeiro, você precisa importar o módulo.

local mFileLink = require('Módulo:Testes/Gkiyoshinishimoto/File link')

Então você pode fazer ligações de arquivos usando a função _main.

mFileLink._main(args)

args é uma tabela de argumentos que pode ter as seguintes chaves:

• file - o nome do arquivo. (necessário)
• format - o formato do arquivo, por exemplo, "thumb", "thumbnail", "frame", "framed", ou "frameless".
• formatfile - um nome de arquivo para especificar com a opção de formato "thumbnail". O nome de arquivo especificado será usado em vez da miniatura gerada automaticamente.
• border - defina como "true" ou "yes" (ou qualquer outro valor reconhecido como verdadeiro por Módulo:Testes/Gkiyoshinishimoto/Yesno) para definir uma borda para a imagem.
• location - o alinhamento horizontal do arquivo, por exemplo, "right", "left", "center", ou "none".
• alignment - o alinhamento vertical do arquivo, por exemplo, "baseline", "middle", "sub", "super", "text-top", "text-bottom", "top", ou "bottom".
• size - o tamanho da imagem, por exemplo, "100px", "x100px" ou "100x100px".
• upright - o parâmetro "upright", usado para definir o tamanho de imagens altas e finas.
• link - a página para a qual o arquivo deve estar vinculado. Use a sequência em branco '' para suprimir a ligação padrão para a página de descrição do arquivo.
• alt - o texto alternativo. Use a sequência em branco '' para suprimir o texto alternativo padrão.
• caption - uma legenda para o arquivo.
• page - define um número de página para arquivos com várias páginas, como os do Formato de documento portátil (F.D.P.).
• class - adiciona um parâmetro class às ligações de imagem. O software MediaWiki adiciona esse parâmetro ao atributo class="..." do elemento <img /> da imagem quando a página é renderizada em Linguagem de marcação de hipertexto (L.M.Ht.).
• lang - adiciona um atributo de linguagem para especificar em qual linguagem renderizar o arquivo.
• start - especifica um tempo de início para arquivos de áudio e vídeo.
• end - especifica um tempo de término para arquivos de áudio e vídeo.
• thumbtime - especifica o tempo a ser usado para gerar a imagem em miniatura para arquivos de vídeo.

Para ver o efeito de cada um desses parâmetros, consulte a página de ajuda de imagens em mediawiki.org.

Exemplos

Com o arquivo somente:

mFileLink.main{file = 'Example.png'}
-- Renderiza como [[Ficheiro:Example.png]]

Com as opções de formato, tamanho, ligação e legenda:

mFileLink.main{
	file = 'Example.png',
	format = 'thumb',
	size = '220px',
	link = 'Ajuda:Página de testes',
	caption = 'Um exemplo.'
}
-- Renderiza como [[Ficheiro:Example.png|thumb|220px|link=Ajuda:Página de testes|Um exemplo.]]

Com formato, tamanho e borda:

mFileLink.main{
	file = 'Example.png',
	format = 'frameless',
	size = '220px',
	border = true
}
-- Renderiza como [[Ficheiro:Example.png|frameless|border|220px]]