Mòdul:Hatnote

Documentació del mòdul [ mostra ] [ modifica el codi ] [ mostra l'historial ] [ refresca ]

A continuació es mostra la documentació transclosa de la subpàgina /ús. [salta a la caixa de codi]

---

Aquest és un metamòdul que proporciona diverses funcions per fer notes d'encapçalament. Implementa la plantilla {{hatnote}}, per utilitzar-la en notes d'encapçalament a la part superior de les pàgines, i la plantilla {{format link}}, que s'utilitza per formatar un enllaç wiki per utilitzar-lo en notes d'encapçalament. També conté una sèrie de funcions auxiliars per utilitzar-les en altres mòduls de Lua hatnote.

Ús des de wikitext

Les funcions d'aquest mòdul no es poden utilitzar directament des de #invoke, sinó que s'han d'utilitzar mitjançant plantilles. Si us plau, vegeu Plantilla:Hatnote i Plantilla:Format link per a la documentació.

Ús des d'altres mòduls de Lua

Per carregar aquest mòdul des d'un altre mòdul Lua, utilitzeu el codi següent.

local mHatnote = require('Mòdul:Hatnote')

A continuació, podeu utilitzar les funcions tal com es documenta a continuació.

Hatnote

mHatnote._hatnote(s, opcions)

Formata la cadena s com a nota d'encapçalament. Això inclou s amb les etiquetes <div class="hatnote">...</div>. Les opcions es proporcionen a la taula options. Les opcions inclouen:

• options.extraclasses: una cadena de classes addicionals a proporcionar
• options.selfref: si això no és nul o fals, afegeix la classe "selfref", que s'utilitza per indicar les autoreferències a la Viquipèdia (vegeu Plantilla:Selfref))

El CSS de la classe hatnote es defineix a Mòdul:Hatnote/styles.css.

Exemple 1

mHatnote._hatnote('Aquesta és una nota.')

Produeix: <div class="hatnote">Aquesta és una nota.</div>

Es mostra com a:

Aquesta és una nota.

Exemple 2

mHatnote._hatnote('Aquesta és una nota.', {extraclasses = 'boilerplate seealso', selfref = true})

Produeix: <div class="hatnote boilerplate seealso selfref">Aquesta és una nota.</div>

Es mostra com a:

Aquesta és una nota.

Cerca l'identificador de l'espai de noms

mHatnote.findNamespaceId(enllaç, remove Colon)

Troba l'identificador de l'espai de noms de la cadena enllaç, que hauria de ser un nom de pàgina vàlid, amb o sense el nom de la secció. Aquesta funció no funcionarà si el nom de la pàgina està entre claudàtors. Quan s'intenta analitzar el nom de l'espai de noms, els dos punts s'eliminen de l'inici de l'enllaç de manera predeterminada. Això és útil si els usuaris han especificat dos punts quan no són estrictament necessaris. Si no necessiteu comprovar els dos punts inicials, configureu removeColon com a false.

Exemples

mHatnote.findNamespaceId('Lleó') → 0

mHatnote.findNamespaceId('Categoria:Lleons') → 14

mHatnote.findNamespaceId(':Categoria:Lleons') → 14

mHatnote.findNamespaceId(':Categoria:Lleons', false) → 0 (l'espai de noms es detecta com a ":Categoria", en lloc de "Categoria")

Comenta un error de wikitext

mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)

Formata la cadena msg com a missatge d'error wikitext en vermell, amb un enllaç opcional a una pàgina d'ajuda helpLink. Normalment aquesta funció també afegeix Categoria:Plantilles de Hatnote amb errors (0). Per suprimir la categorització, passeu false com a tercer paràmetre de la funció (addTrackingCategory).

Exemples:

mHatnote.makeWikitextError("s'ha produït un error") →

mHatnote.makeWikitextError("s'ha produït un error", 'Plantilla:Exemple#Errors') →

Exemples

--------------------------------------------------------------------------------
--                              Module:Hatnote                                --
--                                                                            --
-- This module produces hatnote links and links to related articles. It       --
-- implements the {{hatnote}} and {{format link}} meta-templates and includes --
-- helper functions for other Lua hatnote modules.                            --
--------------------------------------------------------------------------------

local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
local mArguments -- lazily initialise [[Module:Arguments]]
local yesno -- lazily initialise [[Module:Yesno]]
local formatLink -- lazily initialise [[Module:Format link]] ._formatLink

local p = {}

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function getArgs(frame)
	-- Fetches the arguments from the parent frame. Whitespace is trimmed and
	-- blanks are removed.
	mArguments = require('Module:Arguments')
	return mArguments.getArgs(frame, {parentOnly = true})
end

local function removeInitialColon(s)
	-- Removes the initial colon from a string, if present.
	return s:match('^:?(.*)')
end

function p.defaultClasses(inline)
	-- Provides the default hatnote classes as a space-separated string; useful
	-- for hatnote-manipulation modules like [[Module:Hatnote group]].
	return
		(inline == 1 and 'hatnote-inline' or 'hatnote') .. ' ' ..
		'navigation-not-searchable'
end

function p.disambiguate(page, disambiguator)
	-- Formats a page title with a disambiguation parenthetical,
	-- i.e. "Example" → "Example (disambiguation)".
	checkType('disambiguate', 1, page, 'string')
	checkType('disambiguate', 2, disambiguator, 'string', true)
	disambiguator = disambiguator or 'desambiguació'  --CATALAN
	return mw.ustring.format('%s (%s)', page, disambiguator)
end

function p.findNamespaceId(link, removeColon)
	-- Finds the namespace id (namespace number) of a link or a pagename. This
	-- function will not work if the link is enclosed in double brackets. Colons
	-- are trimmed from the start of the link by default. To skip colon
	-- trimming, set the removeColon parameter to false.
	checkType('findNamespaceId', 1, link, 'string')
	checkType('findNamespaceId', 2, removeColon, 'boolean', true)
	if removeColon ~= false then
		link = removeInitialColon(link)
	end
	local namespace = link:match('^(.-):')
	if namespace then
		local nsTable = mw.site.namespaces[namespace]
		if nsTable then
			return nsTable.id
		end
	end
	return 0
end

function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
	-- Formats an error message to be returned to wikitext. If
	-- addTrackingCategory is not false after being returned from
	-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
	-- is added.
	checkType('makeWikitextError', 1, msg, 'string')
	checkType('makeWikitextError', 2, helpLink, 'string', true)
	yesno = require('Module:Yesno')
	title = title or mw.title.getCurrentTitle()
	-- Make the help link text.
	local helpText
	if helpLink then
		helpText = ' ([[' .. helpLink .. '|ajuda]])'
	else
		helpText = ''
	end
	-- Make the category text.
	local category
	if not title.isTalkPage -- Don't categorise talk pages
		and title.namespace ~= 2 -- Don't categorise userspace
		and yesno(addTrackingCategory) ~= false -- Allow opting out
	then
		category = "Plantilles de notes d'encapçalament amb errors"
		category = mw.ustring.format(
			'[[%s:%s]]',
			mw.site.namespaces[14].name,
			category
		)
	else
		category = ''
	end
	return mw.ustring.format(
		'<strong class="error">Error: %s%s.</strong>%s',
		msg,
		helpText,
		category
	)
end

local curNs = mw.title.getCurrentTitle().namespace
p.missingTargetCat =
	--Default missing target category, exported for use in related modules
	((curNs ==  0) or (curNs == 14)) and
	"Articles amb plantilles de notes d'encapçalament que enllacen a una pàgina inexistent" or nil

function p.quote(title)
	--Wraps titles in quotation marks. If the title starts/ends with a quotation
	--mark, kerns that side as with {{-'}}
	local quotationMarks = {
		["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
	}
	local quoteLeft, quoteRight = -- Test if start/end are quotation marks
		quotationMarks[string.sub(title,  1,  1)],
		quotationMarks[string.sub(title, -1, -1)]
	if quoteLeft or quoteRight then
		title = mw.html.create("span"):wikitext(title)
	end
	if quoteLeft  then title:css("padding-left",  "0.15em") end
	if quoteRight then title:css("padding-right", "0.15em") end
	return '"' .. tostring(title) .. '"'
end

--------------------------------------------------------------------------------
-- Hatnote
--
-- Produces standard hatnote text. Implements the {{hatnote}} template.
--------------------------------------------------------------------------------

function p.hatnote(frame)
	local args = getArgs(frame)
	local s = args[1]
	if not s then
		return p.makeWikitextError(
			"no s'ha especificat el text",
			'Plantilla:Hatnote#Errors',
			args.category
		)
	end
	return p._hatnote(s, {
		extraclasses = args.extraclasses,
		selfref = args.selfref
	})
end

function p._hatnote(s, options)
	checkType('_hatnote', 1, s, 'string')
	checkType('_hatnote', 2, options, 'table', true)
	options = options or {}
	local inline = options.inline
	local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
	local extraclasses
	if type(options.extraclasses) == 'string' then
		extraclasses = options.extraclasses
	end

	hatnote
		:attr('role', 'note')
		:addClass(p.defaultClasses(inline))
		:addClass(extraclasses)
		:addClass(options.selfref and 'selfref' or nil)
		:wikitext(s)

	return mw.getCurrentFrame():extensionTag{
		name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
	} .. tostring(hatnote)
end

function p.hatnote0(frame)
	local args = getArgs(frame)
	local s = args[1]
	if not s then
		return p.makeWikitextError(
			"no s'ha especificat el text",
			'Plantilla:Hatnote#Errors',
			args.category
		)
	end
	return s
end

function p._hatnote0(s, options)
	return s
end

return p