"मोड्युल:Asbox" का संशोधनहरू बिचको अन्तर
स्वरूप
Content deleted Content added
comments and some code simplification |
सा en:Module:Asbox बाट ८१ संशोधन(हरू) |
||
(३ प्रयोगकर्ताहरू द्वारा गरिएको बीचको २७ अवतरण देखाइएन) | |||
पङ्क्ति १: | पङ्क्ति १: | ||
--[[ |
|||
local p = { |
|||
This module was created by User:CodeHydro (Alexander Zhikun He). |
|||
cats = {inv = {}} |
|||
User:Jackmcbarn and User:Mr._Stradivarius provided a great deal of assistance in writting p.main() |
|||
} |
|||
local WRAPPER_TEMPLATE = 'Template:Asbox' |
|||
local args, stubCats |
|||
p.main() draw heavily from the following version of Template:Asbox of the English Wikipedia, authored primarily by User:Rich_Farmbrough |
|||
function demo(text, alt) |
|||
https://en.wikipedia.org/w/index.php?title=Template:Asbox&oldid=619510287 |
|||
return args.demo and text or alt |
|||
end |
|||
p.templatepage() is derived from the following revision of Template:Asbox/templatepage, authored primarily by User:MSGJ |
|||
--Formats category links. Stores them until called with cat.done=true |
|||
https://en.wikipedia.org/w/index.php?title=Template:Asbox/templatepage&oldid=632914791 |
|||
--Takes multiple or single categories in the form of 'cat' or {'cat1', 'cat2', {'cat3', 'sort3'}} |
|||
--If it finds a category name of length 1, assumes it is a sort key. |
|||
Both templates had significant contributions from numerous others listed in the revision history tab of their respective pages. |
|||
--Such keys must always be paired in a table {{'cat', 'sort'}} |
|||
--]] |
|||
local attention = 'Stub message templates needing attention' |
|||
local WRAPPER_TEMPLATE, args = 'Template:Asbox' |
|||
function category(cat) |
|||
local p, Buffer, stubCats = { |
|||
for _, v in ipairs(type(cat) == type'' and {cat} or cat) do |
|||
--Prevents dupli-cats... get it? Maybe not? |
|||
p.key = string.format( |
|||
cats = setmetatable({}, {__newindex = function(t, i, v) |
|||
'[[%sCategory:%s]]', |
|||
if not rawget(t, i) then |
|||
rawset(t, i, v) |
|||
--All user-inputed cats are always paired with a sort key |
|||
table.insert(t, i) |
|||
--Since all non-user cat are longer than 2 chars, we can |
|||
end |
|||
--compare length instead of checking type |
|||
end}), |
|||
#v > 2 and v or string.format( |
|||
--initializes variables required by both p.main and p.templatepage |
|||
demo('%s|Category:%s|%s', '%s|%s%s'), |
|||
init = function(self, frame, page) |
|||
#v[1] < 2 and attention or v[1], |
|||
args, page = args or require('Module:Arguments').getArgs(frame, { |
|||
#v[1] < 2 and attention or v[1], |
|||
wrappers = WRAPPER_TEMPLATE |
|||
#v[1] < 2 and table.concat(v) or v[2] |
|||
}), 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 |
|||
if not p.cats.inv[p.key] then |
|||
return args, page |
|||
table.insert(p.cats, p.key) |
|||
end |
|||
p.cats.inv[p.key] = #p.cats |
|||
}, 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'Stub message templates needing attention', '[[Category:%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 |
||
end |
end |
||
return cat.done and table.concat(p.cats, demo |
return cat.done and table.concat(p.cats, p.demo and ' | ' or nil) or '' |
||
end |
end |
||
--[[ |
|||
--Makes an ombox warning; will return an empty string instead |
|||
Makes an ombox warning; |
|||
--if optional v.ifNot is true |
|||
Takes table {ifNot = Boolean, text, {cat. sort key, cat. sort name}} |
|||
function ombox(v)--{text, {subcat, page}} |
|||
Will return an empty string instead when ifNot evaluates to true |
|||
if v.ifNot then |
|||
]] |
|||
return '' |
|||
local function ombox(v) |
|||
end |
|||
if v.ifNot then return end |
|||
p.ombox = p.ombox or require('Module:Message box').ombox |
p.ombox = p.ombox or require('Module:Message box').ombox |
||
category{v[2]} |
category{v[2]} |
||
पङ्क्ति ५१: | पङ्क्ति ७१: | ||
end |
end |
||
--[[ |
|||
Unlike original template, module now takes unlimited cats! This function also performs |
|||
function catStub(page, pageDoc)--p.templatepage passes page; p.main does not |
|||
most stub category error checks except for the ombox for when main |category= is omitted (See p.template()) |
|||
stubCats = { |
|||
]] |
|||
missing = {}, |
|||
local function catStub(page, pageDoc) |
|||
S = {}, |
|||
stubCats = {missing = {}, v = {}} |
|||
v = {} |
|||
local code |
|||
} |
|||
--Find category parameters and store the number (main cat = '') |
|||
for k, _ in pairs(args) do |
for k, _ in pairs(args) do |
||
--Find category parameters and store the number (main cat = '') |
|||
table.insert(stubCats, string.match(k, '^category(%d*)$')) |
table.insert(stubCats, string.match(k, '^category(%d*)$')) |
||
end |
end |
||
table.sort(stubCats) |
table.sort(stubCats) |
||
local cat, tsort |
|||
for k, v in ipairs(stubCats) do |
for k, v in ipairs(stubCats) do |
||
--Get category names and, if called by p.templatepage, the optional sort key |
--Get category names and, if called by p.templatepage, the optional sort key |
||
cat = args['category' .. v] |
local tsort, cat = args['tempsort' .. v], mw.ustring.gsub(args['category' .. v], '[^%w%p%s]', '')--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. |
|||
tsort = args['tempsort' .. v] |
|||
table.insert(stubCats.v, |
|||
--Does not place in main category if |tempsort = 'no' |
|||
page and (--p.templatepage passes page; p.main does not, i.e. articles are categorized without sort keys. |
|||
--For example, if stub template simply adds |qualifier= to a meta stub |
|||
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 page then |
||
--Check category existance |
|||
--This check is only performed on the template page |
|||
--since it uses an expensive parser function |
|||
if not mw.title.new('Category:' .. cat).exists then |
if not mw.title.new('Category:' .. cat).exists then |
||
code = code or mw.html.create'code':wikitext'|category' |
|||
table.insert(stubCats.missing, '<code>category' .. v .. '</code>') |
|||
table.insert(stubCats.missing, tostring(mw.clone(code):wikitext(v))) |
|||
end |
end |
||
--[[ |
|||
table.insert(stubCats.v, |
|||
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'. |
|||
--Main categories with no docs and all numbered categories |
|||
The main stub cat is exempt from the name check if the stub template has its own doc |
|||
--are checked for proper naming and flagged if not |
|||
(presumably, this doc would have an explanation as to why the main stub cat is non-conforming). |
|||
v == '' and pageDoc.exists and |
|||
]] |
|||
'Stub message templates with documentation subpages' |
|||
table.insert(stubCats.v, v == '' and not p.demo and pageDoc.exists and |
|||
or not string.match(cat, ' stubs$') and {'S', page.text} |
|||
'Stub message templates with documentation subpages' |
|||
or nil |
|||
or not cat:match' stubs$' and {k = 'S', t = page.text} |
|||
) |
) |
||
end |
end |
||
पङ्क्ति ९४: | पङ्क्ति ११५: | ||
--Add category names after loop is completed |
--Add category names after loop is completed |
||
category(stubCats.v) |
category(stubCats.v) |
||
return #stubCats.missing > 0 and ombox{ |
|||
--Out params set to non-categories with <code> tags to ombox |
|||
--Changed, original msg: |
|||
return stubCats.missing and ombox{ |
|||
-- |
--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}}. |
|||
'The following parameter' |
'The following parameter' |
||
.. (#stubCats.missing == 1 and ' defines a stub category that does' or 's define stub categories that do') |
|||
.. ' not exist: ' .. mw.text.listToText(stubCats.missing), |
|||
{'N', page.text} |
{k = 'N', t = page.text} |
||
} |
} |
||
end |
end |
||
--Shows population of categories found by catStub() |
--Shows population of categories found by catStub(). Outputs demo values if none |
||
local function population() |
|||
--Outputs demo values if there are none |
|||
local wikitext, base = {}, '* [[:Category:%s]] (population: %s)\n' |
|||
function population() |
|||
if not args.category and stubCats[1] ~= false then |
|||
local wikitext, base = '', '* [[:Category:%s]] (population: (%s)\n' |
|||
table.insert(stubCats, 1, false) |
|||
return string.format(base, '{{{category}}}', 0) |
|||
end |
end |
||
for |
for _, v in ipairs(stubCats) do |
||
table.insert(wikitext, base:format( |
|||
wikitext = wikitext .. string.format(base, args['category' .. v], mw.site.stats.pagesInCategory(args['category' .. v], 'all')) |
|||
v and args['category' .. v] or '{{{category}}}', |
|||
v and mw.site.stats.pagesInCategory(args['category' .. v], 'all') or 0 |
|||
)) |
|||
end |
end |
||
return wikitext |
return table.concat(wikitext) |
||
end |
end |
||
--Includes standard stub documention and flags stub templates with bad parameter values. |
|||
--Flags bad stub templates and creates standard doc page |
|||
function p.templatepage(frame, page) |
function p.templatepage(frame, page) |
||
local tStubDoc = mw.title.new |
args, page = p:init(frame, page) |
||
local tStubDoc = mw.title.new'Template:Stub documentation' |
|||
local pageDoc = |
local pageDoc = page:subPageTitle('doc') |
||
--Reorganization note: Original Asbox alternates between outputting categories and checking on params |category#=. |
|||
page = page or mw.title.getCurrentTitle() |
|||
--Rather than checking multiple times and switching tasks, all stub category param operations have been rolled into catStub() |
|||
args = args or require('Module:Arguments').getArgs(frame, { |
|||
return Buffer( |
|||
wrappers = WRAPPER_TEMPLATE |
|||
ombox{--Show ombox warnings for missing args. |
|||
}) |
|||
ifNot = args.category, |
|||
'The <code>|category</code> parameter is not set. Please add an appropriate stub category.', |
|||
'Stub message templates', |
|||
{k = 'C', t = page.text} |
|||
'Exclude in print', |
|||
}) |
|||
--Changed. Original Asbox does its first of 3 checks on params |category#= here. |
|||
:_(ombox{ |
|||
--Rather than checking multiple times, all operations involving those params have been rolled into catStub() |
|||
ifNot = args.subject or args.article or args.qualifier, |
|||
(args.icon and |
|||
'This stub template contains no description! At least one of the parameters <code>|subject</code>, <code>|article</code> or <code>|qualifier</code> must be defined.', |
|||
'Stub message templates using icon parameter' |
|||
{k = 'D', t = page.text} |
|||
or (args.image and |
|||
}) |
|||
(mw.title.new('Media:' .. mw.text.split(args.image, '|')[1]).exists and |
|||
:_(catStub(page, pageDoc))--catStub() may also return an ombox if there are non-existing categories |
|||
nil |
|||
:_(category{ |
|||
or {'B', page.text} |
|||
done = p.demo ~= 'doc',--Outputs categories if not doc demo |
|||
'Stub message templates', |
|||
'Exclude in print', |
|||
args.icon and |
|||
'Stub message templates using icon parameter' |
|||
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 'Stub message templates without images' |
or 'Stub message templates without images', |
||
args.imagealt and {k = 'I', t = page.text}, |
|||
) |
|||
) |
}) |
||
:_((not p.demo or p.demo == 'doc') and--Add standard stub template documentation |
|||
args.imagealt and {'I', page.text} or nil |
|||
require('Module:Documentation').main{ |
|||
} |
|||
content = Buffer(page.text ~= 'Stub' and--This comparison performed in {{Asbox/stubtree}} before it invokes Module:Asbox stubtree |
|||
--Show ombox warnings and check for bat stub categories |
|||
require('Module:Asbox stubtree').subtree{args = {pagename = page.text}} |
|||
return ombox{ |
|||
) |
|||
ifNot = args.category, |
|||
:_in'\n== About this template ==\nThis template is used to identify a':_(args.subject):_'stub':_(args.qualifier):_out' '--space |
|||
'The <code>|category</code> parameter is not set. Please add an appropriate stub category.', |
|||
:_'. It uses {{[[Template:Asbox|asbox]]}}, which is a meta-template designed to ease the process of creating and maintaining stub templates.\n=== Usage ===\nTyping ' |
|||
{'C', page.text} |
|||
:_(mw.html.create'code' |
|||
} |
|||
:wikitext('{{', page.text == 'Stub' and 'stub' or page.text, '}}') |
|||
.. ombox{ |
|||
) |
|||
ifNot = args.subject or args.article or args.qualifier, |
|||
:_' produces the message shown at the beginning, and adds the article to the following categor' |
|||
'This stub template contains no description! At least one of the parameters <code>|subject</code>, <code>|article</code> or <code>|qualifier</code> must be defined.', |
|||
:_(#stubCats > 1 and 'ies' or 'y') |
|||
{'D', page.text} |
|||
:_':\n' |
|||
} |
|||
:_(population()) |
|||
.. catStub(page, pageDoc) |
|||
:_(pageDoc.exists and--transclusion of /doc if it exists |
|||
--Add standard stub template documentation |
|||
frame:expandTemplate{title = pageDoc.text} |
|||
.. ((args.demo and args.demo ~= 'doc' and '') or (require('Module:Documentation').main{ |
|||
) |
|||
content = |
|||
:_'\n== General information ==\n' |
|||
(page.text ~= 'Stub' and --This comparison performed in {{Asbox/stubtree}} before it invokes Module:Asbox stubtree |
|||
:_(frame:expandTemplate{title = tStubDoc.text}) |
|||
:_'\n\n'(), |
|||
['link box'] = Buffer'This documentation is automatically generated by [[Module:Asbox]].' |
|||
) |
|||
:_in'The general information is transcluded from [[Template:Stub documentation]]. ' |
|||
.. '\n== About this template ==\nThis template is used to identify a ' |
|||
:_(mw.html.create'span' |
|||
.. string.format('%s stub%s.', args.subject or '', args.qualifier and (' ' .. args.qualifier) or '') |
|||
:cssText'font-size:smaller;font-style:normal;line-height:130%' |
|||
.. ' It uses {{[[Template:Asbox|asbox]]}}, which is a meta-template designed to ease the process of creating and maintaining stub templates.\n=== Usage ===\nTyping <code>{{' |
|||
:node(('([%s edit] | [%s history])'):format( |
|||
.. (page.text == 'Stub' and |
|||
tStubDoc:fullUrl('action=edit', 'relative'), |
|||
'stub' |
|||
tStubDoc:fullUrl('action=history', 'relative') |
|||
or page.text |
|||
) |
)) |
||
) |
|||
.. '}}</code> produces the message shown at the beginning, and adds the article to the following categor' .. (#stubCats > 1 and 'ies' or 'y') .. ':\n' |
|||
:_out() |
|||
:_(page.protectionLevels.edit and page.protectionLevels.edit[1] == 'sysop' and |
|||
.. (pageDoc.exists and --transclusion of /doc if it exists |
|||
"This template is [[WP:PROTECT|fully protected]] and any [[WP:CAT|categories]] should be added to the template's [" |
|||
frame:expandTemplate{title = pageDoc.text} |
|||
.. pageDoc:fullUrl('action=edit&preload=Template:Category_interwiki/preload', 'relative') |
|||
or '' |
|||
.. '| /doc] subpage, which is not protected.' |
|||
) |
|||
)' <br/>' |
|||
.. '\n== General information ==\n'--Generic documentation |
|||
} |
|||
.. frame:expandTemplate{title = tStubDoc.text} .. '\n\n' |
|||
)() |
|||
['link box'] = |
|||
string.format( |
|||
'This documentation is automatically generated by [[Template:Asbox/templatepage]].<br>The general information is transcluded from [[Template:Stub documentation]]. <span style="font-size:smaller;font-style:normal;line-height:130%%">([%s edit] | [%s history])</span>', |
|||
tStubDoc:fullUrl('action=edit', 'relative'), |
|||
tStubDoc:fullUrl('action=history', 'relative') |
|||
) |
|||
.. (page.protectionLevels.edit[1] == 'sysop' and |
|||
" <br/>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.' |
|||
or '' |
|||
) |
|||
} |
|||
--Output categories when done. |
|||
.. (args.demo ~= 'doc' and category{done = true} or ''))) |
|||
end |
end |
||
--The template as it appears on articles. |
|||
function p.main(frame, page) |
function p.main(frame, page) |
||
args, page = p:init(frame, page) |
|||
page = page or mw.title.getCurrentTitle() |
|||
local output = mw.html.create'table' |
|||
args = args or require('Module:Arguments').getArgs(frame, { |
|||
:addClass'metadata plainlinks stub' |
|||
wrappers = WRAPPER_TEMPLATE |
|||
:css{background = 'transparent'} |
|||
}) |
|||
:attr{role = 'presentation'} |
|||
local output = mw.html.create() |
|||
:tag'tr' |
|||
local asbox = output:tag'table' |
|||
:node((args.icon or args.image) and |
|||
:addClass('metadata plainlinks stub') |
|||
mw.html.create'td' |
|||
:css('background', 'transparent') |
|||
:wikitext(args.icon or ('[[File:%s|%spx|alt=%s]]'):format( |
|||
:attr('role', 'presentation') |
|||
args.image or '', |
|||
args.pix or '40x30', |
|||
args.imagealt or 'Stub icon' |
|||
'[[File:%s|%spx|alt=%s]]', |
|||
)) |
|||
) |
|||
args.pix or '40x30', |
|||
:tag'td' |
|||
args.imagealt or 'Stub icon' |
|||
:tag'i' |
|||
)) |
|||
:wikitext( |
|||
end |
|||
Buffer'This':_(args.subject):_(args.article or 'article'):_(args.qualifier)' ',--space |
|||
local buffer = asbox:tag('td') |
|||
' is a [[Wikipedia:stub|stub]]. You can help Wikipedia by [', |
|||
buffer:tag('i'):wikitext(string.format( |
|||
page:fullUrl('action=edit', 'relative'), |
|||
'This %s %s %s is a [[Wikipedia:stub|stub]]. You can help Wikipedia by [%s expanding it].', |
|||
' expanding it].' |
|||
args.subject or '', |
|||
) |
|||
args.article or 'article', |
|||
:done() |
|||
args.qualifier or '', |
|||
:node(args.name and |
|||
page:fullUrl('action=edit', 'relative') |
|||
require'Module:Navbar'._navbar{ |
|||
)) |
|||
args.name, |
|||
mini = 'yes', |
|||
buffer:wikitext(require('Module:Navbar')._navbar{ |
|||
style = 'position: absolute; right: 15px; display: none;' |
|||
args.name, |
|||
} |
|||
mini = 'yes', |
|||
) |
|||
style = 'position: absolute; right: 15px; display: none;' |
|||
:node(args.note and |
|||
}) |
|||
mw.html.create() |
|||
end |
|||
:tag'br':done() |
|||
if args.note then |
|||
:tag'span' |
|||
:css{['font-style'] = 'normal', ['font-size'] = 'smaller'} |
|||
buffer:tag('span') |
|||
:wikitext(args.note) |
|||
:css('font-style', 'normal') |
|||
:done() |
|||
:css('font-size', 'smaller') |
|||
) |
|||
:wikitext(args.note) |
|||
:allDone() |
|||
end |
|||
--[[ |
|||
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 |
if page.namespace == 0 then -- Main namespace |
||
category'All stub articles' |
category'All stub articles' |
||
catStub() |
catStub() |
||
elseif |
elseif p.demo then |
||
if p.demo ~= 'doc' then catStub() end |
|||
--Preview categories; not in original template, but shouldn't hurt |
|||
--Unless p.demo is set to 'art', it will also include error categories normally only shown on |
|||
p.templatepage(frame, page) |
|||
--the template but not in the article. The elseif after namespace == 0 means demo cats will never show in article space. |
|||
output:wikitext(string.format('<small>Demo categories: %s</small>', category{done = true})) |
|||
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('(%[%[)(Category:)([^|%]]-)(%|)', '%1%2%3|%2%3%4'):gsub('(%[%[)(Category:)', '%1:%2')) |
|||
):done() |
|||
:wikitext(p.demo == 'doc' and p.demodoc or nil) |
|||
else |
else |
||
--Checks for valid name; emulates original template's check using {{FULLPAGENAME:{{{name|}}}}} |
|||
local normalizedName = mw.title.new(args.name or '') |
local normalizedName = mw.title.new(args.name or '') |
||
if normalizedName and normalizedName.fullText == page.fullText then |
if normalizedName and normalizedName.fullText == page.fullText then |
||
output:wikitext(p.templatepage(frame, page)) |
output = mw.html.create():node(output):wikitext(p.templatepage(frame, page)) |
||
elseif not page.isSubpage and page.namespace == 10 then |
elseif not page.isSubpage and page.namespace == 10 then-- Template namespace and not a subpage |
||
category{{args.name and 'E' or 'W', page.text}} |
category{{k = args.name and 'E' or 'W', t = page.text}} |
||
end |
end |
||
end |
end |
||
return output |
return output:wikitext(not p.demo and category{done = true} or nil) |
||
:wikitext( |
|||
category{done = not args.demo}, |
|||
args.demo == 'doc' and p.templatepage(frame, page) or nil |
|||
) |
|||
end |
end |
||
१९:५७, ६ सेप्टेम्बर २०१९को रुपमा हालको पुनरावलोकनहरू
--[[
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 = 'Template:Asbox'
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'Stub message templates needing attention', '[[Category:%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 = {}}
local code
for k, _ in pairs(args) do
--Find category parameters and store the number (main cat = '')
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], '[^%w%p%s]', '')--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('Category:' .. cat).exists then
code = code or mw.html.create'code':wikitext'|category'
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
'Stub message templates with documentation subpages'
or not cat:match' stubs$' 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}}.
'The following parameter'
.. (#stubCats.missing == 1 and ' defines a stub category that does' or 's define stub categories that do')
.. ' not exist: ' .. 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 = {}, '* [[:Category:%s]] (population: %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'Template:Stub documentation'
local pageDoc = page:subPageTitle('doc')
--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,
'The <code>|category</code> parameter is not set. Please add an appropriate stub category.',
{k = 'C', t = page.text}
})
:_(ombox{
ifNot = args.subject or args.article or args.qualifier,
'This stub template contains no description! At least one of the parameters <code>|subject</code>, <code>|article</code> or <code>|qualifier</code> must be defined.',
{k = 'D', 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
'Stub message templates',
'Exclude in print',
args.icon and
'Stub message templates using icon parameter'
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 'Stub message templates without images',
args.imagealt and {k = 'I', t = page.text},
})
:_((not p.demo or p.demo == 'doc') and--Add standard stub template documentation
require('Module:Documentation').main{
content = Buffer(page.text ~= 'Stub' and--This comparison performed in {{Asbox/stubtree}} before it invokes Module:Asbox stubtree
require('Module:Asbox stubtree').subtree{args = {pagename = page.text}}
)
:_in'\n== About this template ==\nThis template is used to identify a':_(args.subject):_'stub':_(args.qualifier):_out' '--space
:_'. It uses {{[[Template:Asbox|asbox]]}}, which is a meta-template designed to ease the process of creating and maintaining stub templates.\n=== Usage ===\nTyping '
:_(mw.html.create'code'
:wikitext('{{', page.text == 'Stub' and 'stub' or page.text, '}}')
)
:_' produces the message shown at the beginning, and adds the article to the following categor'
:_(#stubCats > 1 and 'ies' or 'y')
:_':\n'
:_(population())
:_(pageDoc.exists and--transclusion of /doc if it exists
frame:expandTemplate{title = pageDoc.text}
)
:_'\n== General information ==\n'
:_(frame:expandTemplate{title = tStubDoc.text})
:_'\n\n'(),
['link box'] = Buffer'This documentation is automatically generated by [[Module:Asbox]].'
:_in'The general information is transcluded from [[Template:Stub documentation]]. '
:_(mw.html.create'span'
:cssText'font-size:smaller;font-style:normal;line-height:130%'
:node(('([%s edit] | [%s history])'):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)
local output = mw.html.create'table'
:addClass'metadata plainlinks stub'
:css{background = 'transparent'}
:attr{role = 'presentation'}
:tag'tr'
: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 '40x30',
args.imagealt or 'Stub icon'
))
)
:tag'td'
:tag'i'
:wikitext(
Buffer'This':_(args.subject):_(args.article or 'article'):_(args.qualifier)' ',--space
' is a [[Wikipedia:stub|stub]]. You can help Wikipedia by [',
page:fullUrl('action=edit', 'relative'),
' expanding it].'
)
:done()
:node(args.name and
require'Module:Navbar'._navbar{
args.name,
mini = 'yes',
style = 'position: absolute; right: 15px; display: none;'
}
)
:node(args.note and
mw.html.create()
:tag'br':done()
:tag'span'
:css{['font-style'] = 'normal', ['font-size'] = 'smaller'}
:wikitext(args.note)
:done()
)
:allDone()
--[[
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'All stub articles'
catStub()
elseif p.demo then
if p.demo ~= 'doc' 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('(%[%[)(Category:)([^|%]]-)(%|)', '%1%2%3|%2%3%4'):gsub('(%[%[)(Category:)', '%1:%2'))
):done()
:wikitext(p.demo == 'doc' 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 output:wikitext(not p.demo and category{done = true} or nil)
end
return p