Module:Protection banner/config: Difference between revisions

    From Nonbinary Wiki
    (better key for MediaWiki namespace explanation blurb message)
     
    (78 intermediate revisions by 25 users not shown)
    Line 4: Line 4:


    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------
    --
    --                                BANNER DATA
    --                                BANNER DATA
    --
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- PARAMETERS
    --[[
    -- Banner data consists of six fields:
    -- * text - the main protection text that appears at the top of protection
    --  banners.
    -- * explanation - the text that appears below the main protection text, used
    --  to explain the details of the protection.
    -- * tooltip - the tooltip text you see when you move the mouse over a small
    --  padlock icon.
    -- * link - the page that the small padlock icon links to.
    -- * alt - the alt text for the small padlock icon. This is also used as tooltip
    --  text for the large protection banners.
    -- * image - the padlock image used in both protection banners and small padlock
    --  icons.
    --
    -- The module checks in three separate tables to find a value for each field.
    -- First it checks the banners table, which has values specific to the reason
    -- for the page being protected. Then the module checks the defaultBanners
    -- table, which has values specific to each protection level. Finally, the
    -- module checks the masterBanner table, which holds data for protection
    -- templates to use if no data has been found in the previous two tables.
    --
    --
    -- The values in the banner data can take parameters. These are specified
    -- The values in the banner data can take parameters. These are specified
    -- using ${TEXTLIKETHIS} (a dollar sign preceding a parameter name
    -- using ${TEXTLIKETHIS} (a dollar sign preceding a parameter name
    -- enclosed in curly braces). Available parameters:
    -- enclosed in curly braces).
    --
    --                          Available parameters:
    --
    --
    -- ${CURRENTVERSION} - a link to the page history or the move log, with the
    -- ${CURRENTVERSION} - a link to the page history or the move log, with the
    Line 18: Line 41:
    --
    --
    -- ${EDITREQUEST} - a link to create an edit request for the current page.
    -- ${EDITREQUEST} - a link to create an edit request for the current page.
    --
    -- ${EXPIRY} - the protection expiry date in the format DD Month YYYY. If
    -- protection is indefinite or is not set, this is the blank string.
    --
    --
    -- ${EXPLANATIONBLURB} - an explanation blurb, e.g. "Please discuss any changes
    -- ${EXPLANATIONBLURB} - an explanation blurb, e.g. "Please discuss any changes
    Line 31: Line 51:
    -- ${INTROBLURB} - the PROTECTIONBLURB parameter, plus the expiry if an expiry
    -- ${INTROBLURB} - the PROTECTIONBLURB parameter, plus the expiry if an expiry
    -- is set. E.g. "Editing of this page by new or unregistered users is currently  
    -- is set. E.g. "Editing of this page by new or unregistered users is currently  
    -- disabled until dd Month YYYY"
    -- disabled until dd Month YYYY."
    --
    -- ${INTROFRAGMENT} - the same as ${INTROBLURB}, but without final punctuation
    -- so that it can be used in run-on sentences.
    --
    --
    -- ${PAGETYPE} - the type of the page, e.g. "article" or "template".
    -- ${PAGETYPE} - the type of the page, e.g. "article" or "template".
    Line 57: Line 80:
    -- ${VANDAL} - links for the specified username (or the root page name)
    -- ${VANDAL} - links for the specified username (or the root page name)
    -- using Module:Vandal-m.
    -- using Module:Vandal-m.
    --
    --                                Functions
    --
    -- For advanced users, it is possible to use Lua functions instead of strings
    -- in the banner config tables. Using functions gives flexibility that is not
    -- possible just by using parameters. Functions take two arguments, the
    -- protection object and the template arguments, and they must output a string.
    --
    -- For example:
    --
    -- text = function (protectionObj, args)
    --    if protectionObj.level == 'autoconfirmed' then
    --        return 'foo'
    --    else
    --        return 'bar'
    --    end
    -- end
    --
    -- Some protection object properties and methods that may be useful:
    -- protectionObj.action - the protection action
    -- protectionObj.level - the protection level
    -- protectionObj.reason - the protection reason
    -- protectionObj.expiry - the expiry. Nil if unset, the string "indef" if set
    --    to indefinite, and the protection time in unix time if temporary.
    -- protectionObj.protectionDate - the protection date in unix time, or nil if
    --    unspecified.
    -- protectionObj.bannerConfig - the banner config found by the module. Beware
    --    of editing the config field used by the function, as it could create an
    --    infinite loop.
    -- protectionObj:isProtected - returns a boolean showing whether the page is
    --    protected.
    -- protectionObj:isTemporary - returns a boolean showing whether the expiry is
    --    temporary.
    -- protectionObj:isIncorrect - returns a boolean showing whether the protection
    --    template is incorrect.
    --]]
    --]]


     
    -- The master banner data, used if no values have been found in banners or
    --------------------------------------------------------------------------------
    -- defaultBanners.
    -- Banner defaults
    --------------------------------------------------------------------------------
     
    -- If no protection reason is specified, or no banner data exists for the
    -- reason given, then this data will be used for the banner. Individual items
    -- from this data will also be used if that item doesn't exist in the reason-
    -- specific banner config.
     
    masterBanner = {
    masterBanner = {
    text = '${INTROBLURB}.',
    text = '${INTROBLURB}',
    explanation = '${EXPLANATIONBLURB}',
    explanation = '${EXPLANATIONBLURB}',
    tooltip = '${TOOLTIPBLURB}.',
    tooltip = '${TOOLTIPBLURB}',
    link = '${IMAGELINK}',
    link = '${IMAGELINK}',
    alt = 'Page ${PROTECTIONLEVEL}'
    alt = 'Page ${PROTECTIONLEVEL}'
    },
    },


    -- The default banner data. This holds banner data for different protection
    -- levels.
    -- *required* - this table needs edit, move, autoreview and upload subtables.
    defaultBanners = {
    defaultBanners = {
    edit = {},
    edit = {},
    move = {},
    move = {},
    autoreview = {
    autoreview = {
    autoconfirmed = {
    alt = 'Page protected with pending changes level 1',
    tooltip = 'All edits by unregistered and new users are subject to review',
    image = 'Padlock-silver-light.svg'
    },
    default = {
    default = {
    alt = 'Page protected with pending changes level 2',
    alt = 'Page protected with pending changes',
    tooltip = 'All edits by users who are not reviewers or administrators are'
    tooltip = 'All edits by unregistered and new users are subject to review prior to becoming visible to unregistered users',
    .. ' subject to review',
    image = 'Pending-protection-shackle.svg'
    }
    }
    }
    },
    upload = {}
    },
    },


    --------------------------------------------------------------------------------
    -- The banner data. This holds banner data for different protection reasons.
    -- Banner config
    -- In fact, the reasons specified in this table control which reasons are
    --------------------------------------------------------------------------------
    -- valid inputs to the first positional parameter.
     
    --
    -- There is also a non-standard "description" field that can be used for items
    -- in this table. This is a description of the protection reason for use in the
    -- module documentation.
    --
    -- *required* - this table needs edit, move, autoreview and upload subtables.
    banners = {
    banners = {
    edit = {
    edit = {
    Line 103: Line 157:
    description = 'For pages protected to promote compliance with the'
    description = 'For pages protected to promote compliance with the'
    .. ' [[Wikipedia:Biographies of living persons'
    .. ' [[Wikipedia:Biographies of living persons'
    .. '|biographies of living persons]] policy.',
    .. '|biographies of living persons]] policy',
    text = '${INTROBLURB} to promote compliance with'
    text = '${INTROFRAGMENT} to promote compliance with'
    .. ' [[Wikipedia:Biographies of living persons'
    .. ' [[Wikipedia:Biographies of living persons'
    .. "|Wikipedia's policy on the biographies"
    .. "|Wikipedia's policy on the biographies"
    .. ' of living people]].',
    .. ' of living people]].',
    tooltip = '${TOOLTIPBLURB} to promote compliance with the policy on biographies of'
    tooltip = '${TOOLTIPFRAGMENT} to promote compliance with the policy on'
    .. ' living people',
    .. ' biographies of living persons',
    },
    },
    dmca = {
    dmca = {
    description = 'For pages protected by the Wikimedia Foundation'
    description = 'For pages protected by the Wikimedia Foundation'
    .. ' due to Digital Millennium Copyright Act takedown requests.',
    .. ' due to [[Digital Millennium Copyright Act]] takedown requests',
    explanation = function (protectionObj, args)
    explanation = function (protectionObj, args)
    local ret = 'Pursuant to a rights owner notice under the Digital'
    local ret = 'Pursuant to a rights owner notice under the Digital'
    Line 131: Line 185:
    return ret
    return ret
    end,
    end,
    image = 'Padlock-black.svg',
    image = 'Office-protection-shackle.svg',
    },
    },
    dispute = {
    dispute = {
    description = 'For pages protected due to editing disputes.',
    description = 'For pages protected due to editing disputes',
    text = function (protectionObj, args)
    text = function (protectionObj, args)
    -- Find the value of "disputes".
    -- Find the value of "disputes".
    Line 154: Line 208:
    local msg
    local msg
    if type(protectionObj.expiry) == 'number' then
    if type(protectionObj.expiry) == 'number' then
    msg = '${INTROBLURB}, or until editing %s have been resolved.'
    msg = '${INTROFRAGMENT} or until editing %s have been resolved.'
    else
    else
    msg = '${INTROBLURB} until editing %s have been resolved.'
    msg = '${INTROFRAGMENT} until editing %s have been resolved.'
    end
    end
    return string.format(msg, disputes)
    return string.format(msg, disputes)
    Line 162: Line 216:
    explanation = "This protection is '''not''' an endorsement of the"
    explanation = "This protection is '''not''' an endorsement of the"
    .. ' ${CURRENTVERSION}. ${EXPLANATIONBLURB}',
    .. ' ${CURRENTVERSION}. ${EXPLANATIONBLURB}',
    tooltip = '${TOOLTIPBLURB} due to editing disputes',
    tooltip = '${TOOLTIPFRAGMENT} due to editing disputes',
    },
    ecp = {
    description = 'For articles in topic areas authorized by'
    .. ' [[Wikipedia:Arbitration Committee|ArbCom]] or'
    .. ' meets the criteria for community use',
    tooltip = 'This ${PAGETYPE} is extended-confirmed protected',
    alt = 'Extended-protected ${PAGETYPE}',
    },
    },
    mainpage = {
    mainpage = {
    description = 'For pages protected for being displayed on the [[Main Page]].',
    description = 'For pages protected for being displayed on the [[Main Page]]',
    text = 'This file is currently'
    text = 'This file is currently'
    .. ' [[Wikipedia:This page is protected|protected]] from'
    .. ' [[Wikipedia:This page is protected|protected]] from'
    Line 178: Line 239:
    },
    },
    office = {
    office = {
    description = 'For pages protected by the Wikimedia Foundation.',
    description = 'For pages protected by the Wikimedia Foundation',
    text = function (protectionObj, args)
    text = function (protectionObj, args)
    local ret = 'This ${PAGETYPE} is currently under the'
    local ret = 'This ${PAGETYPE} is currently under the'
    Line 184: Line 245:
    .. ' [[Wikipedia:Office actions|Wikimedia Foundation Office]]'
    .. ' [[Wikipedia:Office actions|Wikimedia Foundation Office]]'
    .. ' and is protected.'
    .. ' and is protected.'
    if protectiobObj.protectionDate then
    if protectionObj.protectionDate then
    ret = ret .. ' It has been protected since ${PROTECTIONDATE}.'
    ret = ret .. ' It has been protected since ${PROTECTIONDATE}.'
    end
    end
    Line 193: Line 254:
    .. " page unless you are authorized by the Wikimedia Foundation to do"
    .. " page unless you are authorized by the Wikimedia Foundation to do"
    .. " so.'''",
    .. " so.'''",
    image = 'Padlock-black.svg',
    image = 'Office-protection-shackle.svg',
    },
    },
    reset = {
    reset = {
    description = 'For pages protected by the Wikimedia Foundation and'
    description = 'For pages protected by the Wikimedia Foundation and'
    .. ' "reset" to a bare-bones version.',
    .. ' "reset" to a bare-bones version',
    text = function (protectionObj, args)
    text = 'This ${PAGETYPE} is currently under the'
    .. ' scrutiny of the'
    .. ' [[Wikipedia:Office actions|Wikimedia Foundation Office]]'
    .. ' and is protected.',
    explanation = function (protectionObj, args)
    local ret = ''
    local ret = ''
    if protectionObj.protectionDate then
    if protectionObj.protectionDate then
    ret = ret .. 'On ${PROTECTIONDATE} this article was'
    ret = ret .. 'On ${PROTECTIONDATE} this ${PAGETYPE} was'
    else
    else
    ret = ret .. 'This article has been'
    ret = ret .. 'This ${PAGETYPE} has been'
    end
    end
    ret = ret .. ' reduced to a'
    ret = ret .. ' reduced to a'
    Line 211: Line 276:
    .. ' Standard Wikipedia policies will apply to its rewriting—which'
    .. ' Standard Wikipedia policies will apply to its rewriting—which'
    .. ' will eventually be open to all editors—and will be strictly'
    .. ' will eventually be open to all editors—and will be strictly'
    .. ' enforced. The article has been placed under a level of'
    .. ' enforced. The ${PAGETYPE} has been ${PROTECTIONLEVEL} while'
    .. ' semi-protection temporarily during the rebuilding of this'
    .. ' it is being rebuilt.\n\n'
    .. ' article.\n\nAny insertion of material directly from'
    .. 'Any insertion of material directly from'
    .. ' pre-protection revisions of the article will be removed, as'
    .. ' pre-protection revisions of the ${PAGETYPE} will be removed, as'
    .. ' will any material added to the article that is not properly'
    .. ' will any material added to the ${PAGETYPE} that is not properly'
    .. ' sourced. The associated talk page(s) were also cleared on the'
    .. ' sourced. The associated talk page(s) were also cleared on the'
    .. " same date.\n\n'''Administrators may not override this action"
    .. " same date.\n\n"
    .. ' without approval from someone from the [[WP:OFFICE|Office]].'
    .. "If you can edit this page, please discuss all changes and"
    .. " No editor may remove this notice.'''"
    .. " additions on the ${TALKPAGE} first. '''Do not override"
    .. " this action, and do not remove protection from this page,"
    .. " unless you are authorized by the Wikimedia Foundation"
    .. " to do so. No editor may remove this notice.'''"
     
    return ret
    return ret
    end,
    end,
    explanation = "If you can edit this page, please discuss all changes and"
    image = 'Office-protection-shackle.svg',
    .. " additions on the ${TALKPAGE} first. '''Do not remove protection from this"
    .. " page unless you are authorized by the Wikimedia Foundation to do"
    .. " so.'''",
    image = 'Padlock-black.svg',
    },
    },
    sock = {
    sock = {
    description = 'For pages protected due to'
    description = 'For pages protected due to'
    .. ' [[Wikipedia:Sock puppetry|sock puppetry]].',
    .. ' [[Wikipedia:Sock puppetry|sock puppetry]]',
    text = '${INTROBLURB} to prevent [[Wikipedia:Sock puppetry|sock puppets]] of'
    text = '${INTROFRAGMENT} to prevent [[Wikipedia:Sock puppetry|sock puppets]] of'
    .. ' [[Wikipedia:Blocking policy|blocked]] or'
    .. ' [[Wikipedia:Blocking policy|blocked]] or'
    .. ' [[Wikipedia:List of banned users|banned users]]'
    .. ' [[Wikipedia:Banning policy|banned users]]'
    .. ' from editing it',
    .. ' from editing it.',
    tooltip = '${TOOLTIPBLURB} to prevent sock puppets of blocked or banned users from'
    tooltip = '${TOOLTIPFRAGMENT} to prevent sock puppets of blocked or banned users from'
    .. ' editing it',
    .. ' editing it',
    },
    },
    template = {
    template = {
    description = 'For [[Wikipedia:High-risk templates|high-risk]]'
    description = 'For [[Wikipedia:High-risk templates|high-risk]]'
    .. ' templates and Lua modules.',
    .. ' templates and Lua modules',
    text = 'This is a permanently [[Help:Protection|protected]] ${PAGETYPE},'
    text = 'This is a permanently [[Help:Protection|protected]] ${PAGETYPE},'
    .. ' as it is [[Wikipedia:High-risk templates|high-risk]].',
    .. ' as it is [[Wikipedia:High-risk templates|high-risk]].',
    Line 258: Line 323:
    usertalk = {
    usertalk = {
    description = 'For pages protected against disruptive edits by a'
    description = 'For pages protected against disruptive edits by a'
    .. ' particular user.',
    .. ' particular user',
    text = '${INTROBLURB} to prevent ${VANDAL} from using it to make disruptive edits,'
    text = '${INTROFRAGMENT} to prevent ${VANDAL} from using it to make disruptive edits,'
    .. ' such as abusing the'
    .. ' such as abusing the'
    .. ' {{[[Template:unblock|unblock]]}} template',
    .. ' {{[[Template:unblock|unblock]]}} template.',
    explanation = 'If you cannot edit this user talk page and you need to'
    explanation = 'If you cannot edit this user talk page and you need to'
    .. ' make a change or leave a message, you can'
    .. ' make a change or leave a message, you can'
    Line 275: Line 340:
    vandalism = {
    vandalism = {
    description = 'For pages protected against'
    description = 'For pages protected against'
    .. ' [[Wikipedia:Vandalism|vandalism]].',
    .. ' [[Wikipedia:Vandalism|vandalism]]',
    text = '${INTROBLURB} due to [[Wikipedia:Vandalism|vandalism]].',
    text = '${INTROFRAGMENT} due to [[Wikipedia:Vandalism|vandalism]].',
    explanation = function (protectionObj, args)
    explanation = function (protectionObj, args)
    local ret = ''
    local ret = ''
    Line 285: Line 350:
    return ret .. '${EXPLANATIONBLURB}'
    return ret .. '${EXPLANATIONBLURB}'
    end,
    end,
    tooltip = '${TOOLTIPBLURB} due to vandalism',
    tooltip = '${TOOLTIPFRAGMENT} due to vandalism',
    }
    }
    },
    },
    Line 291: Line 356:
    dispute = {
    dispute = {
    description = 'For pages protected against page moves due to'
    description = 'For pages protected against page moves due to'
    .. ' disputes over the page title.',
    .. ' disputes over the page title',
    explanation = "This protection is '''not''' an endorsement of the"
    explanation = "This protection is '''not''' an endorsement of the"
    .. ' ${CURRENTVERSION}. ${EXPLANATIONBLURB}',
    .. ' ${CURRENTVERSION}. ${EXPLANATIONBLURB}',
    image = 'Padlock-olive.svg'
    image = 'Move-protection-shackle.svg'
    },
    },
    vandalism = {
    vandalism = {
    description = 'For pages protected against'
    description = 'For pages protected against'
    .. ' [[Wikipedia:Vandalism#Page-move vandalism'
    .. ' [[Wikipedia:Vandalism#Page-move vandalism'
    .. ' |page-move vandalism]].'
    .. ' |page-move vandalism]]'
    }
    }
    },
    },
    autoreview = {}
    autoreview = {},
    upload = {}
    },
    },
    --------------------------------------------------------------------------------
    --
    --                            GENERAL DATA TABLES
    --
    --------------------------------------------------------------------------------


    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------
    Line 309: Line 381:
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- This table produces the protection blurbs available with the
    -- ${PROTECTIONBLURB} parameter. It is sorted by protection action and
    -- protection level, and is checked by the module in the following order:
    -- 1. page's protection action, page's protection level
    -- 2. page's protection action, default protection level
    -- 3. "edit" protection action, default protection level
    --
    -- It is possible to use banner parameters inside this table.
    -- *required* - this table needs edit, move, autoreview and upload subtables.
    protectionBlurbs = {
    protectionBlurbs = {
    edit = {
    edit = {
    Line 315: Line 396:
    autoconfirmed = 'Editing of this ${PAGETYPE} by [[Wikipedia:User access'
    autoconfirmed = 'Editing of this ${PAGETYPE} by [[Wikipedia:User access'
    .. ' levels#New users|new]] or [[Wikipedia:User access levels#Unregistered'
    .. ' levels#New users|new]] or [[Wikipedia:User access levels#Unregistered'
    .. ' users|unregistered]] users is currently [[Help:Protection|disabled]]'
    .. ' users|unregistered]] users is currently [[Help:Protection|disabled]]',
    extendedconfirmed = 'This ${PAGETYPE} is currently under extended confirmed protection',
    },
    },
    move = {
    move = {
    Line 322: Line 404:
    },
    },
    autoreview = {
    autoreview = {
    autoconfirmed = 'All edits made to this ${PAGETYPE} by'
    default = 'All edits made to this ${PAGETYPE} by'
    .. ' [[Wikipedia:User access levels#New users|new]] or'
    .. ' [[Wikipedia:User access levels#New users|new]] or'
    .. ' [[Wikipedia:User access levels#Unregistered users|unregistered]]'
    .. ' [[Wikipedia:User access levels#Unregistered users|unregistered]]'
    .. ' users are currently'
    .. ' users are currently'
    .. ' [[Wikipedia:Pending changes|subject to review]]',
    default = 'All edits made to this ${PAGETYPE} by users who are not'
    .. ' [[Wikipedia:Reviewing|reviewers]] or'
    .. ' [[Wikipedia:Administrators|administrators]] are currently'
    .. ' [[Wikipedia:Pending changes|subject to review]]'
    .. ' [[Wikipedia:Pending changes|subject to review]]'
    },
    upload = {
    default = 'Uploading new versions of this ${PAGETYPE} is currently disabled'
    }
    }
    },
    },
    Line 339: Line 420:
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- This table produces the explanation blurbs available with the
    -- ${EXPLANATIONBLURB} parameter. It is sorted by protection action,
    -- protection level, and whether the page is a talk page or not. If the page is
    -- a talk page it will have a talk key of "talk"; otherwise it will have a talk
    -- key of "subject". The table is checked in the following order:
    -- 1. page's protection action, page's protection level, page's talk key
    -- 2. page's protection action, page's protection level, default talk key
    -- 3. page's protection action, default protection level, page's talk key
    -- 4. page's protection action, default protection level, default talk key
    --
    -- It is possible to use banner parameters inside this table.
    -- *required* - this table needs edit, move, autoreview and upload subtables.
    explanationBlurbs = {
    explanationBlurbs = {
    edit = {
    edit = {
    Line 357: Line 450:
    .. '|request unprotection]], [[Special:Userlogin|log in]], or'
    .. '|request unprotection]], [[Special:Userlogin|log in]], or'
    .. ' [[Special:UserLogin/signup|create an account]].',
    .. ' [[Special:UserLogin/signup|create an account]].',
    },
    extendedconfirmed = {
    default = 'Extended confirmed protection prevents edits from all unregistered editors'
    .. ' and registered users with fewer than 30 days tenure and 500 edits.'
    .. ' The [[Wikipedia:Protection policy#extended|policy on community use]]'
    .. ' specifies that extended confirmed protection can be applied to combat'
    .. ' disruption, if semi-protection has proven to be ineffective.'
    .. ' Extended confirmed protection may also be applied to enforce'
    .. ' [[Wikipedia:Arbitration Committee|arbitration sanctions]].'
    .. ' Please discuss any changes on the ${TALKPAGE}; you may'
    .. ' ${EDITREQUEST} to ask for uncontroversial changes supported by'
    .. ' [[Wikipedia:Consensus|consensus]].'
    },
    },
    default = {
    default = {
    Line 397: Line 502:
    },
    },
    autoreview = {
    autoreview = {
    default = {
    default = 'See the [[Wikipedia:Protection policy|'
    .. 'protection policy]] and ${PROTECTIONLOG} for more details.'
    .. ' Edits to this ${PAGETYPE} by new and unregistered users'
    .. ' will not be visible to readers until they are accepted by'
    .. ' a reviewer. To avoid the need for your edits to be'
    .. ' reviewed, you may'
    .. ' [[Wikipedia:Requests for page protection'
    .. '#Current requests for reduction in protection level'
    .. '|request unprotection]], [[Special:Userlogin|log in]], or'
    .. ' [[Special:UserLogin/signup|create an account]].'
    },
    },
    upload = {
    default = {
    default = 'See the [[Wikipedia:Protection policy|'
    .. 'protection policy]] and ${PROTECTIONLOG} for more details.'
    .. ' The page may still be edited but new versions of the file'
    .. ' cannot be uploaded until it is unprotected. You can'
    .. ' request that a new version be uploaded by using a'
    .. ' [[Wikipedia:Edit requests|protected edit request]], or you'
    .. ' can  [[Wikipedia:Requests for page protection|request]]'
    .. ' that the file be unprotected.'
    }
    }
    }
    },
    },
    Line 404: Line 533:
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- This table provides the data for the ${PROTECTIONLEVEL} parameter, which
    -- produces a short label for different protection levels. It is sorted by
    -- protection action and protection level, and is checked in the following
    -- order:
    -- 1. page's protection action, page's protection level
    -- 2. page's protection action, default protection level
    -- 3. "edit" protection action, default protection level
    --
    -- It is possible to use banner parameters inside this table.
    -- *required* - this table needs edit, move, autoreview and upload subtables.
    protectionLevels = {
    protectionLevels = {
    edit = {
    edit = {
    default = 'protected',
    default = 'protected',
    templateeditor = 'template-protected',
    templateeditor = 'template-protected',
    extendedconfirmed = 'extended-protected',
    autoconfirmed = 'semi-protected',
    autoconfirmed = 'semi-protected',
    },
    },
    Line 414: Line 554:
    },
    },
    autoreview = {
    autoreview = {
    },
    upload = {
    default = 'upload-protected'
    }
    }
    },
    },
    Line 421: Line 564:
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- This table lists different padlock images for each protection action and
    -- protection level. It is used if an image is not specified in any of the
    -- banner data tables, and if the page does not satisfy the conditions for using
    -- the ['image-filename-indef'] image. It is checked in the following order:
    -- 1. page's protection action, page's protection level
    -- 2. page's protection action, default protection level
    images = {
    images = {
    edit = {
    edit = {
    sysop = 'Padlock.svg',
    default = 'Full-protection-shackle.svg',
    templateeditor = 'Padlock-pink.svg',
    templateeditor = 'Template-protection-shackle.svg',
    autoconfirmed = 'Padlock-silver.svg'
    extendedconfirmed = 'Extended-protection-shackle.svg',
    autoconfirmed = 'Semi-protection-shackle.svg'
    },
    },
    move = {
    move = {
    sysop = 'Padlock-olive.svg',
    default = 'Move-protection-shackle.svg',
    templateeditor = 'Padlock-olive.svg'
    },
    },
    autoreview = {
    autoreview = {
    autoconfirmed = 'Padlock-silver-light.svg',
    default = 'Pending-protection-shackle.svg'
    reviewer = 'Padlock-orange.svg'
    },
    upload = {
    default = 'Upload-protection-shackle.svg'
    }
    }
    },
    -- Pages with a reason specified in this table will show the special "indef"
    -- padlock, defined in the 'image-filename-indef' message, if no expiry is set.
    indefImageReasons = {
    template = true
    },
    },


    Line 441: Line 598:
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- This table provides the data for the ${IMAGELINK} parameter, which gets
    -- the image link for small padlock icons based on the page's protection action
    -- and protection level. It is checked in the following order:
    -- 1. page's protection action, page's protection level
    -- 2. page's protection action, default protection level
    -- 3. "edit" protection action, default protection level
    --
    -- It is possible to use banner parameters inside this table.
    -- *required* - this table needs edit, move, autoreview and upload subtables.
    imageLinks = {
    imageLinks = {
    edit = {
    edit = {
    default = 'Wikipedia:Protection policy#full',
    default = 'Wikipedia:Protection policy#full',
    templateeditor = 'Wikipedia:Protection policy#template',
    templateeditor = 'Wikipedia:Protection policy#template',
    extendedconfirmed = 'Wikipedia:Protection policy#extended',
    autoconfirmed = 'Wikipedia:Protection policy#semi'
    autoconfirmed = 'Wikipedia:Protection policy#semi'
    },
    },
    Line 451: Line 618:
    },
    },
    autoreview = {
    autoreview = {
    autoconfirmed = 'Wikipedia:Protection policy#pc1',
    default = 'Wikipedia:Protection policy#pending'
    reviewer = 'Wikipedia:Protection policy#pc2'
    },
    upload = {
    default = 'Wikipedia:Protection policy#upload'
    }
    }
    },
    },


    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------
    -- Padlock positions
    -- Padlock indicator names
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- Sets the "right" CSS property for padlock icons, based on its protection
    -- This table provides the "name" attribute for the <indicator> extension tag
    -- action. This determines the position of the padlock among the other top
    -- with which small padlock icons are generated. All indicator tags on a page
    -- icons. If no value is found for the action, the default field is used.
    -- are displayed in alphabetical order based on this attribute, and with
     
    -- indicator tags with duplicate names, the last tag on the page wins.
    padlockPositions = {
    -- The attribute is chosen based on the protection action; table keys must be a
    autoreview = '85px',
    -- protection action name or the string "default".
    default = '55px'
    padlockIndicatorNames = {
    autoreview = 'pp-autoreview',
    default = 'pp-default'
    },
    },


    Line 474: Line 645:


    --[[
    --[[
    -- The protection categories are stored in the cfg.protectionCategories table.
    -- The protection categories are stored in the protectionCategories table.
    -- Keys to this table are made up of the following strings:
    -- Keys to this table are made up of the following strings:
    --
    --
    Line 538: Line 709:
    --]]
    --]]


    -- If the reason specified to the template is listed in this table,
    -- namespace data will take priority over reason data in the protectionCategories
    -- table.
    reasonsWithNamespacePriority = {
    reasonsWithNamespacePriority = {
    -- If the reason specified to the template is listed in this table,
    -- namespace data will take priority over reason data in the protectionCategories
    -- table.
    vandalism = true,
    vandalism = true,
    },
    },


    -- The string to use as a namespace key for the protectionCategories table for each
    -- namespace number.
    categoryNamespaceKeys = {
    categoryNamespaceKeys = {
    -- The string to use as a namespace key for the protectionCategories table for each
    -- namespace number.
    [  2] = 'user',
    [  2] = 'user',
    [  3] = 'user',
    [  3] = 'user',
    Line 557: Line 728:
    [ 14] = 'category',
    [ 14] = 'category',
    [100] = 'portal',
    [100] = 'portal',
    [828] = 'module',
    },
    },


    protectionCategories = {
    protectionCategories = {
    ['all|all|all|all|all']                 = 'Wikipedia protected pages',
    ['all|all|all|all|all']                     = 'Wikipedia fully protected pages',
    ['all|all|office|all|all']               = 'Wikipedia Office-protected pages',
    ['all|all|office|all|all']                 = 'Wikipedia Office-protected pages',
    ['all|all|reset|all|all']               = 'Wikipedia Office-protected pages',
    ['all|all|reset|all|all']                   = 'Wikipedia Office-protected pages',
    ['all|all|dmca|all|all']                 = 'Wikipedia Office-protected pages',
    ['all|all|dmca|all|all']                   = 'Wikipedia Office-protected pages',
    ['all|all|mainpage|all|all']             = 'Protected main page images',
    ['all|all|mainpage|all|all']               = 'Wikipedia fully-protected main page files',
    ['all|template|all|all|edit']           = 'Wikipedia protected templates',
    ['all|all|all|extendedconfirmed|all']      = 'Wikipedia extended-confirmed-protected pages',
    ['all|all|all|autoconfirmed|edit']       = 'Wikipedia semi-protected pages',
    ['all|all|ecp|extendedconfirmed|all']      = 'Wikipedia extended-confirmed-protected pages',
    ['indef|all|all|autoconfirmed|edit']     = 'Wikipedia indefinitely semi-protected pages',
    ['all|template|all|all|edit']               = 'Wikipedia fully protected templates',
    ['all|all|blp|autoconfirmed|edit']       = 'Wikipedia indefinitely semi-protected biographies of living people',
    ['all|all|all|autoconfirmed|edit']         = 'Wikipedia semi-protected pages',
    ['temp|all|blp|autoconfirmed|edit']     = 'Wikipedia temporarily semi-protected biographies of living people',
    ['indef|all|all|autoconfirmed|edit']       = 'Wikipedia indefinitely semi-protected pages',
    ['all|all|dispute|autoconfirmed|edit']   = 'Wikipedia pages semi-protected due to dispute',
    ['all|all|blp|autoconfirmed|edit']         = 'Wikipedia indefinitely semi-protected biographies of living people',
    ['all|all|sock|autoconfirmed|edit']     = 'Wikipedia pages semi-protected from banned users',
    ['temp|all|blp|autoconfirmed|edit']         = 'Wikipedia temporarily semi-protected biographies of living people',
    ['all|all|vandalism|autoconfirmed|edit'] = 'Wikipedia pages semi-protected against vandalism',
    ['all|all|dispute|autoconfirmed|edit']     = 'Wikipedia pages semi-protected due to dispute',
    ['all|category|all|autoconfirmed|edit'] = 'Wikipedia semi-protected categories',
    ['all|all|sock|autoconfirmed|edit']         = 'Wikipedia pages semi-protected from banned users',
    ['all|file|all|autoconfirmed|edit']     = 'Semi-protected images',
    ['all|all|vandalism|autoconfirmed|edit']   = 'Wikipedia pages semi-protected against vandalism',
    ['all|portal|all|autoconfirmed|edit']   = 'Semi-protected portals',
    ['all|category|all|autoconfirmed|edit']     = 'Wikipedia semi-protected categories',
    ['all|project|all|autoconfirmed|edit']   = 'Semi-protected project pages',
    ['all|file|all|autoconfirmed|edit']         = 'Wikipedia semi-protected files',
    ['all|talk|all|autoconfirmed|edit']     = 'Semi-protected talk pages',
    ['all|portal|all|autoconfirmed|edit']       = 'Wikipedia semi-protected portals',
    ['all|template|all|autoconfirmed|edit'] = 'Wikipedia semi-protected templates',
    ['all|project|all|autoconfirmed|edit']     = 'Wikipedia semi-protected project pages',
    ['all|template|all|autoconfirmed|edit'] = 'Wikipedia semi-protected templates',
    ['all|talk|all|autoconfirmed|edit']         = 'Wikipedia semi-protected talk pages',
    ['all|user|all|autoconfirmed|edit']     = 'Wikipedia semi-protected user and user talk pages',
    ['all|template|all|autoconfirmed|edit']     = 'Wikipedia semi-protected templates',
    ['all|all|blp|sysop|edit']               = 'Wikipedia indefinitely protected biographies of living people',
    ['all|user|all|autoconfirmed|edit']         = 'Wikipedia semi-protected user and user talk pages',
    ['temp|all|blp|sysop|edit']             = 'Wikipedia temporarily protected biographies of living people',
    ['all|template|all|templateeditor|edit']    = 'Wikipedia template-protected templates',
    ['all|all|dispute|sysop|edit']           = 'Wikipedia pages protected due to dispute',
    ['all|template|all|templateeditor|move']   = 'Wikipedia template-protected templates', -- move-protected
    ['all|all|sock|sysop|edit']             = 'Wikipedia pages protected from banned users',
    ['all|all|blp|sysop|edit']                 = 'Wikipedia indefinitely protected biographies of living people',
    ['all|all|vandalism|sysop|edit']         = 'Wikipedia pages protected against vandalism',
    ['temp|all|blp|sysop|edit']                 = 'Wikipedia temporarily protected biographies of living people',
    ['all|category|all|sysop|edit']         = 'Wikipedia protected categories',
    ['all|all|dispute|sysop|edit']             = 'Wikipedia pages protected due to dispute',
    ['all|file|all|sysop|edit']             = 'Protected images',
    ['all|all|sock|sysop|edit']                 = 'Wikipedia pages protected from banned users',
    ['all|project|all|sysop|edit']           = 'Protected project pages',
    ['all|all|vandalism|sysop|edit']           = 'Wikipedia pages protected against vandalism',
    ['all|talk|all|sysop|edit']             = 'Protected talk pages',
    ['all|category|all|sysop|edit']             = 'Wikipedia fully protected categories',
    ['all|template|all|sysop|edit']         = 'Wikipedia protected templates',
    ['all|file|all|sysop|edit']                 = 'Wikipedia fully-protected files',
    ['all|user|all|sysop|edit']             = 'Wikipedia protected user and user talk pages',
    ['all|project|all|sysop|edit']             = 'Wikipedia fully-protected project pages',
    ['all|all|all|sysop|move']               = 'Wikipedia move-protected pages',
    ['all|talk|all|sysop|edit']                 = 'Wikipedia fully-protected talk pages',
    ['indef|all|all|sysop|move']             = 'Wikipedia indefinitely move-protected pages',
    ['all|template|all|extendedconfirmed|edit'] = 'Wikipedia extended-confirmed-protected templates',
    ['all|all|dispute|sysop|move']           = 'Wikipedia pages move-protected due to dispute',
    ['all|template|all|sysop|edit']             = 'Wikipedia fully protected templates',
    ['all|all|vandalism|sysop|move']         = 'Wikipedia pages move-protected due to vandalism',
    ['all|user|all|sysop|edit']                 = 'Wikipedia fully protected user and user talk pages',
    ['all|portal|all|sysop|move']           = 'Wikipedia move-protected portals',
    ['all|module|all|all|edit']                = 'Wikipedia fully-protected modules',
    ['all|portal|all|sysop|move']           = 'Wikipedia move-protected portals',
    ['all|module|all|templateeditor|edit']      = 'Wikipedia template-protected modules',
    ['all|project|all|sysop|move']           = 'Wikipedia move-protected project pages',
    ['all|module|all|autoconfirmed|edit']      = 'Wikipedia semi-protected modules',
    ['all|talk|all|sysop|move']             = 'Wikipedia move-protected talk pages',
    ['all|all|all|sysop|move']                 = 'Wikipedia move-protected pages',
    ['all|template|all|sysop|move']         = 'Wikipedia move-protected templates',
    ['indef|all|all|sysop|move']               = 'Wikipedia indefinitely move-protected pages',
    ['all|user|all|sysop|move']             = 'Wikipedia move-protected user and user talk pages',
    ['all|all|dispute|sysop|move']             = 'Wikipedia pages move-protected due to dispute',
    ['all|all|all|autoconfirmed|autoreview'] = 'Wikipedia pending changes protected pages (level 1)',
    ['all|all|vandalism|sysop|move']           = 'Wikipedia pages move-protected due to vandalism',
    ['all|all|all|reviewer|autoreview']     = 'Wikipedia pending changes protected pages (level 2)',
    ['all|portal|all|sysop|move']               = 'Wikipedia move-protected portals',
    ['all|portal|all|sysop|move']               = 'Wikipedia move-protected portals',
    ['all|project|all|sysop|move']             = 'Wikipedia move-protected project pages',
    ['all|talk|all|sysop|move']                 = 'Wikipedia move-protected talk pages',
    ['all|template|all|sysop|move']             = 'Wikipedia move-protected templates',
    ['all|user|all|sysop|move']                 = 'Wikipedia move-protected user and user talk pages',
    ['all|all|all|autoconfirmed|autoreview']   = 'Wikipedia pending changes protected pages',
    ['all|file|all|all|upload']                 = 'Wikipedia upload-protected files',
    },
    },


    Line 610: Line 789:
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- If any of the following reasons is passed to the module, it will not output
    -- This table configures the expiry category behaviour for each protection
    -- the "pages without expiry" tracking category.
    -- action.
    reasonsWithoutExpiryCheck = {
    -- * If set to true, setting that action will always categorise the page if
    blp = true,
    --  an expiry parameter is not set.
    },
    -- * If set to false, setting that action will never categorise the page.
    -- * If set to nil, the module will categorise the page if:
    --  1) an expiry parameter is not set, and
    --  2) a reason is provided, and
    --  3) the specified reason is not blacklisted in the reasonsWithoutExpiryCheck
    --      table.


    -- The module will only output the "pages without expiry" tracking category
    -- for the actions set to true in the following table.
    expiryCheckActions = {
    expiryCheckActions = {
    edit = true,
    edit = nil,
    move = false,
    move = false,
    autoreview = true
    autoreview = true,
    upload = false
    },
     
    reasonsWithoutExpiryCheck = {
    blp = true,
    template = true,
    },
    },


    Line 628: Line 816:
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- This table produces the page types available with the ${PAGETYPE} parameter.
    -- Keys are namespace numbers, or the string "default" for the default value.
    pagetypes = {
    pagetypes = {
    [0] = 'article',
    [0] = 'article',
    Line 641: Line 831:
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- This table contains values passed to the expiry parameter that mean the page
    -- is protected indefinitely.
    indefStrings = {
    indefStrings = {
    ['indef'] = true,
    ['indef'] = true,
    Line 646: Line 838:
    ['indefinitely'] = true,
    ['indefinitely'] = true,
    ['infinite'] = true,
    ['infinite'] = true,
    },
    --------------------------------------------------------------------------------
    -- Group hierarchy
    --------------------------------------------------------------------------------
    -- This table maps each group to all groups that have a superset of the original
    -- group's page editing permissions.
    hierarchy = {
    sysop = {},
    reviewer = {'sysop'},
    filemover = {'sysop'},
    templateeditor = {'sysop'},
    extendedconfirmed = {'sysop'},
    autoconfirmed = {'reviewer', 'filemover', 'templateeditor', 'extendedconfirmed'},
    user = {'autoconfirmed'},
    ['*'] = {'user'}
    },
    },


    Line 652: Line 861:
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- This table contains wrapper templates used with the module, and their
    -- default arguments. Templates specified in this table should contain the
    -- following invocation, and no other template content:
    --
    -- {{#invoke:Protection banner|main}}
    --
    -- If other content is desired, it can be added between
    -- <noinclude>...</noinclude> tags.
    --
    -- When a user calls one of these wrapper templates, they will use the
    -- default arguments automatically. However, users can override any of the
    -- arguments.
    wrappers = {
    wrappers = {
    ['Template:Pp']                        = {},
    ['Template:Pp']                        = {},
    ['Template:Pp-blp']                     = {'blp', action = 'edit'},
    ['Template:Pp-extended']               = {'ecp'},
    ['Template:Pp-blp']                    = {'blp'},
    -- we don't need Template:Pp-create
    -- we don't need Template:Pp-create
    ['Template:Pp-dispute']                = {'dispute', action = 'edit'},
    ['Template:Pp-dispute']                = {'dispute'},
    ['Template:Pp-main-page']               = {'mainpage', action = 'edit'},
    ['Template:Pp-main-page']               = {'mainpage'},
    ['Template:Pp-move']                    = {action = 'move'},
    ['Template:Pp-move']                    = {action = 'move'},
    ['Template:Pp-move-dispute']            = {'dispute', action = 'move'},
    ['Template:Pp-move-dispute']            = {'dispute', action = 'move'},
    Line 664: Line 886:
    ['Template:Pp-office']                  = {'office'},
    ['Template:Pp-office']                  = {'office'},
    ['Template:Pp-office-dmca']            = {'dmca'},
    ['Template:Pp-office-dmca']            = {'dmca'},
    ['Template:Pp-pc1']                     = {action = 'autoreview'},
    ['Template:Pp-pc']                     = {action = 'autoreview', small = true},
    ['Template:Pp-pc2']                    = {action = 'autoreview'},
    ['Template:Pp-pc1']                    = {action = 'autoreview', small = true},
    ['Template:Pp-protected']              = {action = 'edit'},
    ['Template:Pp-reset']                  = {'reset'},
    ['Template:Pp-reset']                  = {'reset'},
    ['Template:Pp-semi-indef']              = {expiry = 'indef'},
    ['Template:Pp-semi-indef']              = {small = true},
    ['Template:Pp-sock']                    = {'sock', action = 'edit'},
    ['Template:Pp-sock']                    = {'sock'},
    ['Template:Pp-template']                = {'template', action = 'edit'},
    ['Template:Pp-template']                = {'template', small = true},
    ['Template:Pp-usertalk']                = {'usertalk', action = 'edit'},
    ['Template:Pp-upload']                  = {action = 'upload'},
    ['Template:Pp-vandalism']              = {'vandalism', action = 'edit'},
    ['Template:Pp-usertalk']                = {'usertalk'},
    ['Template:Pp-vandalism']              = {'vandalism'},
    },
    },


    --------------------------------------------------------------------------------