Module:Protection banner/config: Difference between revisions

(124 intermediate revisions by 25 users not shown)

Line 1:

-- 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 =~~ the protection date

-- * tooltip - the tooltip text you see when you move the mouse over a small

-- ~~$6 = {{vandal~~-~~m|username}} replacement~~

-- padlock icon.

-- $~~7 =~~ protection level~~/type blurb~~, e.g. "~~create-~~protected" or "~~fully~~ protected"

-- * link - the page that the small padlock icon links to.

-- $~~8 =~~ the ~~expiry - " until DD Month YYYY". If~~ protection ~~is indefinite~~, ~~this is~~ the ~~blank string~~.

-- * alt - the alt text for the small padlock icon. This is also used as tooltip

-- $~~9 = A~~ link to the page ~~history or the move log~~, ~~with display~~

-- text for the large protection banners.

-- ~~msg['dispute~~-~~edit~~-~~link~~-~~display']~~ or ~~msg['dispute~~-move-~~link~~-~~display']~~

-- * image - the padlock image used in both protection banners and small padlock

-- $~~10 = A link~~ to the protection ~~log or~~ the ~~pending changes log~~, ~~with display~~

-- icons.

-- ~~msg[~~'~~more~~-~~details~~-~~protection~~-~~log~~-~~display~~'~~] or msg[~~'~~more~~-~~details~~-pc-~~log~~-~~display']~~

--

-- ~~$11 = Talk page link~~

-- The module checks in three separate tables to find a value for each field.

-- ~~$12 = Edit request link~~

-- First it checks the banners table, which has values specific to the reason

-- ~~$13 = Request unprotection blurb~~

-- for the page being protected. Then the module checks the defaultBanners

-- ~~$14 = Adds links~~ to ~~edit requests~~ and the ~~talk page~~ if ~~we are on~~ a ~~subject~~ page

-- table, which has values specific to each protection level. Finally, the

-- ~~$15 = Deletion discussion link~~

-- module checks the masterBanner table, which holds data for protection

-- ~~$16 = Deletion log link~~

-- 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

-- create a blurb like "This template is semi-protected", or "This article is

-- move-protected until DD Month YYYY".

--

-- ${VANDAL} - links for the specified username (or the root page name)

-- 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

@@ Line 1: / Line 1: @@
 -- 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 = the protection date
+-- * tooltip - the tooltip text you see when you move the mouse over a small
--- $6 = {{vandal-m|username}} replacement
+--   padlock icon.
--- $7 = protection level/type blurb, e.g. "create-protected" or "fully protected"
+-- * link - the page that the small padlock icon links to.
--- $8 = the expiry - " until DD Month YYYY". If protection is indefinite, this is the blank string.
+-- * alt - the alt text for the small padlock icon. This is also used as tooltip
--- $9 = A link to the page history or the move log, with display
+--   text for the large protection banners.
---       msg['dispute-edit-link-display'] or msg['dispute-move-link-display']
+-- * image - the padlock image used in both protection banners and small padlock
--- $10 = A link to the protection log or the pending changes log, with display
+--   icons.
---       msg['more-details-protection-log-display'] or msg['more-details-pc-log-display']
+--
--- $11 = Talk page link
+-- The module checks in three separate tables to find a value for each field.
--- $12 = Edit request link
+-- First it checks the banners table, which has values specific to the reason
--- $13 = Request unprotection blurb
+-- for the page being protected. Then the module checks the defaultBanners
--- $14 = Adds links to edit requests and the talk page if we are on a subject page
+-- table, which has values specific to each protection level. Finally, the
--- $15 = Deletion discussion link
+-- module checks the masterBanner table, which holds data for protection
--- $16 = Deletion log link
+-- 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
+-- create a blurb like "This template is semi-protected", or "This article is
+-- move-protected until DD Month YYYY".
+--
+-- ${VANDAL} - links for the specified username (or the root page name)
+-- 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