Module:Article stub box: Difference between revisions

Content deleted Content added
fixed?
Escape `{{` in output to avoid a Parsoid bug. See Wikipedia:AutoWikiBrowser/Tasks#c-Anomie-20250302162200-Anomie-20250302155000 for details.
 
(29 intermediate revisions by 11 users not shown)
Line 1:
--[[
local WRAPPER_TEMPLATE = 'Template:Asbox'
This module was created by User:CodeHydro (Alexander Zhikun He).
local args, stubCats
User:Jackmcbarn and User:Mr._Stradivarius provided a great deal of assistance in writting p.main()
local p = {
 
cats = {inv = {}},
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:Article stub box'
-- TODO: update this instance of Asbox to Article stub box eventually
local templatestyles = 'Module:Article stub box/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()
})
page = 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 or nil
return args, page
end
}, require('Module:Buffer')
}
 
--[[
Line 20 ⟶ 38:
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
local attention, link = 'Stub message templates needing attention'
for _, v in ipairs((type(cat) == type'' or cat.t) and {cat} or cat) do
--[[
If v is a table:
Line 30 ⟶ 48:
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
link = string.format(
p.cats[catTag:format(tostring(v) == v and
'[[%sCategory:%s]]',
v
p.demo and ':' or '',
not or (v.t[1] and Buffer(v[1]) or stringattention):_in(v.formatk):_(v.t):_str(2, nil, nil, '|')
)] = true
p.demo and '%s|Category:%s|%s' or '%s|%s%s',
v[1] or attention,
p.demo and (v[1] or attention) or v.k or '',
p.demo and ((v.k or '') .. v.t) or v.t
)
)
--Prevents dupli-cats... get it? Maybe not?
if not p.cats.inv[link] then
table.insert(p.cats, link)
p.cats.inv[link] = #p.cats
end
end
return cat.done and table.concat(p.cats, p.demo and ' | ' or ''nil) or ''
end
 
Line 55 ⟶ 64:
]]
local function ombox(v)
if v.ifNot then return end
return ''
end
p.ombox = p.ombox or require('Module:Message box').ombox
category{v[2]}
Line 72 ⟶ 79:
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 = '')
Line 79 ⟶ 91:
for k, v in ipairs(stubCats) do
--Get category names and, if called by p.templatepage, the optional sort key
local cattsort, tsortcat = args['categorytempsort' .. v], mw.ustring.gsub(args['tempsortcategory' .. v], disallowedUnicodeChars, '')--remove all hidden unicode chars
--Do not place template in main category if |tempsort = 'no';. For exampleHowever, ifDO stubplace articles of that template merelyin the main category.
table.insert(stubCats.v,
--adds |qualifier= to a meta stub and |category#= to a sub-category of meta's main category
page and (--p.templatepage passes page; p.main does not, i.e. articles are categorized without sort keys.
if v ~= '' or tsort ~= 'no' then
v=='' and tsort == 'no'--if true, inserts 'true' in table, which category() will reject
--p.templatepage passes page; p.main does not, i.e. articles are categorized without sort keys.
or tsort and {cat, k = ' ', t = tsort}
table.insert(stubCats.v, page and
(tsort and {cat, t = tsort} or {cat, k = ' *', t = page.text})--note space in front of sort key
or cat
)
end 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, '<code>category' .. v .. '</code>')
table.insert(stubCats.missing, tostring(mw.clone(code):wikitext(v)))
end
--[[
Line 100 ⟶ 113:
(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'
v == '' and not p.demo and pageDoc.exists and
or not cat:match' stubs$' and {k = 'S', t = page.text}
'Stub message templates with documentation subpages'
or not string.match(cat, ' stubs$') and {k = 'S', t = page.text}
or nil
)
end
Line 118 ⟶ 129:
.. ' not exist: ' .. mw.text.listToText(stubCats.missing),
{k = 'N', t = page.text}
} or ''
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, = wikitext .. string.base:format(
base,
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
 
Line 141 ⟶ 151:
args, page = p:init(frame, page)
local tStubDoc = mw.title.new'Template:Stub documentation'
local pageDoc = mw.title.new(page.fullText .. :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{
.. catStub(page, pageDoc)
done = p.demo ~= 'doc',--Outputs categories if not doc demo
.. category{
'Stub message templates',
done = p.demo ~= 'doc',--Outputs categories if not doc demo
args.icon and
'Stub message templates',
'Stub message templates using icon parameter'
'Exclude in print',
( or args.iconimage and (
mw.title.new('Media:' .. mw.text.split(args.image, '|')[1]).exists--do nothing if exists. category() will reject true
'Stub message templates using icon parameter'
or (args.image and
(mw.title.new('Media:' .. mw.text.split(args.image, '|')[1]).exists and
nil
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
args.imagealt and {k = 'I', t = 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
--Add standard stub template documentation; demo calls will not call Module:Documentation unless p.demo = 'doc'
-- TODO: update this instance of Asbox to Article stub box eventually
.. (p.demo and p.demo ~= 'doc' and '' or require('Module:Documentation').main{
require('Module:Asbox stubtree').subtree{args = {pagename = page.text}}
content =
)
(page.text ~= 'Stub' and--This comparison performed in {{Asbox/stubtree}} before it invokes Module:Asbox stubtree
:_in'\n== About this template ==\nThis template is used to identify a':_(args.subject):_'stub':_(args.qualifier):_out' '--space
require('Module:Asbox stubtree').subtree{args = {pagename = page.text}}
:_'. It uses {{[[Template:Article stub box|article stub box]]}}, which is a meta-template designed to ease the process of creating and maintaining stub templates.\n=== Usage ===\nTyping '
or ''
:_(mw.html.create'code'
)
:wikitext( mw.text.nowiki( '{{' ), page.text == 'Stub' and 'stub' or page.text, '}}')
.. '\n== About this template ==\nThis template is used to identify a '
)
.. string.format('%s stub%s.', args.subject or '', args.qualifier and (' ' .. args.qualifier) or '')
:_' produces the message shown at the beginning, and adds the article to the following categor'
.. ' 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>{{'
.. :_(page.text#stubCats ==> 1 and 'Stubies' andor 'y')
:_'stub:\n'
:_(population())
or page.text
:_(pageDoc.exists and--transclusion of /doc if it exists
)
frame:expandTemplate{title = pageDoc.text}
.. '}}</code> produces the message shown at the beginning, and adds the article to the following categor' .. (#stubCats > 1 and 'ies' or 'y') .. ':\n'
.. population( )
:_'\n== General information ==\n'
.. (pageDoc.exists and--transclusion of /doc if it exists
:_(frame:expandTemplate{title = pageDoctStubDoc.text})
or :_'\n\n'(),
['link box'] = Buffer'This documentation is automatically generated by [[Module:Article stub box]].'
)
.. :_in'\n==The Generalgeneral information ==\n'--Genericis transcluded from [[Template:Stub documentation]]. '
:_(mw.html.create'span'
.. frame:expandTemplate{title = tStubDoc.text} .. '\n\n'
:cssText'font-size:smaller;font-style:normal;line-height:130%'
,
:node(('([%s edit] | [%s history])'):format(
['link box'] =
tStubDoc:fullUrl('action=edit', 'relative'),
string.format(
tStubDoc:fullUrl('action=history', 'relative')
'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')
:_out()
:_(page.protectionLevels.edit and (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 )' <br/>'
)}
)()
})
end
 
function p.main(frame, page)
args, page = p:init(frame, page)
local output = mw.html.create()'div'
:attr{role = 'note'}
:addClass'metadata plainlinks asbox stub'
:tag'table'
:attr{role = 'presentation'}
:addClass('metadata plainlinks stub')
:css('background', 'transparent')
:attr('role', 'presentation')
:tag'tr'
:addClass'noresize'
:node((args.icon or args.image) and
mw.html.create'td'
:wikitext(args.icon or string.('[[File:%s|%spx|alt=%s]]'):format(
args.image or '[[File:%s|%spx|alt=%s]]',
args.image,
args.pix or '40x30',
args.imagealt or 'Stub icon'
Line 228 ⟶ 236:
)
:tag'td'
:tag'ip'
:wikitext(string.format(addClass'asbox-body'
:wikitext(
'This %s %s %s is a [[Wikipedia:stub|stub]]. You can help Wikipedia by [%s expanding it].',
Buffer'This':_(args.subject):_(args.article or 'article'):_(args.qualifier)' ',--space
' is a [[Wikipedia:stub|stub]]. You can help Wikipedia by [',
args.article or 'article',
args.qualifier orpage:fullUrl('action=edit', 'relative'),
' expanding it].'
page:fullUrl('action=edit', 'relative')
))
:done()
:wikitext(args.name and
require('Module:Navbar')._navbar{
args.name,
mini = 'yes',
style = 'position: absolute; right: 15px; display: none;'
}
or nil
)
:node(args.note and
mw.html.create()
:tag'brp':done()
:tagaddClass'spanasbox-note'
:css('font-style', 'normal')
:css('font-size', 'smaller')
:wikitext(args.note)
:done()
)
:allDone()
:node(args.name and
require'Module:Navbar'._navbar{
args.name,
mini = 'yes',
}
)
--[[
Stub categories for templates include a sort key; (Otherwisethis ensures that all willstub betags indexedappear underat the letterbeginning 'T'of fortheir 'Template:[]respective stubs')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 p.demo ~= 'doc' then
catStub()
end
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) or nil
output = mw.html.create()
output:wikitext(string.format('<small>Demo categories: %s</small>', category{done = true}))
: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 frame:extensionTag{ name = 'templatestyles', args = { src = templatestyles} } .. tostring(output:wikitext(not p.demo and category{done = true} or nil))
return output:wikitext(
category{done = not p.demo},
p.demo == 'doc' and p.demodoc or nil
)
end