پودمان:Namespace detect
این الگو در در پیامهای سامانه استفاده شدهاست. تغییرات آن تأثیر منجر به تغییر بیدرنگ در میانای کاربری سامانهٔ ویکیپدیا میشود. در ویرایش آن احتیاط کنید و همهٔ ویرایشها را پیش از ذخیرهسازی در یک صفحهٔ آزمایشی محک بزنید. |
این پودمان حفاظتشده ارزیابی شدهاست. این پودمان یکی از الگوهای حساس است و در صفحات بسیار زیادی استفاده میشود. محافظت این پودمان در برابر ویرایش، بهدلیل بار قابل توجهی است که خرابکاریها، خطاها یا ویرایشهای جزئی میتوانند به دوش سرورها بگذارند. |
این پودمان از پودمانهای زیر استفاده میکند: |
این پودمان به شما این امکان را میدهد تا بسته به فضای نامی که صفحه در آن قرار دارد، متنی را نمایش دهید. این پودمان در واقع بهنوعی پیادهسازی {{تشخیص فضای نام}} در بستر لوآ است که دستخوش بهبودهایی شده است: تمام فضاهای نام و تمام نامهای مستعار فضاهای نام پشتیبانی میشوند و نامهای فضاهای نام بهطور خودکار برای ویکیهای محلی شناسایی میشوند.
استفاده
{{#درخواست: Namespace detect | main
| صفحه =
| اصلی =
| بحث =
| درگاه =
| رده =
| کاربر =
| ویکیپدیا =
| مدیاویکی =
| الگو =
| ویژه =
| پرونده =
| راهنما =
| پودمان =
| سایر =
| فضای دمو =
| فضای موضوع =
}}
پارامترها
- اصلی - متنی که در صورت قرار داشتن صفحه در فضای نام اصلی باید نمایش داده شود.
- بحث - متنی که در صورت قرار داشتن صفحه در یکی از فضاهای نام بحث باید نمایش داده شود. این میتواند برابر با هریک از فضاهای نام بحث باشد - با مواردی نظیر «بحث:»، «بحث ویکیپدیا:»، «بحث کاربر:» و غیره مطابقت خواهد داشت.
- پارامترهای فضاهای نام موضوعی مانند ویکیپدیا، کاربر، پرونده... - متنی که در صورت قرار داشتن صفحه در فضای نام موضوع وابسته باید نمایش داده شود. این پودمان نام تمام فضاهای نام موضوعی شامل فضاهای نام مجازی و نامهای مستعار فضاهای نام را بهعنوان پارامتر میپذیرد. برای مشاهدهٔ فهرست مقدارهای مجاز، پایین را ببینید.
- سایر - متنی که در صورت وارد نشدن هرگونه پارامتر برای فضای نام صفحهٔ حاضر باید نمایش داده شود. اگر پارامتر
|فضای دمو=
روی مقدار فضای نامی نامعتبر تنظیم شده باشد نیز این متن برگردانده میشود. - فضای موضوع - اگر صفحه، یک صفحهٔ بحث بود، از صفحهٔ موضوع وابسته استفاده شود. میتواند با هر مقدار مثبتی نظیر «بله» و «yes» (یا سایر مقدارهای مشابه نظیر «آری» یا «y») تنظیم شود.
- صفحه - برای تعیین صفحهای که باید فضای نامش تشخیص داده شود، کاربرد دارد. اگر وارد نشود، و
|فضای دمو=
نیز تنظیم نشده باشد، پودمان بهطور خودکار از نام صفحهٔ حاضر استفاده خواهد کرد. - فضای دمو - اجبار پودمان به نشان دادن رفتاری که در فضای نام وارد شده از خود نشان میدهد. معمولاً برای استفاده در مثالها و بحثها کاربرد دارد.
پارامترهای فضای نام
مقدارهای مجاز برای پارامترهای فضاهای نام موضوعی به شرح زیر است:
Namespace | Aliases |
---|---|
main
|
|
کاربر
|
user , كاربر
|
ویکیپدیا
|
project , وپ , ویکی پدیا , ويكي پديا , ويکيپديا , wikipedia , wp
|
پرونده
|
file , تصویر , image
|
مدیاویکی
|
mediawiki
|
الگو
|
template
|
راهنما
|
help , ره
|
رده
|
category
|
درگاه
|
|
پیشنویس
|
پیشنویس , پيشنويس , پیش_نویس , پيش_نويس , پيشنويس , draft
|
education program
|
|
timedtext
|
|
پودمان
|
module , پود
|
مبحث
|
topic
|
تابع جدول
برای نمایش جدولی حاوی پارامترهای مختلف فضاهای نام مجاز از دستور زیر استفاده کنید:
{{#درخواست:Namespace detect|table|بحث=بله}}
برای اضافه کردن پارامتر فضاهای نام بحث از |بحث=بله
استفاده کنید.
جزئیات فنی
این پودمان از صفحهٔ داده در پودمان:Namespace detect/data استفاده میکند. این صفحه با استفاده از mw.loadData بارگیری میشود؛ به این معنی که در هر صفحه یک بار بارگیری میشود، و نه با هر بار فراخوانی بهواسطهٔ دستور #درخواست. این قابلیت برای بهبود عملکرد اضافه شده است.
--[[
--------------------------------------------------------------------------------
-- --
-- NAMESPACE DETECT --
-- --
-- This module implements the {{namespace detect}} 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. The --
-- module can also use the corresponding subject namespace value if it is --
-- used on a talk page. Parameter names can be configured for different wikis --
-- by altering the values in the "cfg" table in --
-- Module:Namespace detect/config. --
-- --
--------------------------------------------------------------------------------
--]]
local data = mw.loadData('Module:Namespace detect/data')
local argKeys = data.argKeys
local cfg = data.cfg
local mappings = data.mappings
local yesno = require('Module:Yesno')
local mArguments -- Lazily initialise Module:Arguments
local mTableTools -- Lazily initilalise Module:TableTools
local ustringLower = mw.ustring.lower
local p = {}
local function fetchValue(t1, t2)
-- Fetches a value from the table t1 for the first key in array t2 where
-- a non-nil value of t1 exists.
for i, key in ipairs(t2) do
local value = t1[key]
if value ~= nil then
return value
end
end
return nil
end
local function equalsArrayValue(t, value)
-- Returns true if value equals a value in the array t. Otherwise
-- returns false.
for i, arrayValue in ipairs(t) do
if value == arrayValue then
return true
end
end
return false
end
function p.getPageObject(page)
-- Get the page object, passing the function through pcall in case of
-- errors, e.g. being over the expensive function count limit.
if page then
local success, pageObject = pcall(mw.title.new, page)
if success then
return pageObject
else
return nil
end
else
return mw.title.getCurrentTitle()
end
end
-- Provided for backward compatibility with other modules
function p.getParamMappings()
return mappings
end
local function getNamespace(args)
-- This function gets the namespace name from the page object.
local page = fetchValue(args, argKeys.demopage)
if page == '' then
page = nil
end
local demospace = fetchValue(args, argKeys.demospace)
if demospace == '' then
demospace = nil
end
local subjectns = fetchValue(args, argKeys.subjectns)
local ret
if demospace then
-- Handle "demospace = main" properly.
if equalsArrayValue(argKeys.main, ustringLower(demospace)) then
ret = mw.site.namespaces[0].name
else
ret = demospace
end
else
local pageObject = p.getPageObject(page)
if pageObject then
if pageObject.isTalkPage then
-- Get the subject namespace if the option is set,
-- otherwise use "talk".
if yesno(subjectns) then
ret = mw.site.namespaces[pageObject.namespace].subject.name
else
ret = 'talk'
end
else
ret = pageObject.nsText
end
else
return nil -- return nil if the page object doesn't exist.
end
end
ret = ret:gsub('_', ' ')
return ustringLower(ret)
end
function p._main(args)
-- Check the parameters stored in the mappings table for any matches.
local namespace = getNamespace(args) or 'other' -- "other" avoids nil table keys
local params = mappings[namespace] or {}
local ret = fetchValue(args, params)
--[[
-- If there were no matches, return parameters for other namespaces.
-- This happens if there was no text specified for the namespace that
-- was detected or if the demospace parameter is not a valid
-- namespace. Note that the parameter for the detected namespace must be
-- completely absent for this to happen, not merely blank.
--]]
if ret == nil then
ret = fetchValue(args, argKeys.other)
end
return ret
end
function p.main(frame)
mArguments = require('Module:Arguments')
local args = mArguments.getArgs(frame, {removeBlanks = false})
local ret = p._main(args)
return ret or ''
end
function p.table(frame)
--[[
-- Create a wikitable of all subject namespace parameters, for
-- documentation purposes. The talk parameter is optional, in case it
-- needs to be excluded in the documentation.
--]]
-- Load modules and initialise variables.
mTableTools = require('Module:TableTools')
local namespaces = mw.site.namespaces
local cfg = data.cfg
local useTalk = type(frame) == 'table'
and type(frame.args) == 'table'
and yesno(frame.args.talk) -- Whether to use the talk parameter.
-- Get the header names.
local function checkValue(value, default)
if type(value) == 'string' then
return value
else
return default
end
end
local nsHeader = checkValue(cfg.wikitableNamespaceHeader, 'Namespace')
local aliasesHeader = checkValue(cfg.wikitableAliasesHeader, 'Aliases')
-- Put the namespaces in order.
local mappingsOrdered = {}
for nsname, params in pairs(mappings) do
if useTalk or nsname ~= 'talk' then
local nsid = namespaces[nsname].id
-- Add 1, as the array must start with 1; nsid 0 would be lost otherwise.
nsid = nsid + 1
mappingsOrdered[nsid] = params
end
end
mappingsOrdered = mTableTools.compressSparseArray(mappingsOrdered)
-- Build the table.
local ret = '{| class="wikitable"'
.. '\n|-'
.. '\n! ' .. nsHeader
.. '\n! ' .. aliasesHeader
for i, params in ipairs(mappingsOrdered) do
for j, param in ipairs(params) do
if j == 1 then
ret = ret .. '\n|-'
.. '\n| <code>' .. param .. '</code>'
.. '\n| '
elseif j == 2 then
ret = ret .. '<code>' .. param .. '</code>'
else
ret = ret .. ', <code>' .. param .. '</code>'
end
end
end
ret = ret .. '\n|-'
.. '\n|}'
return ret
end
return p