Module:Protection banner/config: Difference between revisions

    From Nonbinary Wiki
    (get rid of the last of the numbered parameters, and move the binary matrix explanation down to the protectionCategories section)
     
    (110 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 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
    -- display message "current-version-edit-display" or
    -- display message "current-version-edit-display" or
    -- "current-version-move-display".
    -- "current-version-move-display".
    --
    -- ${DELETIONDISCUSSION} - a link to the deletion discussion, if a link
    -- to it was specified.
    --
    -- ${DISPUTEBLURB} - a blurb about editing disputes, using the INTROBLURB
    -- parameter and the DISPUTESECTION parameter. E.g. "This page is protected
    -- from editing until disputes have been resolved."
    --
    -- ${DISPUTESECTION} - if a section link is passed to the module, this is
    -- a link to that section with the display message
    -- "dispute-section-link-display". Otherwise it is just the display
    -- message with no link.
    --
    --
    -- ${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
    -- on the talk page; you may submit a request to ask an administrator to make
    -- on the talk page; you may submit a request to ask an administrator to make
    -- an edit if it is minor or supported by consensus."
    -- an edit if it is minor or supported by consensus."
    --
    -- ${IMAGELINK} - a link to set the image to, depending on the protection
    -- action and protection level.
    --
    --
    -- ${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."
    --
    --
    -- ${OFFICEBLURB} - a blurb about pages protected by the WMF office. If the
    -- ${INTROFRAGMENT} - the same as ${INTROBLURB}, but without final punctuation
    -- protection date has been specified, includes a sentence saying when the page
    -- so that it can be used in run-on sentences.
    -- was protected.