Changes: Module:Tooltips

Latest revision as of 02:53, 29 November 2023

Tooltips builds tooltip links and icons. It can be used as a static or instantiated class.

Stylesheet for tooltips and tooltip text can be found on MediaWiki:Tooltips.css. The JS script that enables tooltips is sourced from https://dev.fandom.com/wiki/Tooltips

On this Wiki, Tooltips is used in:

{{A}}
{{M}}
{{WF}}
{{Companion}}
{{Relic}}
{{Weapon}}
{{Arcane}}
{{D}}
{{Resource}}
{{Focus}}
{{Faction}}
{{Gear}}
{{Stat}}

Usage

Direct Invocation

{{#invoke:Tooltip|function|input1|input2|...}}

Examples

Note that these only work on pages with the wikitext content model such as here. In addition, tooltips will not work if a page is added via <tabview> tags.

How it works

When you call a tooltip builder function (e.g. Tooltips.full(itemName, moduleName, ...)), it uses Module:Tooltips/icon to get the item image and page link from a module's /data subpage and builds the basic HTML tooltip tags to put on wiki articles ().
The JS script https://dev.fandom.com/wiki/Tooltips (imported in MediaWiki:ImportJS, configured in MediaWiki:Tooltips.js) does the fetching of data based on data-param (containing item name) and data-param2 (containing name of module which has a /data database containing the item's data) attributes in tooltip tags to build the actual tooltip defined by wikitext in Module:Tooltips/tip and css in MediaWiki:Tooltips.css.
- For example, ... will display a Template:Weapon tooltip of Artemis Bow (Weapon) while ... will display a Template:A ("A" is a shorthand for abilities) tooltip of Artemis Bow.
- The processed wikitext for tooltips will be located in a div container on the bottom of articles with an id of tooltip-storage.
- Data fetching uses MediaWiki's Action API.
- Note that tooltips do not work properly on module pages because they do not have the same HTML structure as article pages.

Documentation

Package items

tooltips._getText(name, index, rep) (function)

Returns formatted tooltip link text.

Parameters:

name Name of object entry to make a tooltip of (string)
index Tooltip index table (table)
rep Replacement args (table)

Returns: Wikitext link (string)

tooltips._getIcon(_, index) (function)

Returns tooltip icon.

Parameters:

_ Ignore; unused variable (string)
index Tooltip index table (table)

Returns: Image wikilink or nil (string)

tooltips.full(name, source, index) (function)

Get the tooltip text and icon.

Parameters:

name Name of object entry to make a tooltip of (can also be used as index) (string)
source Name of module containing object entry (nil to check if a manual index is working) (string)
index Index entry from m:tt/icon, or data point from (source) if source is set (table)
- - frame.args.r Replacement for displayed link text (nil, -> <name>) (string)
 - frame.args.color Color replacement for displayed link text (e.g. '#ffffff') (string)
 - frame.args.i Index for data replacement (will also prevent data from loading) (string)
 - frame.args.l Link for data replacement (string)
 - frame.args.n Name for data replacement (string)
 - frame.args.icon Icon image name for data replacement (e.g. 'Ash.png') (string)

Returns: Tooltip tags, icon, & link in wikitext (string)

tooltips.text(name, ...) (function)

Get the tooltip text with no icon.

Parameters:

name Name of object entry to make a tooltip of (string)
... see p.full (string)

Returns: Tooltip text in wikitext (string)

tooltips.icon(name, ...) (function)

Get the tooltip icon with no text.

Parameters:

name Name of object entry to make a tooltip of (string)
... see p.full (string)

Returns: Tooltip icon in wikitext (string)

tooltips._getIndex(name, source) (function)

Get the data index.

Parameters:

name Item name (string)
source Name of source module containing object entry (string)

Returns: index table (table)

tooltips.getTip(name, source, slot) (function)

Get the tooltip.

Parameters:

name Name of object entry to make a tooltip of (string)
source Name of source module containing object entry (string)
slot Name of submodule (string)

Returns: Tooltip (string)

tooltips._source(source) (function)

Returns a function that serves as a interface to tooltip builders. Another way of thinking about this function is to treat the entire module as a class. When you require(), the module, you are 'instantiating' a new instance of this class and pass in the name of the database to pull data from. Then you call a tooltip function and pass in a database entry name for the desired tooltip.

Parameter: source Name of source module containing object entry (string)

Returns: Wrapper function (function)

Created with Docbunto

Code

---	'''Tooltips''' builds tooltip links and icons. It can be used as a static or 
--	instantiated class.<br />
--	
--	Stylesheet for tooltips and tooltip text can be found on [[MediaWiki:Tooltips.css]].
--	The JS script that enables tooltips is sourced from https://dev.fandom.com/wiki/Tooltips
--	
--	@module		tooltips
--	@author		[[User:Gigamicro|Gigamicro]]
--	@image		TooltipPic.PNG
--	@require	[[w:c:dev:MediaWiki:Tooltips.js|MediaWiki:Tooltips.js]]
--	@require	[[Module:Tooltips/icon]]
--	@require	[[Module:Tooltips/tip]]
--	@release	stable
--	<nowiki>

local p = {}
local dataPrep;
dataPrep = setmetatable({}, { __index = function(self, index)
	dataPrep = require[[Module:Tooltips/icon]]
	return dataPrep[index]
end })

-- TODO: Update index table to be just a map instead of a mixed map and array.
-- Instead of index[3] (don't know what this contains at first glance), store the link in index['link'] or index['Link']

---	Returns formatted tooltip link text.
--	@function		p._getText
--	@param			{string} name Name of object entry to make a tooltip of
--	@param			{table} index Tooltip index table
--	@param			{table} rep Replacement args
--	@return			{string} Wikitext link
function p._getText(name, index, rep)
	return ('[[%s|<span style="border-bottom:2px dotted; color:%s;">%s</span>]]')
		:format(
			index[3] or name,
			rep.color ~= '' and rep.color or index.color or '',
			-- index.name is the Name key of object entries
			-- name is the index key to object entry (typically the same as Name key but not always)
			(rep.r ~= '' and rep.r or index.name or name or ' '):gsub('%s+', ' ')
		)
end

---	Returns tooltip icon.
--	@function		p._getIcon
--	@param			{string} _ Ignore; unused variable
--	@param			{table} index Tooltip index table
--	@return			{string} Image wikilink or nil
function p._getIcon(_, index)
	return index.icon ~= '' and index.icon or nil
end

---	Creates a tooltip index table for passing parameters to the tooltip builder.
--	@function		makeData
--	@param			{string} source Name of module containing object entry
--	@param			{table} frame Frame object
--	@return			{table} Tooltip index table or nil
local function makeData(source, frame)
	return (source and frame and type(frame) == 'table' and type(frame.args) == 'table' and frame.args.i) and {
		source,
		frame.args.i,
		frame.args.l,
		name = frame.args.n,
		icon = ('[[File:%s|x19px|link=%s|class=icon]]'):format(frame.args.icon, frame.args.l or ''),
		color = frame.args.color,
		overridden = true,
	} or nil
end

---	Function preprocessor.
--	@function		pp
--	@param			{function} func
--	@return			{function} tooltip span applied to return value of func
local function pp(func)
	return function(...)
		--standardise input to frame object equivalent
		--(nt,b,c)         ->(nt,b,c)
		--({args={a,b,c}}) -> (a,b,c)
		--({a,b,c})        -> (a,b,c)
		--(a,b,c)          -> (a,b,c)
		local frame = nil
			or type(...)~='table' and {args={...}}
			or (...).args         and       (...)
			or not select(2,...)  and {args=(...)}
			or true and true      and {args={...}}
		local name, source, index = (function(t) return t[1], t[2], t[3] end)(frame.args)--unpack doesn't work on the frame object
		if type(name) == 'table' then
			--({}) -> ({}.name/2,{}.1,{})
			index = name
			source = index[1]
			name = index.name or index[2]
		end
		if type(index) ~= 'table' then
			local error = '<strong class="error scribunto-error" title="%s">%s</strong>[[Category:Pages with script errors]]'
			if source == '' or not source then
				return error:format(debug.traceback('pp(func): source is '..type(source)..'. ', 2):gsub('[<>]', ''),
					'Where is '..(name and '"[['..name..']]"' or '<nil>')..'?')
			elseif name == '' or not name then
				return error:format(debug.traceback('pp(func): name is '..type(name)..'. ', 2):gsub('[<>]', ''),
					'What did you want in '..(source and '[[Module:'..source..'/data]]' or '<nil>')..'?')
			elseif not dataPrep[source] then
				return error:format(debug.traceback('pp(func): source is '..type(source)..'. ', 2):gsub('[<>]', ''),
					'Invalid source "'..source..'"')
			end
			--get the data from the source module + formatted
			--(a,b,nt) -> (dca,b,fdat)
			name = mw.text.decode(name)
			index = makeData(source, frame) or dataPrep[source](name)
			
			if not index then
				return error:format(debug.traceback('pp(func)', 1):gsub('[<>]', ''),
					(name and '"[['..name..']]"' or '<nil>')..' wasn\'t found in [[Module:'..source..'/data]]')
			end
		elseif not index[2] then
			--index is a data entry, get it formatted properly
			--(a,b,dat) -> (a,b,fdat)
			if not dataPrep[source] then
				error('M:Tooltips.pp()(): Missing tooltip gen script for source "'..(source or '<nil>')..'"')
			end
			index = dataPrep[source](index,name)
		end
		source = index[1]
		-- Damage tooltips are unique in that they both need invert and hue-rotate filters for colored damage icons and text
		return ('<span class="tooltip tooltip-full %s" data-param="%s" data-param2="%s">%s</span>')
			:format(source == 'DamageTypes' and 'damage-type-tooltip' or '', 
				index[2] or mw.log('pp(func): no index[2]:', name, index[1]) or name or index[3], source or error('no sauce :('..mw.dumpObject(index)) or 'nil', 
				func(name, index, frame.args)
			)
	end
end

---	Get the tooltip text and icon.
--	@function		p.full
--	@param			{string} name Name of object entry to make a tooltip of (can also be used as index)
--	@param			{string} source Name of module containing object entry (nil to check if a manual index is working)
--	@param			{table} index Index entry from m:tt/icon, or data point from (source) if source is set
--	@param			{string} frame.args.r Replacement for displayed link text (nil, '' -> <name>)
--	@param			{string} frame.args.color Color replacement for displayed link text (e.g. '#ffffff')
--	@param			{string} frame.args.i Index for data replacement (will also prevent data from loading)
--	@param			{string} frame.args.l Link for data replacement
--	@param			{string} frame.args.n Name for data replacement
--	@param			{string} frame.args.icon Icon image name for data replacement (e.g. 'Ash.png')
--	@example		`p.full('Serration', 'Mods')` for mod tooltip for Serration
--	@example		`p.full( { 'Serration', 'Mods', r = 'Replacement Display Link Name' } ) for mod tooltip for serration with replacement link text
--	@return			{string} Tooltip <span> tags, icon, & link in wikitext
p.full = pp(function(...)
	local icon = p._getIcon(...)
	return icon 
		and icon..' '..p._getText(...) --&nbsp;
		or p._getText(...)
end)
p.icontext = p.full

---	Get the tooltip text with no icon.
--	@function		p.text
--	@param			{string} name Name of object entry to make a tooltip of
--	@param			{string} ... see p.full
--	@return			{string} Tooltip text in wikitext
p.text = pp(p._getText)

---	Get the tooltip icon with no text.
--	@function		p.icon
--	@param			{string} name Name of object entry to make a tooltip of
--	@param			{string} ... see p.full
--	@return			{string} Tooltip icon in wikitext
p.icon = pp(p._getIcon)
p.image = p.icon

---	Get the data index.
--	@function		p._getIndex
--	@param			{string} name Item name
--	@param			{string} source Name of source module containing object entry
--	@return			{table} index table
p._getIndex = function(name, source)
	if name == '' or not name or source == '' or not source then
		return
	end
	-- name = mw.text.decode(name)
	
	local success, index = pcall(dataPrep[source], name)
	return success and index or nil
end

---	Get the tooltip.
--	@function		p.getTip
--	@param			{string} name Name of object entry to make a tooltip of
--	@param			{string} source Name of source module containing object entry
--	@param			{string} slot Name of submodule
--	@return			{string} Tooltip
p.getTip = function(frame, ...)
	local name, source, slot = (function(t) return t[1], t[2], t[3] end)(frame.args or {frame, ...})
	assert(name and name ~= '', 'p.getTip(): No name provided')
	return (require('Module:Tooltips/tip')[source] or 
		error('M:Tooltips.getTip(): Missing tooltip gen script for source "'..(source or '<nil>')..'"'))(name, slot)
end

---	Returns a function that serves as a interface to tooltip builders.
--	Another way of thinking about this function is to treat the entire module as a class.
--	When you require(), the module, you are 'instantiating' a new instance of this class
--	and pass in the name of the database to pull data from. Then you call a 
--	tooltip function and pass in a database entry name for the desired tooltip.
--	@function		p._source
--	@param			{string} source Name of source module containing object entry
--	@return			{function} Wrapper function
p._source = function(source)
	return function(func)
		return function(name, ...)
			return p[func](name, source, ...)
			-- E.g. require('Module:Tooltips')('Warframes')('full')('Ivara') === require('Module:Tooltips').full('Ivara', 'Warframes')
		end
	end
end

-- For calling export module directly: require('Module:Tooltips')()
setmetatable(p, { __call = function(self, ...) return p._source(...) end })

return p

Modules and Lua Libraries
Standard Libraries (STL)	Included	Scribunto (optional bit32 & libraryUtil)
Standard Libraries (STL)	Extensions	M:Math • M:String • M:Table
Databases	General	M:Codex (/data) • M:Companions (/data) • M:Conservation (/data) • M:DamageTypes (/data) • M:DojoRoom/data • M:Enemies (/data) • M:Factions/data • M:FactionScript (/data) • M:GuaranteedRewards/data • M:Icon (/data) • M:Keys/data • M:KeyBindings (/data) • M:Missions (/data) • M:Music/data • M:Upgrades/data • M:Version (/data)
	Warframes	M:Ability (/data) • M:Maximization (/data) • M:Warframes (/data)
	Weapons	M:Modular (/data) • M:Weapons (/data, /ppdata)
	Upgrades	M:Arcane (/data) • M:Decrees/data • M:Focus (/data) • M:Mods (/data) • M:Stances (/data)
	Drop Tables	M:Acquisition (/data) • M:DropTables (/data) • M:Void (/data)
	Vendors	M:Baro (/data) • M:Vendors (/data)
	Crafting	M:Blueprints/data • M:Research (/data) • M:Resources (/data)
	Cosmetics	M:Decorations (/data) • M:Cosmetics/data • M:Sigils/data • M:TennoGen (/data)
Infoboxes	M:Arcane/infobox • M:Conservation/infobox • M:Enemies/infobox • M:Missions/infobox • M:Mods/infobox • M:Resources/infobox • M:Void/page • M:Warframes/infobox • M:Weapons/infobox
Wiki	Dev Wiki Fork	Module:Common (/i18n) • M:Docbunto (/cli, /i18n) • M:Entrypoint • M:I18n • M:Infobox (/i18n) • M:LanguageList • M:Mbox (/i18n) • M:ModuleTest • M:Reference • M:ReleaseStatus (/i18n) • M:TestHarness (/i18n) • M:WDSButton (/data)
	Wikipedia Fork	M:Arguments (/i18n) • M:FallbackList • M:Yesno
	Third-Party Fork	M:Codec • M:CSV • M:Date • M:Inspect • M:JSON • M:Lexer • M:LuaClassSystem • M:LuaSerializer • M:Navbox • M:Navigation • M:Unindent
	Wiki-Unique	M:Database • M:DatastoreManifest • M:Delay • M:DependencyGraph • M:InfoboxBuilder • M:Lua • M:Map • M:Placeholder • M:RemoveCategory • M:StatObject • M:Tooltips
Other	M:Cost • M:Enum/data • M:InternalNames • M:MasteryRank • M:Polarity • M:Sandbox • M:WarframeUsageData2020/data
Archived/Depreciated	M:Avionics (/data) • M:BuildRequire • M:FormatingTool • M:Gallery • M:NightwaveActs • M:Shared • M:Syndicates/data • M:TennoScript • M:TranslationExamples • M:VoidByReward • M:WorldState (/data)
Bug Reports • Development Guide • Localization Guide (L10n Message Data Stores) • Programming Standards • Projects & Current Backlog • Updating Databases • Full Module List • Lua Reference Manual

Changes: Module:Tooltips

Latest revision as of 02:53, 29 November 2023

Contents

Usage

Direct Invocation

Examples

How it works

Directory

Documentation

Package items

See Also

Code