پودمان:Asbox
توضیحات این پودمان می‌تواند در پودمان:Asbox/توضیحات قرار گیرد.
--[[
This module was created by User:CodeHydro (Alexander Zhikun He).
User:Jackmcbarn and User:Mr._Stradivarius provided a great deal of assistance in writting p.main()
p.main() draw heavily from the following version of Template:Asbox of the English imamatpedia, authored primarily by User:Rich_Farmbrough
https://en.imamatpedia.org/w/index.php?title=Template:Asbox&oldid=619510287
p.templatepage() is derived from the following revision of Template:Asbox/templatepage, authored primarily by User:MSGJ
https://en.imamatpedia.org/w/index.php?title=Template:Asbox/templatepage&oldid=632914791
Both templates had significant contributions from numerous others listed in the revision history tab of their respective pages.
--]]
local WRAPPER_TEMPLATE, args = 'الگو:الگوی_خرد'
local templatestyles = 'الگوی_خرد/styles.css'
local num_con = require('Module:Numeral converter').convert -- convert numbers to Persian
local p, Buffer, stubCats = {
--Prevents dupli-cats... get it? Maybe not?
cats = setmetatable({}, {__newindex = function(t, i, v)
if not rawget(t, i) then
rawset(t, i, v)
table.insert(t, i)
end
end}),
--initializes variables required by both p.main and p.templatepage
init = function(self, frame, page)
args, page = args or require('Module:Arguments').getArgs(frame, {
wrappers = WRAPPER_TEMPLATE
}), page or mw.title.getCurrentTitle()
--Ensures demo parameter will never affect category() output for articles
self.demo = self.demo or page.namespace ~= 0 and args.demo
return args, page
end
}, require('Module:Buffer')
--[[
Formats category links. Stores them until called with cat.done=true
Takes multiple or single categories in the form of 'cat'
or a table of strings and/or tables containing parts. (See below)
]]
local attention, catTag, catKey = Buffer'الگو:پیامی خرد نیازمند توجه', '[[رده:%s]]', '%s|%s%s'
local function category(cat)
for _, v in ipairs((tostring(cat) == cat or cat.t) and {cat} or cat) do
--[[
If v is a table:
[1] = full category name; defaults to local attention if blank
k = Category sort key. Prefix before v.t
t = page.text or args.tempsort#; appended after k (or in its place if omitted). Required if v is not a string
Basically the same as v = (v[1] or attention) .. ' | ' .. (v.k or '') .. v.t
]]
if v and v ~= true then--reject v = nil, false, or true
p.cats[catTag:format(tostring(v) == v and
v
or (v[1] and Buffer(v[1]) or attention):_in(v.k):_(v.t):_str(2, nil, nil, '|')
)] = true
end
end
return cat.done and table.concat(p.cats, p.demo and ' | ' or nil) or ''
end
--[[
Makes an ombox warning;
Takes table {ifNot = Boolean, text, {cat. sort key, cat. sort name}}
Will return an empty string instead when ifNot evaluates to true
]]
local function ombox(v)
if v.ifNot then return end
p.ombox = p.ombox or require('Module:Message box').ombox
category{v[2]}
return p.ombox{
type = 'content',
text = v[1]
}
end
--[[
Unlike original template, module now takes unlimited cats! This function also performs
most stub category error checks except for the ombox for when main |category= is omitted (See p.template())
]]
local function catStub(page, pageDoc)
stubCats = {missing = {}, v = {}}
-- zwj and zwnj have semantical use in other other wikis, don't remove them
local zwj = '\226\128\141' -- U+200D, E2 80 8D
local zwnj = '\226\128\140' -- U+200C, E2 80 8C
disallowedUnicodeChars = '[^%w%p%s' .. zwj .. zwnj .. ']' -- for i18n we make this a separate string
local code
for k, _ in pairs(args) do
--Find category parameters and store the number (main cat = '')
table.insert(stubCats, string.match(k, '^رده(%d*)$'))
table.insert(stubCats, string.match(k, '^category(%d*)$'))
end
table.sort(stubCats)
for k, v in ipairs(stubCats) do
--Get category names and, if called by p.templatepage, the optional sort key
local tsort, cat = args['tempsort' .. v], mw.ustring.gsub(args['category' .. v], disallowedUnicodeChars, '')--remove all hidden unicode chars
--Do not place template in main category if |tempsort = 'no'. However, DO place articles of that template in the main category.
table.insert(stubCats.v,
page and (--p.templatepage passes page; p.main does not, i.e. articles are categorized without sort keys.
v=='' and tsort == 'no'--if true, inserts 'true' in table, which category() will reject
or tsort and {cat, k = ' ', t = tsort}
or {cat, k = ' *', t = page.text}--note space in front of sort key
)
or cat
)
--Check category existance only if on the template page (i.e. stub documentation)
if page then
if not mw.title.new('رده:' .. cat).exists then
code = code or mw.html.create'code':wikitext'|رده'
table.insert(stubCats.missing, tostring(mw.clone(code):wikitext(v)))
end
--[[
Checks non-demo stub template for documentation and flags if doc is present.
All stub cats names are checked and flagged if it does not match 'Category: [] stub'.
The main stub cat is exempt from the name check if the stub template has its own doc
(presumably, this doc would have an explanation as to why the main stub cat is non-conforming).
]]
table.insert(stubCats.v, v == '' and not p.demo and pageDoc.exists and
'الگو:پیامی خرد با زیرصفحه توضیحات'
or not cat:match' ^مقاله‌های خرد' and {k = 'S', t = page.text}
)
end
end
--Add category names after loop is completed
category(stubCats.v)
return #stubCats.missing > 0 and ombox{
--Changed, original msg:
--One or more of the stub categories defined in this template do not seem to exist!
--Please double-check the parameters {{para|category}}, {{para|category1}} and {{para|category2}}.
'پارامتر'
.. (#stubCats.missing == 1 and ' زیر رده خردی را تعریف می‌کند که موجود نیست' or 'های زیر رده‌های خردی را تعریف می‌کنند که موجود نیستند')
.. ': ' .. mw.text.listToText(stubCats.missing),
{k = 'N', t = page.text}
}
end
--Shows population of categories found by catStub(). Outputs demo values if none
local function population()
local wikitext, base = {}, '* [[:رده:%s]] (صفحه‌ها: %s)\n'
if not args.category and stubCats[1] ~= false then
table.insert(stubCats, 1, false)
end
for _, v in ipairs(stubCats) do
table.insert(wikitext, base:format(
v and args['category' .. v] or '{{{category}}}',
v and num_con("fa", mw.site.stats.pagesInCategory(args['category' .. v], 'all')) or "۰"
))
end
return table.concat(wikitext)
end
--Includes standard stub documention and flags stub templates with bad parameter values.
function p.templatepage(frame, page)
args, page = p:init(frame, page)
local tStubDoc = mw.title.new'الگو:توضیحات خرد'
local pageDoc = page:subPageTitle('توضیحات')
--Reorganization note: Original Asbox alternates between outputting categories and checking on params |category#=.
--Rather than checking multiple times and switching tasks, all stub category param operations have been rolled into catStub()
return Buffer(
ombox{--Show ombox warnings for missing args.
ifNot = args.category,
'پارامتر <code>|category</code> تنظیم نشده‌است. لطفاً یک ردهٔ مناسب را اضافه کنید.',
{k = 'C', t = page.text}
})
:_(ombox{
ifNot = args.subject or args.article or args.qualifier,
'این الگوی خرد شامل هیچ توضیحی نیست! دست کم یکی از پارامترهای <code>|subject</code>، <code>|article</code> یا <code>|qualifier</code> باید تعریف شوند.',
{k = 'D', t = page.text}
})
:_(catStub(page, pageDoc))--catStub() may also return an ombox if there are non-existing categories
:_(category{
done = p.demo ~= 'توضیحات',--Outputs categories if not doc demo
'الگو:مقاله‌های خرد',
'مستثنی از چاپ',
args.icon and
'الگو:پیامی خرد که از پارامتر نشان استفاده می‌کنند'
or args.image and (
mw.title.new('Media:' .. mw.text.split(args.image, '|')[1]).exists--do nothing if exists. category() will reject true
or {k = 'B', t = page.text}
)
or 'الگو:پیامی خرد بدون تصویر',
args.imagealt and {k = 'I', t = page.text},
})
:_((not p.demo or p.demo == 'توضیحات') and--Add standard stub template documentation
require('Module:Documentation').main{
content = Buffer(page.text ~= 'خرد' and--This comparison performed in {{Asbox/stubtree}} before it invokes Module:Asbox stubtree
require('Module:Asbox stubtree').subtree{args = {pagename = page.text}}
)
:_in'\n== درباره این الگو ==\nاین الگو برای شناسایی یک مقالهٔ خرد ':_(args.subject):_' ':_(args.qualifier):_' به‌کار می‌رود'--space
:_'. این الگو از {{[[الگو:الگوی خرد|الگوی خرد]]}} استفاده می‌کند که یک فرا-الگوی طراحی‌شده به‌منظور تسهیل فرایند ایجاد و نگهداری از الگوهای خرد است.\n=== استفاده ===\nنوشتن '
:_(mw.html.create'code'
:wikitext('{{', page.text == 'خرد' and 'خرد' or page.text, '}}')
)
:_' پیامی که در ابتدا نمایش داده شده‌است را تولید می‌کند و مقاله را به رده'
:_(#stubCats > 1 and 'های زیر می‌افزاید' or ' زیر می‌افزاید')
:_':\n'
:_(population())
:_(pageDoc.exists and--transclusion of /doc if it exists
frame:expandTemplate{title = pageDoc.text}
)
:_'\n== اطلاعات اصلی ==\n'
:_(frame:expandTemplate{title = tStubDoc.text})
:_'\n\n'(),
['link box'] = Buffer'این زیرصفحهٔ توضیحات به‌طور خودکار توسط [[پودمان:Asbox]] تولید شده‌است.'
:_in'اطلاعات اصلی از [[الگو:توضیحات خرد]] تراگنجانش شده‌است. '
:_(mw.html.create'span'
:cssText'font-size:smaller;font-style:normal;line-height:130%'
:node(('([%s ویرایش] | [%s تاریخچه])'):format(
tStubDoc:fullUrl('action=edit', 'relative'),
tStubDoc:fullUrl('action=history', 'relative')
))
)
:_out()
:_(page.protectionLevels.edit and page.protectionLevels.edit[1] == 'sysop' and
"این الگو [[وپ:حفاظت|کاملاً حفاظت‌شده]] است و هرگونه [[وپ:رده|رده‌ای]] باید به زیرصفحهٔ ["
.. pageDoc:fullUrl('action=edit&preload=الگو:میان‌ویکی_رده/پیش‌بارگیری', 'relative')
.. '| /توضیحات] که محافظت نشده‌است، افزوده شود.'
)' <br/>'
}
)()
end
local convertBack = require('Module:Numeral converter').convert
function p.main(frame, page)
args, page = p:init(frame, page)
if args['نوشتار'] then args.article = args['نوشتار'] end
if args['مقاله'] then args.article = args['مقاله'] end
if args['تصویر'] then args.image = args['تصویر'] end
if args['اندازه'] then args.pix = convertBack('en', args['اندازه']) end
if args['موضوع'] then args.subject = args['موضوع'] end
if args['توصیف'] then args.qualifier = args['توصیف'] end
if args['رده'] then args.category = args['رده'] end
if args['ترتیب الگو'] then args.tempsort = args['ترتیب الگو'] end
if args['رده۱'] then args.category1 = args['رده۱'] end
if args['ترتیب الگو۱'] then args.tempsort1 = args['ترتیب الگو۱'] end
if args['یادداشت'] then args.note = args['یادداشت'] end
if args['نام'] then args.name = args['نام'] end
if args['شمایل'] then args.icon = args['شمایل'] end
if args['نمایشی'] then args.demo = args['نمایشی'] end
local output = mw.html.create'div'
:attr{role = 'note'}
:addClass'metadata plainlinks asbox stub'
:tag'table'
:attr{role = 'presentation'}
:tag'tr'
:addClass'noresize'
:node((args.icon or args.image) and
mw.html.create'td'
:wikitext(args.icon or ('[[پرونده:%s|%spx|alt=%s]]'):format(
args.image or '',
args.pix or '40x30',
args.imagealt or 'آیکون خرد'
))
)
:tag'td'
:tag'p'
:addClass'asbox-body'
:wikitext(
Buffer'این یک [[امامت‌پدیا:خرد|مقالهٔ خرد]] ':_(args.subject):_(args.qualifier)' ',--space
' است. می‌توانید با [',
page:fullUrl('action=edit', 'relative'),
' گسترش آن] به امامت‌پدیا کمک کنید.'
)
:done()
:node(args.note and
mw.html.create()
:tag'p'
:addClass'asbox-note'
:wikitext(args.note)
:done()
)
:allDone()
:node(args.name and
require'پودمان:Navbar'._navbar{
args.name,
mini = 'yes',
}
)
--[[
Stub categories for templates include a sort key; this ensures that all stub tags appear at the beginning of their respective categories.
Articles using the template do not need a sort key since they have unique names.
When p.demo equals 'doc', the demo stub categories will appear as those for a stub template.
Otherwise, any non-nil p.demo will emulate article space categories (plus any error cats unless set to 'art')
]]
if page.namespace == 0 then -- Main namespace
category'همه مقاله‌های خرد'
catStub()
elseif p.demo then
if p.demo ~= 'توضیحات' then catStub() end
--Unless p.demo is set to 'art', it will also include error categories normally only shown on
--the template but not in the article. The elseif after namespace == 0 means demo cats will never show in article space.
p.demodoc = p.demo ~= 'art' and p.templatepage(frame, page)
output = mw.html.create()
:node(output)
:tag'small':wikitext(
'Demo categories: ',
(category{done = true}:gsub('(%[%[)(رده:)([^|%]]-)(%|)', '%1%2%3|%2%3%4'):gsub('(%[%[)(رده:)', '%1:%2'))
):done()
:wikitext(p.demo == 'توضیحات' and p.demodoc or nil)
else
--Checks for valid name; emulates original template's check using {{FULLPAGENAME:{{{name|}}}}}
local normalizedName = mw.title.new(args.name or '')
if normalizedName and normalizedName.fullText == page.fullText then
output = mw.html.create():node(output):wikitext(p.templatepage(frame, page))
elseif not page.isSubpage and page.namespace == 10 then-- Template namespace and not a subpage
category{{k = args.name and 'E' or 'W', t = page.text}}
end
end
return frame:extensionTag{ name = 'templatestyles', args = { src = templatestyles} } .. tostring(output:wikitext(not p.demo and category{done = true} or nil))
end
return p