وحدة: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 Wikipedia, authored primarily by User:Rich_Farmbrough
https://en.wikipedia.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.wikipedia.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 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/sandbox').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
	local 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 = 'ب', 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 = 'غ', 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 mw.site.stats.pagesInCategory(args['category' .. v], 'all') or 0
		))
	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>|التصنيف</code>. فضلًا أضف تصنيف بذرة مناسب.',
			{k = 'ت', t = page.text}
		})
		:_(ombox{
			ifNot = args.subject or args.article or args.qualifier,
			'قالب البذرة هذا لا يحتوي وصفًا! على الأقل ينبغي أن يُعرّف أحد الوسائط <code>|الموضوع=</code> أو <code>|المقالة=</code>.',
			{k = 'و', t = page.text}
		})
		:_(catStub(page, pageDoc))--catStub() may also return an ombox if there are non-existing categories
		:_(category{
			done = p.demo ~= 'doc',--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 = 'ص', t = page.text}
				)
				or 'قوالب رسائل بذرة بدون صورة',
			args.imagealt and {k = 'ة', t = page.text},
		})
		:_((not p.demo or p.demo == 'doc') and--Add standard stub template documentation
			require('وحدة:توثيق').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):_out' '--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
						"This template is [[WP:PROTECT|fully protected]] and any [[WP:CAT|categories]] should be added to the template's ["
						.. pageDoc:fullUrl('action=edit&preload=Template:Category_interwiki/preload', 'relative')
						.. '| /doc] subpage, which is not protected.'
					)' <br/>'
			}
		)()
end

function p.main(frame, page)
	args, page = p:init(frame, page)
	if args['المقالة'] then args.article = args['المقالة'] end
    if args['الصورة'] then args.image = args['الصورة'] end
    if args['الحجم'] then args.pix =  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['التصنيف1'] then args.category1 = args['التصنيف1'] end
    if args['ترتيب القالب1'] then args.tempsort1 = args['ترتيب القالب1'] end
	if args['التصنيف2'] then args.category2 = args['التصنيف2'] end
    if args['ترتيب القالب2'] then args.tempsort2 = args['ترتيب القالب2'] end
	if args['التصنيف3'] then args.category3 = args['التصنيف3'] end
    if args['ترتيب القالب3'] then args.tempsort3 = args['ترتيب القالب3'] end
	if args['التصنيف4'] then args.category4 = args['التصنيف4'] end
    if args['ترتيب القالب4'] then args.tempsort4 = args['ترتيب القالب4'] 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 ('[[File:%s|%spx|alt=%s]]'):format(
							args.image or '',
							args.pix or '30x20',
							args.imagealt or 'أيقونة بذرة'
						))
				)
				:tag'td'
					:tag'p'
						:addClass'asbox-body'
						:wikitext(
							Buffer'هذه [[ويكيبيديا:بذرة|بذرة]]':_(args.article or 'مقالة'):_(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()
			
		-- Local modification: The following node is disabled in arwiki
		-- due to overlinking to stub template talk pages from Special:WantedPages
	--[[
		:node(args.name and
			require'Module: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 ~= 'doc' or 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 == 'doc' or 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 'ع' or 'س', 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