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

From Game Detectives Wiki
Jump to: navigation, search
(return the cfg table)
(make this fit within 80 chars)
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.       --
−
----------------------------------------------------------------------------------------------------------
+
--------------------------------------------------------------------------------
  
 
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
+
-- The following config values set the names of parameters that suppress
−
-- with Module:Yesno, and work as follows:
+
-- categorisation. They are used with Module:Yesno, and work as follows:
 
--
 
--
 
-- cfg.nocat:
 
-- cfg.nocat:
 
-- Result of yesno(args[cfg.nocat])        Effect
 
-- Result of yesno(args[cfg.nocat])        Effect
 
-- true                                    Categorisation is suppressed
 
-- true                                    Categorisation is suppressed
−
-- false                                    Categorisation is allowed, and the blacklist check is skipped
+
-- false                                    Categorisation is allowed, and the
 +
--                                          blacklist check is skipped
 
-- nil                                      Categorisation is allowed
 
-- nil                                      Categorisation is allowed
 
--
 
--
 
-- cfg.categories:
 
-- cfg.categories:
 
-- Result of yesno(args[cfg.categories])    Effect
 
-- Result of yesno(args[cfg.categories])    Effect
−
-- true                                    Categorisation is allowed, and the blacklist check is skipped
+
-- true                                    Categorisation is allowed, and the
 +
--                                          blacklist check is skipped
 
-- false                                    Categorisation is suppressed
 
-- false                                    Categorisation is suppressed
 
-- nil                                      Categorisation is allowed
 
-- nil                                      Categorisation is allowed
Line 27: Line 29:
 
cfg.categories = 'categories'
 
cfg.categories = 'categories'
  
−
-- The parameter name for the legacy "category2" parameter. This skips the blacklist if set to the
+
-- The parameter name for the legacy "category2" parameter. This skips the
−
-- cfg.category2Yes value, and suppresses categorisation if present but equal to anything other than
+
-- blacklist if set to the cfg.category2Yes value, and suppresses categorisation
−
-- cfg.category2Yes or cfg.category2Negative.
+
-- if present but equal to anything other than cfg.category2Yes or
 +
-- cfg.category2Negative.
 
cfg.category2 = 'category2'
 
cfg.category2 = 'category2'
 
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
+
-- cfg.subpage is the parameter name to specify how to behave on subpages.
−
-- 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.only
 +
-- is the value to specify to only categorise on subpages.
 
cfg.subpage = 'subpage'
 
cfg.subpage = 'subpage'
 
cfg.subpageNo = 'no'
 
cfg.subpageNo = 'no'
Line 43: Line 47:
 
cfg.all = 'all'
 
cfg.all = 'all'
  
−
-- The parameter name for data to return if no data is specified for the namespace that is detected. This
+
-- The parameter name for data to return if no data is specified for the
−
-- must be the same as the cfg.other parameter in [[Module:Namespace detect]].
+
-- namespace that is detected. This must be the same as the cfg.other parameter
 +
-- in [[Module:Namespace detect]].
 
cfg.other = 'other'
 
cfg.other = 'other'
  
−
-- The parameter name used to specify a page other than the current page; used for testing and
+
-- The parameter name used to specify a page other than the current page; used
−
-- demonstration. This must be the same as the cfg.page parameter in [[Module:Namespace detect]].
+
-- for testing and demonstration. This must be the same as the cfg.page
 +
-- parameter in [[Module:Namespace detect]].
 
cfg.page = 'page'
 
cfg.page = 'page'
  
−
-- The categorisation blacklist. Pages that match Lua patterns in this list will not be categorised.
+
-- The categorisation blacklist. Pages that match Lua patterns in this list will
−
-- (However, see the explanation of cfg.nocat, cfg.categories and cfg.category2 for some exceptions.)
+
-- not be categorised. (However, see the explanation of cfg.nocat,
−
-- If the namespace name has a space in, it must be written with an underscore, e.g. "Wikipedia_talk".
+
-- 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.
 
-- Other parts of the title can have either underscores or spaces.
 
cfg.blacklist = {
 
cfg.blacklist = {
Line 73: Line 80:
 
}
 
}
  
−
-- This is a table of namespaces to categorise by default. They should be in the format of parameter
+
-- This is a table of namespaces to categorise by default. They should be in the
−
-- names accepted by [[Module:Namespace detect]].
+
-- format of parameter names accepted by [[Module:Namespace detect]].
 
cfg.defaultNamespaces = {
 
cfg.defaultNamespaces = {
 
     'main',
 
     'main',
Line 82: Line 89:
 
}
 
}
  
−
----------------------------------------------------------------------------------------------------------
+
--------------------------------------------------------------------------------
−
--                                         End configuration data                                     --
+
--                           End configuration data                           --
−
----------------------------------------------------------------------------------------------------------
+
--------------------------------------------------------------------------------
  
 
return cfg -- Don't edit this line.
 
return cfg -- Don't edit this line.

Revision as of 16:08, 7 April 2014

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

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

--------------------------------------------------------------------------------
--                       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:
--
-- 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.category2Yes = 'yes'
cfg.category2Negative = '¬'

-- cfg.subpage is the parameter name to specify how to behave on subpages.
-- cfg.subpageNo is the value to specify to not categorise on subpages; cfg.only
-- is the value to specify to only categorise on subpages.
cfg.subpage = 'subpage'
cfg.subpageNo = 'no'
cfg.subpageOnly = 'only'

-- 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. This must be the same as the cfg.other parameter
-- in [[Module:Namespace detect]].
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.page = 'page'

-- The categorisation blacklist. Pages that match Lua patterns in this list will
-- not be categorised. (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                           --
--------------------------------------------------------------------------------

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