Module:Category handler
模块文档[创建]
您可能想要创建本的文档。 编者可以在本模板的沙盒 (创建 | 镜像)和测试样例 (创建)页面进行实验。 请在/doc子页面中添加分类。本模块的子页面。 |
---------------------------------------------------------------------------------- ---- CATEGORY HANDLER ---- ---- This module implements the {{category handler}} template in Lua, ---- with a few improvements: all namespaces and all namespace aliases ---- are supported, and namespace names are detected automatically for ---- the local wiki. This module requires [[Module:Namespace detect]] ---- and [[Module:Yesno]] to be available on the local wiki. It can be ---- configured for different wikis by altering the values in ---- [[Module:Category handler/config]], and pages can be blacklisted ---- from categorisation by using [[Module:Category handler/blacklist]]. ---- ------------------------------------------------------------------------------------ Load required moduleslocal yesno = require('Module:Yesno')-- Lazily load things we don't always needlocal mShared, mappingslocal p = {}---------------------------------------------------------------------------------- Helper functions--------------------------------------------------------------------------------local function trimWhitespace(s, removeBlanks)if type(s) ~= 'string' thenreturn sends = s:match('^%s*(.-)%s*$')if removeBlanks thenif s ~= '' thenreturn selsereturn nilendelsereturn sendend---------------------------------------------------------------------------------- CategoryHandler class--------------------------------------------------------------------------------local CategoryHandler = {}CategoryHandler.__index = CategoryHandlerfunction CategoryHandler.new(data, args)local obj = setmetatable({ _data = data, _args = args }, CategoryHandler)-- Set the title objectdolocal pagename = obj:parameter('demopage')local success, titleObjif pagename thensuccess, titleObj = pcall(mw.title.new, pagename)endif success and titleObj thenobj.title = titleObjif titleObj == mw.title.getCurrentTitle() thenobj._usesCurrentTitle = trueendelseobj.title = mw.title.getCurrentTitle()obj._usesCurrentTitle = trueendend-- Set suppression parameter valuesfor _, key in ipairs{'nocat', 'categories'} dolocal value = obj:parameter(key)value = trimWhitespace(value, true)obj['_' .. key] = yesno(value)enddolocal subpage = obj:parameter('subpage')local category2 = obj:parameter('category2')if type(subpage) == 'string' thensubpage = mw.ustring.lower(subpage)endif type(category2) == 'string' thensubpage = mw.ustring.lower(category2)endobj._subpage = trimWhitespace(subpage, true)obj._category2 = trimWhitespace(category2) -- don't remove blank valuesendreturn objendfunction CategoryHandler:parameter(key)local parameterNames = self._data.parameters[key]local pntype = type(parameterNames)if pntype == 'string' or pntype == 'number' thenreturn self._args[parameterNames]elseif pntype == 'table' thenfor _, name in ipairs(parameterNames) dolocal value = self._args[name]if value ~= nil thenreturn valueendendreturn nilelseerror(string.format('invalid config key "%s"',tostring(key)), 2)endendfunction CategoryHandler:isSuppressedByArguments()return-- See if a category suppression argument has been set.self._nocat == trueor self._categories == falseor (self._category2and self._category2 ~= self._data.category2Yesand self._category2 ~= self._data.category2Negative)-- Check whether we are on a subpage, and see if categories are-- suppressed based on our subpage status.or self._subpage == self._data.subpageNo and self.title.isSubpageor self._subpage == self._data.subpageOnly and not self.title.isSubpageendfunction CategoryHandler:shouldSkipBlacklistCheck()-- Check whether the category suppression arguments indicate we-- should skip the blacklist check.return self._nocat == falseor self._categories == trueor self._category2 == self._data.category2Yesendfunction CategoryHandler:matchesBlacklist()if self._usesCurrentTitle thenreturn self._data.currentTitleMatchesBlacklistelsemShared = mShared or require('Module:Category handler/shared')return mShared.matchesBlacklist(self.title.prefixedText,mw.loadData('Module:Category handler/blacklist'))endendfunction CategoryHandler:isSuppressed()-- Find if categories are suppressed by either the arguments or by-- matching the blacklist.return self:isSuppressedByArguments()or not self:shouldSkipBlacklistCheck() and self:matchesBlacklist()endfunction CategoryHandler:getNamespaceParameters()if self._usesCurrentTitle thenreturn self._data.currentTitleNamespaceParameterselseif not mappings thenmShared = mShared or require('Module:Category handler/shared')mappings = mShared.getParamMappings(true) -- gets mappings with mw.loadDataendreturn mShared.getNamespaceParameters(self.title,mappings)endendfunction CategoryHandler:namespaceParametersExist()-- Find whether any namespace parameters have been specified.-- We use the order "all" --> namespace params --> "other" as this is what-- the old template did.if self:parameter('all') thenreturn trueendif not mappings thenmShared = mShared or require('Module:Category handler/shared')mappings = mShared.getParamMappings(true) -- gets mappings with mw.loadDataendfor ns, params in pairs(mappings) dofor i, param in ipairs(params) doif self._args[param] thenreturn trueendendendif self:parameter('other') thenreturn trueendreturn falseendfunction CategoryHandler:getCategories()local params = self:getNamespaceParameters()local nsCategoryfor i, param in ipairs(params) dolocal value = self._args[param]if value ~= nil thennsCategory = valuebreakendendif nsCategory ~= nil or self:namespaceParametersExist() then-- Namespace parameters exist - advanced usage.if nsCategory == nil thennsCategory = self:parameter('other')endlocal ret = {self:parameter('all')}local numParam = tonumber(nsCategory)if numParam and numParam >= 1 and math.floor(numParam) == numParam then-- nsCategory is an integerret[#ret + 1] = self._args[numParam]elseret[#ret + 1] = nsCategoryendif #ret < 1 thenreturn nilelsereturn table.concat(ret)endelseif self._data.defaultNamespaces[self.title.namespace] then-- Namespace parameters don't exist, simple usage.return self._args[1]endreturn nilend---------------------------------------------------------------------------------- Exports--------------------------------------------------------------------------------local p = {}function p._exportClasses()-- Used for testing purposes.return {CategoryHandler = CategoryHandler}endfunction p._main(args, data)data = data or mw.loadData('Module:Category handler/data')local handler = CategoryHandler.new(data, args)if handler:isSuppressed() thenreturn nilendreturn handler:getCategories()endfunction p.main(frame, data)data = data or mw.loadData('Module:Category handler/data')local args = require('Module:Arguments').getArgs(frame, {wrappers = data.wrappers,valueFunc = function (k, v)v = trimWhitespace(v)if type(k) == 'number' thenif v ~= '' thenreturn velsereturn nilendelsereturn vendend})return p._main(args, data)endreturn p
🔥 Popular: 首页User talk:Zhuyifei1999Special:搜索Wiki Travel:互助客栈/存檔/2014年1月至3月中国行政区划国际电话区号列表联合国教科文组织世界遗产名录新竹縣欧洲非洲File:Map of Asia (zh-hans)-亚洲地图.png亚洲User talk:小躍中东Category:追蹤分類巴尔干意大利香港國際機場User talk:TianyinLeeWiki Travel:互助客栈/存檔/2014年7月至9月Template:Outlinetopic黃刀东南亚印度臺灣丝绸之路Wiki Travel:帮助维基导游的方式大洋洲Wiki Travel:快速贡献指南土耳其台灣高速鐵路User talk:Crystallus0北美洲新北马来语会话手册新豐鄉平顶山南美洲中亚佛罗伦萨屏東縣File:Map of India (zh-hans)-印度地图.png菲律宾泰国File:Vietnam Regions Map (zh-hans)-越南地图.png東蘇丹Wiki Travel:互助客栈/存檔/2013年10月至12月苗栗縣格鲁吉亚Wiki Travel:社区主页User talk:PianoPoet印度尼西亚User:-ZestUser talk:Renamed user 23o2iqy4ewqoiudh阿拉伯語會話手冊File:Malaysia regions map (zh-hans)-马来西亚地图.png中欧User:Vhorvat所罗门群岛Template:Uw-block塞舌尔柬埔寨Wiki Travel:维护面板北港迓媽祖上海File:Map-USA-Regions (zh-hans)-美国地图.png北京福州话会话手册新疆昔日每月目的地俄语会话手册德國臺中Wiki Travel:互助客栈/存檔/2015年1月至3月Wiki Travel:互助客栈/存檔/2021年4月至6月目的地俄羅斯新加坡File:Wikimania 2022 Vector (2022) Presentation.pdf