BESA® Wiki - User contributions [en]

Module:Documentation

2016-03-24T11:36:10Z

Majr: Fix large docs disappearing

local p = {}

local getType = function( namespace, page )
local pageType = 'template'
if namespace == 'Module' then
pageType = 'module'
elseif page.fullText:gsub( '/doc$', '' ):find( '%.css$' ) then
pageType = 'stylesheet'
elseif page.fullText:gsub( '/doc$', '' ):find( '%.js$' ) then
pageType = 'script'
elseif namespace == 'MediaWiki' then
pageType = 'message'
end

return pageType
end

-- Creating a documentation page or transclution through {{subst:doc}}
function p.create( f )
local args = require( 'Module:ProcessArgs' ).norm()
local page = mw.title.getCurrentTitle()
local docPage = args.page or page.nsText .. ':' .. page.baseText .. '/doc'

local out
if not args.content and tostring( page ) == docPage then
out = f:preprocess( '{{subst:Template:Documentation/preload}}' )
else
local templateArgs = {}
for _, key in ipairs{ 'type', 'page', 'content' } do
local val = args[key]
if val then
if key == 'content' then val = '\n' .. val .. '\n' end
table.insert( templateArgs, key .. '=' .. val )
end
end

out = '{{documentation|' .. table.concat( templateArgs, '|' ) .. '}}'
out = out:gsub( '|}}', '}}' )

if not args.content then
out = out .. '\n'
end
end

if not mw.isSubsting() then
out = f:preprocess( out )
if not args.nocat then
out = out .. '[[Category:Pages with templates requiring substitution]]'
end
end

return out
end

-- Header on the documentation page
function p.docPage( f )
local args = require( 'Module:ProcessArgs' ).merge( true )
local badDoc = args.baddoc
if f:callParserFunction( '#dplvar', '$doc noheader' ) == '1' then
if badDoc then
f:callParserFunction( '#dplvar:set', '$doc bad', '1' )
end
return
end

local page = mw.title.getCurrentTitle()
local namespace = page.nsText
local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )

local body = mw.html.create( 'div' ):addClass( 'documentation-header' )
body
:css{
['margin-bottom'] = '0.8em',
padding = '0.8em 1em 0.7em',
['background-color'] = '#' .. ( badDoc and 'F9F2EA' or 'EAF4F9' ),
border = '1px solid #AAA'
}
:tag( 'div' )
:css( 'float', 'right' )
:wikitext( '[[', page:fullUrl( 'action=purge' ), ' purge]]' )
:done()
:wikitext(
'This is the documentation page, it ',
pageType == 'module' and 'will' or 'should',
' be transcluded into the main ', pageType, ' page. ',
'See [[Template:Documentation]] for more information'
)
if badDoc then
body:wikitext( "<br>'''This ", pageType, "'s documentation needs improving or additional information.'''" )
end
if not ( args.nocat or namespace == 'User' ) then
body:wikitext( '[[Category:Documentation pages]]' )
end

return body
end

-- Wrapper around the documentation on the main page
function p.page( f )
-- mw.text.trim uses mw.ustring.gsub, which silently fails on large strings
local function trim( s )
return string.gsub( s, '^[\t\r\n\f ]*(.-)[\t\r\n\f ]*$', '%1' )
end
local args = require( 'Module:ProcessArgs' ).merge( true )
local page = mw.title.getCurrentTitle()
local namespace = page.nsText
local docText = trim( args.content or '' )
if docText == '' then docText = nil end

local docPage
local noDoc
if docText then
docPage = page
else
docPage = mw.title.new( args.page or namespace .. ':' .. page.text .. '/doc' )
noDoc = args.nodoc or not docPage.exists
end
local badDoc = args.baddoc
local pageType = mw.ustring.lower( args.type or getType( namespace, page ) )

if not docText and not noDoc then
f:callParserFunction( '#dplvar:set', '$doc noheader', '1' )
docText = trim( f:expandTemplate{ title = ':' .. docPage.fullText } )
if f:callParserFunction( '#dplvar', '$doc bad' ) == '1' then
badDoc = 1
end

if docText == '' then
docText = nil
noDoc = 1
end
end
if docText then
docText = '\n' .. docText .. '\n'
end

local action = 'edit'
local preload = ''
local colour = 'EAF4F9'
local message
local category
if noDoc then
action = 'create'
preload = '&preload=Template:Documentation/preload'
colour = 'F9EAEA'
message = "'''This " .. pageType .. " has no documentation. " ..
"If you know how to use this " .. pageType .. ", please create it.'''"
if not ( args.nocat or namespace == 'User' ) then
category = pageType .. 's with no documentation'
if not mw.title.new( 'Category:' .. category ).exists then
category = 'Pages with no documentation'
end
end
elseif badDoc then
colour = 'F9F2EA'
message = "'''This " .. pageType .. "'s documentation needs improving or additional information.'''\n"
if not ( args.nocat or namespace == 'User' ) then
category = pageType .. 's with bad documentation'
if not mw.title.new( 'Category:' .. category ).exists then
category = 'Pages with bad documentation'
end
end
end

local links = {
'[' .. docPage:fullUrl( 'action=edit' .. preload ) .. ' ' .. action .. ']',
'[' .. docPage:fullUrl( 'action=history' ) .. ' history]',
'[' .. page:fullUrl( 'action=purge' ) .. ' purge]'
}
if not noDoc and page ~= docPage then
table.insert( links, 1, '[[' .. docPage.fullText .. '|view]]' )
end
links = mw.html.create( 'span' )
:css( 'float', 'right' )
:wikitext( mw.text.nowiki( '[' ), table.concat( links, ' | ' ), mw.text.nowiki( ']' ) )

local body = mw.html.create( 'div' ):addClass( 'documentation' )
body:css{
['background-color'] = '#' .. colour,
border = '1px solid #AAA',
padding = '0.8em 1em 0.7em',
['margin-top'] = '1em',
clear = 'both'
}

local header = mw.html.create( 'div' )
:css{
margin = '-0.8em -1em 0.8em',
padding = '0.8em 1em 0.7em',
['background-color'] = '#EAF4F9',
['border-bottom'] = 'inherit'
}

header
:node( links )
:tag( 'span' )
:css{
['font-weight'] = 'bold',
['font-size'] = '130%',
['margin-right'] = '1em',
['line-height'] = '1'
}
:wikitext( 'Documentation' )

if not noDoc and pageType ~= 'template' and pageType ~= 'message' then
header
:tag( 'span' )
:css( 'white-space', 'nowrap' )
:wikitext( '[[#the-code|Jump to code ↴]]' )
end

body
:node( header ):done()
:wikitext( message )
:wikitext( docText )

if not noDoc and page ~= docPage then
body
:tag( 'div' )
:css{
margin = '0.7em -1em -0.7em',
['background-color'] = '#EAF4F9',
['border-top'] = 'inherit',
padding = '0.8em 1em 0.7em',
clear = 'both'
}
:node( links )
:wikitext( 'The above documentation is transcluded from [[', docPage.fullText, ']].' )
end

if category then
body:wikitext( f:expandTemplate{ title = 'Translation category', args = { category, project = '0' } } )
end

local anchor = ''
if not noDoc and pageType ~= 'template' and pageType ~= 'message' then
anchor = mw.html.create( 'div' ):attr( 'id', 'the-code' )
end

return tostring( body ) .. tostring( anchor )
end

return p

Template:Lua

2016-01-23T05:55:46Z

Majr: Magic words are case-sensitive

{{msgbox
| image = Lua logo.svg
| text = This template uses '''<includeonly>[[</includeonly>Module:{{ucfirst: {{PAGENAME:{{{1|{{BASEPAGENAME}}}}}}} }}<includeonly>]]</includeonly>''', {{ #if: {{{data|}}} | with data stored in [[Module:{{ ucfirst: {{PAGENAME:{{{data}}}}} }}]]{{ #if: {{{data2|}}} |  and [[Module:{{ ucfirst: {{PAGENAME:{{{data2}}}}} }}]] }} | a script written in [[wikipedia:Lua (programming language)|Lua]] }}.<br>{{ #if: {{{data|}}} | These scripts are written in [[wikipedia:Lua (programming language)|Lua]]. }} Please see [[wp:Lua]] and [[mw:Extension:Scribunto]] to learn more.
| <includeonly>nocat = 1</includeonly>
}}<includeonly>{{
#if: {{{nocat|}}}
|
| {{#ifeq: {{SUBPAGENAME}} | doc
|
| {{#switch: {{NAMESPACENUMBER}}
| 0 | 10 = [[Category:Lua-based templates]]
}}
}}
}}</includeonly><noinclude>
{{documentation}}

Template:SimpleNavbox

2015-11-29T12:20:21Z

Majr: Protected "Template:SimpleNavbox": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

<includeonly>class="navbox hlist collapsible {{{class|}}}"
! class="navbox-top" {{#if: {{{topstyle|}}} | style="{{{topstyle}}}" }} colspan="2" | {{
#if: {{{navbar|}}} | <div class="navbox-navbar">{{navbar|{{{navbar|}}}|mini={{{mini|}}}}}</div>
}}<span class="navbox-title">{{{1}}}</span>{{#if: {{#var: history-head }} | {{#ifeq: {{#var: history-mode }} | foot || [[Category:Pages missing history footer]] }} }}
|-</includeonly><noinclude>
{{documentation}}

Module:Infobox

2015-08-17T07:43:16Z

Majr: Feel like I need an easier way to see if an image exists due to supporting the fallback individual images

local p = {}
function p.infobox( f )
local args = require( 'Module:ProcessArgs' ).merge( true )
local titleObject = mw.title.getCurrentTitle()
local title = args.title or titleObject.baseText

local imageArea = args.imagearea
if not imageArea and imageArea ~= 'none' then
local images = {}
local invImages = {}
local defaultImageSize = args.defaultimagesize or '150px'
args.image1 = args.image1 or args.image or 'title'
args.image1size = args.image1size or args.imagesize
args.invimage1 = args.invimage1 or args.invimage or 'title'

local imgCount = {}
local invImgCount = {}
for k, v in pairs( args ) do
if type( k ) == 'string' then
local image, num = k:match( '^(image)(%d+)$' )
local invImage, invNum = k:match( '^(invimage)(%d+)$' )
if v:lower() ~= 'none' then
if image then
table.insert( imgCount, tonumber( num ) )
elseif invImage then
table.insert( invImgCount, tonumber( invNum ) )
end
end
end
end

table.sort( imgCount )
local animate
for k, v in ipairs( imgCount ) do
local image = args['image' .. v]
local size = args['image' .. v .. 'size'] or defaultImageSize

if image == 'title' then
local imageTitle = mw.title.new( 'File:' .. title .. '.png' )
if imageTitle and imageTitle.exists then
image = '[[File:' .. title .. '.png|' .. size .. ']]'
elseif titleObject.namespace == 0 then
image = '[[File:No image.svg|' .. size .. '|link=File:' .. title .. '.png|Upload ' .. title .. '.png]]'
else
image = '[[File:No image.svg|' .. size .. '|link=]]'
end
elseif image:match( ';' ) then
if not animate then
animate = require( 'Module:Animate' ).animate
end
image = animate{ image, size }
else
image = '[[File:' .. image .. '|' .. size .. ']]'
end

table.insert( images, '<div>' .. image .. '</div>' )
end
images = table.concat( images, '\n' )

if #invImgCount > 0 then
table.sort( invImgCount )
local slot
local invIds = mw.loadData( 'Module:InvSprite/IDs' ).ids
for k, v in ipairs( invImgCount ) do
local image = args['invimage' .. v]
if image == 'title' then
local imageExists
if invIds[title] then
imageExists = true
else
local imageTitle = mw.title.new( 'File:Grid ' .. title .. '.png' )
imageExists = imageTitle and imageTitle.exists
end
if imageExists then
image = title
else
image = false
end
end

if image == '----' then
table.insert( invImages, '</div><div style="padding-top:.5em">' )
elseif image then
if not slot then
slot = require( 'Module:Inventory slot' ).slot
end
table.insert( invImages, slot{ image, link = 'none' } )
end
end

if slot and #invImages > 0 then
invImages = '<div class="infobox-invimages"><div>' .. table.concat( invImages, '' ) .. '</div></div>'
else
invImages = ''
end
else
invImages = ''
end

if images ~= '' or invImages ~= '' then
imageArea = images .. '\n' .. invImages
else
imageArea = 'none'
end
end
if imageArea and imageArea ~= 'none' then
imageArea = '<div class="infobox-imagearea">' .. imageArea .. '</div>'
else
imageArea = ''
end

local footer = args.footer
if footer then
footer = '| class="infobox-footer" colspan="2" | ' .. footer
end

local html = {
'<div class="notaninfobox">',
'<div class="mcwiki-header infobox-title">' .. title .. '</div>',
imageArea,
'{| class="infobox-rows" cellspacing="1" cellpadding="4"',
'|-',
args.rows or '',
footer or '',
'|}',
'</div>'
}

return table.concat( html, '\n' )
end

return p

Template:Infobox/doc

2015-07-24T12:05:13Z

Majr:

{{documentation header}}
{{lua}}
This is a skeleton for infoboxes, for use in other infobox templates or standalone.

== Usage ==

{<nowiki/>{infobox
| title = box title, defaults to page's name
| image''n'' = Images displayed below the title. Supports [[Template:Animate|animation]]. First image defaults to {{{title}}}.png. Set to "none" to remove.
| defaultimagesize = Set the default size used by the above images. Defaults to 150px.
| image''n''size = Sets the size of the corresponding image, overriding {{{defaultimagesize}}}.
| invimage''n'' = Invimages displayed under the images, using {{tl|grid}}. Set to "----" to add a line break. First invimage defaults to {{{title}}}, set to "none" to remove.
| imagearea = Completely replaces the functionality of the above 4 parameters, leaving a blank canvas below the title to put whatever
| rows = all rows go here using {{tl|infobox row}}
| footer = optional centered footer that goes across both columns
}}

<includeonly>

[[Category:Infobox templates|*]]
[[de:Vorlage:Infobox]]
[[es:Plantilla:Infobox]]
[[fr:Modèle:Infobox common]]
</includeonly>
<noinclude>

[[fr:Modèle:Infobox common/doc]]
</noinclude>

Template:Documentation header

2015-02-21T23:32:49Z

Majr:

<includeonly>{{#invoke: documentation | docPage }}</includeonly><noinclude>
{{documentation|content=
Used on the documentation page because the parser is nasty and won't let a template transclude itself even once. :(
}}

[[Category:Documentation templates|*]]

Template:Documentation

2014-02-15T10:15:35Z

Majr:

Module:ProcessArgs

2014-02-12T04:56:40Z

Majr: Protected "Module:ProcessArgs": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

local p = {}
function p.norm( origArgs )
if type( origArgs ) ~= 'table' then
origArgs = mw.getCurrentFrame():getParent().args
end
local args = {}

for k, v in pairs( origArgs ) do
v = mw.text.trim( tostring( v ) )
if v ~= '' then
args[k] = v
end
end

return args
end

function p.merge( origArgs, parentArgs, norm )
if type( origArgs ) ~= 'table' then
norm = origArgs
local f = mw.getCurrentFrame()
origArgs = f.args
parentArgs = f:getParent().args
end
local args = {}

for k, v in pairs( origArgs ) do
v = mw.text.trim( tostring( v ) )
if not norm or norm and v ~= '' then
args[k] = v
end
end

for k, v in pairs( parentArgs ) do
v = mw.text.trim( v )
if ( not norm or norm and v ~= '' ) and not args[k] then
args[k] = v
end
end

return args
end
return p

Template:Tl

2014-01-02T11:22:53Z

Majr: Majr moved page Template:Tl to Template:Template link: Use redirect for shortcut name

#REDIRECT [[Template:Template link]]