Module:Category handler/config: Difference between revisions

← Older edit

Module:Category handler/config (view source)

Revision as of 23:27, 31 October 2022

165 bytes added , 1 year ago

m

1 revision imported from wikipedia:Module:Category_handler/config

Rob Kam

Bureaucrats, Administrators

2,154

edits

Revision as of 01:55, 7 July 2014 (view source) m>Mr. Stradivarius (don't bother to use default parameter names - allow each wiki to set parameter names however they want) ← Older edit		Latest revision as of 23:27, 31 October 2022 (view source) Rob Kam (talk \| contribs) m (1 revision imported from wikipedia:Module:Category_handler/config)
(12 intermediate revisions by 4 users not shown)
Line 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~~ ~~the~~Effect ---- true ~~blacklist~~ ~~check~~Categorisation is ~~skipped~~suppressed -- -- ~~nil~~ false Categorisation is allowed, and -- the blacklist check is skipped ----▼ -- -- ~~true~~nil Categorisation is allowed~~, and the~~▼ ---- cfg.categories:▼ ▲-- -- ~~---- Result of yesno(args[cfg.categories]) Effect~~ ▲-- -- cfg.categories: ▲---- true Categorisation is allowed, and the ---- Result of yesno() ~~blacklist~~ ~~check~~ is ~~skipped~~Effect -- -- ~~false~~true Categorisation is ~~suppressed~~allowed, and ---- ~~nil~~ ~~Categorisation~~ the blacklist check is ~~allowed~~skipped ▲ --~~-- true~~ false Categorisation is suppressed cfg.nocat = 'nocat' ▼ -- ~~defaults~~nil ~~instead.~~ Categorisation is --allowed▼ cfg.categories = 'categories'▼ ▲~~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▼ ▲-- -- 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.category2Yes~~ cfg.category2 = 'category2'▼ ▲ ---- cfg.category2Yes or cfg.category2Negative. ▲~~cfg.~~ 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. ▲~~cfg.~~ subpage = 'subpage', ---- The parameter for data to return in all namespaces.▼ cfg.all = 'all'▼ ▲-- -- 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.▼ ▲-- -- The parameter name for data to return if no data is specified for the cfg.other = 'other'▼ ▲-- -- 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▼ ▲-- -- The parameter name used to specify a page other than the current page; ~~used~~ ~~---- parameter in [[Module:Namespace detect]].~~ ▲ ---- used for testing and demonstration. ~~This must be the same as the cfg.page~~ ~~cfg.~~ demopage = 'page', } -------------------------------------------------------------------------------- Line 69 ⟶ 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' Line 90 ⟶ 88: -------------------------------------------------------------------------------- -- Default namespaces -- -- This is a table of namespaces to categorise by default. ~~They~~The ~~should~~keys beare the in -- -- namespace numbers. -- ~~-- the format of parameter names accepted by [[Module:Namespace detect]]. --~~ -------------------------------------------------------------------------------- cfg.defaultNamespaces = { [ 0] = true, -- main ~~'main',~~ [ 6] = true, -- file ~~'file',~~ [ 12] = true, -- help ~~'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' --------------------------------------------------------------------------------