Title: Module:Category handler/config - freem

URL Source: https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig

Markdown Content:
_Documentation for this module may be created at [Module:Category handler/config/doc](https://freemwiki.com/index.php?title=Module:Category\_handler/config/doc&action=edit&redlink=1 "Module:Category handler/config/doc (page does not exist)")_

[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-1)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-2)-- [[Module:Category handler]] configuration data --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-3)-- Language-specific parameter names and values can be set here. --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-4)-- For blacklist config, see [[Module:Category handler/blacklist]]. --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-5)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-6)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-7)local cfg = {} -- Don't edit this line.[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-8)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-9)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-10)-- Start configuration data --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-11)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-12)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-13)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-14)-- Parameter names --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-15)-- These configuration items specify custom parameter names. --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-16)-- To add one extra name, you can use this format: --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-17)-- --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-18)-- foo = 'parameter name', --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-19)-- --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-20)-- To add multiple names, you can use this format: --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-21)-- --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-22)-- foo = {'parameter name 1', 'parameter name 2', 'parameter name 3'}, --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-23)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-24)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-25)cfg.parameters = {[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-26)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-27)-- The nocat and categories parameter suppress[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-28)-- categorisation. They are used with Module:Yesno, and work as follows:[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-29)--[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-30)-- cfg.nocat:[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-31)-- Result of yesno() Effect[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-32)-- true Categorisation is suppressed[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-33)-- false Categorisation is allowed, and[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-34)-- the blacklist check is skipped[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-35)-- nil Categorisation is allowed[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-36)--[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-37)-- cfg.categories:[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-38)-- Result of yesno() Effect[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-39)-- true Categorisation is allowed, and[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-40)-- the blacklist check is skipped[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-41)-- false Categorisation is suppressed[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-42)-- nil Categorisation is allowed[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-43)nocat = 'nocat',[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-44)categories = 'categories',[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-45)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-46)-- The parameter name for the legacy "category2" parameter. This skips the[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-47)-- blacklist if set to the cfg.category2Yes value, and suppresses[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-48)-- categorisation if present but equal to anything other than[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-49)-- cfg.category2Yes or cfg.category2Negative.[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-50)category2 = 'category2',[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-51)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-52)-- cfg.subpage is the parameter name to specify how to behave on subpages.[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-53)subpage = 'subpage',[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-54)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-55)-- The parameter for data to return in all namespaces.[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-56)all = 'all',[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-57)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-58)-- The parameter name for data to return if no data is specified for the[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-59)-- namespace that is detected.[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-60)other = 'other',[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-61)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-62)-- The parameter name used to specify a page other than the current page;[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-63)-- used for testing and demonstration.[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-64)demopage = 'page',[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-65)}[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-66)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-67)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-68)-- Parameter values --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-69)-- These are set values that can be used with certain parameters. Only one --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-70)-- value can be specified, like this: --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-71)-- --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-72)-- cfg.foo = 'value name' -- --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-73)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-74)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-75)-- The following settings are used with the cfg.category2 parameter. Setting[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-76)-- cfg.category2 to cfg.category2Yes skips the blacklist, and if cfg.category2[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-77)-- is present but equal to anything other than cfg.category2Yes or[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-78)-- cfg.category2Negative then it supresses cateogrisation.[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-79)cfg.category2Yes = 'yes'[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-80)cfg.category2Negative = '¬'[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-81)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-82)-- The following settings are used with the cfg.subpage parameter.[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-83)-- cfg.subpageNo is the value to specify to not categorise on subpages;[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-84)-- cfg.subpageOnly is the value to specify to only categorise on subpages.[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-85)cfg.subpageNo = 'no'[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-86)cfg.subpageOnly = 'only'[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-87)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-88)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-89)-- Default namespaces --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-90)-- This is a table of namespaces to categorise by default. The keys are the --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-91)-- namespace numbers. --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-92)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-93)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-94)cfg.defaultNamespaces = {[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-95)[ 0] = true, -- main[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-96)[ 6] = true, -- file[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-97)[ 12] = true, -- help[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-98)[ 14] = true, -- category[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-99)[100] = true, -- portal[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-100)[108] = true, -- book[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-101)}[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-102)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-103)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-104)-- Wrappers --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-105)-- This is a wrapper template or a list of wrapper templates to be passed to --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-106)-- [[Module:Arguments]]. --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-107)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-108)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-109)cfg.wrappers = 'Template:Category handler'[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-110)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-111)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-112)-- End configuration data --[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-113)--------------------------------------------------------------------------------[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-114)[](https://freemwiki.com/index.php?mobileaction=toggle_view_mobile&oldid=580044&title=Module%3ACategory_handler%2Fconfig#L-115)return cfg -- Don't edit this line.