Changes

Module:Category handler/config

2,932 bytes added, 10:59, 7 April 2014
restructure, make most config optional, and add a few items to the blacklist
--------------------------------------------------------------------------------
-- The following config values set the names of parameters that suppress-------------------------------------------------------------------------------- categorisation. They are used with Module:Yesno, and work as follows: Parameter names ---- cfgThese configuration items specify custom parameter names.nocat:Values added ---- Result of yesno(args[cfghere will work in addition to the default English parameter names.nocat]) Effect-- true Categorisation is suppressed-- false Categorisation is allowedTo add one extra name, and theyou can use this format: -- blacklist check is skipped-- nil Categorisation is allowed ---- cfg.categories:foo = 'parameter name' ---- Result of yesno(args[cfg.categories]) Effect ---- true Categorisation is allowedTo add multiple names, and theyou can use this format: ---- blacklist check is skipped -- false Categorisation is suppressed-- nil Categorisation is allowedcfg.nocat foo = {'parameter name 1', 'nocatparameter name 2' cfg.categories = , 'categoriesparameter name 3'} ----------------------------------------------------------------------------------
---- The nocat and categories parameter name for the legacy "category2" parameter. This skips thesuppress-- blacklist if set to the cfg-- categorisation.category2Yes valueThey are used with Module:Yesno, and suppresses categorisationwork as follows:------ if present but equal to anything other than -- cfg.category2Yes ornocat:-- -- Result of yesno(args[cfg.category2Negativenocat]) 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.category2 = 'category2'categories]) Effect---- true Categorisation is allowed, and the---- blacklist check is skipped---- false Categorisation is suppressed---- nil Categorisation is allowed-- cfg.category2Yes nocat = 'yesnocat' -- cfg.category2Negative categories = '¬categories'
-- cfg.subpage is -- The parameter name for the legacy "category2" parameter name to specify how to behave on subpages.This skips the-- -- blacklist if set to the cfg.subpageNo is the category2Yes value , and suppresses---- categorisation if present but equal to specify to not categorise on subpages; anything other than cfg.onlycategory2Yes-- is the value to specify to only categorise on subpages.-- or cfg.subpage = 'subpage'cfgcategory2Negative.subpageNo = 'no'-- cfg.subpageOnly category2 = 'onlycategory2'
-- The -- cfg.subpage is the parameter for data name to specify how to return in all namespacesbehave on subpages.-- cfg.all subpage = 'allsubpage'
---- 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 cfgin all namespaces.other parameter-- in [[Module:Namespace detect]].cfg.other all = 'otherall'
---- The parameter name for data to return if no data is specified for the---- namespace that is detected.-- 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.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' ---- ---- 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 = 'pageonly---------------------------------------------------------------------------------- Blacklist ---- 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. ----------------------------------------------------------------------------------
-- 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/.+$', -- Don't categorise User CSD logs or PROD logs. '^User:.*/[aAcC][sS][dD] ?[lL][oO][gG]', '^User:.*/[pP][rR][oO][dD] ?[lL][oO][gG]rchive' ,  -- Don't categorise archives. '/[aA]rchive', "^Wikipedia:Administrators' noticeboard/IncidentArchive", "^Wikipedia:Administrators' noticeboard/3RRArchive",
}
---------------------------------------------------------------------------------- Default namespaces ---- This is a table of namespaces to categorise by default. They should be in the ---- the format of parameter names accepted by [[Module:Namespace detect]]. ---------------------------------------------------------------------------------- 
cfg.defaultNamespaces = {
'main', 'file', 'help', 'category'
}
Anonymous user