Halopedia

Module:Ref: Difference between revisions

Module Discussion

Module:Ref (view source)

Revision as of 13:06, September 24, 2022

6,809 bytes added ,  1 year ago
no edit summary
No edit summary
No edit summary
 
(36 intermediate revisions by the same user not shown)
Line 1: Line 1:
local utils = require( 'Module:Utils' )
local utils = require( 'Module:Utils' )
local arguments = require( 'Module:Arguments' )


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
Line 5: Line 6:
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


--[[[
Constructs a reference with the given text, using the provided parser frame, ref
id and group.
@param frame - object - The current parser frame
@param id - string - The id to give to the reference
@param group - string - The group to include the reference in
@param text - string - The text of the reference
@return wikitext - the constructed reference
]]
function makeRef( frame, id, group, text )
function makeRef( frame, id, group, text )
if text == nil or text == '' then
if utils.empty( text ) then
return utils.error(
return utils.error(
'No reference text was specified!',
'No reference text was specified!',
Line 14: Line 26:
text = tostring( text )
text = tostring( text )
local args = {}
local args = {}
if id ~= nil and id ~= '' then
if not utils.empty( id ) then
args.name = tostring( id )
args.name = tostring( id )
end
end
if group ~= nil and group ~= '' then
if not utils.empty( group ) then
args.group = tostring( group )
args.group = tostring( group )
end
end
Line 24: Line 36:
end
end


function makeGenericRef( frame, id, group )
--[[[
return 'TODO: Implement this'
Constructs a standard format reference using the given parameters, with the
provided content. Content table supports unlimited numeric arguments, in
addition to Subheading, Detail, Quote, Quotee and Suffix arguments.
 
@param frame - object - The current parser frame
@param id - string - The id to give to the reference
@param group - string - The group to include the reference in
@param content - table - The content of the reference
 
@return wikitext - the constructed reference
]]
function makeStandardRef( frame, id, group, content )
local text = makeRefText( content )
return makeRef( frame, id, group, text )
end
end


--[[[
Generates the text content of a standard format reference from the provided
arguments. Content table supports unlimited numeric arguments, in
addition to subheading, detail, quote, quotee and suffix arguments.
@param content - table - The content of the reference
@return wikitext - the constructed reference text
]]
function makeRefText( content )
local text = "''" .. tostring( content[ 1 ] or '' ) .. "''"
if not utils.empty( content.subheading ) then
text = text .. ': ' .. tostring( content.subheading )
end
content[ 1 ] = ''
for i, v in ipairs( content or {} ) do
if not utils.empty( v ) then
text = text .. ', ' .. tostring( v )
end
end
if not utils.empty( content.detail ) or not utils.empty( content.quote ) then
text = text .. ':'
if not utils.empty( content.detail ) then
text = text .. ' ' .. tostring( content.detail )
end
if not utils.empty( content.quote ) then
text = text .. " ''\"" .. tostring( content.quote ) .. "\"''"
if not utils.empty( content.quotee ) then
text = text .. ' - '
text = text .. uniqueLinkIfExists( content.quotee, content.quoteetext, 'ref' )
end
end
end
if not utils.empty( content.suffix ) then
text = text .. ' <small>' .. tostring( content.suffix ) .. '</small>'
end
return text
end
--[[[
Constructs wikitext to reuse an existing reference with the given id, in the
given group.
@param frame - object - The current parser frame
@param id - string - The id to give to the reference
@param group - string - The group to include the reference in
@return wikitext - the constructed reference reuse wikitext
]]
function makeReuse( frame, id, group )
function makeReuse( frame, id, group )
local args = {}
local args = {}
Line 44: Line 118:
end
end


--[[[
Constructs the list of references in a given group.
@param frame - object - The current parser frame
@param group - string - The reference group to list
@param colNum - int - The number of columns to use in the list
@param colWidth - int - The width list columns should be
@param colGap - int - The size of the gap between list columns
@return wikitext - the constructed reference
]]
function makeList( frame, group, colNum, colWidth, colGap )
function makeList( frame, group, colNum, colWidth, colGap )
local warnings = ''
local args = {}
if not utils.empty( group ) then
args.group = tostring( group )
end
return frame:extensionTag( 'references', '', args )
end
 
function uniqueLink( page, text, category )
local frame = mw.getCurrentFrame()
local listArgs = {}
if utils.empty( text ) then
if group ~= nil and group ~= '' then
text = page
listArgs.group = tostring( group )
end
end
local divArgs = {}
return frame:callParserFunction( '#uniquelink', page, text, category )
if colNum ~= nil and colNum ~= '' then
end
if tonumber( colNum ) == nil then
 
warnings = warnings .. utils.warning(
function uniqueLinkIfExists( page, text, category )
'Column amount must be a number! Instead, it was: "' .. colNum .. '"!',
local frame = mw.getCurrentFrame()
'ref list',
'Pages containing invalid template parameter warnings' )
if utils.empty( text ) then
else
text = page
colNum = tonumber( colNum )
divArgs[ '-moz-column-count' ] = colNum
divArgs[ '-moz-webkit-count' ] = colNum
divArgs[ 'column-count' ] = colNum
end
end
end
if colWidth ~= nil and colWidth ~= '' then
colWidth = tostring( colWidth )
return frame:callParserFunction( '#uniquelinkifexists', page, text, category )
if string.find( colWidth, '[:;"\']') then
end
warnings = warnings .. utils.warning(
 
'Column width cannot contain any of the following characters: \' " ; :',
function acronym( category, acronym, target, default )
'ref list',
local frame = mw.getCurrentFrame()
'Pages containing invalid template parameter warnings' )
else
if utils.empty( default ) then
divArgs[ '-moz-column-width' ] = colWidth
default = acronym
divArgs[ '-webkit-column-width' ] = colWidth
divArgs[ 'column-width' ] = colWidth
end
end
if colGap ~= nil and colGap ~= '' then
colGap = tostring( colGap )
if string.find( colGap, '[:;"\']') then
warnings = warnings .. utils.warning(
'Column gap cannot contain any of the following characters: \' " ; :',
'ref list',
'Pages containing invalid template parameter warnings' )
else
divArgs[ '-moz-column-gap' ] = colGap
divArgs[ '-webkit-column-gap' ] = colGap
divArgs[ 'column-gap' ] = colGap
end
end
end
local wikitext = frame:extensionTag( 'references', '', listArgs )
return frame:callParserFunction( '#acronym', category, acronym, target, default )
local html = mw.html.create( 'div' )
:attr( divArgs )
:wikitext( wikitext )
:allDone()
return html .. warnings
end
end


Line 108: Line 174:
local ref = {}
local ref = {}


--[[[
Invocation entry point for Template:Ref. Takes arguments Id, Name, Group and
Text from the template parser frame and constructs the appropriate reference.
@param frame - object - The current parser frame
@return wikitext - the constructed reference
]]
function ref.ref( frame )
function ref.ref( frame )
local templateFrame = frame:getParent()
local templateFrame = frame:getParent()
Line 116: Line 190:
end
end


--[[[
Invocation entry point for Template:Ref/List. Takes argument Group from the
template parser frame and constructs the appropriate reference list.
@param frame - object - The current parser frame
@return wikitext - the constructed reference list
]]
function ref.list( frame )
function ref.list( frame )
local templateFrame = frame:getParent()
local templateFrame = frame:getParent()
local group = templateFrame.args['Group']
local group = templateFrame.args['Group']
local colNum = templateFrame.args['Columns']
local colWidth = templateFrame.args['ColWidth']
local colGap = templateFrame.args['ColGap']
return makeList( frame, group, colNum, colWidth, colGap )
return makeList( frame, group, colNum, colWidth, colGap )
end
end


--[[[
Invocation entry point for Template:Ref/Generic.
@param frame - object - The current parser frame
@return wikitext - the constructed reference
]]
function ref.generic( frame )
function ref.generic( frame )
return 'TODO: Implement this'
local args, out = arguments.preprocess( frame, {
[ 'required' ] = { 'heading' },
[ 'recommended' ] = { 2 },
[ 'valid' ] = { 'id', 'subheading', 3, 4, 5, 6, 7, 'detail', 'quote',
'quotee', 'quoteelinktext', 'suffix' },
[ 'aliases' ] = { [ 1 ] = 'heading' }
} )
local content = {
args.heading, args[2], args[3], args[4], args[5], args[6], args[7],
[ 'subheading' ] = args.subheading,
[ 'detail' ] = args.detail,
[ 'quote' ] = args.quote,
[ 'quotee' ] = args.quotee,
[ 'suffix' ] = args.suffix
}
return out .. makeStandardRef( frame, args.id, nil, content)
end
 
--[[[
Invocation entry point for Template:Ref/Game.
 
@param frame - object - The current parser frame
 
@return wikitext - the constructed reference
]]
function ref.game( frame )
local args, out = arguments.preprocess( frame, {
[ 'required' ] = { 'game' },
[ 'recommended' ] = { 'what' },
[ 'valid' ] = { 'whattext', 'id', 'part', 'parttext', 'detail', 'quote',
'quotee', 'quoteetext', 'suffix' },
[ 'deprecated' ] = { 'gamelinktext', 'whatlinktext', 'partlinktext',
'quoteelinktext' },
[ 'aliases' ] = { [ 1 ] = 'game', [ 'gamelink' ] = 'game',
[ 2 ] = 'what', [ 'whatlink' ] = 'what', [ 3 ] = 'whattext',
[ 'whatlinktext' ] = 'whattext', [ 'partlink' ] = 'part',
[ 'expansion' ] = 'part',
[ 'dlc' ] = 'part', [ 'edition' ] = 'part', [ 'partlink' ] = 'part',
[ 'expansionlink' ] = 'part', [ 'dlclink' ] = 'part',
[ 'editionlink' ] = 'part',
[ 'partlinktext' ] = 'parttext', [ 'expansiontext' ] = 'parttext',
[ 'dlctext' ] = 'parttext', [ 'editiontext' ] = 'parttext',
[ 'quoteelinktext' ] = 'quoteetext' }
} )
 
local game = uniqueLinkIfExists(
acronym( 'game', args.game, 'page', args.game ),
args.gameLinkText or acronym( 'game', args.game, 'title', args.game ),
'ref'
)
local part
if not utils.empty( args.part ) then
part = uniqueLinkIfExists(
args.part,
args.parttext or args.part,
'ref'
)
end
local what
if not utils.empty( args.what ) then
what = uniqueLinkIfExists(
args.what,
args.whattext or args.what,
'ref'
)
end
local content = {
game, what,
[ 'subheading' ] = part or args.part,
[ 'detail' ] = args.detail,
[ 'quote' ] = args.quote,
[ 'quotee' ] = args.quotee,
[ 'quoteetext' ] = args.quoteetext or args.quotee,
[ 'suffix' ] = args.suffix
}
return out .. makeStandardRef( frame, args.id, nil, content)
end
 
--[[[
Invocation entry point for Template:Ref/File.
 
@param frame - object - The current parser frame
 
@return wikitext - the constructed reference
]]
function ref.file( frame )
local args, out = arguments.preprocess( frame, {
[ 'required' ] = { 'game', 'file' },
[ 'valid' ] = { 'gametext', 'excerpt', 'id', 'part', 'parttext',
'detail', 'quote', 'quotee', 'quoteetext', 'suffix' },
[ 'deprecated' ] = { 'gamelinktext' },
[ 'aliases' ] = { [ 1 ] = 'game', [ 'gamelink' ] = 'game',
[ 2 ] = 'file', [ 3 ] = 'excerpt',
[ 'gamelinktext' ] = 'gametext', [ 'partlink' ] = 'part',
[ 'expansion' ] = 'part',
[ 'dlc' ] = 'part', [ 'edition' ] = 'part', [ 'partlink' ] = 'part',
[ 'expansionlink' ] = 'part', [ 'dlclink' ] = 'part',
[ 'editionlink' ] = 'part',
[ 'partlinktext' ] = 'parttext', [ 'expansiontext' ] = 'parttext',
[ 'dlctext' ] = 'parttext', [ 'editiontext' ] = 'parttext',
[ 'quoteelinktext' ] = 'quoteetext' }
} )
 
local game = uniqueLinkIfExists(
acronym( 'game', args.game, 'page', args.game ),
args.gameLinkText or acronym( 'game', args.game, 'title', args.game ),
'ref'
)
local part
if not utils.empty( args.part ) then
part = uniqueLinkIfExists(
args.part,
args.parttext or args.part,
'ref'
)
end
local file = args.file or 'unspecified file'
file = 'game file <code>' .. file .. '</code>'
local excerpt = args.excerpt
if not utils.empty( excerpt ) then
excerpt = 'excerpt <code>' .. excerpt .. '</code>'
end
local content = {
game, file, excerpt,
[ 'subheading' ] = part or args.part,
[ 'detail' ] = args.detail,
[ 'quote' ] = args.quote,
[ 'quotee' ] = args.quotee,
[ 'quoteetext' ] = args.quoteetext or args.quotee,
[ 'suffix' ] = args.suffix
}
return out .. makeStandardRef( frame, args.id, nil, content)
end
end


return ref
return ref
Retrieved from "https://www.halopedia.org/Special:MobileDiff/1428780...1556511"