Module:Category handler/config - Revision history

Abinash: 12 revisions

2016-04-08T12:23:06Z

12 revisions

Abinash: 1 revision

2016-04-08T11:49:55Z

1 revision

Mr. Stradivarius: Protected Module:Category handler/config: High-risk Lua module ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))

2014-07-13T09:05:36Z

Protected Module:Category handler/config: High-risk Lua module ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))

New page

--------------------------------------------------------------------------------
-- [[Module:Category handler]] configuration data --
-- Language-specific parameter names and values can be set here. --
-- For blacklist config, see [[Module:Category handler/blacklist]]. --
--------------------------------------------------------------------------------

local cfg = {} -- Don't edit this line.

--------------------------------------------------------------------------------
-- Start configuration data --
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
-- Parameter names --
-- These configuration items specify custom parameter names. --
-- To add one extra name, you can use this format: --
-- --
-- foo = 'parameter name', --
-- --
-- To add multiple names, you can use this format: --
-- --
-- foo = {'parameter name 1', 'parameter name 2', 'parameter name 3'}, --
--------------------------------------------------------------------------------

cfg.parameters = {

-- The nocat and categories parameter suppress
-- categorisation. They are used with Module:Yesno, and work as follows:
--
-- cfg.nocat:
-- Result of yesno() Effect
-- true Categorisation is suppressed
-- false Categorisation is allowed, and
-- the blacklist check is skipped
-- nil Categorisation is allowed
--
-- cfg.categories:
-- Result of yesno() Effect
-- true Categorisation is allowed, and
-- the blacklist check is skipped
-- false Categorisation is suppressed
-- nil Categorisation is allowed
nocat = 'nocat',
categories = 'categories',

-- The parameter name for the legacy "category2" parameter. This skips the
-- blacklist if set to the cfg.category2Yes value, and suppresses
-- categorisation if present but equal to anything other than
-- cfg.category2Yes or cfg.category2Negative.
category2 = 'category2',

-- cfg.subpage is the parameter name to specify how to behave on subpages.
subpage = 'subpage',

-- The parameter for data to return in all namespaces.
all = 'all',

-- The parameter name for data to return if no data is specified for the
-- namespace that is detected.
other = 'other',

-- The parameter name used to specify a page other than the current page;
-- used for testing and demonstration.
demopage = 'page',
}

--------------------------------------------------------------------------------
-- Parameter values --
-- These are set values that can be used with certain parameters. Only one --
-- value can be specified, like this: --
-- --
-- cfg.foo = 'value name' -- --
--------------------------------------------------------------------------------

-- The following settings are used with the cfg.category2 parameter. Setting
-- cfg.category2 to cfg.category2Yes skips the blacklist, and if cfg.category2
-- is present but equal to anything other than cfg.category2Yes or
-- cfg.category2Negative then it supresses cateogrisation.
cfg.category2Yes = 'yes'
cfg.category2Negative = '¬'

-- The following settings are used with the cfg.subpage parameter.
-- cfg.subpageNo is the value to specify to not categorise on subpages;
-- cfg.subpageOnly is the value to specify to only categorise on subpages.
cfg.subpageNo = 'no'
cfg.subpageOnly = 'only'

--------------------------------------------------------------------------------
-- Default namespaces --
-- This is a table of namespaces to categorise by default. The keys are the --
-- namespace numbers. --
--------------------------------------------------------------------------------

cfg.defaultNamespaces = {
[ 0] = true, -- main
[ 6] = true, -- file
[ 12] = true, -- help
[ 14] = true, -- category
[100] = true, -- portal
[108] = true, -- book
}

--------------------------------------------------------------------------------
-- Wrappers --
-- This is a wrapper template or a list of wrapper templates to be passed to --
-- [[Module:Arguments]]. --
--------------------------------------------------------------------------------

cfg.wrappers = 'Template:Category handler'

--------------------------------------------------------------------------------
-- End configuration data --
--------------------------------------------------------------------------------

return cfg -- Don't edit this line.

Mr. Stradivarius: update comments

2014-07-08T05:27:50Z

update comments

Mr. Stradivarius: add wrappers config

2014-07-08T02:09:08Z

add wrappers config

Mr. Stradivarius: that must be the other file namespace

2014-07-07T23:57:08Z

that must be the other file namespace

Mr. Stradivarius: use namespace numbers for the default namespaces

2014-07-07T14:37:14Z

use namespace numbers for the default namespaces

Mr. Stradivarius: tweak parameter comments

2014-07-07T07:04:39Z

tweak parameter comments

Mr. Stradivarius: move parameter names to a cfg.parameters subtable

2014-07-07T07:03:44Z

move parameter names to a cfg.parameters subtable

Mr. Stradivarius: don't bother to use default parameter names - allow each wiki to set parameter names however they want

2014-07-07T01:55:54Z

don't bother to use default parameter names - allow each wiki to set parameter names however they want

← Older revision	Revision as of 12:23, 8 April 2016
(2 intermediate revisions by 2 users not shown)
(No difference)

← Older revision	Revision as of 11:49, 8 April 2016
(No difference)

@@ Line 13: / Line 13: @@
 --------------------------------------------------------------------------------
 --                              Parameter names                               --
--- These configuration items specify custom parameter names. Values added     --
+-- These configuration items specify custom parameter names.                  --
--- here will work in addition to the default English parameter names.         --
 -- To add one extra name, you can use this format:                            --
 --                                                                            --
@@ Line 30: / Line 29: @@
 	--
 	-- cfg.nocat:
-	-- Result of yesno(args[cfg.nocat])         Effect
+	-- Result of yesno()                        Effect
 	-- true                                     Categorisation is suppressed
 	-- false                                    Categorisation is allowed, and
@@ Line 37: / Line 36: @@
 	--
 	-- cfg.categories:
-	-- Result of yesno(args[cfg.categories])    Effect
+	-- Result of yesno()                        Effect
 	-- true                                     Categorisation is allowed, and
 	--                                          the blacklist check is skipped
@@ Line 62: / Line 61: @@
 	-- The parameter name used to specify a page other than the current page;
-	-- used for testing and demonstration. This must be the same as the cfg.page
+	-- used for testing and demonstration.
-	-- parameter in [[Module:Namespace detect]].
 	demopage = 'page',
+}
@@ Line 72: / Line 70: @@
 -- value can be specified, like this:                                         --
 --                                                                            --
--- cfg.foo = 'value name'                                                     --
+-- cfg.foo = 'value name'                                                     --                                               --
---                                                                            --
--- These settings are optional. It is always possible to use the module       --
--- defaults instead.                                                          --
 --------------------------------------------------------------------------------
@@ Line 93: / Line 88: @@
 --------------------------------------------------------------------------------
 --                           Default namespaces                               --
--- This is a table of namespaces to categorise by default. They should be in  --
+-- This is a table of namespaces to categorise by default. The keys are the   --
--- the format of parameter names accepted by [[Module:Namespace detect]].     --
+-- namespace numbers.                                                         --
 --------------------------------------------------------------------------------

@@ Line 105: / Line 105: @@
 	[108] = true, -- book
+}
 --------------------------------------------------------------------------------

@@ Line 99: / Line 99: @@
 cfg.defaultNamespaces = {
 	[  0] = true, -- main
-	[  4] = true, -- file
+	[  6] = true, -- file
 	[ 12] = true, -- help
 	[ 14] = true, -- category

@@ Line 17: / Line 17: @@
 -- To add one extra name, you can use this format:                            --
 --                                                                            --
--- cfg.foo = 'parameter name'                                                 --
+-- foo = 'parameter name',                                                    --
 --                                                                            --
 -- To add multiple names, you can use this format:                            --
 --                                                                            --
--- cfg.foo = {'parameter name 1', 'parameter name 2', 'parameter name 3'}     --
+-- foo = {'parameter name 1', 'parameter name 2', 'parameter name 3'},        --
 --------------------------------------------------------------------------------

@@ Line 24: / Line 24: @@
 --------------------------------------------------------------------------------
----- The nocat and categories parameter suppress
+cfg.parameters = {
----- categorisation. They are used with Module:Yesno, and work as follows:
-----
+	-- The nocat and categories parameter suppress
----- cfg.nocat:
+	-- categorisation. They are used with Module:Yesno, and work as follows:
----- Result of yesno(args[cfg.nocat])         Effect
+	--
----- true                                     Categorisation is suppressed
+	-- cfg.nocat:
----- false                                    Categorisation is allowed, and the
+	-- Result of yesno(args[cfg.nocat])         Effect
-----                                          blacklist check is skipped
+	-- true                                     Categorisation is suppressed
----- nil                                      Categorisation is allowed
+	-- false                                    Categorisation is allowed, and
-----
+	--                                          the blacklist check is skipped
----- cfg.categories:
+	-- nil                                      Categorisation is allowed
----- Result of yesno(args[cfg.categories])    Effect
+	--
----- true                                     Categorisation is allowed, and the
+	-- cfg.categories:
-----                                          blacklist check is skipped
+	-- Result of yesno(args[cfg.categories])    Effect
----- false                                    Categorisation is suppressed
+	-- true                                     Categorisation is allowed, and
----- nil                                      Categorisation is allowed
+	--                                          the blacklist check is skipped
-cfg.nocat = 'nocat'
+	-- false                                    Categorisation is suppressed
-cfg.categories = 'categories'
+	-- nil                                      Categorisation is allowed
+	nocat = 'nocat',
----- The parameter name for the legacy "category2" parameter. This skips the
+	categories = 'categories',
----- blacklist if set to the cfg.category2Yes value, and suppresses
----- categorisation if present but equal to anything other than cfg.category2Yes
+	-- The parameter name for the legacy "category2" parameter. This skips the
----- or cfg.category2Negative.
+	-- blacklist if set to the cfg.category2Yes value, and suppresses
-cfg.category2 = 'category2'
+	-- categorisation if present but equal to anything other than
+	-- cfg.category2Yes or cfg.category2Negative.
----- cfg.subpage is the parameter name to specify how to behave on subpages.
+	category2 = 'category2',
-cfg.subpage = 'subpage'
+	-- cfg.subpage is the parameter name to specify how to behave on subpages.
----- The parameter for data to return in all namespaces.
+	subpage = 'subpage',
-cfg.all = 'all'
+	-- The parameter for data to return in all namespaces.
----- The parameter name for data to return if no data is specified for the
+	all = 'all',
----- namespace that is detected.
-cfg.other = 'other'
+	-- The parameter name for data to return if no data is specified for the
+	-- namespace that is detected.
----- The parameter name used to specify a page other than the current page; used
+	other = 'other',
----- for testing and demonstration. This must be the same as the cfg.page
----- parameter in [[Module:Namespace detect]].
+	-- The parameter name used to specify a page other than the current page;
-cfg.demopage = 'page'
+	-- used for testing and demonstration. This must be the same as the cfg.page
 --------------------------------------------------------------------------------
@@ Line 75: / Line 78: @@
 --------------------------------------------------------------------------------
----- The following settings are used with the cfg.category2 parameter. Setting
+-- The following settings are used with the cfg.category2 parameter. Setting
----- cfg.category2 to cfg.category2Yes skips the blacklist, and if cfg.category2
+-- cfg.category2 to cfg.category2Yes skips the blacklist, and if cfg.category2
----- is present but equal to anything other than cfg.category2Yes or
+-- is present but equal to anything other than cfg.category2Yes or
----- cfg.category2Negative then it supresses cateogrisation.
+-- cfg.category2Negative then it supresses cateogrisation.
 cfg.category2Yes = 'yes'
 cfg.category2Negative = '¬'
----- The following settings are used with the cfg.subpage parameter.
+-- The following settings are used with the cfg.subpage parameter.
----- cfg.subpageNo is the value to specify to not categorise on subpages;
+-- cfg.subpageNo is the value to specify to not categorise on subpages;
----- cfg.subpageOnly is the value to specify to only categorise on subpages.
+-- cfg.subpageOnly is the value to specify to only categorise on subpages.
 cfg.subpageNo = 'no'
 cfg.subpageOnly = 'only'