Misplaced Pages

This is an old revision of this page, as edited by Gonnym (talk | contribs) at 10:29, 1 December 2024. The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

This is the module sandbox page for Module:Wikt-lang (diff). See also the companion subpage for test cases (run).

This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.

This module depends on the following other modules: Module:Wikt-lang/data (sandbox) Module:Unicode data (sandbox)

This module is used by {{Wikt-lang}}. It is inspired by the templates {{m}} and {{l}} and their associated modules on Wiktionary. It has a Wiktionary link function that links to the correct section of the Wiktionary entry, and applies correct language formatting and italics. The language-tagging function does most of what {{Lang}} does, except that italics can't be customized and categories aren't added.

The module uses Module:Wikt-lang/data to retrieve the language name for a language code, and to perform the necessary entry-name replacements (for instance, removing macrons from Latin entry names). These are unfortunately not automatically retrieved from Wiktionary's Wikt-lang data modules. For language codes that do not have a name value in this module, the language name is fetched with mw.language.fetchLanguage. When mw.language.fetchLanguage does not fetch the correct language name (or any language name at all), please add it to Module:Wikt-lang/data, and similarly when the correct entry name is not generated, please add the entry name replacements to the module.

Examples

• {{#invoke:Wikt-lang|wiktlang|en|language}} -> language
• {{#invoke:Wikt-lang|wiktlang|en|language|languages}} -> languages
• {{#invoke:Wikt-lang|wiktlang|fr|bourguignon}} -> bourguignon
• {{#invoke:Wikt-lang|wiktlang|la|homō}} -> homō
• {{#invoke:Wikt-lang|wiktlang|grc|δημοκρατίᾱ}} -> δημοκρατίᾱ
• {{#invoke:Wikt-lang|wiktlang|ru|язы́к}} -> язы́к
• {{#invoke:Wikt-lang|wiktlang|ar|العَرَبِيَّة}} -> ‏العَرَبِيَّة‎
• {{#invoke:Wikt-lang|wiktlang|fa|فارسی}} -> فارسی
• {{#invoke:Wikt-lang|wiktlang|ine-x-proto|*h₂enǵʰ-}} -> *h₂enǵʰ-

Invalid codes

• {{#invoke:Wikt-lang|wiktlang|EN|language}} -> language
• {{#invoke:Wikt-lang|wiktlang|En|language|languages}} -> languages
• {{#invoke:Wikt-lang|wiktlang|La|homō}} -> homō
• {{#invoke:Wikt-lang|wiktlang|Grc|δημοκρατίᾱ}} -> δημοκρατίᾱ
• {{#invoke:Wikt-lang|wiktlang|Ru|язы́к}} -> язы́к
• {{#invoke:Wikt-lang|wiktlang|Ar|العَرَبِيَّة}} -> ‏العَرَبِيَّة‎
• {{#invoke:Wikt-lang|wiktlang|Fa|فارسی}} -> فارسی

Errors

• {{#invoke:Wikt-lang|wiktlang|en-Latin|language}} -> language

Comparison of codes

Tracking categories

• Template:Tracking/wikt-lang/reconstructed with no asterisk

require('strict')
local m_data = mw.loadData("Module:Wikt-lang/data")
local langData = m_data.languages or m_data

local p = {}

local error_mesages = {
	 = "The function makeEntryName requires a string argument",
	 = "Name for the language code $1 could not be retrieved with mw.language.fetchLanguageName, so it should be added to ]",
	 = "Language name is empty",
	 = "linkToWiktionary needs a Wiktionary entry or link text, or both",
	 = "The function wiktlang generated nothing",
}

local cfg = {
	template = "Wikt-lang",
	wiki_language = "en",
	error = "Error",
	category = "]",
	appendix = "Appendix:$1/$2",
	reconstruction = "Reconstruction:$1/$2",
	types = {
		appendix = "appendix",
		reconstructed = "reconstructed",
	}
}

local function makeEntryName(word, languageCode)
	local data = langData

	local ugsub = mw.ustring.gsub
	word = tostring(word)
	if word == nil then
		error(error_mesages.makeEntryName)
	elseif word == "" then
		return ""
	else
		-- Remove bold and italics, so that words that contain bolding or emphasis can be linked without piping.
		word = word:gsub("\'\'\'", "")
		word = word:gsub("\'\'", "")
		if data == nil then
			return word
		else
			local replacements = data and data
			if replacements == nil then
				return word
			else
				-- Decompose so that the diacritics of characters such
				-- as á can be removed in one go.
				-- No need to compose at the end, because the MediaWiki software
				-- will handle that.
				if replacements.decompose then
					word = mw.ustring.toNFD(word)
					for i, from in ipairs(replacements.from) do
						word = ugsub(
							word,
							from,
							replacements.to and replacements.to or "")
					end
				else
					for regex, replacement in pairs(replacements) do
						word = ugsub(word, regex, replacement)
					end
				end
				return word
			end
		end
	end
end



local function linkToWiktionary(entry, link_text, languageCode)
	local data = langData
	local name
	if languageCode then
		if data and data.name then
			name = data.name
		else
			-- On other languages' wikis, use mw.getContentLanguage():getCode(),
			-- or replace 'en' with that wiki's language code.
			name = mw.language.fetchLanguageName(languageCode, cfg.wiki_language)
			if name == "" then
				error("Name for the language code " .. ("%q"):format(languageCode or nil)
					.. " could not be retrieved with mw.language.fetchLanguageName, "
					.. "so it should be added to ]")
			end
		end
		if entry:sub(1, 1) == "*" then
			if name ~= "" then
				entry = "Reconstruction:" .. name .. "/" .. entry:sub(2)
			else
				error(error_mesages.empty_language_name)
			end
		elseif data and data.type == cfg.types.reconstructed then
			mw.log("Reconstructed language without asterisk:", languageCode, name, entry)
			local frame = mw.getCurrentFrame()
			-- Track reconstructed entries with no asterisk by transcluding
			-- a nonexistent template. This technique is used in Wiktionary:
			-- see ].
			-- ]
			pcall(frame.expandTemplate, frame,
				{ title = 'tracking/wikt-lang/reconstructed with no asterisk' })
			if name ~= "" then
				entry = "Reconstruction:" .. name .. "/" .. entry
			else
				error(error_mesages.empty_language_name)
			end
		elseif data and data.type == cfg.types.appendix then
			if name ~= "" then
				entry = "Appendix:" .. name .. "/" .. entry
			else
				error(error_mesages.empty_language_name)
			end
		end
		if entry and link_text then
			return "]"
		else
			error(error_mesages.no_text)
		end
	else
		return "]"
	end
end

--[[--------------------------< M A K E _ E R R O R >--------------------------------------------------

]]

local function make_error(msg)
	return table.concat ({'<span style="color: #d33;">', cfg.error, ': ', cfg.template, msg, '</span>', category})
end

--[[--------------------------< W I K T L A N G >--------------------------------------------------------------------

Entry point for {{Wikt-lang}}.

Parameters are received from the template's frame (parent frame).

* 1 – language code
* 2 – link text
* 3 – display text
* italic – "no" to disable

]]
function p.wiktlang(frame)
	local getArgs = require ('Module:Arguments').getArgs
	local args = getArgs(frame)
	
	-- Handle the display text.
	local lang = require("Module:Lang")
	
	-- The display text should be the text wrapped in the language tag.
	args = args or args
	
	-- To allow the errors to be associated with this template.
	args.template = cfg.template

	local result = lang._lang(args)
	mw.log(result)
	
	-- An error returned, stop here.
	if string.find(result, "Error") then
		return result
	end

	--TODO: we need the result to return as follows:
	--TODO: 1. without a <span title=""> tag which probably should be removed.
	--TODO: 2. the result should be a table of 4 values: language span, category, language code, error. - this will allow easier handling later on.

	-- languageCode = m_data.redirects or languageCode
	
	-- local link_text = args
	-- local entry = makeEntryName(link_text, languageCode)
	--TODO: what happens if no entry?
	-- if not entry then
	-- end
	
	-- local out
	-- if languageCode then
	-- 	out = linkToWiktionary(entry, link_text, languageCode)
	-- else
	-- 	out = linkToWiktionary(entry, link_text)
	-- end

	-- TODO: probably redundant now, the errors should all have been handled up til this point.
	-- if errorText then
	-- 	return errorText or error(error_mesages.no_result)
	-- end

	-- return out

	return result
end

return p

• Module sandboxes