Módulo:Asbox
A documentação para este módulo pode ser criada na página Módulo:Asbox/doc
--[[
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 = 'Predefinição: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('Módulo: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('Módulo: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'!Predefinições de esboço com problemas', '[[Categoria:%s]]', '%s|%s%s'
local function categoria(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('Módulo:Message box').ombox
categoria{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, '^categoria(%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['categoria' .. 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('Categoria:' .. cat).exists then
code = code or mw.html.create'code':wikitext'|categoria'
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 'Categoria: [] 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
'!Predefinições de mensagem de esboço com subpáginas de documentação'
or not cat:match' esboços$' and {k = 'S', t = page.text}
)
end
end
--Add category names after loop is completed
categoria(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|categoria}}, {{para|categoria1}} and {{para|categoria2}}.
'The following parameter'
.. (#stubCats.missing == 1 and ' define uma categoria que faz' or ' define categoria de esboço que fazem')
.. ' 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 = {}, '* [[:Categoria:%s]] (população: %s)\n'
if not args.categoria 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['categoria' .. v] or '{{{categoria}}}',
v and mw.site.stats.pagesInCategory(args['categoria' .. 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'Predefinição:Documentação de esboço'
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.categoria,
'The <code>|categoria</code> parameter is not set. Please add an appropriate stub categoria.',
{k = 'C', t = page.text}
})
:_(ombox{
ifNot = args.tema or args.relacionado or args.qualificador,
'This stub template contains no description! At least one of the parameters <code>|tema</code>, <code>|relacionado</code> or <code>|qualificador</code> must be defined.',
{k = 'D', t = page.text}
})
:_(catStub(page, pageDoc))--catStub() may also return an ombox if there are non-existing categories
:_(categoria{
done = p.demo ~= 'doc',--Outputs categories if not doc demo
'!Predefinições de mensagem de esboço',
'Excluir na impressão',
args.icon and
'!Predefinições que usam o parâmetro ícone'
or args.imagem and (
mw.title.new('Media:' .. mw.text.split(args.imagem, '|')[1]).exists--do nothing if exists. category() will reject true
or {k = 'B', t = page.text}
)
or '!Predefinições de mensagem de esboço sem imagem',
args.imagemalt and {k = 'I', t = page.text},
})
:_((not p.demo or p.demo == 'doc') and--Add standard stub template documentation
require('Módulo:Documentação').main{
content = Buffer(page.text ~= 'Esboço' and--This comparison performed in {{Asbox/stubtree}} before it invokes Module:Asbox árvore esboços
require('Módulo:Asbox árvore esboços').subtree{args = {pagename = page.text}}
)
:_in'\n== Sobre esta predefinição ==\nEsta predefinição é usada para identificar um ':_(args.tema):_'esboço':_(args.qualificador):_out' '--space
:_'. Este utiliza a {{[[Predefinição:Asbox|asbox]]}}, que é um meta módulo criados para facilitar o processo de criar e manter predefinições sobre esboços.\n=== Uso ===\nTyping '
:_(mw.html.create'code'
:wikitext('{{', page.text == 'Esboço' and 'esboço' or page.text, '}}')
)
:_' produz a mensagem mostrada no inicio, e adiciona or artigo relacionado a seguinte categori'
:_(#stubCats > 1 and 'ias' or 'a')
:_':\n'
:_(population())
:_(pageDoc.exists and--transclusion of /doc if it exists
frame:expandTemplate{title = pageDoc.text}
)
:_'\n== Informação geral ==\n'
:_(frame:expandTemplate{title = tStubDoc.text})
:_'\n\n'(),
['link box'] = Buffer'Esta documentação é automaticamente gerada por [[Módulo:Asbox]].'
:_in'A informação geral é transcluída de [[Predefinição:Documentação de esboço]]. '
:_(mw.html.create'span'
:cssText'font-size:smaller;font-style:normal;line-height:130%'
:node(('([%s edite] | [%s Ver histórico])'):format(
tStubDoc:fullUrl('action=edit', 'relative'),
tStubDoc:fullUrl('action=history', 'relative')
))
)
:_out()
:_(page.protectionLevels.edit and page.protectionLevels.edit[1] == 'sysop' and
"Esta predefinição está [[Wikipédia:Página protegida|protegida]] e as [[WP:CAT|categorias]] devem ser adicionadas na subpágina da predefinição ["
.. pageDoc:fullUrl('action=edit&preload=Template:Categoria_interwiki/preload', 'de documentação')
.. '| /doc] que não está protegida.'
)' <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.imagem) and
mw.html.create'td'
:wikitext(args.icon or ('[[Ficheiro:%s|%spx|alt=%s]]'):format(
args.imagem or '',
args.pix or '40x30',
args.imagemalt or 'Icon esboço'
))
)
:tag'td'
:tag'i'
:wikitext(
Buffer'Este':_(args.tema):_(args.relacionado or 'relacionado'):_(args.qualificador)' ',--space
' é um [[Wikipédia:esboço|esboço]]. Você pode ajudar a Wikipédia ao [',
page:fullUrl('action=edit', 'relative'),
' expandi-lo].'
)
:done()
:node(args.nome and
require'Módulo:Navbar'._navbar{
args.nome,
mini = 'yes',
style = 'position: absolute; right: 15px; display: none;'
}
)
:node(args.nota and
mw.html.create()
:tag'br':done()
:tag'span'
:css{['font-style'] = 'normal', ['font-size'] = 'smaller'}
:wikitext(args.nota)
:done()
)
:allDone()
--[[
Stub categories for templates include a sort key (Otherwise all will be indexed under the letter 'T' for 'Template:[] stubs')
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
categoria'Todos os artigos esboço'
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(
'Categorias demo: ',
(categoria{done = true}:gsub('(%[%[)(Categoria:)([^|%]]-)(%|)', '%1%2%3|%2%3%4'):gsub('(%[%[)(Categoria:)', '%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.nome 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
categoria{{k = args.nome and 'E' or 'W', t = page.text}}
end
end
return output:wikitext(not p.demo and categoria{done = true} or nil)
end
return p