Module:Article stub box: Difference between revisions

Revision as of 09:32, 1 February 2015

Latest revision as of 21:04, 2 March 2025

(19 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 = {}

local buffer = require('Module:Buffer')

--initializes variables required by both p.main and p.templatepage

function p:init(frame, page)

args = args or require('Module:Arguments').getArgs(frame, {

wrappers = WRAPPER_TEMPLATE

})

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

p.main() draw heavily from the following version of Template:Asbox of the English Wikipedia, authored primarily by User:Rich_Farmbrough

--Prevents dupli-cats... get it? Maybe not?

https://en.wikipedia.org/w/index.php?title=Template:Asbox&oldid=619510287

p.cats = setmetatable({}, {__newindex = function(t, i, v)

if not rawget(t, i) then

p.templatepage() is derived from the following revision of Template:Asbox/templatepage, authored primarily by User:MSGJ

rawset(t, i, v)

https://en.wikipedia.org/w/index.php?title=Template:Asbox/templatepage&oldid=632914791

table.insert(t, i)

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()

--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')

end})

--[[

Formats category links. Stores them until called with cat.done=true

Line 26 ⟶ 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 37 ⟶ 49:

]]

if v and v ~= true then--reject v = nil, false, or true

link = ('p.cats[[%sCategory:%s]]')catTag:format(tostring(v) == v and

v

p.demo and ':' or '',

or (v[1] and Buffer(v[1]) or attention):_in(v.k):_(v.t):_str(2, nil, nil, '|')

type(v) == type'' and

v)] = true

or (p.demo and '%s|Category:%s|%s' or '%s|%s%s'):format(

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

)

)

p.cats[link] = true

end

end

Line 74 ⟶ 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

Line 82 ⟶ 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 tonumber(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, k = ' ', 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

cat = mw.ustring.gsub(cat, '[^%w%p%s]', '')--remove hidden unicode chars before checks

if not mw.title.new('Category:' .. cat).exists then

code = code or mw.html.create'code':wikitext'|category'

Line 146 ⟶ 154:

--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 bufferBuffer(

ombox{--Show ombox warnings for missing args.

ifNot = args.category,

Line 161 ⟶ 169:

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'

Line 173 ⟶ 180:

:_((not p.demo or p.demo == 'doc') and--Add standard stub template documentation

require('Module:Documentation').main{

content = bufferBuffer(page.text ~= 'Stub' and--This comparison performed in {{Asbox/stubtree}} before it invokes Module:Asbox stubtree

-- TODO: update this instance of Asbox to Article stub box eventually

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:AsboxArticle stub box|asboxarticle stub box]]}}, which is a meta-template designed to ease the process of creating and maintaining stub templates.\n=== Usage ===\nTyping '

:_(mw.html.create'code'

:wikitext( mw.text.nowiki( '{{' ), page.text == 'Stub' and 'stub' or page.text, '}}')

)

:_' produces the message shown at the beginning, and adds the article to the following categor'

Line 191 ⟶ 199:

:_(frame:expandTemplate{title = tStubDoc.text})

:_'\n\n'(),

['link box'] = bufferBuffer'This documentation is automatically generated by [[Module:AsboxArticle stub box]].'

:_in'The general information is transcluded from [[Template:Stub documentation]]. '

:_(mw.html.create'span'

Line 201 ⟶ 209:

)

:_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')

Line 212 ⟶ 220:

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'

: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'

Line 227 ⟶ 236:

)

:tag'td'

:tag'ip'

:addClass'asbox-body'

:wikitext(

bufferBuffer'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'),

Line 235 ⟶ 245:

)

:done()

:node(args.namenote and

mw.html.create()

require'Module:Navbar'._navbar{

args.name,:tag'p'

mini = :addClass'yesasbox-note',

:wikitext(args.note)

style = 'position: absolute; right: 15px; display: none;'

} :done()

)

:node(args.note and

mw.html.create'span'

:css{['font-style'] = 'normal', ['font-size'] = 'smaller'}

:tag'br':done()

:wikitext(args.note)

)

: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