Module:Protection banner/config: Difference between revisions

From Nonbinary Wiki

< Module:Protection banner

@@ Line 1: / Line 1: @@
 -- This module provides configuration data for [[Module:Protection banner]].
-local cfg = {}
+return {
-cfg.defaultBanners = {
+--------------------------------------------------------------------------------
+--
+--                                BANNER DATA
+--
+--------------------------------------------------------------------------------
+--[[
+-- 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
+-- using ${TEXTLIKETHIS} (a dollar sign preceding a parameter name
+-- enclosed in curly braces).
+--
+--                          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
+-- 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
+-- is set. E.g. "Editing of this page by new or unregistered users is currently
+-- 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".
+-- Defined in the cfg.pagetypes table.
+--
+-- ${PROTECTIONBLURB} - a blurb explaining the protection level of the page, e.g.
+-- "Editing of this page by new or unregistered users is currently disabled"
+--
+-- ${PROTECTIONDATE} - the protection date, if it has been supplied to the
+-- template.
+--
+-- ${PROTECTIONLEVEL} - the protection level, e.g. "fully protected" or
+-- "semi-protected".
+--
+-- ${PROTECTIONLOG} - a link to the protection log or the pending changes log,
+-- depending on the protection action.
+--
+-- ${TALKPAGE} - a link to the talk page. If a section is specified, links
+-- straight to that talk page section.
+--
+-- ${TOOLTIPBLURB} - uses the PAGETYPE, PROTECTIONTYPE and EXPIRY parameters to