Module:Category handler/config: Difference between revisions
From All Skies Encyclopaedia
imported>Mr. Stradivarius (return the cfg table) |
imported>MusikAnimal m (1 revision imported) |
||
| (13 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
-------------------------------------------------------------------------------- |
|||
-- |
-- [[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. |
local cfg = {} -- Don't edit this line. |
||
-------------------------------------------------------------------------------- |
|||
-- |
-- Start configuration data -- |
||
-------------------------------------------------------------------------------- |
|||
-------------------------------------------------------------------------------- |
|||
-- The following config values set the names of parameters that suppress categorisation. They are used |
|||
-- Parameter names -- |
|||
-- with Module:Yesno, and work as follows: |
|||
-- These configuration items specify custom parameter names. -- |
|||
-- |
|||
-- To add one extra name, you can use this format: -- |
|||
-- cfg.nocat: |
|||
-- -- |
|||
-- Result of yesno(args[cfg.nocat]) Effect |
|||
-- |
-- foo = 'parameter name', -- |
||
-- |
-- -- |
||
-- |
-- To add multiple names, you can use this format: -- |
||
-- -- |
|||
-- |
|||
-- foo = {'parameter name 1', 'parameter name 2', 'parameter name 3'}, -- |
|||
-- cfg.categories: |
|||
-------------------------------------------------------------------------------- |
|||
-- Result of yesno(args[cfg.categories]) Effect |
|||
-- true Categorisation is allowed, and the blacklist check is skipped |
|||
-- false Categorisation is suppressed |
|||
-- nil Categorisation is allowed |
|||
cfg.nocat = 'nocat' |
|||
cfg.categories = 'categories' |
|||
cfg.parameters = { |
|||
-- 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 |
|||
-- The nocat and categories parameter suppress |
|||
-- cfg.category2Yes or cfg.category2Negative. |
|||
-- categorisation. They are used with Module:Yesno, and work as follows: |
|||
cfg.category2 = 'category2' |
|||
-- |
|||
-- 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.category2Yes = 'yes' |
||
cfg.category2Negative = '¬' |
cfg.category2Negative = '¬' |
||
-- The following settings are used with the cfg.subpage parameter. |
|||
-- cfg.subpage is the parameter name to specify how to behave on subpages. cfg.subpageNo is the value to |
|||
-- |
-- 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.subpage = 'subpage' |
|||
cfg.subpageNo = 'no' |
cfg.subpageNo = 'no' |
||
cfg.subpageOnly = 'only' |
cfg.subpageOnly = 'only' |
||
-------------------------------------------------------------------------------- |
|||
-- The parameter for data to return in all namespaces. |
|||
-- Default namespaces -- |
|||
cfg.all = 'all' |
|||
-- This is a table of namespaces to categorise by default. The keys are the -- |
|||
-- namespace numbers. -- |
|||
-------------------------------------------------------------------------------- |
|||
-- The parameter name for data to return if no data is specified for the namespace that is detected. This |
|||
-- must be the same as the cfg.other parameter in [[Module:Namespace detect]]. |
|||
cfg.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 parameter in [[Module:Namespace detect]]. |
|||
cfg.page = 'page' |
|||
-- The categorisation blacklist. Pages that match Lua patterns in this list 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.blacklist = { |
|||
'^Main Page$', -- don't categorise the main page. |
|||
-- Don't categorise the following pages or their subpages. |
|||
'^Wikipedia:Cascade%-protected items$', |
|||
'^Wikipedia:Cascade%-protected items/.*$', |
|||
'^User:UBX$', -- The userbox "template" space. |
|||
'^User:UBX/.*$', |
|||
'^User_talk:UBX$', |
|||
'^User_talk:UBX/.*$', |
|||
-- Don't categorise subpages of these pages, but allow |
|||
-- categorisation of the base page. |
|||
'^Wikipedia:Template messages/.+$', |
|||
'/[aA]rchive' -- Don't categorise archives. |
|||
} |
|||
-- This is a table of namespaces to categorise by default. They should be in the format of parameter |
|||
-- names accepted by [[Module:Namespace detect]]. |
|||
cfg.defaultNamespaces = { |
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. |
return cfg -- Don't edit this line. |
||
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.
