Модуль:Check for unknown parameters

Матеріал з Вікіпедії — вільної енциклопедії.
Перейти до: навігація, пошук


{{Модуль:Check for unknown parameters}} (і·о·д·р··#)

Модуль викликається з шаблонів, які бажають перевіряти власні виклики з невідомими їм параметрами.


Використання[ред. код]

Базове[ред. код]

{{#invoke:check for unknown parameters|check
|unknown=[[Категорія:Шаблон:<Назва шаблону>:Параметр не підтримується]]
|arg1|arg2|...|argN}}

або щоб відсортувати сторінки з помилками в категорії спостереження за помилковою назвою параметра із повідомленням про помилку у попередньому перегляді

{{#invoke:check for unknown parameters|check
|unknown=[[Категорія:Шаблон:<Назва шаблону>:Параметр не підтримується |_VALUE_]]
|preview=невідомий параметр "_VALUE_"
|arg1|arg2|...|argN}}

або для повідомлення про помилку у тілі сторінки

{{#invoke:check for unknown parameters|check
|unknown=<span class="error">Вибачте, я не розумію параметр «_VALUE_»</span>
|arg1|arg2|...|argN}}

або використати приховані повідомлення про помилку, які можна побачити у вихідному коді HTML, разом з повідомленням у попередньому перегляді

{{#invoke:check for unknown parameters|check
|unknown=<span class="error" style="display:none">HIDDEN ERROR: Usage of "_VALUE_" is not recognized</span>
|preview=unknown parameter "_VALUE_"
|arg1|arg2|...|argN}}

Тут, arg1, arg2, ..., argN — параметри, які вміє обробляти шаблон. Any parameter which is used, but not on this list, will cause the module to return whatever is passed with the unknown parameter. The _VALUE_ keyword, if used, will be changed to the name of the parameter. This is useful for either sorting the entries in a tracking category, or for provide more explicit information.

By default, the module makes no distinction between a defined-but-blank parameter and a non-blank parameter. Щоб відстежувати лише непорожні параметри вкажіть модулю |ignoreblank=1.

Регулярні вирази[ред. код]

Модуль підтримує регулярні вирази, якими зручно користуватися, коли у шаблона багато відомих параметрів за певною маскою назви параметра. Наприклад, {{infobox3cols}} (і·о·д·р··#) використовує

| regexp1 = header[%d][%d]*
| regexp2 = label[%d][%d]*
| regexp3 = data[%d][%d]*[abc]?
| regexp4 = class[%d][%d]*[abc]?
| regexp5 = rowclass[%d][%d]*
| regexp6 = rowstyle[%d][%d]*
| regexp7 = rowcellstyle[%d][%d]*

to match all parameters of the form headerNUM, labelNUM, dataNUM, dataNUMa, dataNUMb, dataNUMc, ..., rowcellstyleNUM, where NUM is a string of digits.

Приклад[ред. код]

{{Infobox
| above = {{{name|}}}

| label1 = Height
| data1 = {{{height|}}}

| label2 = Weight
| data2 = {{{weight|}}}

| label3 = Website
| data3 = {{{website|}}}
}}<!-- 
  end infobox, start tracking
-->{{#invoke:Check for unknown parameters|check
| unknown = [[Category:Some tracking category|_VALUE_]]
| preview = unknown parameter "_VALUE_"
| name
| height | weight
| website
}}

Шаблони на Модуль:Check for unknown parameters[ред. код]

The following is a list of templates which invoke this module, with the associated category for each.

CC-logo.svg

Цей модуль містить код, запозичений з модуля «Check for unknown parameters» англійської Вікіпедії.

Переклад

-- This module may be used to compare the arguments passed to the parent
-- with a list of arguments, returning a specified result if an argument is
-- not on the list
local p = {}

local function trim(s)
  return s:match('^%s*(.-)%s*$')
end

local function isnotempty(s)
  return s and trim(s) ~= ''
end

function p.check (frame)
  local args = frame.args
  local pargs = frame:getParent().args
  local ignoreblank = isnotempty(frame.args['ignoreblank'])
  local showblankpos = isnotempty(frame.args['showblankpositional'])
  local knownargs = {}
  local unknown = frame.args['unknown'] or 'Found _VALUE_, '
  local preview = frame.args['preview']
  local values = {}
  local res = {}
  local regexps = {}
-- create the list of known args, regular expressions, and the return string
  for k, v in pairs(args) do
    if type(k) == 'number' then
      v = trim(v)
      knownargs[v] = 1
    elseif k:find('^regexp[1-9][0-9]*$') then
      table.insert(regexps, '^' .. v .. '$')
    end
  end
  if isnotempty(preview) then
    preview = '<div class="hatnote" style="color:red"><strong>Увага:</strong> ' .. preview .. ' (це повідомлення відображається лише у попередньому перегляді сторінки).</div>'
  elseif preview == nil then
    preview = unknown
  end
-- loop over the parent args, and make sure they are on the list
  for k, v in pairs(pargs) do
    if type(k) == 'string' and knownargs[k] == nil then
      local knownflag = false
      for i, regexp in ipairs(regexps) do
        if mw.ustring.match(k, regexp) then
          knownflag = true
          break
        end
      end
      if not knownflag and ( not ignoreblank or isnotempty(v) ) then
        k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
        table.insert(values, k)
      end
    elseif type(k) == 'number' and knownargs[tostring(k)] == nil and ( showblankpos or isnotempty(v) ) then
      local vlen = mw.ustring.len(v)
      v = mw.ustring.sub(v, 1, (vlen < 25) and vlen or 25)
      v = mw.ustring.gsub(v, '[^%w\-_ ]', '?')
      table.insert(values, k .. ' = ' .. v .. ((vlen >= 25) and ' ...' or ''))
    end
  end
-- add resuls to the output tables
  if #values > 0 then
    if frame:preprocess( "{{REVISIONID}}" ) == "" then
      unknown = preview
    end
    for k, v in pairs(values) do
      if v == '' then
-- Fix odd bug for | = which gets stripped to the empty string and
-- breaks category links
        v = ' '
      end
      local r = unknown:gsub('_VALUE_', v)
      table.insert(res, r)
    end
  end
  return table.concat(res)
end

function p.check_old (frame)
	local args = frame.args
	local pargs = frame:getParent().args
	local ignoreblank = isnotempty(frame.args['ignoreblank'])
	local checkpos = isnotempty(frame.args['checkpositional'])
	local knownargs = {}
	local unknown = 'Found _VALUE_, '

	local res = {}
	local regexps = {}
	local comments = {}
	local commentstr = ''
	
	-- create the list of known args, regular expressions, and the return string
	for k, v in pairs(args) do
		if type(k) == 'number' then
			v = mw.ustring.gsub(v, '^%s*(.-)%s*$', '%1')
			knownargs[v] = 1
		else
			if (k == 'unknown' and type(v) == 'string') then
				unknown = v
			elseif (mw.ustring.match(k, '^regexp[%d]*$') and type(v) == 'string') then
				table.insert(regexps, '^' .. v .. '$')
			end
		end
	end

	-- loop over the parent args, and make sure they are on the list
	for k,v in pairs(pargs) do
		if (type(k) == 'string' and knownargs[k] == nil) then
			local knownflag = nil
			for r = 1,#regexps do
				if( mw.ustring.match(k,regexps[r]) ) then
					knownflag = 1
				end
			end
			if( (not knownflag) and ( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) ) then
				k = mw.ustring.gsub(k, '[^%w\-_ ]', '?')
				local r = mw.ustring.gsub(unknown, '_VALUE_', k)
				table.insert(res, r)
				table.insert(comments, '"' .. k .. '"')
			end
		elseif(checkpos and type(k) == 'number' and knownargs[tostring(k)] == nil) then
			if( (not ignoreblank) or (ignoreblank and isnotempty(v)) ) then
				local r = mw.ustring.gsub(unknown, '_VALUE_', k)
				table.insert(res, r)
				table.insert(comments, '"' .. k .. '"')
			end
		end
	end

	if(#comments > 0) then
		commentstr = '<!-- Module:Check for unknown parameters results: ' ..
			table.concat(comments, ', ') .. '-->'
	end
	
	return table.concat(res) .. commentstr
end

return p