Editing Module:Category handler/config
From MINR.ORG WIKI
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 13: | Line 13: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
-- Parameter names -- | -- Parameter names -- | ||
| − | -- These configuration items specify custom 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: -- | -- To add one extra name, you can use this format: -- | ||
-- -- | -- -- | ||
| − | -- foo = 'parameter name' | + | -- cfg.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.foo = {'parameter name 1', 'parameter name 2', 'parameter name 3'} -- |
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
| − | + | ---- 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 | |
| − | + | ---- 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 | |
| − | + | ---- true Categorisation is allowed, and the | |
| − | + | ---- blacklist check is skipped | |
| − | + | ---- false Categorisation is suppressed | |
| − | + | ---- nil Categorisation is allowed | |
| − | + | cfg.nocat = 'nocat' | |
| − | + | cfg.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. | |
| − | + | cfg.category2 = 'category2' | |
| − | + | ||
| − | + | ---- cfg.subpage is the parameter name to specify how to behave on subpages. | |
| − | + | cfg.subpage = 'subpage' | |
| − | + | ||
| − | + | ---- The parameter for data to return in all namespaces. | |
| − | + | cfg.all = 'all' | |
| − | + | ||
| − | + | ---- 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' | |
| − | |||
| − | |||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
| Line 70: | Line 69: | ||
-- 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 | + | ---- The following settings are used with the cfg.category2 parameter. Setting |
| − | -- cfg.category2 to cfg.category2Yes skips the blacklist, and if cfg.category2 | + | ---- cfg.category2 to cfg.category2Yes skips the blacklist, and if cfg.category2 |
| − | -- is present but equal to anything other than cfg.category2Yes or | + | ---- is present but equal to anything other than cfg.category2Yes or |
| − | -- cfg.category2Negative then it supresses cateogrisation. | + | ---- 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. | + | ---- The following settings are used with the cfg.subpage parameter. |
| − | -- cfg.subpageNo is the value to specify to not categorise on subpages; | + | ---- 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.subpageOnly is the value to specify to only categorise on subpages. |
cfg.subpageNo = 'no' | cfg.subpageNo = 'no' | ||
cfg.subpageOnly = 'only' | cfg.subpageOnly = 'only' | ||
| Line 88: | Line 90: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
-- Default namespaces -- | -- Default namespaces -- | ||
| − | -- This is a table of namespaces to categorise by default. | + | -- 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 = { | ||
| − | + | 'main', | |
| − | + | 'file', | |
| − | + | 'help', | |
| − | + | 'category' | |
| − | |||
| − | |||
} | } | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||