Documentação do módulo[ver] [editar] [histórico] [purgar]

Este módulo gera vários tipos de listas. Atualmente, ele suporta listas com marcadores, listas sem marcadores, listas horizontais, listas ordenadas (numeradas ou alfabéticas) e listas ordenadas horizontais. Ele permite um estilo de CSS fácil de lista ou de itens individuais da lista.

Uso editar

Uso rápido editar

{{#invoke:Lista/Testes|função|primeiro item|segundo item|terceiro item|...}}

Todos os parâmetros editar

{{#invoke:Lista/Testes|função
|primeiro item|segundo item|terceiro item|...
|start           = número inicial para listas ordenadas
|type            = tipo de numeração para listas ordenadas
|list_style_type = tipo de marcador para listas ordenadas (usa CSS)
|class           = classe
|style           = style
|list_style      = estilo para a lista
|item_style      = estilo para todos os itens da lista
|item1_style     = estilo para o primeiro item da lista |item2_style = estilo para o segundo item da lista |...
|item1_value     = valor para o primeiro item da lista |item2_value = valor para o segundo item da lista |...
|indent          = indentação para listas horizontais
}}

Argumentos passados a partir da predefinição parental editar

{{#invoke:Lista/Testes|função}}

Funções editar

Nome da função Produz Exemplo de saída Predefinição usando a função
bulleted Listas com marcadores
  • Primeiro item
  • Segundo item
  • Terceiro item
{{Lista com marcas/Testes}}
unbulleted Listas sem marcadores
  • Primeiro item
  • Segundo item
  • Terceiro item
{{Lista sem marcas/Testes}}
horizontal Listas com marcadores horizontais
  • Primeiro item
  • Segundo item
  • Terceiro item
{{Hlist/Testes}}
ordered Listas ordenadas (listas numeradas e listas alfabéticas)
  1. Primeiro item
  2. Segundo item
  3. Terceiro item
{{Lista ordenada/Testes}}
horizontal_ordered Listas ordenadas horizontais
  1. Primeiro item
  2. Segundo item
  3. Terceiro item
{{Lista ordenada horizontal/Testes}}

Parâmetros editar

  • Parâmetros posicionais (1, 2, 3...) – estes são os itens da lista. Se nenhum item da lista estiver presente, o módulo não produzirá nada.
  • start – define o item inicial para listas ordenadas. Pode ser um número inicial para listas numeradas ou uma letra inicial para listas alfabéticas. Listas ordenadas horizontais suportam apenas números.
  • type – o tipo de marcador usado em listas ordenadas. Os valores possíveis são "1" para números (o padrão), "A" para letras maiúsculas, "a" para letras minúsculas, "I" para algarismos romanos maiúsculos e "i" para algarismos romanos minúsculos. Não suportado em listas ordenadas horizontais. Veja também o parâmetro list_style_type.
  • list_style_type – o tipo de marcador usado em listas ordenadas. Isso usa estilo de CSS e tem mais tipos disponíveis do que o parâmetro type, que usa um atributo de HTML [en]. Os valores possíveis estão listados na página de tipo de estilo de lista da MDN (em inglês). O suporte pode variar de acordo com o navegador. list-style-type é um nome alternativo para este parâmetro.
  • class – uma classe personalizada para as marcações <div>...</div> ao redor da lista, plainlinkspor exemplo.
  • style – um estilo de CSS personalizado para as marcações <div>...</div> ao redor da lista, por exemplo font-size: 90%;.
  • list_style – um estilo de CSS personalizado para a própria lista. O formato é o mesmo do parâmetro |style=.
  • item_style – um estilo de CSS personalizado para todos os itens da lista (as marcações <li>...</li>). O formato é o mesmo do parâmetro |style=.
  • item1_style, item2_style, item3_style... – estilos de CSS personalizados para cada um dos itens da lista. O formato é o mesmo do parâmetro |style=.
  • item1_value, item2_value, item3_value... – valor personalizado para o item de lista fornecido. Os itens da lista após aquele fornecido serão incrementados a partir do valor especificado. O valor deve ser um número inteiro positivo. (Observe que esta opção só tem efeito em listas ordenadas.)
  • indent – este parâmetro indenta a lista, apenas para listas ordenadas horizontais e horizontais. O valor deve ser um número, por exemplo, 2. A indentação é calculada em em e é 1,6 vezes o valor especificado. Se nenhuma indentação for especificada, o padrão será zero.

Exemplos editar

Listas com marcadores editar

Código Resultado
{{#invoke:Lista/Testes|bulleted|Primeiro item|Segundo item|Terceiro item}}
  • Primeiro item
  • Segundo item
  • Terceiro item
{{#invoke:Lista/Testes|bulleted|Primeiro item|Segundo item|Terceiro item|item_style=color:blue;}}
  • Primeiro item
  • Segundo item
  • Terceiro item
{{#invoke:Lista/Testes|bulleted|Primeiro item|Segundo item|Terceiro item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
  • Primeiro item
  • Segundo item
  • Terceiro item

Listas sem marcadores editar

Código Resultado
{{#invoke:Lista/Testes|unbulleted|Primeiro item|Segundo item|Terceiro item}}
  • Primeiro item
  • Segundo item
  • Terceiro item
{{#invoke:Lista/Testes|unbulleted|Primeiro item|Segundo item|Terceiro item|item_style=color:blue;}}
  • Primeiro item
  • Segundo item
  • Terceiro item
{{#invoke:Lista/Testes|unbulleted|Primeiro item|Segundo item|Terceiro item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
  • Primeiro item
  • Segundo item
  • Terceiro item

Listas horizontais editar

Código Resultado
{{#invoke:Lista/Testes|horizontal|Primeiro item|Segundo item|Terceiro item}}
  • Primeiro item
  • Segundo item
  • Terceiro item
{{#invoke:Lista/Testes|horizontal|Primeiro item|Segundo item|Terceiro item|indent=2}}
  • Primeiro item
  • Segundo item
  • Terceiro item

Listas ordenadas editar

Código Resultado
{{#invoke:Lista/Testes|ordered|Primeiro item|Segundo item|Terceiro item}}
  1. Primeiro item
  2. Segundo item
  3. Terceiro item
{{#invoke:Lista/Testes|ordered|Primeiro item|Segundo item|Terceiro item|start=3}}
  1. Primeiro item
  2. Segundo item
  3. Terceiro item
Minúsculas dos algarismos romanos: {{#invoke:Lista/Testes|ordered|Primeiro item|Segundo item|Terceiro item|type=i}}
  1. Primeiro item
  2. Segundo item
  3. Terceiro item
Letras minúsculas do alfabeto grego: {{#invoke:Lista/Testes|ordered|Primeiro item|Segundo item|Terceiro item|list_style_type=lower-greek}}
  1. Primeiro item
  2. Segundo item
  3. Terceiro item

Listas ordenadas horizontais editar

Código Resultado
{{#invoke:Lista/Testes|horizontal_ordered|Primeiro item|Segundo item|Terceiro item}}
  1. Primeiro item
  2. Segundo item
  3. Terceiro item
{{#invoke:Lista/Testes|horizontal_ordered|Primeiro item|Segundo item|Terceiro item|start=3}}
  1. Primeiro item
  2. Segundo item
  3. Terceiro item
{{#invoke:Lista/Testes|horizontal_ordered|Primeiro item|Segundo item|Terceiro item|indent=2}}
  1. Primeiro item
  2. Segundo item
  3. Terceiro item

Categoria de rastreamento/manutenção editar

Ver também editar

local libUtil = require('libraryUtil')
local checkType = libUtil.checkType
local mTableTools = require('Módulo:TableTools/Testes')

local p = {}

local listTypes = {
	['bulleted'] = true,
	['unbulleted'] = true,
	['horizontal'] = true,
	['ordered'] = true,
	['horizontal_ordered'] = true
}

function p.makeListData(listType, args)
	-- Constrói uma tabela de dados para ser passada para p.renderList.
	local data = {}

	-- Classes e TemplateStyles
	data.classes = {}
	data.templatestyles = ''
	if listType == 'horizontal' or listType == 'horizontal_ordered' then
		table.insert(data.classes, 'hlist')
		data.templatestyles = mw.getCurrentFrame():extensionTag{
			name = 'templatestyles', args = { src = 'Hlist/Testes/styles.css' }
		}
	elseif listType == 'unbulleted' then
		table.insert(data.classes, 'plainlist')
		data.templatestyles = mw.getCurrentFrame():extensionTag{
			name = 'templatestyles', args = { src = 'Lista simples/Testes/styles.css' }
		}
	end
	table.insert(data.classes, args.class)

	-- Estilo div principal
	data.style = args.style

	-- Indentação para listas horizontais
	if listType == 'horizontal' or listType == 'horizontal_ordered' then
		local indent = tonumber(args.indent)
		indent = indent and indent * 1.6 or 0
		if indent > 0 then
			data.marginLeft = indent .. 'em'
		end
	end
	
	-- Tipos de estilo de lista para listas ordenadas.
	-- Isto pode ser "1, 2, 3", "a, b, c" ou vários outros. O tipo de estilo de 
	-- lista é definido pelo atributo "type" ou pela propriedade de CSS
	-- "list-style-type".
	if listType == 'ordered' or listType == 'horizontal_ordered' then 
		data.listStyleType = args.list_style_type or args['list-style-type']
		data.type = args['type']

		-- Detecta atributos de tipo inválidos e tenta convertê-los em
		-- propriedades de CSS de list-style-type.
		if data.type 
			and not data.listStyleType
			and not tostring(data.type):find('^%s*[1AaIi]%s*$')
		then
			data.listStyleType = data.type
			data.type = nil
		end
	end
	
	-- Tipo de tag de lista
	if listType == 'ordered' or listType == 'horizontal_ordered' then
		data.listTag = 'ol'
	else
		data.listTag = 'ul'
	end

	-- Número inicial para listas ordenadas
	data.start = args.start
	if listType == 'horizontal_ordered' then
		-- Aplica correção para fazer com que os números iniciais funcionem com
		-- listas ordenadas horizontais.
		local startNum = tonumber(data.start)
		if startNum then
			data.counterReset = 'listitem ' .. tostring(startNum - 1)
		end
	end

	-- Estilo de lista 
	 -- ul_style e ol_style estão incluídos para compatibilidade com versões 
	 -- anteriores. Nenhuma distinção é feita para listas que são ordenadas ou 
	 -- que não são ordenadas.
	data.listStyle = args.list_style

	-- Lista de itens
	-- li_style está incluído para compatibilidade com versões anteriores.
	-- item_style foi incluído para ser mais fácil de entender para os que não
	-- são programadores.
	data.itemStyle = args.item_style or args.li_style
	data.items = {}
	for _, num in ipairs(mTableTools.numKeys(args)) do
		local item = {}
		item.content = args[num]
		item.style = args['item' .. tostring(num) .. '_style']
			or args['item_style' .. tostring(num)]
		item.value = args['item' .. tostring(num) .. '_value']
			or args['item_value' .. tostring(num)]
		table.insert(data.items, item)
	end
	
	return data
end

function p.renderList(data)
	-- Renderiza a lista em HTML.
	
	-- Retorna a sequência (string) em branco se não houver itens na lista.
	if type(data.items) ~= 'table' or #data.items < 1 then
		return ''
	end
	
	-- Renderiza a tag div principal.
	local root = mw.html.create('div')
	for _, class in ipairs(data.classes or {}) do
		root:addClass(class)
	end
	root:css{['margin-left'] = data.marginLeft}
	if data.style then
		root:cssText(data.style)
	end

	-- Renderiza a tag da lista.
	local list = root:tag(data.listTag or 'ul')
	list
		:attr{start = data.start, type = data.type}
		:css{
			['counter-reset'] = data.counterReset,
			['list-style-type'] = data.listStyleType
		}
	if data.listStyle then
		list:cssText(data.listStyle)
	end

	-- Renderiza os itens da lista
	for _, t in ipairs(data.items or {}) do
		local item = list:tag('li')
		if data.itemStyle then
			item:cssText(data.itemStyle)
		end
		if t.style then
			item:cssText(t.style)
		end
		item
			:attr{value = t.value}
			:wikitext(t.content)
	end

	return data.templatestyles .. tostring(root)
end

function p.renderTrackingCategories(args)
	local isDeprecated = false -- Rastreia parâmetros obsoletos.
	for k, v in pairs(args) do
		k = tostring(k)
		if k:find('^item_style%d+$') or k:find('^item_value%d+$') then
			isDeprecated = true
			break
		end
	end
	local ret = ''
	if isDeprecated then
		ret = ret .. '[[Categoria:!Predefinições de lista com parâmetros obsoletos]]'
	end
	return ret
end

function p.makeList(listType, args)
	if not listType or not listTypes[listType] then
		error(string.format(
			"argumento incorreto #1 para 'makeList' ('%s' não é um tipo de lista válido)",
			tostring(listType)
		), 2)
	end
	checkType('makeList', 2, args, 'table')
	local data = p.makeListData(listType, args)
	local list = p.renderList(data)
	local trackingCategories = p.renderTrackingCategories(args)
	return list .. trackingCategories
end

for listType in pairs(listTypes) do
	p[listType] = function (frame)
		local mArguments = require('Módulo:Arguments/Testes')
		local origArgs = mArguments.getArgs(frame, {
			valueFunc = function (key, value)
			if not value or not mw.ustring.find(value, '%S') then return nil end
			if mw.ustring.find(value, '^%s*[%*#;:]') then
				return value
			else
				return value:match('^%s*(.-)%s*$')
			end
			return nil
		end
		})
		-- Copia todos os argumentos para uma nova tabela, para uma indexação 
		-- mais rápida.
		local args = {}
		for k, v in pairs(origArgs) do
			args[k] = v
		end
		return p.makeList(listType, args)
	end
end

return p