Module:Category handler/config: Difference between revisions

move parameter names to a cfg.parameters subtable
(don't bother to use default parameter names - allow each wiki to set parameter names however they want)
(move parameter names to a cfg.parameters subtable)
Line 24:
--------------------------------------------------------------------------------
 
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
-- -- Result of yesno(args[cfg.nocat]) Effect
---- false Categorisation is allowed, and the
---- true blacklist checkCategorisation is skippedsuppressed
-- -- nil false Categorisation is allowed, and
---- the blacklist check is skipped
----
-- -- falsenil 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(args[cfg.categories]) Effect
---- blacklist check is skipped
-- -- falsetrue Categorisation is suppressedallowed, and
---- nil Categorisation the blacklist check is allowedskipped
---- true false Categorisation is suppressed
cfg.nocat = 'nocat'
-- -- truenil Categorisation is allowed, and the
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'
-- -- parameter in [[Module:Namespace detect]].
cfg. demopage = 'page',
}
 
--------------------------------------------------------------------------------
Line 75 ⟶ 78:
--------------------------------------------------------------------------------
 
---- 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'
Anonymous user