Modded Wiki

Module:Sprite: Difference between revisions

← Older editNewer edit →
Actually support not showing text, rather than hacking it with an empty string
Update to support merging settings and IDs module into a single data module, and specifying an inline URL in the settings for instant cache busting. The sprite documentation will be broken until the modules are merged.
Line 7: Line 7:
f = mw.getCurrentFrame()
f = mw.getCurrentFrame()
end
end
local data = args.data and mw.loadData( 'Module:' .. args.data ) or {}
local settings = data.settings or args.settings and mw.loadData( 'Module:' .. args.settings )
settings = settings and settings.settings or settings
-- Default settings
-- Default settings
Line 18: Line 22:
local defaultStyle = default
local defaultStyle = default
if args.settings then
if settings then
local settings = mw.loadData( 'Module:' .. args.settings )
if not settings.stylesheet then
if not settings.stylesheet then
-- Make a separate clone of the current default settings
-- Make a separate clone of the current default settings
Line 41: Line 44:
local styles = {}
local styles = {}
if setting( 'url' ) then
styles[#styles + 1] = 'background-image:' .. setting( 'url' )
end
if setting( 'stylesheet' ) then
if setting( 'stylesheet' ) then
sprite:addClass(
sprite:addClass(
Line 46: Line 52:
mw.ustring.lower( setting( 'name' ):gsub( ' ', '-' ) ) .. '-sprite'
mw.ustring.lower( setting( 'name' ):gsub( ' ', '-' ) ) .. '-sprite'
)
)
else
elseif not setting( 'url' ) then
table.insert( styles, 'background-image:{{FileUrl|' .. (
styles[#styles + 1] = 'background-image:' .. p.getUrl(
setting( 'image' ) or setting( 'name' ) .. 'Sprite.png'
setting( 'image' ) or setting( 'name' ) .. 'Sprite.png'
) .. '}}' )
)
end
end
local class = setting( 'class' )
local class = setting( 'class' )
Line 57: Line 63:
local size = setting( 'size' )
local size = setting( 'size' )
local pos = math.abs( setting( 'pos' ) ) - 1
local sheetWidth = setting( 'sheetsize' )
local sheetWidth = setting( 'sheetsize' )
local tiles = sheetWidth / size
local tiles = sheetWidth / size
local left = pos % tiles * size
local pos = setting( 'pos' ) - 1
local top = math.floor( pos / tiles ) * size
local scale = setting( 'scale' )
local scale = setting( 'scale' )
local autoScale = setting( 'autoscale' )
local autoScale = setting( 'autoscale' )
if left > 0 or top > 0 then
if pos then
table.insert( styles, 'background-position:-' .. left * scale .. 'px -' .. top * scale .. 'px' )
local left = pos % tiles * size * scale
local top = math.floor( pos / tiles ) * size * scale
styles[#styles + 1] = 'background-position:-' .. left .. 'px -' .. top .. 'px'
end
end
if not autoScale and scale ~= defaultStyle.scale then
if not autoScale and scale ~= defaultStyle.scale then
table.insert( styles, 'background-size:' .. sheetWidth * scale .. 'px auto' )
styles[#styles + 1] = 'background-size:' .. sheetWidth * scale .. 'px auto'
end
end
if size ~= defaultStyle.size or ( not autoScale and scale ~= defaultStyle.scale ) then
if size ~= defaultStyle.size or ( not autoScale and scale ~= defaultStyle.scale ) then
table.insert( styles, 'height:' .. size * scale .. 'px' )
styles[#styles + 1] = 'height:' .. size * scale .. 'px'
table.insert( styles, 'width:' .. size * scale .. 'px' )
styles[#styles + 1] = 'width:' .. size * scale .. 'px'
end
end
local align = setting( 'align' )
local align = setting( 'align' )
if align ~= defaultStyle.align then
if align ~= defaultStyle.align then
table.insert( styles, 'vertical-align:' .. align )
styles[#styles + 1] = 'vertical-align:' .. align
end
end
table.insert( styles, setting( 'css' ) )
styles[#styles + 1] = setting( 'css' )
sprite:cssText( table.concat( styles, ';' ) )
sprite:cssText( table.concat( styles, ';' ) )
Line 126: Line 135:
end
end
local default = args.settings and mw.loadData( 'Module:' .. args.settings )
local data = args.data and mw.loadData( 'Module:' .. args.data ) or {}
default = default and default.settings or default or data.settings or {}
local categories = {}
local categories = {}
local idData = args.iddata
local idData = args.iddata
if not idData then
if not idData then
local default = {}
if args.settings then
default = mw.loadData( 'Module:' .. args.settings )
end
local name = args.name or default.name
local name = args.name or default.name
local ids = mw.loadData( 'Module:' .. ( args.ids or default.ids or name .. '/IDs' ) )
local ids = data.ids or mw.loadData( 'Module:' .. ( args.ids or default.ids or name .. '/IDs' ) ).ids
ids = ids.ids or ids
local id = mw.text.trim( tostring( args[1] or '' ) )
local id = mw.text.trim( tostring( args[1] or '' ) )
idData = ids[id] or ids[mw.ustring.lower( id ):gsub( '[%s%+]', '-' )]
idData = ids[id] or ids[mw.ustring.lower( id ):gsub( '[%s%+]', '-' )]
Line 145: Line 151:
local disallowCats = args.nocat or title.isTalkPage or title.nsText:find( '^User' )
local disallowCats = args.nocat or title.isTalkPage or title.nsText:find( '^User' )
if idData then
if idData then
if type( idData ) == 'table' then
if idData.deprecated and not disallowCats then
if idData.deprecated and not disallowCats then
categories[#categories + 1] = f:expandTemplate{ title = 'Translation category', args = { 'Pages using deprecated sprite names', project = 0 } }
table.insert( categories, f:expandTemplate{ title = 'Translation category', args = { 'Pages using deprecated sprite names', project = 0 } } )
end
args.pos = idData.pos
else
args.pos = idData
end
end
args.pos = idData.pos
elseif not disallowCats then
elseif not disallowCats then
table.insert( categories, f:expandTemplate{ title = 'Translation category', args = { 'Pages with missing sprites', project = 0 } } )
categories[#categories + 1] = f:expandTemplate{ title = 'Translation category', args = { 'Pages with missing sprites', project = 0 } }
end
end
return p.base( args ), table.concat( categories, '' )
return p.base( args ), table.concat( categories )
end
end


Line 181: Line 183:
return p.sprite( args )
return p.sprite( args )
end
function p.getUrl( spritesheet, query )
return mw.getCurrentFrame():expandTemplate{ title = 'FileUrl', args = { spritesheet, query = query } }
end
end


Line 190: Line 196:
f = mw.getCurrentFrame()
f = mw.getCurrentFrame()
end
end
local settingsPage = mw.text.trim( args[1] )
local dataPage = mw.text.trim( args[1] )
local settings = mw.loadData( 'Module:' .. settingsPage )
local data = mw.loadData( 'Module:' .. dataPage )
local idsPage = 'Module:' .. ( settings.ids or settings.name .. '/IDs' )
local getProtection = function( title, action, extra )
local getProtection = function( title, action, extra )
local protections = { 'edit' }
local protections = { 'edit' }
if extra then
if extra then
table.insert( protections, extra )
protections[#protections + 1] = extra
end
end
Line 207: Line 212:
end
end
table.insert( protections, protection )
protections[#protections + 1] = protection
end
end
Line 216: Line 221:
local cascading = title.cascadingProtection.restrictions[action] or {}
local cascading = title.cascadingProtection.restrictions[action] or {}
if #cascading > 0 then
if #cascading > 0 then
table.insert( protections, 'protect' )
protections[#protections + 1] = 'protect'
end
end
for _, protection in ipairs( cascading ) do
for _, protection in ipairs( cascading ) do
Line 225: Line 230:
end
end
local body
local dataTitle = mw.title.new( 'Module:' .. dataPage )
if args.refresh then
local spritesheet = data.settings.image or data.settings.name .. 'Sprite.png'
body = mw.html.create( '' )
local spriteTitle = mw.title.new( 'File:' .. spritesheet )
else
local dataProtection = getProtection( dataTitle, 'edit' )
local idsTitle = mw.title.new( idsPage )
local spriteProtection = getProtection( spriteTitle, 'upload', 'upload,reupload' )
local spritesheet = settings.image or settings.name .. 'Sprite.png'
local body = mw.html.create( 'div' ):attr( {
local spriteTitle = mw.title.new( 'File:' .. spritesheet )
id = 'spritedoc',
local idsProtection = getProtection( idsTitle, 'edit' )
['data-dataprotection'] = dataProtection,
local spriteProtection = getProtection( spriteTitle, 'upload', 'upload,reupload' )
['data-datatimestamp'] = f:callParserFunction( 'REVISIONTIMESTAMP', 'Module:' .. dataPage ),
body = mw.html.create( 'div' ):attr( {
['data-datapage'] = 'Module:' .. dataPage,
id = 'spritedoc',
['data-spritesheet'] = spritesheet,
['data-idspage'] = idsTitle.id,
['data-spriteprotection'] = spriteProtection,
['data-idsprotection'] = idsProtection,
['data-urlfunc'] = "require( [[Module:Sprite]] ).getUrl( '" .. spritesheet .. "', '$1' )",
['data-idstimestamp'] = f:callParserFunction( 'REVISIONTIMESTAMP', idsPage ),
['data-refreshtext'] = mw.text.nowiki( '{{#invoke:sprite|doc|' .. dataPage .. '|refresh=1}}' ),
['data-spritesheet'] = spritesheet,
['data-settings'] = mw.text.jsonEncode( data.settings ),
['data-spriteprotection'] = spriteProtection,
} )
['data-pos'] = settings.pos or 1,
['data-refreshtext'] = mw.text.nowiki( '{{#invoke:sprite|doc|' .. settingsPage .. '|refresh=1}}' )
} )
end
local data = mw.loadData( idsPage )
local sections = {}
local sections = {}
for _, sectionData in ipairs( data.sections or { 'Uncategorized' } ) do
for _, sectionData in ipairs( data.sections or { name = 'Uncategorized' } ) do
local sectionTag = body:tag( 'div' ):addClass( 'spritedoc-section' ):attr( 'data-section-id', sectionData.id )
local sectionTag = body:tag( 'div' ):addClass( 'spritedoc-section' ):attr( 'data-section-id', sectionData.id )
-- https://phabricator.wikimedia.org/T73594
sectionTag:tag( 'h3' ):wikitext( sectionData.name )
sectionTag:wikitext( '<h3>', sectionData[1], '</h3>' )
sections[sectionData.id] = { boxes = sectionTag:tag( 'ul' ):addClass( 'spritedoc-boxes' ) }
sections[sectionData.id] = { boxes = sectionTag:tag( 'ul' ):addClass( 'spritedoc-boxes' ) }
end
end
local keyedData = {}
local keyedData = {}
local i = 1
for name, idData in pairs( data.ids ) do
for name, idData in pairs( data.ids ) do
table.insert( keyedData, {
keyedData[i] = {
sortKey = mw.ustring.lower( name ),
sortKey = mw.ustring.lower( name ),
name = name,
name = name,
data = idData
data = idData
} )
}
i = i + 1
end
end
table.sort( keyedData, function( a, b )
table.sort( keyedData, function( a, b )
Line 276: Line 276:
local box = section.boxes:tag( 'li' ):addClass( 'spritedoc-box' ):attr( 'data-pos', pos )
local box = section.boxes:tag( 'li' ):addClass( 'spritedoc-box' ):attr( 'data-pos', pos )
box:tag( 'div' ):addClass( 'spritedoc-image' )
box:tag( 'div' ):addClass( 'spritedoc-image' )
:wikitext( p.base{ pos = pos, settings = settingsPage } )
:wikitext( p.base{ pos = pos, data = dataPage } )
names = box:tag( 'ul' ):addClass( 'spritedoc-names' )
names = box:tag( 'ul' ):addClass( 'spritedoc-names' )
Line 293: Line 293:
return '', tostring( body )
return '', tostring( body )
end
end
return f:callParserFunction( '#widget:Stylesheet', { page = 'SpriteDoc' } ), tostring( body )
return f:callParserFunction( '#widget:SpriteDoc.css' ), tostring( body )
end
end
return p
return p
Retrieved from "https://modded.wiki/w/Module:Sprite"