Module:Keyboard vis

Todo: Documentation

---

Documentation transcluded from /doc

---

local p = {}

local CORNER_TL				= '┌'
local CORNER_TR				= '┐'
local CORNER_BL				= '└'
local CORNER_BR				= '┘'
local BORDER_BLACK_KEY_TOP	= '╥'
local BORDER_WHITE_KEY_TOP	= '┬'
local BORDER_KEY_BOTTOM		= '┴'
local BORDER_BLACK_KEY_SIDE	= '║'
local BORDER_WHITE_KEY_SIDE	= '│'

-- Produces a small keyboard visualization
-- Likely to display correctly on most devices
function p.vis_small(step_pattern)
	local step_pattern = step_pattern or "LLLsLLs"
	
	local line_1 = CORNER_TL
	local line_2 = BORDER_WHITE_KEY_SIDE
	local line_3 = BORDER_WHITE_KEY_SIDE
	local line_4 = CORNER_BL
	
	for i = 1, #step_pattern do
		local current_step = step_pattern:sub(i,i)
		if current_step == "L" then
			line_1 = line_1 .. BORDER_BLACK_KEY_TOP
			line_2 = line_2 .. BORDER_BLACK_KEY_SIDE
			line_3 = line_3 .. BORDER_WHITE_KEY_SIDE
			line_4 = line_4 .. BORDER_KEY_BOTTOM
		elseif current_step == "s" then
			line_1 = line_1 .. BORDER_WHITE_KEY_TOP
			line_2 = line_2 .. BORDER_WHITE_KEY_SIDE
			line_3 = line_3 .. BORDER_WHITE_KEY_SIDE
			line_4 = line_4 .. BORDER_KEY_BOTTOM
		end
	end
	line_1 = line_1 .. CORNER_TR
	line_2 = line_2 .. BORDER_WHITE_KEY_SIDE
	line_3 = line_3 .. BORDER_WHITE_KEY_SIDE
	line_4 = line_4 .. CORNER_BR
	
	local out_str = '<pre style="background-color: white; '
		.. 'line-height: 1; '
		.. 'font-family: Courier New, monospace; '
		.. 'font-size: 1em; '
		.. 'padding: 0.1em; '
		.. 'margin: 0.1em;">'
		.. string.format('%s\n%s\n%s\n%s', line_1, line_2, line_3, line_4)
		.. '</pre>'
	return out_str
end

return p