Modulo:Abbreviazioni

Istruzioni per l'uso
Questo è un modulo scritto in Lua. Le istruzioni che seguono sono contenute nella sottopagina Modulo:Abbreviazioni/man (modifica · cronologia)
Sandbox: Modulo:Abbreviazioni/sandbox (modifica · cronologia) · Test: Modulo:Abbreviazioni/test (modifica · cronologia · Esegui)

Questo modulo crea un riquadro che mostra i collegamenti a una pagina.

Uso

Tramite wikitesto

Tramite wikitesto, questo modulo può essere richiamato da un template, di solito il {{Abbreviazione}}. Per favore guarda la documentazione del template. Tuttavia, può anche essere richiamato usando la sintassi {{#invoke:shortcut|main|argomenti}}.

Da Lua

Per utilizzare questo modulo da Lua, va prima caricato.

local mShortcut = require('Module:Shortcut')

Quindi puoi creare caselle di scelta rapida con la seguente sintassi:

mShortcut._main(shortcuts, options, frame, cfg)

• shortcuts è un array per le pagine di abbreviazione. (necessario)
• options è una tabella di opzioni. Sono supportati i seguenti valori:
  • msg - un messaggio da visualizzare dopo l'elenco delle scorciatoie.
  • category - se impostato su false (o un valore considerato falso da Modulo:Yesno, come "no"), le categorie vengono soppresse.
• frame un oggetto frame. Questo è facoltativo e deve essere utilizzato solo internamente.
• cfg una tabella di valori di configurazione. Questo è facoltativo ed è destinato esclusivamente ai test.

Dettagli tecnici

Questo modulo ha un file di configurazione in Modulo:Abbreviazioni/config. Può essere utilizzato per tradurre questo modulo in diverse lingue o per modificare i dettagli come i nomi delle categorie.

---

-- This module implements {{shortcut}}.

-- copiato da en.wikipedia.org alla versione: https://en.wikipedia.org/w/index.php?title=Module:Shortcut&oldid=853242017
-- Set constants
local CONFIG_MODULE = 'Modulo:Abbreviazioni/config'

-- Load required modules
local checkType = require('libraryUtil').checkType
local yesno = require('Modulo:Yesno')

local p = {}

local function message(msg, ...)
	return mw.message.newRawMessage(msg, ...):plain()
end

local function makeCategoryLink(cat)
	return string.format('[[%s:%s]]', mw.site.namespaces[14].name, cat)
end

function p._main(shortcuts, options, frame, cfg)
	checkType('_main', 1, shortcuts, 'table')
	checkType('_main', 2, options, 'table', true)
	options = options or {}
	frame = frame or mw.getCurrentFrame()
	cfg = cfg or mw.loadData(CONFIG_MODULE)
	local isCategorized = yesno(options.category) ~= false

	-- Validate shortcuts
	for i, shortcut in ipairs(shortcuts) do
		if type(shortcut) ~= 'string' or #shortcut < 1 then
			error(message(cfg['invalid-shortcut-error'], i), 2)
		end
	end

	-- Make the list items. These are the shortcuts plus any extra lines such
	-- as options.msg.
	local listItems = {}
	for i, shortcut in ipairs(shortcuts) do
		listItems[i] = frame:expandTemplate{
			title = 'No redirect',
			args = {shortcut}
		}
	end
	table.insert(listItems, options.msg)

	-- Return an error if we have nothing to display
	if #listItems < 1 then
		local msg = cfg['no-content-error']
		msg = string.format('<strong class="error">%s</strong>', msg)
		if isCategorized and cfg['no-content-error-category'] then
			msg = msg .. makeCategoryLink(cfg['no-content-error-category'])
		end
		return msg
	end

	local root = mw.html.create()

	-- Anchors
	local anchorDiv = root
		:tag('div')
			:css('position', 'relative')
			:css('top', '-3em')
	for i, shortcut in ipairs(shortcuts) do
		local anchor = mw.uri.anchorEncode(shortcut)
		anchorDiv:tag('span'):attr('id', anchor)
	end

	root:newline() -- To match the old [[Template:Shortcut]]

	-- Shortcut heading
	local shortcutHeading
	do
		local nShortcuts = #shortcuts
		if nShortcuts > 0 then
			shortcutHeading = message(cfg['shortcut-heading'], nShortcuts)
			shortcutHeading = frame:preprocess(shortcutHeading)
			shortcutHeading = shortcutHeading .. '\n'
		end
	end

	-- Shortcut box
	local shortcutList = root
		:tag('div')
			:addClass('shortcutbox plainlist noprint')
			:attr('role', 'note')
			:css('float', 'right')
			:css('border', '1px solid #aaa')
			:css('background', '#fff')
			:css('color', '#000')
			:css('margin', '0em 0em 0em 1em')
			:css('padding', '.3em .6em .2em .6em')
			:css('text-align', 'center')
			:css('font-size', '85%')
			:css('font-weight', 'bold')
	if shortcutHeading then
		shortcutList
			:tag('div')
				:css('display','inline-block')
				:css('border-bottom','1px solid #aaa')
				:css('margin-bottom', '.2em')
				:css('font-weight', 'normal')
				:wikitext(shortcutHeading)
	end
	list = mw.html.create('p')
	for i, item in ipairs(listItems) do
		list:wikitext(item):tag('br')
	end
	shortcutList:node(list)
	return tostring(root)
end

function p.main(frame)
	local args = require('Modulo:Arguments').getArgs(frame, {
		wrappers = 'Template:Abbreviazione'
	})

	-- Separate shortcuts from options
	local shortcuts, options = {}, {}
	for k, v in pairs(args) do
		if type(k) == 'number' then
			shortcuts[k] = v
		else
			options[k] = v
		end
	end

	-- Compress the shortcut array, which may contain nils.
	local function compressArray(t)
		local nums, ret = {}, {}
		for k in pairs(t) do
			nums[#nums + 1] = k
		end
		table.sort(nums)
		for i, num in ipairs(nums) do
			ret[i] = t[num]
		end
		return ret
	end
	shortcuts = compressArray(shortcuts)

	return p._main(shortcuts, options, frame)
end

return p