Module:Category handler/config: Difference between revisions

m
(restructure, make most config optional, and add a few items to the blacklist)
m (1 revision imported from wikipedia:Module:Category_handler/config)
 
(14 intermediate revisions by 4 users not shown)
Line 2:
-- [[Module:Category handler]] configuration data --
-- Language-specific parameter names and values can be set here. --
-- For blacklist config, see [[Module:Category handler/blacklist]]. --
--------------------------------------------------------------------------------
 
Line 12 ⟶ 13:
--------------------------------------------------------------------------------
-- Parameter names --
-- These configuration items specify custom parameter names. Values added --
-- here will work in addition to the default English parameter names. --
-- To add one extra name, you can use this format: --
-- --
-- cfg.foo = 'parameter name', --
-- --
-- To add multiple names, you can use this format: --
-- --
-- cfg.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
---- false Result of yesno() Categorisation is allowed, and theEffect
---- true blacklist checkCategorisation is skippedsuppressed
-- -- nil 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() blacklist check is skippedEffect
-- -- falsetrue Categorisation is suppressedallowed, and
---- nil Categorisation the blacklist check is allowedskipped
-- 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 ⟶ 70:
-- value can be specified, like this: --
-- --
-- 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 Blacklist 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.blacklistdefaultNamespaces = {
'^Main[ Page$' 0] = true, -- don't categorise the main page.
[ 6] = true, -- file
 
[ 12] = true, -- help
-- Don't categorise the following pages or their subpages.
[ 14] = true, -- category
'^Wikipedia:Cascade%-protected items$',
[100] = true, -- portal
'^Wikipedia:Cascade%-protected items/.*$',
[108] = true, -- book
'^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/.+$',
 
-- 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",
}
 
--------------------------------------------------------------------------------
-- Default namespaces Wrappers --
-- This is a tablewrapper oftemplate namespacesor toa categoriselist byof default.wrapper Theytemplates shouldto be inpassed to --
-- [[Module:Arguments]]. --
-- the format of parameter names accepted by [[Module:Namespace detect]]. --
--------------------------------------------------------------------------------
 
cfg.wrappers = 'Template:Category handler'
cfg.defaultNamespaces = {
'main',
'file',
'help',
'category'
}
 
--------------------------------------------------------------------------------