Module:Protection banner/config: Difference between revisions

    From Nonbinary Wiki
    (various simplifications and formatting)
     
    (127 intermediate revisions by 25 users not shown)
    Line 1: Line 1:
    -- This module provides configuration data for [[Module:Protection banner]].
    -- This module provides configuration data for [[Module:Protection banner]].


    local cfg = {}
    return {


    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------
    -- Banner config
    --
    --                                BANNER DATA
    --
    --------------------------------------------------------------------------------
    --------------------------------------------------------------------------------


    -- A table of protection banners, sorted by protection type.
    --[[
    -- $1 = Intro blurb, e.g. "This page is currently
    -- Banner data consists of six fields:
    --     [[Help:Protection|protected]] from editing"
    -- * text - the main protection text that appears at the top of protection
    -- $2 = "until" or "or until" depending on the expiry
    --  banners.
    -- $3 = "disputes", with or without a section link
    -- * explanation - the text that appears below the main protection text, used
    -- $4 = the type of the page, e.g. "article", "template", or "page"
    --  to explain the details of the protection.
    -- $5 = A blurb "it has been protected for x years, x months and x days."
    -- * tooltip - the tooltip text you see when you move the mouse over a small
    -- $6 = the protection date
    --  padlock icon.
    -- $7 = {{vandal-m|username}} replacement
    -- * link - the page that the small padlock icon links to.
    -- $8 = protection level/type blurb, e.g. "create-protected" or "fully protected"
    -- * alt - the alt text for the small padlock icon. This is also used as tooltip
    -- $9 = the expiry - " until DD Month YYYY". If protection is indefinite, this is the blank string.
    --  text for the large protection banners.
    -- $10 = the icon-reason, prefixed with ", "
    -- * image - the padlock image used in both protection banners and small padlock
    -- $11 = A link to the page history, with display msg['dispute-edit-link-display']
    --  icons.
    -- $12 = A link to the move log, with display msg['dispute-move-link-display']
    --
    -- $13 = A link to the protection log or the pending changes log, with display
    -- The module checks in three separate tables to find a value for each field.
    --       msg['more-details-protection-log-display'] or msg['more-details-pc-log-display']
    -- First it checks the banners table, which has values specific to the reason
    -- $14 = Talk page link
    -- for the page being protected. Then the module checks the defaultBanners
    -- $15 = Edit request link
    -- table, which has values specific to each protection level. Finally, the
    -- $16 = Request unprotection blurb
    -- module checks the masterBanner table, which holds data for protection
    -- $17 = Adds links to edit requests and the talk page if we are on a subject page
    -- templates to use if no data has been found in the previous two tables.
    -- $18 = Deletion discussion link
    --
    -- $19 = Deletion log link
    -- The values in the banner data can take parameters. These are specified
    -- $20 = {{#ifeq:{{NAMESPACE}}|{{ns:6}}|image, included in a high-risk template or message,|high-risk {{pp-meta/pagetype}} }}
    -- using ${TEXTLIKETHIS} (a dollar sign preceding a parameter name
    -- $21 = "semi-protected from editing", "protected from editing" or "move-protected"
    -- enclosed in curly braces).
    -- $22 = "This protection is '''not''' an endorsement of the current version"
    --
    --                         Available parameters:
    --
    -- ${CURRENTVERSION} - a link to the page history or the move log, with the
    -- display message "current-version-edit-display" or
    -- "current-version-move-display".
    --
    -- ${EDITREQUEST} - a link to create an edit request for the current page.
    --
    -- ${EXPLANATIONBLURB} - an explanation blurb, e.g. "Please discuss any changes
    -- on the talk page; you may submit a request to ask an administrator to make<