模組:IfUtil
外观
![]() | 此模块被引用於約172,000個頁面。 為了避免造成大規模的影響,所有對此模块的編輯應先於沙盒或測試樣例上測試。 測試後無誤的版本可以一次性地加入此模块中,但是修改前請務必於討論頁發起討論。 模板引用數量會自動更新。 |
ifnewhtmlline
判斷輸入字串中是否存在HTML的換行標籤
noTrim
由於預設的解析器函數(如{{#if:}}
、{{#ifexpr:}}
)會自動將輸入的參數做去除頭尾空白或斷行字元的操作
這對部分需要使替換引用結果出現換行又要避免出現尾部佔位符(如在換行後加入<!---->
或{{void}}
等作法避免trim)是不可行的,或者需要較複雜的語法書寫方式(参见mw:Manual:Newlines_and_spaces#Trimming_on_expansion),這將使的模板代碼的可讀性和可維護性變得十分的差,並且增加模板展開調用甚至可能增加維基媒體伺服器的運作負擔。
因此為了解決{{#if:}}
、{{#ifexpr:}}
和{{if}}
會自動將參數trim掉的問題,因此這個模組透過Module:Arguments將關閉參數trim功能提供了一個解決方案。
基本用法
{{#invoke:ifUtil
|noTrim|命令|判斷參數|成立時返回|不成立時返回}}
- 簡易用法
- 進階用法
{{yesno}}
- 參數順序:
{{#invoke:ifUtil|noTrim|yesno|布林值|為真時(yes)|為假時(no)|空白時(blank)|非法輸入時(def)|未定義時(¬)}}
- 參數順序:
- if...elseif...else
{{#invoke:ifUtil|noTrim|expr|判斷式1|式1為真時|式1為假時}}
{{#invoke:ifUtil|noTrim|expr|判斷式1|式1為真時|elseif判斷式2|式2為真時}}
{{#invoke:ifUtil|noTrim|expr|判斷式1|式1為真時|elseif判斷式2|式2為真時|皆為假時}}
{{#invoke:ifUtil|noTrim|expr|判斷式1|式1為真時|elseif判斷式2|式2為真時|elseif判斷式3|式3為真時}}
{{#invoke:ifUtil|noTrim|expr|判斷式1|式1為真時|elseif判斷式2|式2為真時|elseif判斷式3|式3為真時|皆為假時}}
- 以此類推,參數長度沒有上限 (除了WP:模板限制)
- 比較
注意留意「文字」與「Yse/No」模板間的空格狀況
項目 | 使用Module:IfUtil#noTrim | 使用Help:解析器函數 | ||
---|---|---|---|---|
您所輸入的 | 您所看到的 | 您所輸入的 | 您所看到的 | |
#ifexpr: |
文字{{#invoke:IfUtil|noTrim|expr|5>3|
Yes
|
No
}}文字
|
文字脚本错误:函数“noTrim”不存在。文字 | 文字{{#ifexpr:5>3|
Yes
|
No
}}文字
|
文字Yes文字 |
#ifexpr: |
文字{{#invoke:IfUtil|noTrim|expr|5<3|
Yes
|
No
}}文字
|
文字脚本错误:函数“noTrim”不存在。文字 | 文字{{#ifexpr:5<3|
Yes
|
No
}}文字
|
文字No文字 |
#ifeq: |
文字{{#invoke:IfUtil|noTrim|eq|A|A|
Yes
|
No
}}文字
|
文字脚本错误:函数“noTrim”不存在。文字 | 文字{{#ifeq:A|A|
Yes
|
No
}}文字
|
文字Yes文字 |
#ifeq: |
文字{{#invoke:IfUtil|noTrim|eq|A|B|
Yes
|
No
}}文字
|
文字脚本错误:函数“noTrim”不存在。文字 | 文字{{#ifeq:A|B|
Yes
|
No
}}文字
|
文字No文字 |
yesno:是 | 文字{{#invoke:IfUtil|noTrim|yesno|是|
Yes
|
No
}}文字
|
文字脚本错误:函数“noTrim”不存在。文字 | 文字{{yesno|是|yes=
Yes
|no=
No
}}文字
|
文字Yes文字 |
#ifexist: 無此條目!! |
文字{{#invoke:IfUtil|noTrim|exist|無此條目!!|
Yes
|
No
}}文字
|
文字脚本错误:函数“noTrim”不存在。文字 | 文字{{#ifexist:無此條目!!|
Yes
|
No
}}文字
|
文字No文字 |
#ifexist: WP:條目 |
文字{{#invoke:IfUtil|noTrim|exist|WP:條目|
Yes
|
No
}}文字
|
文字脚本错误:函数“noTrim”不存在。文字 | 文字{{#ifexist:WP:條目|
Yes
|
No
}}文字
|
文字Yes文字 |
所有命令
命令 | 基本用法 | 描述 | ||
---|---|---|---|---|
常規判斷 | ||||
if
|
{{#invoke:ifUtil|noTrim|if|判斷的字串|字串有值時返回|字串為空時返回}}
|
{{#if:}} 的不trim版本。
| ||
expr
|
{{#invoke:ifUtil|noTrim|expr|expr表達式|表達式為真時返回|表達式為假時返回}}
|
{{#ifexpr:}} 的不trim版本。
| ||
內容比對 | ||||
eq
|
{{#invoke:ifUtil|noTrim|eq|判斷的字串|字串有值時返回|字串為空時返回}}
|
{{#ifeq:}} 的不trim版本。
| ||
eq|選項=Y/N
|
{{#invoke:ifUtil|noTrim|eq|選項1=Y/N|選項2=Y/N|判斷的字串|字串有值時返回|字串為空時返回}}
|
特殊選項的{{#ifeq:}} 。目前的選項有:
可疊加多個選項。 | ||
eq|trim=no
|
{{#invoke:ifUtil|noTrim|eq|trim=no|比對的字串1|比對的字串2|字串相等時返回|字串不同時返回}}
|
連輸入欲比對之字串都不trim的{{#ifeq:}} 。其會將「foo 」與「foo 」視為相異。
| ||
eq|i=yes
|
{{#invoke:ifUtil|noTrim|eq|i=yes|比對的字串1|比對的字串2|字串相等時返回|字串不同時返回}}
|
忽略大小寫的trim的{{#ifeq:}} 。其會將「FOO 」與「foo 」視為相同。
| ||
內容判斷 | ||||
error
|
{{#invoke:ifUtil|noTrim|error|欲除錯的內容|內容有錯誤時返回|內容沒有問題時返回}}
|
{{#iferror:}} 的不trim版本。
| ||
exist
|
{{#invoke:ifUtil|noTrim|exist|要判斷是否存在的頁面標題|頁面存在時返回|頁面不存在時返回}}
|
{{#ifexist:}} 的不trim版本。
| ||
工具 | ||||
yesno
|
{{#invoke:ifUtil|noTrim|yesno|可代表布林值的字串|布林值為真時返回|布林值為假時返回}}
|
{{yesno}} 的不trim版本[a],同時也支援{{yesno}}的。|yes= 、|no= 、|def= 、|¬= 和|blank= 等參數。(參見#進階用法#yesno)
| ||
其他if-else類模板
|
{{#invoke:ifUtil|noTrim|<其他if-else類模板>|判斷用參數|成立時返回|不成立時返回}}
|
其他if-else類模板的不trim版本[a]。 | ||
其他模板 [b]
|
{{#invoke:ifUtil|noTrim|<模板名稱>|參數1|參數2|參數3....}}
|
對於不支援或非if-else類的模板會有類似一般地調用模板的效果。 | ||
參數
下表按固定顺序显示了可用的位置参数(参数*
)。对于每个命令,都会标记适用的参数集。例如,如果已给出命令 eq
,那么至少应给出 判斷式①
和比對式
兩個参数。
(必要) | (必要) | (ifeq必填) | (可选) | (可选) | (可选) | (可选) | ||||
{{#invoke:ifUtil|noTrim
|
命令
|
判斷式①
|
比對式
|
①成立時
|
否則
|
判斷式②
|
②成立時
|
判斷式③...
|
}}
| |
---|---|---|---|---|---|---|---|---|---|---|
其他參數
|
其他參數2
|
其他參數3...
| ||||||||
if , expr ,eq ,error ,exist ,yesno ,其他if-else類模板, 其他模板 |
||||||||||
eq
|
||||||||||
if , expr ,eq ,error ,exist ,yesno (yes參數),其他if-else類模板
|
||||||||||
if , expr , eq ,error ,exist ,yesno (no參數), 其他if-else類模板
|
||||||||||
expr , yesno (blank參數), 其他模板
|
||||||||||
expr , yesno (def參數), 其他模板 (可选 2nd, 3rd 等)
|
||||||||||
expr (可选 2nd, 3rd 等), yesno (¬參數), 其他模板
| ||||||||||
if2number
local p={}
local lib_arg={}
--todo iferrornoTrim, ifexistnoTrim, ifeqnoTrim
function p.ifexprnoTrim(frame)--{{#invoke:IfUtil|ifexprnoTrim|5>3|Yes|No}}
local args, working_frame
if frame == mw.getCurrentFrame() then
-- We're being called via #invoke. The args are passed through to the module
-- from the template page, so use the args that were passed into the template.
if lib_arg.getArgs == nil then lib_arg = require('Module:Arguments') end
args = lib_arg.getArgs(frame, {
parentFirst=true,
trim = false,
removeBlanks = false
})
working_frame = frame
else
-- We're being called from another module or from the debug console, so assume
-- the args are passed in directly.
args = frame
working_frame = mw.getCurrentFrame()
if type(args) ~= type({}) then args = {frame} end
end
local input_str = args['1'] or args[1] or '0'
local output_if = args['2'] or args[2] or ''
local check_max_arg = 2
local ifexpr_table = {}
for k,v in pairs(args) do
local check_num = tonumber(mw.text.trim(k))
if check_num and check_num > check_max_arg then
check_max_arg = check_num
end
ifexpr_table[k] = v
end
ifexpr_table['1'] = input_str
ifexpr_table['2'] = output_if
local tail = check_max_arg - check_max_arg % 2
local output_else = (check_max_arg % 2 == 1) and (args[tostring(check_max_arg)] or args[check_max_arg]) or ''
for i=1,tail,2 do
local expr = ifexpr_table[tostring(i)] or ifexpr_table[i] or '0'
local true_result = args[tostring(i+1)] or args[i+1] or ''
local flag,ifexpr = xpcall(function() return mw.ext.ParserFunctions.expr(expr)end,function()end)
--use original #ifexpr: to print original error
if flag~=true then return working_frame:preprocess("{{safesubst:#ifexpr:" .. expr .. '|' .. true_result .. '|' .. output_else .."}}") end
mw.log(expr .. ' => ' .. (ifexpr or'Error'))
if (tonumber(ifexpr or'0') or 0) ~= 0 then return true_result end
end
return output_else
end
function p.ifnoTrim(frame)
local args, working_frame
if frame == mw.getCurrentFrame() then
-- We're being called via #invoke. The args are passed through to the module
-- from the template page, so use the args that were passed into the template.
if lib_arg.getArgs == nil then lib_arg = require('Module:Arguments') end
args = lib_arg.getArgs(frame, {
parentFirst=true,
trim = false,
removeBlanks = false
})
working_frame = frame
else
-- We're being called from another module or from the debug console, so assume
-- the args are passed in directly.
args = frame
working_frame = mw.getCurrentFrame()
if type(args) ~= type({}) then args = {frame} end
end
local input_str = args['1'] or args[1] or ''
local output_if = args['2'] or args[2] or ''
local output_else = args['3'] or args[3] or ''
if mw.text.trim(input_str) ~= '' then
return output_if
end
return output_else
end
function p.if2number(frame)
local args, working_frame
if frame == mw.getCurrentFrame() then
-- We're being called via #invoke. The args are passed through to the module
-- from the template page, so use the args that were passed into the template.
if lib_arg.getArgs == nil then lib_arg = require('Module:Arguments') end
args = lib_arg.getArgs(frame, {
parentFirst=true,
trim = false,
removeBlanks = false
})
working_frame = frame
else
-- We're being called from another module or from the debug console, so assume
-- the args are passed in directly.
args = frame
working_frame = mw.getCurrentFrame()
if type(args) ~= type({}) then args = {frame} end
end
local input_str = args['1'] or args[1] or ''
local output_hasTwo = args['2'] or args[2] or '1'
local output_otherwise = args['3'] or args[3] or ''
local check_split = args['4'] or args[4] or '~'
local local_check = mw.text.trim(require('Module:TemplateParameters').containsNumber({input_str}))
if local_check ~= '' then
local split_end, split2_first = mw.ustring.find(input_str,check_split)
local first_num_str, second_num_str = '', ''
if split_end then first_num_str = mw.ustring.sub(input_str,1,split_end-1) end
if split2_first then second_num_str = mw.ustring.sub(input_str,split2_first+1,-1) end
local first_num_check, second_num_check = mw.text.trim(require('Module:TemplateParameters').containsNumber({first_num_str})),
mw.text.trim(require('Module:TemplateParameters').containsNumber({second_num_str}))
if first_num_check ~= '' and second_num_check ~= '' then
first_num_check, second_num_check = require('Module:TemplateParameters').getNumberValue({first_num_str}),
require('Module:TemplateParameters').getNumberValue({second_num_str})
local first_num, second_num = tonumber(first_num_check), tonumber(second_num_check)
if first_num and second_num then
if first_num ~= second_num then
return output_hasTwo
else return output_otherwise end
else return output_otherwise end
else return output_otherwise end
else return output_otherwise end
end
return p