Módulo:Su/doc

Esta é uma subpágina de documentação para o Módulo:Su.
Ela contém informações sobre o seu uso, categorias, bem como todo o conteúdo que não faz parte do módulo original.

Descrição

Este módulo implementa a predefinição {{su}}. Ela é utilizada para criar duas linhas mais pequenas de texto em uma linha atual.

Utilização desde texto wiki

Este módulo não pode ser usado diretamente de texto wiki. Apenas pode ser utilizada através de uma predefinição, que é normalmente a predefinição {{su}}. Por favor consulte a página de documentação da predefinição.

Utilização desde módulos Lua

Para utilizar este módulo desde outros módulos Lua, primeiro carregue o módulo.

local mSu = require('Módulo:Su')

Voçê pode gerar as ligações su ao utilizar a função _main.

mSu._main(sup, sub, options)

sup é o conteúdo do topo da linha, e sub é o conteúdo inferior da linha. options é uma tabela que tem os seguintes campos:

align - este pode definir-se "r" ou "right" para alinhamento à direita, e "c" ou "center" para centrar. Qualquer outro valor mostra-se alinhado à esquerda. Ele deve ser um valor de cadeia de texto.
fontSize - o tamanho ou largura da fonte do texto, e.g. "90%". Se está definido para "f" ou "fixed", o módulo mostra o texto com fonte de largura fixa de 85%. Valor tem que ser texto.
lineHeight - a distância do topo até fundo (incluindo caractere no topo). Valor padrão é 1.2em. Valor tem que ser texto.
verticalAlign - o alinhamento base da parte inferior. Valor padrão depende se existe sub; -0.4em se estiver definido, 0.8em se não estiver definido. Valor tem que ser texto.

Todos os argumentos são opcionais.

Exemplos

Code	Resultado
`mSu._main('texto linha-cima', 'texto linha-inferior')`	texto linha-cima texto linha-inferior
`mSu._main('texto linha-cima', 'texto linha-inferior', {fontSize = '100%'})`	texto linha-cima texto linha-inferior
`mSu._main('texto linha-cima', 'texto linha-inferior', {fontSize = 'f'})`	texto linha-cima texto linha-inferior
`mSu._main('texto linha-cima', 'texto linha-inferior', {align = 'r'})`	texto linha-cima texto linha-inferior
`mSu._main('texto linha-cima', 'texto linha-inferior', {align = 'c'})`	texto linha-cima texto linha-inferior
`mSu._main('12', '8', {align = 'c', lineHeight = '0.8em'})`	12 8
`mSu._main('texto linha-cima')`	texto linha-cima
`mSu._main(nil, 'texto linha-inferior')`	texto linha-inferior