Module:Tt

Module documentation

[view] [edit] [history] [purge]

Main

Documentation

Usage

This module implements {{Tt}}.

Text above can be found here (edit)
Editors can experiment in this module's draft (create |  mirror) page.
Please add categories to the documentation subpage. Subpages of this module.

local p = {}

function p.main(frame)
	local args = require('Module:Arguments').getArgs(frame, {
		parentFirst = true,
		wrappers = { 'Template:Tt' }
	})

	args[1] = args[1] or '<i>Missing text</i>'

	if args.clean then
		return p.CleanTT(args[1])
	elseif not args[2] or args[2] == '' then
		return args[1]
	else
		return p._main(args)
	end
end

function p._main(args)
	local text = args[1]
	local tooltip = mw.text.decode(args[2], true)
	local out = mw.html.create()

	out:wikitext('&zwj;')

	local wrapper = out:tag('span')
		:addClass('custom-tt-wrapper')
		:addClass('toggle-tooltip')
		:addClass('mw-collapsible')
		:addClass('mw-collapsed')
		:addClass('giw-collapsible')

	if args.class and args.class ~= '' then
		wrapper:addClass(args.class)
	end

	local isLinked = (
		(args.link and args.link ~= '')
		or (text:find('%[%[') and text:find('%]%]'))
	)

	if isLinked then
		local link = tostring(args.link or '')

		-- Visible linked text
		if link == '1' then
			wrapper:wikitext('[[' .. text .. ']]&thinsp;')
		elseif link ~= '' then
			wrapper:wikitext('[[' .. link .. '|' .. text .. ']]&thinsp;')
		else
			wrapper:wikitext(text .. '&thinsp;')
		end

		-- Clean text for screen readers
		local cleanText = text
			:gsub('%[%[?[^|%]]+|', '')
			:gsub('%[%[', '')
			:gsub('%]%]', '')

		-- Store the tooltip label
		wrapper:attr(
			'data-tt-text',
			'ⓘ'
		)

		-- Info icon / actual collapsible toggle
		wrapper:tag('span')
			:addClass('mw-collapsible-toggle')
			:addClass('mw-collapsible-toggle-collapsed')
			:addClass('custom-tt')
			:attr('aria-label', 'Tooltip for ' .. cleanText)
			:wikitext(
				'<span class="screen-reader-text">Tooltip for '
				.. cleanText
				.. '</span>ⓘ'
			)
			:done()

	else
		-- Plain text itself is the toggle
		wrapper:attr('data-tt-text', text)

		wrapper:tag('span')
			:addClass('mw-collapsible-toggle')
			:addClass('mw-collapsible-toggle-collapsed')
			:addClass('custom-tt')
			:wikitext(text)
			:done()
	end

	-- Tooltip content
	wrapper:tag('span')
		:addClass('mw-collapsible-content')
		:addClass('custom-tt')
		:wikitext(tooltip)
		:done()

	out:wikitext('&zwj;')

	return out
end

function p.CleanTT(tx)
	local clean = tx:gsub(
		'&zwj;<span class="custom%-tt%-wrapper[^>]-data%-tt%-text="(.-)">.-&zwj;',
		'%1'
	)

	return clean
end

return p