Module:Category handler/config: Difference between revisions
From All Skies Encyclopaedia
imported>Mr. Stradivarius (blacklist tweaks) |
imported>MusikAnimal m (1 revision imported) |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
-- [[Module:Category handler]] configuration data -- |
-- [[Module:Category handler]] configuration data -- |
||
-- Language-specific parameter names and values can be set here. -- |
-- Language-specific parameter names and values can be set here. -- |
||
-- For blacklist config, see [[Module:Category handler/blacklist]]. -- |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
| Line 12: | Line 13: | ||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- Parameter names -- |
-- Parameter names -- |
||
-- These configuration items specify custom parameter names. |
-- 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: -- |
-- To add one extra name, you can use this format: -- |
||
-- -- |
-- -- |
||
-- |
-- foo = 'parameter name', -- |
||
-- -- |
-- -- |
||
-- To add multiple names, you can use this format: -- |
-- 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: |
|||
-- The nocat and categories parameter suppress |
|||
---- |
|||
-- categorisation. They are used with Module:Yesno, and work as follows: |
|||
---- cfg.nocat: |
|||
-- |
|||
---- Result of yesno(args[cfg.nocat]) Effect |
|||
-- cfg.nocat: |
|||
---- true Categorisation is suppressed |
|||
-- |
-- 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(args[cfg.categories]) Effect |
|||
-- cfg.categories: |
|||
---- true Categorisation is allowed, and the |
|||
-- |
-- Result of yesno() Effect |
||
-- true Categorisation is allowed, and |
|||
-- |
-- the blacklist check is skipped |
||
-- false Categorisation is suppressed |
|||
-- cfg.nocat = 'nocat' |
|||
-- nil Categorisation is allowed |
|||
-- cfg.categories = 'categories' |
|||
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 |
|||
-- The parameter name for the legacy "category2" parameter. This skips the |
|||
---- categorisation if present but equal to anything other than cfg.category2Yes |
|||
-- blacklist if set to the cfg.category2Yes value, and suppresses |
|||
---- or cfg.category2Negative. |
|||
-- categorisation if present but equal to anything other than |
|||
-- cfg.category2 = 'category2' |
|||
-- cfg.category2Yes or cfg.category2Negative. |
|||
category2 = 'category2', |
|||
---- cfg.subpage is the parameter name to specify how to behave on subpages. |
|||
-- cfg.subpage = 'subpage' |
|||
-- cfg.subpage is the parameter name to specify how to behave on subpages. |
|||
subpage = 'subpage', |
|||
---- The parameter for data to return in all namespaces. |
|||
-- cfg.all = 'all' |
|||
-- 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. |
|||
-- The parameter name for data to return if no data is specified for the |
|||
-- cfg.other = 'other' |
|||
-- namespace that is detected. |
|||
other = 'other', |
|||
---- 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 |
|||
-- The parameter name used to specify a page other than the current page; |
|||
---- parameter in [[Module:Namespace detect]]. |
|||
-- used for testing and demonstration. |
|||
cfg.demopage = 'page' |
|||
demopage = 'page', |
|||
} |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
| Line 68: | Line 70: | ||
-- value can be specified, like this: -- |
-- 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. -- |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- 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 -- |
|||
-- The categorisation blacklist. Pages that match Lua patterns in this list -- |
|||
-- namespace numbers. -- |
|||
-- will not be categorised. (However, see the explanation of cfg.nocat, -- |
|||
-- cfg.categories and cfg.category2 for some exceptions.) If the namespace -- |
|||
-- name has a space in, it must be written with an underscore, e.g. -- |
|||
-- "Wikipedia_talk". Other parts of the title can have either underscores or -- |
|||
-- spaces. -- |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
cfg. |
cfg.defaultNamespaces = { |
||
[ 0] = true, -- main |
|||
-- Don't categorise the Main Page. |
|||
[ 6] = true, -- file |
|||
'^Main Page$', |
|||
[ 12] = true, -- help |
|||
[ 14] = true, -- category |
|||
-- Don't categorise [[Wikipedia:Cascade-protected items]] or its subpages. |
|||
[100] = true, -- portal |
|||
-- The pattern '%f[/\0]' matches a blank string where the next character is |
|||
[108] = true, -- book |
|||
-- either '/' or the end of the string, and the previous character is not |
|||
-- one of those characters. |
|||
'^Wikipedia:Cascade%-protected items%f[/\0]', |
|||
-- Don't categorise [[User:UBX]], [[User talk:UBX]] or any of their |
|||
-- subpages. This is the userbox "template" space, and often gets |
|||
-- categorised with userbox categories by mistake. |
|||
'^User:UBX%f[/\0]', |
|||
'^User_talk:UBX%f[/\0]', |
|||
-- Don't categorise subpages of [[Wikipedia:Template messages]], but allow |
|||
-- categorisation of the base page. |
|||
'^Wikipedia:Template messages/.+$', |
|||
-- Don't categorise User CSD logs or PROD logs. |
|||
'^User:.*/[cC][sS][dD] ?[lL][oO][gG]', |
|||
'^User:.*/[pP][rR][oO][dD] ?[lL][oO][gG]', |
|||
-- Don't categorise archives. |
|||
'/[aA]rchive', |
|||
"^Wikipedia:Administrators' noticeboard/IncidentArchive", |
|||
"^Wikipedia:Administrators' noticeboard/3RRArchive", |
|||
} |
} |
||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- |
-- Wrappers -- |
||
-- This is a |
-- This is a wrapper template or a list of wrapper templates to be passed to -- |
||
-- [[Module:Arguments]]. -- |
|||
-- the format of parameter names accepted by [[Module:Namespace detect]]. -- |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
cfg.wrappers = 'Template:Category handler' |
|||
cfg.defaultNamespaces = { |
|||
'main', |
|||
'file', |
|||
'help', |
|||
'category' |
|||
} |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
Latest revision as of 06:12, 1 April 2020
Documentation for this module may be created at Module:Category handler/config/doc
--------------------------------------------------------------------------------
-- [[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.
