Module:Category handler: Difference between revisions

-- --

----------------------------------------------------------------------------------------------------------

----------------------------------------------------------------------------------------------------------

-- Configuration data --

-- Language-specific parameter names and values can be set here. --

----------------------------------------------------------------------------------------------------------

local cfg = {}

-- The following config values set the names of parameters that suppress categorisation. They are used

-- with Module:Yesno, and work as follows:

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 = '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.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.)

cfg.blacklist = {

'^Main Page$', -- don't categorise the main page.

-- Don't categorise the following pages or their subpages.

'^Wikipedia:Cascade%-protected items$',

'^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]].

'category'

}

----------------------------------------------------------------------------------------------------------

-- End configuration data --

----------------------------------------------------------------------------------------------------------

-- Get dependent modules

local nsDetect = require('Module:Namespace detect')

local yesno = require('Module:Yesno')

----------------------------------------------------------------------------------------------------------

-- Local functions --

-- The following are internal functions, which we do not want to be accessible from other modules. --

----------------------------------------------------------------------------------------------------------

-- Find whether we need to return a category or not.

local function needsCategory(pageObject, args)

return true

end

-- Find whether we need to check the blacklist or not.

local function needsBlacklistCheck(args)

end

end

-- Find whether any namespace parameters have been specified.

-- Mappings is the table of parameter mappings taken from

return false

end

----------------------------------------------------------------------------------------------------------

-- Global functions --

-- from other Lua modules. --

----------------------------------------------------------------------------------------------------------

local p = {}

-- Find if a string matches the blacklist. Returns the match if one is found, or nil otherwise.

-- Input should be a page title with a namespace prefix, e.g. "Wikipedia talk:Articles for deletion".

end

end

-- The main structure of the module. Checks whether we need to categorise,

-- and then passes the relevant arguments to [[Module:Namespace detect]].

local pageObject = nsDetect.getPageObject(args[cfg.page])

local mappings = nsDetect.getParamMappings()

if not needsCategory(pageObject, args) then return end

local ret = ''

-- Check blacklist if necessary.

ret = ret .. all

end

-- Get the arguments to pass to [[Module:Namespace detect]].

local ndargs = {}

ndargs.page = args.page

ndargs.demospace = args.demospace

local data = nsDetect._main(ndargs)

-- Work out what to return based on the result of the namespace detect call.

local datanum = tonumber(data)

return ret

end

function p.main(frame)

-- If called via #invoke, use the args passed into the invoking

origArgs = frame

end

-- Trim whitespace and remove blank arguments for the following args:

-- 1, 2, 3 etc., "nocat", "categories", "subpage", and "page".

end

end

-- Lower-case "nocat", "categories", "category2", and "subpage". These

-- parameters are put in lower case whenever they appear in the old

end

end

return p._main(args)

end

return p