Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Join the Playtest on Steam Now: SpiritVale

Module:Definitions: Difference between revisions

From SpiritVale Wiki
No edit summary
Tags: Reverted Mobile edit Mobile web edit
No edit summary
Tags: Mobile edit Mobile web edit
 
(12 intermediate revisions by the same user not shown)
Line 4: Line 4:
-- Data source (static):
-- Data source (static):
--  Module:Definitions/Definitions.json
--  Module:Definitions/Definitions.json
--
-- JSON shape:
-- {
--  "Schema": 1,
--  "UpdatedAt": "YYYY-MM-DD",
--  "Stat":  { "Vit": { "Name":"...", "Definition":"...", "Icon":"", "Link":"" }, ... },
--  "Target": { ... },
--  ...
-- }
--
--
-- Notes:
-- Notes:
Line 18: Line 9:
-- - CSS namespace: ONLY "sv-def" (plus sv-def--* modifiers).
-- - CSS namespace: ONLY "sv-def" (plus sv-def--* modifiers).
-- - Output classes: sv-def, sv-def-icon, sv-def-icon-img, sv-def-text.
-- - Output classes: sv-def, sv-def-icon, sv-def-icon-img, sv-def-text.
-- - Tooltip/link behavior is handled by Universal Popups (Common.js).


local p = {}
local p = {}
Line 34: Line 26:
local function lc(s)
local function lc(s)
return string.lower(tostring(s or ""))
return string.lower(tostring(s or ""))
end
local function truthy(v)
v = lc(mw.text.trim(tostring(v or "")))
return v == "1" or v == "true" or v == "yes" or v == "y"
end
end


Line 121: Line 118:
-- =============================================================================
-- =============================================================================
-- Icon rendering
-- Icon rendering
-- - Blank icon: render nothing (no generic dot/circle)
-- - Blank icon: render nothing
-- - Missing file: render "?" badge (no redlink image)
-- - Missing file: render "?" badge (no redlink image)
-- =============================================================================
-- =============================================================================
Line 142: Line 139:
end
end


return '<span class="sv-def-icon-img">[[' .. fileTitle .. '|15px|link=]]</span>'
return '<span class="sv-def-icon-img">[[' .. fileTitle .. '|14px|link=]]</span>'
end
end


-- =============================================================================
-- =============================================================================
-- Link rendering
-- Render
-- - If Link is present, render a real <a href="...">
-- - If Link is blank, render plain text
-- =============================================================================
-- =============================================================================


local function link_to_href(link)
local function render(domain, key, opts)
link = trim(link)
opts = opts or {}
if link == "" then return nil end
local noicon = truthy(opts.noicon)
 
local pill  = truthy(opts.pill)
-- External
local fill  = truthy(opts.fill)
if link:match("^https?://") or link:match("^//") then
return link
end


-- Internal: allow "Page#Fragment"
local page, frag = link:match("^(.-)#(.*)$")
if not page then
page = link
frag = nil
end
local t = mw.title.new(page)
if not t then
return nil
end
local url = t:localUrl()
if frag and frag ~= "" then
url = url .. "#" .. mw.uri.encode(frag, "WIKI")
end
return url
end
local function text_html(name, link)
name = tostring(name or "")
local href = link_to_href(link)
if href then
return '<a class="sv-def-text" href="' .. enc_attr(href) .. '">' .. mw.text.nowiki(name) .. '</a>'
end
return '<span class="sv-def-text">' .. mw.text.nowiki(name) .. '</span>'
end
-- =============================================================================
-- Render
-- =============================================================================
local function render(domain, key)
local db = load_db()
local db = load_db()
domain = norm_domain(db, domain)
domain = norm_domain(db, domain)
Line 217: Line 176:
local d_lc = lc(domain)
local d_lc = lc(domain)


-- Missing record: show a visible hint but NO tooltip/link data.
-- Missing record: visible hint, no tooltip/link attributes.
if rec == nil then
if rec == nil then
local miss_icon = noicon and "" or '<span class="sv-def-icon sv-def-icon--missing" aria-hidden="true">?</span>'
return
return
'<span class="sv-def sv-def--missing sv-def--' .. enc_attr(d_lc) .. '"' ..
'<span class="sv-def sv-def--missing' ..
(pill and ' sv-def--pill' or '') ..
(fill and ' sv-def--fill' or '') ..
' sv-def--' .. enc_attr(d_lc) .. '"' ..
' data-sv-def-domain="' .. enc_attr(domain) .. '"' ..
' data-sv-def-domain="' .. enc_attr(domain) .. '"' ..
' data-sv-def-key="' .. enc_attr(key) .. '"' ..
' data-sv-def-key="' .. enc_attr(key) .. '"' ..
(pill and ' data-sv-def-pill="1"' or '') ..
(fill and ' data-sv-def-fill="1"' or '') ..
'>' ..
'>' ..
'<span class="sv-def-icon sv-def-icon--missing" aria-hidden="true">?</span>' ..
miss_icon ..
'<span class="sv-def-text">' .. mw.text.nowiki(name) .. '</span>' ..
'<span class="sv-def-text">' .. mw.text.nowiki(name) .. '</span>' ..
'</span>'
'</span>'
end
end
local classes = 'sv-def sv-def--' .. enc_attr(d_lc)
if noicon then classes = classes .. ' sv-def--noicon' end
if pill then classes = classes .. ' sv-def--pill' end
if fill then classes = classes .. ' sv-def--fill' end


local attrs = {
local attrs = {
'class="sv-def sv-def--' .. enc_attr(d_lc) .. '"',
'class="' .. classes .. '"',
'data-sv-def-domain="' .. enc_attr(domain) .. '"',
'data-sv-def-domain="' .. enc_attr(domain) .. '"',
'data-sv-def-key="' .. enc_attr(key) .. '"',
'data-sv-def-key="' .. enc_attr(key) .. '"',
}
}
if pill then attrs[#attrs + 1] = 'data-sv-def-pill="1"' end
if fill then attrs[#attrs + 1] = 'data-sv-def-fill="1"' end


-- Only include tooltip/link attributes when populated.
-- Only include tooltip/link attributes when populated.
if defn ~= "" then
if defn ~= "" then
attrs[#attrs + 1] = 'data-sv-def-tip="' .. enc_attr(defn) .. '"'
attrs[#attrs + 1] = 'data-sv-def-tip="' .. enc_attr(defn) .. '"'
-- Interactive definitions are focusable for consistent UX.
attrs[#attrs + 1] = 'tabindex="0"'
end
end
if link ~= "" then
if link ~= "" then
Line 243: Line 218:
end
end


local title_attr = (defn ~= "") and (' title="' .. enc_attr(defn) .. '"') or ""
local ico = noicon and "" or icon_html(icon)


return
return
'<span ' .. table.concat(attrs, " ") .. title_attr .. '>' ..
'<span ' .. table.concat(attrs, " ") .. '>' ..
icon_html(icon) ..
ico ..
text_html(name, link) ..
'<span class="sv-def-text">' .. mw.text.nowiki(name) .. '</span>' ..
'</span>'
'</span>'
end
end
Line 258: Line 233:
function p.def(frame)
function p.def(frame)
local a = frame.args or {}
local a = frame.args or {}
return render(a[1] or a.Domain or a.domain, a[2] or a.Key or a.key)
local domain = a[1] or a.Domain or a.domain
local key    = a[2] or a.Key or a.key
local noicon = a.noicon or a.NoIcon or a[3]
local pill  = a.pill or a.Pill
local fill  = a.fill or a.Fill
return render(domain, key, { noicon = noicon, pill = pill, fill = fill })
end
end


function p.render(domain, key)
function p.render(domain, key, opts)
return render(domain, key)
return render(domain, key, opts)
end
end


return p
return p