Toggle search
Toggle menu
460
3.3K
88
61.8K
MassiveCraft Wiki
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Module:Hatnote: Difference between revisions

From MassiveCraft Wiki
More actions
← Older edit
starcitizentools>Alistair3149
Sync with upstream
m 1 revision imported
 
(One intermediate revision by the same user not shown)
Line 9: Line 9:
local libraryUtil = require('libraryUtil')
local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local checkType = libraryUtil.checkType
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
local mArguments -- lazily initialise [[Module:Arguments]]
local mArguments -- lazily initialise [[Module:Arguments]]
local yesno -- lazily initialise [[Module:Yesno]]
local yesno -- lazily initialise [[Module:Yesno]]
local formatLink -- lazily initialise [[Module:Format link]] ._formatLink


local p = {}
local p = {}
Line 19: Line 21:


local function getArgs(frame)
local function getArgs(frame)
    -- Fetches the arguments from the parent frame. Whitespace is trimmed and
-- Fetches the arguments from the parent frame. Whitespace is trimmed and
    -- blanks are removed.
-- blanks are removed.
    mArguments = require('Module:Arguments')
mArguments = require('Module:Arguments')
    return mArguments.getArgs(frame, {parentOnly = true})
return mArguments.getArgs(frame, {parentOnly = true})
end
end


local function removeInitialColon(s)
local function removeInitialColon(s)
    -- Removes the initial colon from a string, if present.
-- Removes the initial colon from a string, if present.
    return s:match('^:?(.*)')
return s:match('^:?(.*)')
end
end


function p.defaultClasses(inline)
function p.defaultClasses(inline)
    -- Provides the default hatnote classes as a space-separated string; useful
-- Provides the default hatnote classes as a space-separated string; useful
    -- for hatnote-manipulation modules like [[Module:Hatnote group]].
-- for hatnote-manipulation modules like [[Module:Hatnote group]].
    return
return
    (inline == 1 and 'hatnote-inline' or 'hatnote') .. ' ' ..
(inline == 1 and 'hatnote-inline' or 'hatnote') .. ' ' ..
            'navigation-not-searchable'
'navigation-not-searchable'
end
end


function p.disambiguate(page, disambiguator)
function p.disambiguate(page, disambiguator)
    -- Formats a page title with a disambiguation parenthetical,
-- Formats a page title with a disambiguation parenthetical,
    -- i.e. "Example" → "Example (disambiguation)".
-- i.e. "Example" → "Example (disambiguation)".
    checkType('disambiguate', 1, page, 'string')
checkType('disambiguate', 1, page, 'string')
    checkType('disambiguate', 2, disambiguator, 'string', true)
checkType('disambiguate', 2, disambiguator, 'string', true)
    disambiguator = disambiguator or 'disambiguation'
disambiguator = disambiguator or 'disambiguation'
    return mw.ustring.format('%s (%s)', page, disambiguator)
return mw.ustring.format('%s (%s)', page, disambiguator)
end
end


function p.findNamespaceId(link, removeColon)
function p.findNamespaceId(link, removeColon)
    -- Finds the namespace id (namespace number) of a link or a pagename. This
-- Finds the namespace id (namespace number) of a link or a pagename. This
    -- function will not work if the link is enclosed in double brackets. Colons
-- function will not work if the link is enclosed in double brackets. Colons
    -- are trimmed from the start of the link by default. To skip colon
-- are trimmed from the start of the link by default. To skip colon
    -- trimming, set the removeColon parameter to false.
-- trimming, set the removeColon parameter to false.
    checkType('findNamespaceId', 1, link, 'string')
checkType('findNamespaceId', 1, link, 'string')
    checkType('findNamespaceId', 2, removeColon, 'boolean', true)
checkType('findNamespaceId', 2, removeColon, 'boolean', true)
    if removeColon ~= false then
if removeColon ~= false then
        link = removeInitialColon(link)
link = removeInitialColon(link)
    end
end
    local namespace = link:match('^(.-):')
local namespace = link:match('^(.-):')
    if namespace then
if namespace then
        local nsTable = mw.site.namespaces[namespace]
local nsTable = mw.site.namespaces[namespace]
        if nsTable then
if nsTable then
            return nsTable.id
return nsTable.id
        end
end
    end
end
    return 0
return 0
end
end


function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
    -- Formats an error message to be returned to wikitext. If
-- Formats an error message to be returned to wikitext. If
    -- addTrackingCategory is not false after being returned from
-- addTrackingCategory is not false after being returned from
    -- [[Module:Yesno]], and if we are not on a talk page, a tracking category
-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
    -- is added.
-- is added.
    checkType('makeWikitextError', 1, msg, 'string')
checkType('makeWikitextError', 1, msg, 'string')
    checkType('makeWikitextError', 2, helpLink, 'string', true)
checkType('makeWikitextError', 2, helpLink, 'string', true)
    yesno = require('Module:Yesno')
yesno = require('Module:Yesno')
    title = title or mw.title.getCurrentTitle()
title = title or mw.title.getCurrentTitle()
    -- Make the help link text.
-- Make the help link text.
    local helpText
local helpText
    if helpLink then
if helpLink then
        helpText = ' ([[' .. helpLink .. '|help]])'
helpText = ' ([[' .. helpLink .. '|help]])'
    else
else
        helpText = ''
helpText = ''
    end
end
    -- Make the category text.
-- Make the category text.
    local category
local category
    if not title.isTalkPage -- Don't categorise talk pages
if not title.isTalkPage -- Don't categorise talk pages
            and title.namespace ~= 2 -- Don't categorise userspace
and title.namespace ~= 2 -- Don't categorise userspace
            and yesno(addTrackingCategory) ~= false -- Allow opting out
and yesno(addTrackingCategory) ~= false -- Allow opting out
    then
then
        category = 'Hatnote templates with errors'
category = 'Hatnote templates with errors'
        category = mw.ustring.format(
category = mw.ustring.format(
                '[[%s:%s]]',
'[[%s:%s]]',
                mw.site.namespaces[14].name,
mw.site.namespaces[14].name,
                category
category
        )
)
    else
else
        category = ''
category = ''
    end
end
    return mw.ustring.format(
return mw.ustring.format(
            '<strong class="error">Error: %s%s.</strong>%s',
'<strong class="error">Error: %s%s.</strong>%s',
            msg,
msg,
            helpText,
helpText,
            category
category
    )
)
end
end


local curNs = mw.title.getCurrentTitle().namespace
local curNs = mw.title.getCurrentTitle().namespace
p.missingTargetCat =
p.missingTargetCat =
--Default missing target category, exported for use in related modules
--Default missing target category, exported for use in related modules
((curNs ==  0) or (curNs == 14)) and
((curNs ==  0) or (curNs == 14)) and
        'Articles with hatnote templates targeting a nonexistent page' or nil
'Articles with hatnote templates targeting a nonexistent page' or nil


function p.quote(title)
function p.quote(title)
    --Wraps titles in quotation marks. If the title starts/ends with a quotation
--Wraps titles in quotation marks. If the title starts/ends with a quotation
    --mark, kerns that side as with {{-'}}
--mark, kerns that side as with {{-'}}
    local quotationMarks = {
local quotationMarks = {
        ["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
    }
}
    local quoteLeft, quoteRight = -- Test if start/end are quotation marks
local quoteLeft, quoteRight = -- Test if start/end are quotation marks
    quotationMarks[string.sub(title,  1,  1)],
quotationMarks[string.sub(title,  1,  1)],
    quotationMarks[string.sub(title, -1, -1)]
quotationMarks[string.sub(title, -1, -1)]
    if quoteLeft or quoteRight then
if quoteLeft or quoteRight then
        title = mw.html.create("span"):wikitext(title)
title = mw.html.create("span"):wikitext(title)
    end
end
    if quoteLeft  then title:css("padding-left",  "0.15em") end
if quoteLeft  then title:css("padding-left",  "0.15em") end
    if quoteRight then title:css("padding-right", "0.15em") end
if quoteRight then title:css("padding-right", "0.15em") end
    return '"' .. tostring(title) .. '"'
return '"' .. tostring(title) .. '"'
end
end


Line 134: Line 136:
-- Produces standard hatnote text. Implements the {{hatnote}} template.
-- Produces standard hatnote text. Implements the {{hatnote}} template.
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
local function decorateHatnote(hatnote, options)
    local function getIcon(filename)
        local html = ''
        if type(filename) == 'string' then
            local icon = mw.html.create('span')
            icon
                    :addClass('hatnote-icon')
                    :addClass('metadata')
                    :wikitext('[[File:' .. filename .. '|14px|link=]]')
                    :done()
            html = tostring(icon)
        end
        return html
    end
    local container = mw.html.create('div')
    container
            :addClass('hatnote-container')
            :wikitext(getIcon(options.icon))
            :wikitext(tostring(hatnote))
            :done()
    return container
end


function p.hatnote(frame)
function p.hatnote(frame)
    local args = getArgs(frame)
local args = getArgs(frame)
    local s = args[1]
local s = args[1]
    if not s then
if not s then
        return p.makeWikitextError(
return p.makeWikitextError(
                'no text specified',
'no text specified',
                'Template:Hatnote#Errors',
'Template:Hatnote#Errors',
                args.category
args.category
        )
)
    end
end
    return p._hatnote(s, {
return p._hatnote(s, {
        extraclasses = args.extraclasses,
extraclasses = args.extraclasses,
        selfref = args.selfref
selfref = args.selfref
    })
})
end
end


function p._hatnote(s, options)
function p._hatnote(s, options)
    checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 1, s, 'string')
    checkType('_hatnote', 2, options, 'table', true)
checkType('_hatnote', 2, options, 'table', true)
    options = options or {}
options = options or {}
    local inline = options.inline
local inline = options.inline
    local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
    local extraclasses
local extraclasses
    if type(options.extraclasses) == 'string' then
if type(options.extraclasses) == 'string' then
        extraclasses = options.extraclasses
extraclasses = options.extraclasses
    end
end
 
    hatnote
            :attr('role', 'note')
            :addClass(p.defaultClasses(inline))
            :addClass(extraclasses)
            :addClass(options.selfref and 'selfref' or nil)
            :wikitext(s)


    -- Decorate WP hatnote to SCW standard
hatnote
    hatnote = decorateHatnote(hatnote, options)
:attr('role', 'note')
:addClass(p.defaultClasses(inline))
:addClass(extraclasses)
:addClass(options.selfref and 'selfref' or nil)
:wikitext(s)


    return mw.getCurrentFrame():extensionTag{
return mw.getCurrentFrame():extensionTag{
        name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
    } .. tostring(hatnote)
} .. tostring(hatnote)
end
end


return p
return p
Retrieved from "https://wiki.massivecraft.com/Module:Hatnote"