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

  1. --------------------------------------------------------------------------------
  2. -- [[Module:Category handler]] configuration data --
  3. -- Language-specific parameter names and values can be set here. --
  4. -- For blacklist config, see [[Module:Category handler/blacklist]]. --
  5. --------------------------------------------------------------------------------
  6.  
  7. local cfg = {} -- Don't edit this line.
  8.  
  9. --------------------------------------------------------------------------------
  10. -- Start configuration data --
  11. --------------------------------------------------------------------------------
  12.  
  13. --------------------------------------------------------------------------------
  14. -- Parameter names --
  15. -- These configuration items specify custom parameter names. --
  16. -- To add one extra name, you can use this format: --
  17. -- --
  18. -- foo = 'parameter name', --
  19. -- --
  20. -- To add multiple names, you can use this format: --
  21. -- --
  22. -- foo = {'parameter name 1', 'parameter name 2', 'parameter name 3'}, --
  23. --------------------------------------------------------------------------------
  24.  
  25. cfg.parameters = {
  26. -- The nocat and categories parameter suppress
  27. -- categorisation. They are used with Module:Yesno, and work as follows:
  28. --
  29. -- cfg.nocat:
  30. -- Result of yesno() Effect
  31. -- true Categorisation is suppressed
  32. -- false Categorisation is allowed, and
  33. -- the blacklist check is skipped
  34. -- nil Categorisation is allowed
  35. --
  36. -- cfg.categories:
  37. -- Result of yesno() Effect
  38. -- true Categorisation is allowed, and
  39. -- the blacklist check is skipped
  40. -- false Categorisation is suppressed
  41. -- nil Categorisation is allowed
  42. nocat = 'nocat',
  43. categories = 'categories',
  44. -- The parameter name for the legacy "category2" parameter. This skips the
  45. -- blacklist if set to the cfg.category2Yes value, and suppresses
  46. -- categorisation if present but equal to anything other than
  47. -- cfg.category2Yes or cfg.category2Negative.
  48. category2 = 'category2',
  49. -- cfg.subpage is the parameter name to specify how to behave on subpages.
  50. subpage = 'subpage',
  51. -- The parameter for data to return in all namespaces.
  52. all = 'all',
  53. -- The parameter name for data to return if no data is specified for the
  54. -- namespace that is detected.
  55. other = 'other',
  56. -- The parameter name used to specify a page other than the current page;
  57. -- used for testing and demonstration.
  58. demopage = 'page',
  59. }
  60.  
  61. --------------------------------------------------------------------------------
  62. -- Parameter values --
  63. -- These are set values that can be used with certain parameters. Only one --
  64. -- value can be specified, like this: --
  65. -- --
  66. -- cfg.foo = 'value name' -- --
  67. --------------------------------------------------------------------------------
  68.  
  69. -- The following settings are used with the cfg.category2 parameter. Setting
  70. -- cfg.category2 to cfg.category2Yes skips the blacklist, and if cfg.category2
  71. -- is present but equal to anything other than cfg.category2Yes or
  72. -- cfg.category2Negative then it supresses cateogrisation.
  73. cfg.category2Yes = 'yes'
  74. cfg.category2Negative = '¬'
  75.  
  76. -- The following settings are used with the cfg.subpage parameter.
  77. -- cfg.subpageNo is the value to specify to not categorise on subpages;
  78. -- cfg.subpageOnly is the value to specify to only categorise on subpages.
  79. cfg.subpageNo = 'no'
  80. cfg.subpageOnly = 'only'
  81.  
  82. --------------------------------------------------------------------------------
  83. -- Default namespaces --
  84. -- This is a table of namespaces to categorise by default. The keys are the --
  85. -- namespace numbers. --
  86. --------------------------------------------------------------------------------
  87.  
  88. cfg.defaultNamespaces = {
  89. [ 0] = true, -- main
  90. [ 6] = true, -- file
  91. [ 12] = true, -- help
  92. [ 14] = true, -- category
  93. [100] = true, -- portal
  94. [108] = true, -- book
  95. }
  96.  
  97. --------------------------------------------------------------------------------
  98. -- Wrappers --
  99. -- This is a wrapper template or a list of wrapper templates to be passed to --
  100. -- [[Module:Arguments]]. --
  101. --------------------------------------------------------------------------------
  102.  
  103. cfg.wrappers = 'Template:Category handler'
  104.  
  105. --------------------------------------------------------------------------------
  106. -- End configuration data --
  107. --------------------------------------------------------------------------------
  108.  
  109. return cfg -- Don't edit this line.