Definition from Wiktionary, the free dictionary
Jump to: navigation, search
The following documentation is located at Module:links/documentation. [edit]

This module provides many useful utility functions for creating and processing wikilinks within Wiktionary.


full_link(term, alt, lang, sc, face, id, annotations, curtitle)

Creates a full link, with annotations, in the style of {{l}} or {{term}}. The parameters are: term (page name), alternative display, language object, script code, script face (see Module:script utilities#tag_text), senseid, table of annotations (see format_link_annotations). All parameters may be nil except for the annotations, but an error will be shown if the term, alt and transliteration (in the annotations) are all missing.

The function will:

  • Try to determine the script, based on the characters found in the term or alt parameter, if the script was not given.
  • Call language_link on the term/alt forms, to remove diacritics in the page name, process any embedded wikilinks and create links to appendix pages when necessary.
  • Call Module:script utilities#tag_text to add the appropriate language and script tags to the term.
  • Generate a transliteration, based on the alt or term parameters, if the script is not Latin and no transliteration was provided.
  • Add the annotations (transliteration, gender, gloss etc.) after the link.


format_link_annotations(lang, info)

Formats annotations that are displayed with a link. Annotations are the extra bits of information that are displayed following the linked term, and include things such as gender, transliteration, gloss and so on. The first parameter is the language object, the second is a table possessing some or all of the following keys:

Table containing a list of gender specifications in the style of Module:gender and number.
Gloss that translates the term in the link, or gives some other descriptive information.
Part of speech of the linked term. If the given parameter matches one of the templates in Category:Part of speech tags, then call that to show a part-of-speech tag. Otherwise, just show the given text as it is.
Literal meaning of the term, if the usual meaning is figurative or idiomatic.

Any of the above values can be omitted from the info parameter. If a completely empty table is given (with no annotations at all), then an empty string is returned.


language_link(text, alt, lang, id, curtitle)

Creates a basic link to the given term. It links to the language section (such as #English), but it does not add language and script wrappers, so any code that uses this function should call Module:script utilities#tag_text to add such wrappers itself at some point.

It accepts the following parameters:

The text to turn into a link. This is generally the name of a page. The entry name will be processed by prepare_title to generate the correct entry name before creating a link.
The string can contain wikilinks already embedded in them. Embedded wikilinks can also contain their own alternative display text; this will be preserved, while the alt parameter is ignored. A language section will be added to each individual wikilink in the string, and each link's entry name will be processed by prepare_title individually.
If the text starts with *, then the term is considered a reconstructed term, and this will be passed on to prepare_title. If the text contains embedded wikilinks, then the * is applied to each one individually, while preserving the displayed form of each link. This allows linking to phrases containing multiple reconstructed terms, while only showing the * once at the beginning.
The alternative display for the link, if this is different from the linked page. If this is nil, the text parameter is used instead (much like regular wikilinks). If text contains wikilinks in it, this parameter is ignored and has no effect.
The language object for the term being linked.
An additional sense ID to insert into the link. This is used in conjunction with {{senseid}}. This is optional.
When provided, the function won't link to this title. It is used in inflection tables.


remove_diacritics(text, lang)

Removes all diacritics from the text that are not permitted in page names. This removes certain punctuation characters, and replaces letters with diacritics with plain versions, according to the conventions of the given language. For example, macrons are removed from Latin entry names, while vowel diacritics are removed from Hebrew or Arabic terms. These replacements are defined by the entry_name setting for each language in the Module:languages data.



Replaces all [[wikilinks]] with their linktitle as simple text. This function can be invoked from either a template or from another module.

local export = {}
local gsub = mw.ustring.gsub
--TODO: move to [[Module:languages]]
local override_translit = {
	["ab"] = true,
	["abq"] = true,
	["ady"] = true,
	["av"] = true,
	["axm"] = true,
	["ba"] = true,
	["bua"] = true,
	["ce"] = true,
	["chm"] = true,
	["cv"] = true,	
	["dar"] = true,
	["el"] = true,
	["hy"] = true,
	["inh"] = true,
	["ka"] = true,
	["kk"] = true,
	["kbd"] = true,
	["kca"] = true,
	["kjh"] = true,
	["koi"] = true,
	["kpv"] = true,
	["ky"] = true,
	["lbe"] = true,
	["lez"] = true,
	["lzz"] = true,
	["mdf"] = true,
	["mn"] = true,
	["myv"] = true,
	["oge"] = true,
	["os"] = true,
	["sah"] = true,
	["si"] = true,
	["sva"] = true,
	["tab"] = true,
	["tg"] = true,
	["udm"] = true,
	["xal"] = true,
	["xcl"] = true,
	["xmf"] = true,
-- A version of {{l}} or {{term}} that can be called from other modules too
function export.full_link(term, alt, lang, sc, face, id, annotations, curtitle)
	annotations = annotations or {}
	-- Some entries use this as a filler when the native script is missing.
	if term == "..." then error("Term is \"...\", should probably be empty") end
	if alt == "..." then error("Alt is \"...\", should probably be empty") end
	-- Create the link
	local link = ""
	local m_utilities = require("Module:utilities")
	local m_scriptutils = require("Module:script utilities")
	local scFix = false
	-- Is there any text to show?
	if (term or alt) then
		-- Try to detect the script if it was not provided
		if not sc then
			sc, scFix = m_utilities.detect_script(alt or term, lang)
		-- Only make a link if the term has been given, otherwise just show the alt text without a link
		link = m_scriptutils.tag_text(term and export.language_link(term, alt, lang, id, curtitle) or alt, lang, sc, face)
		-- No term to show.
		-- Is there at least a transliteration we can work from?
		link = m_scriptutils.request_script(lang, sc)
		if link == "" or not annotations["tr"] or annotations["tr"] == "-" then
			-- No link to show, and no transliteration either. Just show an error because can't really do anything now.
			error("At least one of the following should be provided: the term, alternative display, transliteration")
	local mantrFix, redtrFix
	local manual_tr = ""
	if annotations["tr"] == "" or annotations["tr"] == "-" then
		annotations["tr"] = nil
	elseif (term or alt) and not ((sc:find("Latn", nil, true)) or sc == "Latinx" or sc == "unicode") and (not annotations["tr"] or override_translit[lang:getCode()]) then
		-- Try to generate a transliteration if necessary
		local automated_tr
		automated_tr = lang:transliterate(export.remove_links(alt or term), sc)
		if automated_tr then
		   if annotations["tr"] ~= automated_tr then
			   if annotations["tr"] then
				   manual_tr = annotations["tr"]
				   mantrFix = true
			   annotations["tr"] = automated_tr
			   redtrFix = true
	return link .. format_link_annotations(lang, annotations, face)
				.. (scFix and "[[Category:Terms using script detection fallback]][[Category:Terms using script detection fallback/" .. lang:getCode() .. "]]" or "")
				.. (mantrFix and "[[Category:Terms with manual transliterations different from the automated ones]][[Category:Terms with manual transliterations different from the automated ones/" .. lang:getCode() .. "]]" or "")
				.. (redtrFix and "[[Category:Terms with redundant transliterations]]" or "")
-- Format the annotations (things following the linked term)
function format_link_annotations(lang, annotations, face)
	local ret = ""
	-- Interwiki link
	if annotations["interwiki"] then
		ret = ret .. annotations["interwiki"]
	-- Genders
	if annotations["genders"] and #annotations["genders"] > 0 then
		local gen = require("Module:gender and number")
		ret = ret .. " " .. gen.format_list(annotations["genders"], lang:getCode())
	local glosses = {}
	-- Transliteration
	if annotations["tr"] then
		if face == "term" then
			table.insert(glosses, "<span lang=\"\" class=\"tr mention-tr\">" .. annotations["tr"] .. "</span>")
			table.insert(glosses, "<span lang=\"\" class=\"tr\">" .. annotations["tr"] .. "</span>")
	-- Gloss/translation
	if annotations["gloss"] then
		table.insert(glosses, "<span class=\"mention-gloss-double-quote\">“</span><span class='mention-gloss'>" .. annotations["gloss"] .. "</span><span class=\"mention-gloss-double-quote\">”</span>")
	-- Part of speech
	-- TODO: remove
	if annotations["pos"] then
		local pos_template = mw.title.makeTitle("Template", "pos " .. annotations["pos"])
		if pos_template and pos_template.exists then
			table.insert(glosses, mw.getCurrentFrame():expandTemplate{title = "pos " .. annotations["pos"]})
			table.insert(glosses, annotations["pos"])
	-- Literal/sum-of-parts meaning
	if annotations["lit"] then
		table.insert(glosses, "literally <span class=\"mention-gloss-double-quote\">“</span><span class='mention-gloss'>" .. annotations["lit"] .. "</span><span class=\"mention-gloss-double-quote\">”</span>")
	if #glosses > 0 then
		ret = ret .. " (" .. table.concat(glosses, ", ") .. ")"
	return ret
-- Creates a basic wikilink to the given term. If the text already contains
-- links, these are replaced with links to the correct section.
function export.language_link(text, alt, lang, id, curtitle)
	local sectFix = false
	local tracking = ""
	if text and text:gsub("&#[Xx]?[0-9A-Fa-f]+;", ""):find("#", nil, true) then
		sectFix = true
	-- takes target page's title and linktitle and return a standard wikilink if necessary
	local core = function(target, linktitle)
		-- Don't link to appendix if the language is undetermined
		if lang:getCode() == "und" and target:find("^*.") then
			return linktitle or target
		local target2 = make_pagename(target, lang)
		-- Don't link to the current page; return bold form of the linktitle
		if target2 == curtitle then
			return "<strong class=\"selflink\">" .. (linktitle or target) .. "</strong>"
		--if linktitle then
		--	local new = export.remove_diacritics(linktitle, lang)
		--	if target == new then
		--		tracking = tracking .. "[[Category:Link alt form tracking/redundant]][[Category:Link alt form tracking/redundant/" .. lang .. "]]"
		--	end
		local fragment = ""
		-- Do not add a section link to "Undetermined", or when linking to an appendix.
		-- TabbedLanguages handles links without a section by linking to the "last visited"
		-- section, but adding "Undetermined" would mess that up when {{term}} lacks a language.
		if lang:getCode() ~= "und" then
			if id then
				fragment = "#" .. lang:getCanonicalName() .. "-" .. id
			elseif not target2:find("^Appendix:") then
				fragment = "#" .. lang:getCanonicalName()
		return "[[" .. target2 .. fragment .. "|" .. (linktitle or target) .. "]]"
	-- Do we have embedded wikilinks?
	if text:find("[[", nil, true) then
		-- fix for linking to unattested terms that are consisted of more than one word
		if text:find("^*.") then
			text = gsub(text, "%[%[([^%*][^#%]]-)|", "[[*%1|")
			text = gsub(text, "%[%[([^%*][^#|]-)%]", "[[*%1|%1]")
		-- find embedded wikilinks and improve them
		text = gsub(text, "%[%[([^#|%]]-)|(.-)%]%]", core)
		text = gsub(text, "%[%[([^#|%]]-)%]%]", core)
		-- remove the extra "*" at the beginning
		text = gsub(text, "^%*%[%[(.-)|%*", "[[%1|*")
		-- there is no embedded wikilink
		text = core(text, alt)
	return text .. (sectFix and "[[Category:Link with section]]" or "") .. tracking
-- Creates the appropriate page name from the given term.
-- This removes diacritics and adds Appendix: when necessary.
function make_pagename(text, lang)
	-- Remove diacritics from the page name
	text = lang:makeEntryName(text)
	-- Link to appendix for reconstructed terms and terms in appendix-only languages
	if text:find("^*.") then
		return "Appendix:" .. lang:getCanonicalName() .. "/" .. mw.ustring.sub(text, 2)
	elseif lang:getType() == "reconstructed" then
		error("The specified language " .. lang:getCanonicalName() .. " is unattested, while the given word is not marked with '*' to indicate that it is reconstructed")
	elseif lang:getType() == "appendix-constructed" then
		return "Appendix:" .. lang:getCanonicalName() .. "/" .. text
		return text
-- Removes characters from a term that do not belong in the page name.
-- This includes any diacritics displayed in the headword line or alternative
-- display, but left out of the entry names.
-- This function is used by the translation editor (User:Conrad.Irwin/editor.js)
function export.remove_diacritics(text, lang)
	if type(text) == "table" then 
		text, lang = text.args[1], text.args[2]
	if type(lang) == "string" then
		lang = require("Module:languages").getLanguageByCode(lang)
	return lang:makeEntryName(text)
-- Strips all square brackets out or replaces them.
function export.remove_links(text)
	if type(text) == "table" then text = text.args[1] end; if not text then text = "" end
	text = text:gsub("%[%[[^|%]]-|", "")
	text = text:gsub("%[%[", "")
	text = text:gsub("%]%]", "")
	return text
return export