Difference between revisions of "Module:Category handler/config"

From Game Detectives Wiki
Jump to: navigation, search
(return the cfg table)
m (16 revisions imported)
 
(19 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
----------------------------------------------------------------------------------------------------------
+
--------------------------------------------------------------------------------
−
--                                         Configuration data                                         --
+
--           [[Module:Category handler]] configuration data                 --
−
--                     Language-specific parameter names and values can be set here.                   --
+
--       Language-specific parameter names and values can be set here.       --
−
----------------------------------------------------------------------------------------------------------
+
--       For blacklist config, see [[Module:Category handler/blacklist]].    --
 +
--------------------------------------------------------------------------------
  
 
local cfg = {} -- Don't edit this line.
 
local cfg = {} -- Don't edit this line.
  
−
----------------------------------------------------------------------------------------------------------
+
--------------------------------------------------------------------------------
−
--                                         Start configuration data                                     --
+
--                       Start configuration data                             --
−
----------------------------------------------------------------------------------------------------------
+
--------------------------------------------------------------------------------
  
−
-- The following config values set the names of parameters that suppress categorisation. They are used
+
--------------------------------------------------------------------------------
−
-- with Module:Yesno, and work as follows:
+
--                              Parameter names                              --
−
--
+
-- These configuration items specify custom parameter names.                 --
−
-- cfg.nocat:
+
-- To add one extra name, you can use this format:                           --
−
-- Result of yesno(args[cfg.nocat])        Effect
+
--                                                                           --
−
-- true                                    Categorisation is suppressed
+
-- foo = 'parameter name',                                                    --
−
-- false                                    Categorisation is allowed, and the blacklist check is skipped
+
--                                                                           --
−
-- nil                                      Categorisation is allowed
+
-- To add multiple names, you can use this format:                           --
−
--
+
--                                                                           --
−
-- cfg.categories:
+
-- foo = {'parameter name 1', 'parameter name 2', 'parameter name 3'},        --
−
-- 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.parameters = {
−
-- cfg.category2Yes value, and suppresses categorisation if present but equal to anything other than
+
−
-- cfg.category2Yes or cfg.category2Negative.
+
-- The nocat and categories parameter suppress
−
cfg.category2 = 'category2'
+
-- categorisation. They are used with Module:Yesno, and work as follows:
 +
--
 +
-- cfg.nocat:
 +
-- Result of yesno()                        Effect
 +
-- true                                    Categorisation is suppressed
 +
-- false                                    Categorisation is allowed, and
 +
--                                          the blacklist check is skipped
 +
-- nil                                      Categorisation is allowed
 +
--
 +
-- cfg.categories:
 +
-- Result of yesno()                        Effect
 +
-- true                                    Categorisation is allowed, and
 +
--                                          the blacklist check is skipped
 +
-- false                                    Categorisation is suppressed
 +
-- nil                                      Categorisation is allowed
 +
nocat = 'nocat',
 +
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.
 +
category2 = 'category2',
 +
 +
-- cfg.subpage is the parameter name to specify how to behave on subpages.
 +
subpage = 'subpage',
 +
 +
-- The parameter for data to return in all namespaces.
 +
all = 'all',
 +
 +
-- The parameter name for data to return if no data is specified for the
 +
-- namespace that is detected.
 +
other = 'other',
 +
 +
-- The parameter name used to specify a page other than the current page;
 +
-- used for testing and demonstration.
 +
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'                                                    --                                              --
 +
--------------------------------------------------------------------------------
 +
 
 +
-- 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.category2Yes = 'yes'
 
cfg.category2Negative = '¬'
 
cfg.category2Negative = '¬'
  
−
-- cfg.subpage is the parameter name to specify how to behave on subpages. cfg.subpageNo is the value to
+
-- The following settings are used with the cfg.subpage parameter.
−
-- specify to not categorise on subpages; cfg.only is the value to specify to only categorise on subpages.
+
-- cfg.subpageNo is the value to specify to not categorise on subpages;
−
cfg.subpage = 'subpage'
+
-- cfg.subpageOnly is the value to specify to only categorise on subpages.
 
cfg.subpageNo = 'no'
 
cfg.subpageNo = 'no'
 
cfg.subpageOnly = 'only'
 
cfg.subpageOnly = 'only'
  
−
-- The parameter for data to return in all namespaces.
+
--------------------------------------------------------------------------------
−
cfg.all = 'all'
+
--                          Default namespaces                              --
 +
-- This is a table of namespaces to categorise by default. The keys are the  --
 +
-- namespace numbers.                                                         --
 +
--------------------------------------------------------------------------------
  
−
-- The parameter name for data to return if no data is specified for the namespace that is detected. This
+
cfg.defaultNamespaces = {
−
-- must be the same as the cfg.other parameter in [[Module:Namespace detect]].
+
[  0] = true, -- main
−
cfg.other = 'other'
+
[  6] = true, -- file
 +
[ 12] = true, -- help
 +
[ 14] = true, -- category
 +
[100] = true, -- portal
 +
[108] = true, -- book
 +
}
  
−
-- 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]].
+
--                                Wrappers                                    --
−
cfg.page = 'page'
+
-- This is a wrapper template or a list of wrapper templates to be passed to  --
 +
-- [[Module:Arguments]].                                                     --
 +
--------------------------------------------------------------------------------
  
−
-- The categorisation blacklist. Pages that match Lua patterns in this list will not be categorised.
+
cfg.wrappers = 'Template:Category handler'
−
-- (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/.+$',
 
−
   
 
−
    '/[aA]rchive' -- Don't categorise archives.
 
−
}
 
−
 
 
−
-- 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 = {
 
−
    'main',
 
−
    'file',
 
−
    'help',
 
−
    'category'
 
−
}
 
  
−
----------------------------------------------------------------------------------------------------------
+
--------------------------------------------------------------------------------
−
--                                         End configuration data                                     --
+
--                           End configuration data                           --
−
----------------------------------------------------------------------------------------------------------
+
--------------------------------------------------------------------------------
  
 
return cfg -- Don't edit this line.
 
return cfg -- Don't edit this line.

Latest revision as of 02:45, 18 May 2018

Documentation for this module may be created at Module:Category handler/config/doc 

--------------------------------------------------------------------------------
--            [[Module:Category handler]] configuration data                  --
--       Language-specific parameter names and values can be set here.        --
--       For blacklist config, see [[Module:Category handler/blacklist]].     --
--------------------------------------------------------------------------------

local cfg = {} -- Don't edit this line.

--------------------------------------------------------------------------------
--                       Start configuration data                             --
--------------------------------------------------------------------------------

--------------------------------------------------------------------------------
--                              Parameter names                               --
-- These configuration items specify custom parameter names.                  --
-- To add one extra name, you can use this format:                            --
--                                                                            --
-- foo = 'parameter name',                                                    --
--                                                                            --
-- To add multiple names, you can use this format:                            --
--                                                                            --
-- 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:
	--
	-- cfg.nocat:
	-- Result of yesno()                        Effect
	-- true                                     Categorisation is suppressed
	-- false                                    Categorisation is allowed, and
	--                                          the blacklist check is skipped
	-- nil                                      Categorisation is allowed
	--
	-- cfg.categories:
	-- Result of yesno()                        Effect
	-- true                                     Categorisation is allowed, and
	--                                          the blacklist check is skipped
	-- false                                    Categorisation is suppressed
	-- nil                                      Categorisation is allowed
	nocat = 'nocat',
	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.
	category2 = 'category2',
	
	-- cfg.subpage is the parameter name to specify how to behave on subpages.
	subpage = 'subpage',
	
	-- The parameter for data to return in all namespaces.
	all = 'all',
	
	-- The parameter name for data to return if no data is specified for the
	-- namespace that is detected.
	other = 'other',
	
	-- The parameter name used to specify a page other than the current page;
	-- used for testing and demonstration.
	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'                                                     --                                               --
--------------------------------------------------------------------------------

-- 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'

--------------------------------------------------------------------------------
--                           Default namespaces                               --
-- This is a table of namespaces to categorise by default. The keys are the   --
-- namespace numbers.                                                         --
--------------------------------------------------------------------------------

cfg.defaultNamespaces = {
	[  0] = true, -- main
	[  6] = true, -- file
	[ 12] = true, -- 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'

--------------------------------------------------------------------------------
--                           End configuration data                           --
--------------------------------------------------------------------------------

return cfg -- Don't edit this line.
Retrieved from "https://wiki.gamedetectives.net/index.php?title=Module:Category_handler/config&oldid=13301"