Wikipedia

Module:Annotated link: Difference between revisions

Browse history interactively
Content deleted Content added
first draft to test in the wild
 
disable wikidata short descriptions, per RFC and multiple talk page discussions. Please report any bugs on the template talk page
 
(62 intermediate revisions by 4 users not shown)
Line 1:
local p = {}
 
local function pipedLink(name, display) return '[[:'..name..'|'..display..']]' end
local getShortDesc = require( 'Module:User:Fred Gandt/getShortDescription' ).main
local getArgs = require( 'Module:Arguments' ).getArgs
 
local function handleFirstLetterCaseisEmpty(value) short_description,return casevalue )== nil or value == '' end
 
if not case then
local function notEmpty(value) return not isEmpty(value) end
return short_description
 
end
-- Unescape functionality grabbed from https://stackoverflow.com/a/14899740/1832568
local case_altered_short_description = mw.ustring.gsub( short_description, '^(.)', function( first_char )
local function unescape(str)
if case == 'lower' then
str = string.gsub(str, '&#(%d+);', string.char)
return mw.ustring.lower( first_char )
str = string.gsub(str, '&#x(%d+);', function(d) return string.char(tonumber(d, 16)) end)
return str
end
 
local function hashDelimitedList(list_string) return mw.text.gsplit(unescape(list_string), '%s*#%s*') end
 
local function alarmingMessage(message)
return '<span style="color:#d33">[[Module:Annotated link]] '..message..'.</span>'..
'[[Category:Pages displaying alarming messages about Module:Annotated link]]'
end
 
local function optionallyVisibleCategory(class, category)
return '<span style="display:none" class="'..class..'">'..category..
'</span>[[Category:'..category..' via Module:Annotated link]]'
end
 
local function handleFirstLetterCase(short_description, case)
return mw.ustring.gsub(short_description, '^([^%d])', function(first_char)
if case == 'upper' then
return mw.ustring.upper(first_char)
end
return mw.ustring.upperlower( first_char) )end
end )
end
if case_altered_short_description ~= short_description then
 
mw.log( 'tracking' )
local mLang = require('Module:Lang')
local function langify(args)
local lang = args.lang
local text = args.text
if isEmpty(lang) or lang == 'en' then
return text
end
return case_altered_short_descriptionmLang._lang {
lang,
text,
italic = args.italic,
nocat = args.nocat,
size = args.size,
cat = args.cat,
rtl = args.rtl
}
end
 
local function getShortDescriptionformatResult(result, namedash, casedescription, prefix_parentheses)
if notEmpty(description) then
local short_description = getShortDesc( { args = { name = name } } )
if prefix_parentheses then
return handleFirstLetterCase( short_description, case )
local startIdx = description:find("%(")
if startIdx then
local beforeParens = description:sub(1, startIdx - 2)
local insideParens = description:sub(startIdx, -1)
return result..' '..insideParens..dash..' '..beforeParens
end
end
return result..dash..' '..description
end
return result
end
 
local function annotatedLink( args )
local name = args.name
if not isEmpty(name) then
return alarmingMessage('requires a page title mustname be(including providednamespace)')
end
-- In order to handle an attempt to annotate a template link
local dash = args.dash or ' –'
-- already formatted with the likes of {{tl|<template name>}};
local display = args.display
-- unescape name to make sense of braces in lua patern matching.
local wedge = args.wedge
name = unescape(name)
local quote = args.quote
local abbr = args.abbr
local case = args.case
local aka = args.aka
if name:match('^{%b{}}$') then
local result = '[[' .. name
-- The possibility to extract useful data exists here: e.g. {{tl*|Template}}.
if display then
return alarmingMessage(
result = result .. '|' .. display
'requires only a page name (including namespace) without markup. '..
'If an attempt is being made to annotate a link to a template, '..
'provide only the template name with namespace e.g. "Template:Example"')
end
result = result .. ']]'
-- If a literal link was provided as name;
if quote then
-- extract the content and apply it to name and display as appropriate.
result = '"' .. result .. '"'
local wikilink = mw.ustring.match(name, '^%[%[%s*:*%s*(.-)%s*%]%]$')
if wikilink then
local link_name, link_display = unpack(mw.text.split(wikilink, '%s*|%s*'))
if link_name then
name = link_name
end
if link_display and isEmpty(args.display) then
args.display = link_display
end
end
-- Prepare to concatenate.
if abbr then
local result
result = result .. ' (' .. abbr .. ')'
local is_template = name:match('^Template:(.+)$')
local template_link = args.template_link
if is_template and template_link ~= 'no' then
result = '{{'..pipedLink(name, is_template)..'}}'
if template_link == 'code' then
result = '<code>'..result..'</code>'
end
else
local display = args.display
if isEmpty(display) then
display = name
end
result = langify({
lang = args.link_lang,
text = pipedLink(name, display),
italic = args.link_lang_italic,
nocat = args.link_lang_nocat,
size = args.link_lang_size,
cat = args.link_lang_cat,
rtl = args.link_lang_rtl
})
if notEmpty(args.quote) then
result = '"'..result..'"'
end
local abbr = args.abbr
if notEmpty(abbr) then
result = result..' (<abbr'
local abbr_title = args.abbr_title
if notEmpty(abbr_title) then
result = result..' title="'..abbr_title..'"'
end
result = result..'>'..abbr..'</abbr>)'
end
end
if akaisEmpty(result) then
return alarmingMessage('could not create a link for "'..name..'"')
result = result .. ', also known as ' .. aka
end
local aka = args.aka
if wedge then
if notEmpty(aka) then
result = result .. ' (' .. wedge .. ')'
result = result..', also known as '..langify({
lang = args.aka_lang,
text = aka,
italic = args.aka_lang_italic,
nocat = args.aka_lang_nocat,
size = args.aka_lang_size,
cat = args.aka_lang_cat,
rtl = args.aka_lang_rtl
})
end
local wedge = args.wedge
local short_description = getShortDescription( name, case )
if notEmpty(wedge) then
if short_description and short_description ~= '' then
result = result .. dash .. ', ' .. short_descriptionlangify({
lang = args.wedge_lang,
text = wedge,
italic = args.wedge_lang_italic,
nocat = args.wedge_lang_nocat,
size = args.wedge_lang_size,
cat = args.wedge_lang_cat,
rtl = args.wedge_lang_rtl
})
end
-- Exclude wikidata fallback for any specified list of link titles,
mw.log( 'result' )
-- unless explicity instructed that it's okay.
mw.log( result )
local not_wikidata_for_links_starting_with = args.not_wikidata_for_links_starting_with
if isEmpty(args.wikidata) and notEmpty(not_wikidata_for_links_starting_with) then
for only_explicit in hashDelimitedList(not_wikidata_for_links_starting_with) do
if name:match('^'..only_explicit) then
args.only = 'explicit'
break
end
end
end
-- Get the short description from Module:GetShortDescription.
return result
local short_description = require('Module:GetShortDescription').main({
none_is_valid = args.none_is_valid,
none_is_nil = args.none_is_nil,
lang_italic = args.desc_lang_italic,
lang_nocat = args.desc_lang_nocat,
lang_size = args.desc_lang_size,
lang_cat = args.desc_lang_cat,
lang_rtl = args.desc_lang_rtl,
lang_no = args.desc_lang_no,
prefer = args.prefer,
only = args.only,
name = name
})
local dash = args.dash
end
if isEmpty(dash) then
 
dash = '&nbsp;–'
function p.main( frame )
local args = getArgs( frame.args )
if not args then
return 'something is severely wrong with this module; send help'
end
return annotatedLink( args )
end
 
local fallback = args.fallback
return p
 
if isEmpty(short_description) or short_description.redlink then
--[[
return formatResult(result, dash, fallback, args.prefix_parentheses)
 
end
{{#invoke:User:Fred Gandt/annotatedLink|main |name= |display= |wedge= |quote= |dash= |abbr= |case= |aka= }}
if short_description.alarm then
p.main { args = { name = "", display = "", wedge = "", quote = "", dash = "", abbr = "", case = "", aka = "" } }
return short_description.alarm
 
end
 
{{#invoke:User:Fred Gandt/annotatedLink|main|name=The Partisan}}
{{#invoke:User:Fred Gandt/annotatedLink|main|name=Author, Author (Star Trek: Voyager)}}
local maintenance = ''
p.main { args = { name = "The Partisan" } }
p.main { args = { name = "Author, Author (Star Trek: Voyager)" } }
if short_description.redirected then
p.main { args = { name = "Confédération Mondiale des Activités Subaquatiques", display = "World Underwater Federation", abbr = "CMAS", aka = "''Confédération Mondiale des Activités Subaquatiques''", case = "lower" } }
maintenance = optionallyVisibleCategory(
'category-annotation-with-redirected-description',
'Pages displaying short descriptions of redirect targets')
end
local fellback
if short_description.wikidata then
-- if short_description.fellback then
-- fellback = true
-- maintenance = maintenance..optionallyVisibleCategory(
-- 'category-wikidata-fallback-annotation',
-- 'Pages displaying wikidata descriptions as a fallback')
-- end
-- short_description = short_description.wikidata
-- Filter against likely rubbish wikidata descriptions.
-- local not_wikidata_descriptions_including = args.not_wikidata_descriptions_including
-- if notEmpty(not_wikidata_descriptions_including) then
-- Case insentive matching.
-- local lower_case_short_description = short_description:lower()
-- for exclusion in hashDelimitedList(not_wikidata_descriptions_including:lower()) do
-- if lower_case_short_description:match(exclusion) then
short_description = ''
-- break
-- end
-- end
-- end
if isEmpty(short_description) then
return formatResult(result, dash, fallback, args.prefix_parentheses)
end
else
short_description = short_description.explicit
end
local lower_case_name = name:lower()
if notEmpty(short_description) and not short_description:match(' ') then
-- Filter against likely rubbish single word descriptions.
local lower_case_short_description = short_description:lower()
local not_single_word = args.not_single_word
if notEmpty(not_single_word) then
-- Case insentive matching.
for single_word in hashDelimitedList(not_single_word:lower()) do
if single_word == lower_case_short_description then
short_description = ''
break
end
end
end
if isEmpty(short_description) or lower_case_name:match(lower_case_short_description) then
return formatResult(result, dash, fallback, args.prefix_parentheses)
end
if isEmpty(args.space_cat) then
maintenance = maintenance..optionallyVisibleCategory(
'category-spaceless-annotation',
'Pages displaying short descriptions with no spaces')
end
end
if lower_case_name == short_description:lower() then
if fellback then
return formatResult(result, dash, fallback, args.prefix_parentheses)
end
maintenance = maintenance..optionallyVisibleCategory(
'category-annotation-matches-name',
'Pages displaying short descriptions matching their page name')
end
-- Short descriptions on en Wikipedia should be formatted with an uppercase first letter, but
-- the typical application of this module will require the first character to be lowercase, but
-- some descriptions may start with proper names and should start with an uppercase letter even if used in an annotaion.
-- By default; this module will not affect the first letter case of descriptions retrieved by Module:GetShortDescription, but
-- the first letter case may be transformed explicitly if required.
local desc_first_letter_case = args.desc_first_letter_case
if desc_first_letter_case == 'upper' or desc_first_letter_case == 'lower' then
short_description = handleFirstLetterCase(short_description, desc_first_letter_case)
end
return formatResult(result, dash, (short_description or fallback)..maintenance, args.prefix_parentheses)
end
 
local p = {}
--]]
 
function p.main(frame)
local args = require('Module:Arguments' ).getArgs(frame)
if isEmpty(args) then
return alarmingMessage('could not getArgs') -- This really would be alarming.
end
return annotatedLink(args)
end
 
return p
Retrieved from "https://en.wikipedia.org/wiki/Module:Annotated_link"