وحدة:links
This module provides many useful utility functions for creating and processing wikilinks within Wiktionary. It is used by the linking templates {{m}}
and {{l}}
through the functions in Module:links/templates.
Functions
عدلfull_link
عدلCreates a full link, with annotations (see format_link_annotations
), in the style of {{l}}
or {{m}}
.
The first argument, data
, must be a table. It contains the various elements that can be supplied as parameters to {{l}}
or {{m}}
:
{
term = entry_to_link_to,
alt = link_text_or_displayed_text,
lang = language_object,
sc = script_object,
id = sense_id,
genders = { "gender1", "gender2", ... },
tr = transliteration,
ts = transcription,
gloss = gloss,
pos = part_of_speech_tag,
lit = literal_translation,
accel = {accelerated_creation_tags},
interwiki = interwiki,
}
Any one of the items in the data
table may be قالب:code, but an error will be shown if neither term
nor alt
nor tr
is present.
Thus, calling قالب:code, where term
is an entry name, lang
is a language object from Module:languages, and sc
is a script object from Module:scripts, will give a plain link similar to the one produced by the template {{l}}
, and calling قالب:code will give a link similar to the one produced by the template {{m}}
.
The function will:
- Try to determine the script, based on the characters found in the term or alt argument, if the script was not given.
- Call
language_link
on the term or alt forms, to remove diacritics in the page name, process any embedded wikilinks and create links to Reconstruction or Appendix pages when necessary. - Call
Module:script utilities#tag_text
to add the appropriate language and script tags to the term, and to italicize terms written in the Latin script if necessary. Accelerated creation tags, as used by WT:ACCEL, are included. - Generate a transliteration, based on the alt or term arguments, if the script is not Latin and no transliteration was provided.
- Add the annotations (transliteration, gender, gloss etc.) after the link.
format_link_annotations
عدلFormats the annotations that are displayed with a link created by قالب:code. 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 argument is a table possessing some or all of the following keys:
genders
- Table containing a list of gender specifications in the style of Module:gender and number.
tr
- Transliteration.
gloss
- Gloss that translates the term in the link, or gives some other descriptive information.
pos
- Part of speech of the linked term. If the given argument 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.
lit
- Literal meaning of the term, if the usual meaning is figurative or idiomatic.
- Any of the above values can be omitted from the
info
argument. If a completely empty table is given (with no annotations at all), then an empty string is returned.
- The second argument is a string. Valid values are listed in Module:script utilities/data "data.translit" table.
language_link
عدل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 the tag_text
from Module:script utilities to add such wrappers itself at some point.
The first argument, data
, may contain the following items, a subset of the items used in the data
argument of full_link
. If any other items are included, they are ignored.
{
term = entry_to_link_to,
alt = link_text_or_displayed_text,
lang = language_object,
id = sense_id,
}
term
- Text to turn into a link. This is generally the name of a page. The text can contain wikilinks already embedded in it. These are processed individually just like a single link would be. The
alt
argument is ignored in this case. alt
(optional)- The alternative display for the link, if different from the linked page. If this is قالب:code, the
text
argument is used instead (much like regular wikilinks). Iftext
contains wikilinks in it, this argument is ignored and has no effect. (Links in which the alt is ignored are tracked with the tracking template قالب:whatlinkshere.) lang
- The language object for the term being linked. If this argument is defined, the function will determine the language's canonical name (see قالب:language data documentation), and point the link or links in the
term
to the language's section of an entry, or to a language-specific senseid if theid
argument is defined. id
(optional)- Sense id string. If this argument is defined, the link will point to a language-specific sense id (قالب:ll) created by the template
{{senseid}}
. A sense id consists of the language's canonical name, a hyphen (-
), and the string that was supplied as theid
argument. This is useful when a term has more than one sense in a language. If theterm
argument contains wikilinks, this argument is ignored. (Links in which the sense id is ignored are tracked with the tracking template قالب:whatlinkshere.)
The second argument is as follows:
allowSelfLink
- If قالب:code, the function will also generate links to the current page. The default (قالب:code) will not generate a link but generate a bolded "self link" instead.
The following special options are processed for each link (both simple text and with embedded wikilinks):
- The target page name will be processed to generate the correct entry name. This is done by the makeEntryName function in Module:languages, using the
entry_name
replacements in the language's data file (see قالب:language data documentation for more information). This function is generally used to automatically strip dictionary-only diacritics that are not part of the normal written form of a language. - If the text starts with
*
, then the term is considered a reconstructed term, and a link to the Reconstruction: namespace will be created. If the text contains embedded wikilinks, then*
is automatically applied to each one individually, while preserving the displayed form of each link as it was given. This allows linking to phrases containing multiple reconstructed terms, while only showing the * once at the beginning. - If the text starts with
:
, then the link is treated as "raw" and the above steps are skipped. This can be used in rare cases where the page name begins with*
or if diacritics should not be stripped. For example:{{l|en|*nix}}
links to the nonexistent page Reconstruction:English/nix (*
is interpreted as a reconstruction), but{{l|en|:*nix}}
links to *nix.{{l|sl|Franche-Comté}}
links to the nonexistent page Franche-Comte (é
is converted toe
bymakeEntryName
), but{{l|sl|:Franche-Comté}}
links to Franche-Comté.
remove_links
عدلReplaces all wikilinks with their displayed text, and removes any categories. This function can be invoked either from a template or from another module.
[[page|displayed text]]
→displayed text
[[page and displayed text]]
→page and displayed text
[[تصنيف:English lemmas|WORD]]
→ (nothing)
Changes
عدل- 2013-09-13: Category:Terms with manual transliterations different from the automated ones and Category:Terms with redundant transliterations or their subcategories begin to be added
- 2018-03-08:
ts
(transcription) annotation added; accepted as field of table in first parameter offull_link
and as field of table in second parameter offormat_link_annotations
, and as second parameter (itemType
) ofmark
Contents of data module
عدلخطأ: لا توجد وحدة بهذا الاسم "links/print_data".
local export = {}
--TODO: move to [[Module:languages]]
local override_translit = {
["ab"] = true,
["abq"] = true,
["ady"] = true,
["av"] = true,
["axm"] = true,
["ba"] = true,
["bo"] = true,
["bua"] = true,
["ce"] = true,
["chm"] = true,
["cv"] = true,
["dar"] = true,
["dv"] = true,
["dz"] = true,
["el"] = true,
["grc"] = true,
["hy"] = true,
["inh"] = true,
["iu"] = true,
["ka"] = true,
["kk"] = true,
--["ko"] = true,
["kbd"] = true,
["kca"] = true,
["kjh"] = true,
["kn"] = true,
["koi"] = true,
["kpv"] = true,
["ky"] = true,
["kv"] = true,
["lo"] = true,
["lbe"] = true,
["lez"] = true,
["lzz"] = true,
["mdf"] = true,
["ml"] = true,
["mn"] = true,
["my"] = true,
["myv"] = true,
["oge"] = true,
["os"] = true,
["sah"] = true,
["si"] = true,
["sva"] = true,
["ta"] = true,
["tab"] = true,
["te"] = true,
["tg"] = true,
["tt"] = true,
["tyv"] = true,
["ug"] = true,
["udm"] = true,
["xal"] = true,
["xcl"] = true,
["xmf"] = true,
}
local ignore_cap = {
["ko"] = true,
}
-- Make a language-specific link from given link's parts
local function makeLangLink(link, lang, id, allowSelfLink)
-- If there is no display form, then create a default one
if not link.display then
link.display = link.target
-- Strip the prefix from the displayed form
-- TODO: other interwiki links?
if link.display:find("^:") then
link.display = link.display:gsub("^:", "")
elseif link.display:find("^w:") then
link.display = link.display:gsub("^w:", "")
end
end
-- If the link contains unexpanded template parameters, then don't create a link
if link.target:find("{{{", nil, true) then
return link.display
end
-- Process the target
if not (link.target:find("^:") or link.target:find("^w:")) then
-- Remove diacritics from the page name
link.target = lang:makeEntryName(link.target)
-- Link to appendix for reconstructed terms and terms in appendix-only languages
if link.target:find("^*.") then
if lang:getCode() == "und" then
return link.display
else
link.target = "Appendix:" .. lang:getCanonicalName() .. "/" .. mw.ustring.sub(link.target, 2)
end
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
link.target = "Appendix:" .. lang:getCanonicalName() .. "/" .. link.target
end
end
-- If the target is the same as the current page, then return a "self-link" like the software does
if not allowSelfLink and (link.target == mw.title.getCurrentTitle().prefixedText or link.target == ":" .. mw.title.getCurrentTitle().prefixedText) then
return "<strong class=\"selflink\">" .. link.display .. "</strong>"
end
-- Add fragment
-- Do not add a section link to "Undetermined", as such sections do not exist and are invalid.
-- TabbedLanguages handles links without a section by linking to the "last visited" section,
-- but adding "Undetermined" would break that feature.
if not link.fragment and lang:getCode() ~= "und" and not link.target:find("^w:") then
if id then
link.fragment = lang:getCanonicalName() .. "-" .. id
elseif not link.target:find("^Appendix:") then
link.fragment = lang:getCanonicalName()
end
end
return "[[" .. link.target .. (link.fragment and "#" .. link.fragment or "") .. "|" .. link.display .. "]]"
end
-- Split a link into its parts
local function parseLink(linktext)
local link = {target = linktext}
local found, _, first, second
found, _, first, second = mw.ustring.find(link.target, "^([^|]+)|(.+)$")
if found then
link.target = first
link.display = second
else
link.display = link.target
end
found, _, first, second = mw.ustring.find(link.target, "^(.+)#(.+)$")
if found then
link.target = first
link.fragment = second
end
return link
end
-- Creates a basic wikilink to the given term. If the text already contains
-- links, these are replaced with links to the correct section.
local function language_link2(text, alt, lang, id, allowSelfLink)
local sectFix = false
local tracking = ""
if text and text:gsub("&#[Xx]?[0-9A-Fa-f]+;", ""):find("#", nil, true) then
sectFix = true
end
if ignore_cap[lang:getCode()] and text then
text = mw.ustring.gsub(text, "%^", "")
end
-- If the text begins with * and another character,
-- then act as if each link begins with *
local allReconstructed = false
if text:find("^*.") then
allReconstructed = true
end
-- Do we have embedded wikilinks?
if text:find("[[", nil, true) then
if id then
require("Module:debug").track("language link/bad id")
end
local function repl(linktext)
local link = parseLink(linktext)
if allReconstructed then
link.target = "*" .. link.target
end
return makeLangLink(link, lang, id, allowSelfLink)
end
text = mw.ustring.gsub(text, "%[%[([^%]]+)%]%]", repl)
-- Remove the extra * at the beginning if it's immediately followed
-- by a link whose display begins with * too
if allReconstructed then
text = mw.ustring.gsub(text, "^%*%[%[([^|%]]+)|%*", "[[%1|*")
end
else
-- There is no embedded wikilink, make a link using the parameters.
text = makeLangLink({target = text, display = alt}, lang, id, allowSelfLink)
end
return text .. (sectFix and "[[تصنيف:Link with section]]" or "") .. tracking
end
-- Format the annotations (things following the linked term)
local function format_link_annotations(lang, annotations, face)
local ret = ""
-- Interwiki link
if annotations["interwiki"] then
ret = ret .. annotations["interwiki"]
end
-- Genders
if annotations["genders"] and #annotations["genders"] > 0 then
local gen = require("Module:gender and number")
ret = ret .. " " .. gen.format_list(annotations["genders"], lang)
end
local glosses = {}
-- Transliteration
if annotations["tr"] then
if face == "term" then
table.insert(glosses, "<span lang=\"\" class=\"tr mention-tr\">" .. annotations["tr"] .. "</span>")
else
table.insert(glosses, "<span lang=\"\" class=\"tr\">" .. annotations["tr"] .. "</span>")
end
end
-- 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>")
end
-- 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"]})
else
table.insert(glosses, annotations["pos"])
end
end
-- 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>")
end
if #glosses > 0 then
ret = ret .. " (" .. table.concat(glosses, ", ") .. ")"
end
return ret
end
-- A version of {{l}} or {{m}} that can be called from other modules too
function export.full_link(term, alt, lang, sc, face, id, annotations, allowSelfLink)
annotations = annotations or {}
-- Create the link
local link = ""
local m_utilities = require("Module:utilities")
local m_scriptutils = require("Module:script utilities")
-- 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 = require("Module:scripts").findBestScript(alt or term, lang)
end
-- 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 language_link2(term, alt, lang, id, allowSelfLink) or alt, lang, sc, face)
else
-- 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. Show a term request.
local category = ""
if mw.title.getCurrentTitle().nsText ~= "Template" then
category = "[[تصنيف:" .. lang:getCanonicalName() .. " term requests]]"
end
link = "<small>[Term?]</small>" .. category
end
end
local mantrFix, redtrFix
local manual_tr = ""
if annotations["tr"] == "" or annotations["tr"] == "-" then
annotations["tr"] = nil
elseif (term or alt) and not ((sc:getCode():find("Latn", nil, true)) or sc:getCode() == "Latinx") 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
end
annotations["tr"] = automated_tr
else
redtrFix = true
end
end
end
return link .. format_link_annotations(lang, annotations, face)
.. (mantrFix and "[[تصنيف:Terms with manual transliterations different from the automated ones]][[تصنيف:Terms with manual transliterations different from the automated ones/" .. lang:getCode() .. "]]" or "")
.. (redtrFix and "[[تصنيف:Terms with redundant transliterations]][[تصنيف:Terms with redundant transliterations/" .. lang:getCode() .. "]]" or "")
end
function export.language_link(text, alt, lang, id, allowSelfLink)
if allowSelfLink == false then
require("Module:debug").track("curtitle/false")
elseif allowSelfLink == true then
require("Module:debug").track("curtitle/true")
elseif allowSelfLink == nil then
allowSelfLink = true
require("Module:debug").track("curtitle/nil")
else
if allowSelfLink ~= mw.title.getCurrentTitle().prefixedText then
require("Module:debug").track("curtitle/string/not pagename")
end
allowSelfLink = false
require("Module:debug").track("curtitle/string")
end
require("Module:debug").track("language_link")
return language_link2(text, alt, lang, id, allowSelfLink)
end
-- 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("%[%[Category:[^|%]]-|?[^|%]]-%]%]", "")
text = text:gsub("%[%[[^|%]]-|", "")
text = text:gsub("%[%[", "")
text = text:gsub("%]%]", "")
return text
end
return export