Jump to content

Module:Wikt-lang/sandbox

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Gonnym (talk | contribs) at 14:59, 1 December 2024. The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.
require('strict')
local m_data = mw.loadData("Module:Wikt-lang/data/sandbox")
local langData = m_data.languages or m_data

local p = {}

local error_msgs = {
	internal = {
		["make_entry_name"] = "The function make_entry_name requires a link string.",
		["link_to_Wiktionary"] = "The function link_to_Wiktionary needs a Wiktionary link and display text.",
	},
	["language_code_missing"] = "Name for the language code %q could not be retrieved with mw.language.fetchLanguageName, so it should be added to [[Module:Wikt-lang/data]]",
}

local cfg = {
	template = "Wikt-lang",
	wiki_language = "en",
	error = "Error",
	category = "[[Category:Wikt-lang template errors]]",
	appendix = "Appendix:%s/%s",
	reconstruction = "Reconstruction:%s/%s",
	types = {
		appendix = "appendix",
		reconstructed = "reconstructed",
	},
}


--[[--------------------------< 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>', cfg.category})
end


--[[--------------------------< M A K E _ E N T R Y _ N A M E >--------------------------------------------------

]]

local function make_entry_name(link_text, language_code)
	link_text = tostring(link_text)
	if link_text == nil or link_text == "" then
		return nil, make_error(error_msgs.internal.make_entry_name)
	end

	local data = langData[language_code]

	--TODO: is this an error?
	if data == nil then
		return link_text
	end

	--TODO: is this an error?
	local replacements = data and data["replacements"]
	if replacements == nil then
		return link_text
	end

	-- Remove bold and italics, so that words that contain bolding or emphasis can be linked without piping.
	link_text = link_text:gsub("\'\'\'", "")
	link_text = link_text:gsub("\'\'", "")

	-- 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
		link_text = mw.ustring.toNFD(link_text)
		for i, from in ipairs(replacements.from) do
			link_text = mw.ustring.gsub(
				link_text,
				from,
				replacements.to and replacements.to[i] or "")
		end
	else
		for regex, replacement in pairs(replacements) do
			link_text = mw.ustring.gsub(link_text, regex, replacement)
		end
	end
	return link_text
end


--[[--------------------------< L I N K _ T O _ W I K T I O N A R Y >--------------------------------------------------

]]

local function link_to_Wiktionary(link_text, display_text, language_code)
	if not link_text and not display_text then
		return nil, make_error(error_msgs.internal.link_to_Wiktionary)
	end

	local data = langData[language_code]
	local language_name
	if language_code then
		if data and data.name then
			language_name = data.name
		else
			-- On other languages' wikis, use mw.getContentLanguage():getCode(),
			-- or replace 'en' with that wiki's language code.
			language_name = mw.language.fetchLanguageName(language_code, cfg.wiki_language)
			
			--TODO: test if this works
			--language_name = mw.language.fetchLanguageName(language_code, cfg.wiki_language) or mw.getContentLanguage():getCode()
			if language_name == "" then
				return nil, make_error(string.format(error_msgs.language_code_missing, language_code or nil))
			end
		end
		if link_text:sub(1, 1) == "*" then
			link_text = string.format(cfg.reconstruction, language_name, link_text:sub(2))
		elseif data and data.type == cfg.types.reconstructed then
			mw.log("Reconstructed language without asterisk:", language_code, language_name, link_text)
			local frame = mw.getCurrentFrame()
			-- TODO: replace with category
			-- Track reconstructed entries with no asterisk by transcluding
			-- a nonexistent template. This technique is used in Wiktionary:
			-- see [[wikt:Module:debug]].
			-- [[Special:WhatLinksHere/tracking/wikt-lang/reconstructed with no asterisk]]
			pcall(frame.expandTemplate, frame, {title = 'tracking/wikt-lang/reconstructed with no asterisk'})
			link_text = string.format(cfg.reconstruction, language_name, link_text)
		elseif data and data.type == cfg.types.appendix then
			link_text = string.format(cfg.appendix, language_name, link_text)
		end
		if link_text then
			return "[[wikt:" .. link_text .. "#" .. language_name .. "|" .. display_text .. "]]"
		else
			--TODO: this might not be an internal error. Test how to reach this.
			return nil, make_error(error_msgs.internal.link_to_Wiktionary)
		end
	else
		return "[[wikt:" .. link_text .. "|" .. display_text .. "]]"
	end
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/sandbox2")
	
	-- The display text should be the text wrapped in the language tag.
	args[2] = args[3] or args[2]
	
	-- 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 type(result) == "string" and string.find(result, "Error") then
		return result
	end
	
	mw.logObject(result)
	--TODO: we need the result to return as follows:
	--TODO: 1. without a <span title=""> tag which probably should be removed.

	local entry, error_msg = make_entry_name(args[2], result.code)
	if error_msg then
		return error_msg
	end
	
	local link
	if result.code then
		link, error_msg = link_to_Wiktionary(entry, result.html, result.code)
	else
		link, error_msg = link_to_Wiktionary(entry, result.html)
	end

	if error_msg then
		return error_msg
	end

	return link .. result.language_categories .. result.maintenance  
end

return p