MediaWiki:Common.js: Difference between revisions

Content deleted Content added
No edit summary
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 354:
});
 
/* Collapsible inlineInline footnotes ({{footnote}}). We click-triggeredrender card.the note OURSELVES, appended to
<body> (the ROOT stacking context), so a table's sticky column can never
Clicking the "note" chip toggles .ed-fn-open; ALL positioning/visibility
cover it and it behaves identically across browsers. The native title=""
is in Common.css (a fixed bottom-centre card), so the JS just flips the
class — theretooltip is nothingunreliable to+ mis-placeunstyled, so thewe cardmove canit neverto opendata-fn to(the bot still
reads the hidden .ed-fn-body span) and show:
"nothing". One card open at a time; outside-click and Escape dismiss;
- PHONE (no hover): tap a cue -> full-width banner at the top; tap to dismiss.
Enter/Space + aria-expanded for keyboard and screen readers. The note text
- DESKTOP (hover): hover a cue -> a small popover beside the cue.
stays in the DOM at all times, so the bot reads it from the parsed HTML. */
If this script never runs, the title="" stays and the native tooltip is the
$( function () {
graceful fallback. */
$( '.ed-fn-chip' ).attr( { role: 'button', tabindex: 0, 'aria-expanded': 'false' } );
(function () {
var cues = document.querySelectorAll('.ed-fn');
if (!cues.length) { return; }
 
// Suppress the native tooltip; keep the note text in data-fn.
function closeAll( except ) {
$( ' Array.ed-fnprototype.ed-fn-open' )forEach.eachcall(cues, function (el) {
if (el.hasAttribute('title')) {
if ( this !== except ) {
el.setAttribute('data-fn', el.getAttribute('title'));
$( this ).removeClass( 'ed-fn-open' )
el.removeAttribute('title');
.children( '.ed-fn-chip' ).attr( 'aria-expanded', 'false' );
}
}
} });
}
 
var box = null, activeCue = null;
$( document ).on( 'click keydown', '.ed-fn-chip', function ( e ) {
function noteOf(el) { return el.getAttribute('data-fn') || ''; }
if ( e.type === 'keydown' && e.key !== 'Enter' && e.key !== ' ' ) {
function cueOf(e) {
return;
var t = e.target;
}
return (t && t.closest) ? t.closest('.ed-fn') : null;
e.preventDefault();
}
var $fn = $( this ).closest( '.ed-fn' ),
function close() {
willOpen = !$fn.hasClass( 'ed-fn-open' );
if (box) { box.remove(); box = null; }
closeAll( $fn[ 0 ] );
activeCue = null;
$fn.toggleClass( 'ed-fn-open', willOpen );
document.removeEventListener('click', onAway, true);
$( this ).attr( 'aria-expanded', willOpen ? 'true' : 'false' );
}
} );
function onAway(e) {
if (!cueOf(e)) { close(); }
}
 
var touch = window.matchMedia && window.matchMedia('(hover: none)').matches;
// click outside any .ed-fn, or press Escape, to dismiss
 
$( document ).on( 'click', function ( e ) {
if (touch) {
if ( !$( e.target ).closest( '.ed-fn' ).length ) {
// Phone: full-width banner pinned to the top; the next tap anywhere dismisses.
closeAll( null );
document.addEventListener('click', function (e) {
}
var cue = cueOf(e);
} );
if (!cue) { return; }
$( document ).on( 'keydown', function ( e ) {
e.preventDefault();
if ( e.key === 'Escape' ) {
var txt = noteOf(cue);
closeAll( null );
if (!txt) { return; }
}
e.stopPropagation();
} );
close();
} );
box = document.createElement('div');
box.className = 'ed-fn-banner';
box.textContent = txt;
document.body.appendChild(box);
setTimeout(function () {
document.addEventListener('click', onAway, true);
}, 0);
}, false);
} else {
// Desktop: a styled popover beside the cue while hovering it.
document.addEventListener('mouseover', function (e) {
var cue = cueOf(e);
if (!cue || cue === activeCue) { return; }
var txt = noteOf(cue);
if (!txt) { return; }
close();
activeCue = cue;
box = document.createElement('div');
box.className = 'ed-fn-popover';
box.textContent = txt;
document.body.appendChild(box);
var r = cue.getBoundingClientRect();
var left = Math.max(8, Math.min(r.left, window.innerWidth - box.offsetWidth - 8));
var top = r.top - box.offsetHeight - 8; // above the cue...
if (top < 8) { top = r.bottom + 8; } // ...or below if no room
box.style.left = left + 'px';
box.style.top = top + 'px';
});
document.addEventListener('mouseout', function (e) {
if (!activeCue) { return; }
var to = e.relatedTarget;
if (to && to.closest && to.closest('.ed-fn') === activeCue) { return; }
close();
});
window.addEventListener('scroll', function () { if (box) { close(); } }, true);
}
})();
 
/* ── Datacheck confirm/correct gadget ───────────────────────────────────────
On a Datacheck: page (namespace 3006), fill each Module:ReportedTable row's
action cells — .rt-confirm / .rt-reject / .rt-override — with one button each
(Confirm toggle · Reject · Correct→enter a number), and mirror the verdict in the
.rt-status badge. Writes the verdict straight into the underlying Data:<...>.json
page under the REVIEWER'S OWN session (no bot creds). DOM order within each class
== records[] order (one per record); the exact Data title comes from the hidden
.rt-data-title marker. Verdicts survive a re-publish via wiki_extract.merge_verdicts
(value-gated). Anonymous users see the Status badge only (no buttons). */
$(function () {
if (!(window.mw && mw.config) || mw.config.get('wgNamespaceNumber') !== 3006) { return; }
var confirmCells = document.querySelectorAll('.rt-confirm');
var rejectCells = document.querySelectorAll('.rt-reject');
var overrideCells = document.querySelectorAll('.rt-override');
var statusCells = document.querySelectorAll('.rt-status');
if (!confirmCells.length) { return; }
if (!mw.config.get('wgUserName')) { mw.log('Datacheck: log in to enable confirm controls.'); return; }
 
// Data page title from the hidden marker, else derived from the page name (Datacheck:X -> Data:X.json).
var marker = document.querySelector('.rt-data-title');
var dataTitle = marker ? (marker.textContent || '').trim() : '';
if (!dataTitle) {
var pn = mw.config.get('wgPageName') || '', rest = pn.replace(/^Datacheck:/, '');
if (rest && rest !== pn) { dataTitle = 'Data:' + rest + '.json'; }
}
if (!dataTitle) { mw.log('Datacheck: could not resolve the Data page title.'); return; }
 
function notify(msg) { if (mw.notify) { mw.notify(msg); } else { mw.log(msg); } }
 
mw.loader.using(['mediawiki.api']).then(function () { // mw.notify is global; only the API needs loading
var api = new mw.Api(), data = null, baseRevId = null;
 
function fetchAndRender() {
api.get({ action: 'query', prop: 'revisions', rvprop: 'content|ids',
rvslots: 'main', titles: dataTitle, formatversion: 2 }).done(function (res) {
var page = res.query && res.query.pages && res.query.pages[0];
var rev = page && page.revisions && page.revisions[0];
if (!rev) { notify('Datacheck: data page not found — ' + dataTitle); return; }
baseRevId = rev.revid;
var content = rev.slots ? rev.slots.main.content : rev.content;
try { data = JSON.parse(content); }
catch (e) { notify('Datacheck: bad JSON in ' + dataTitle); return; }
render();
}).fail(function (code) { notify('Datacheck: load failed — ' + code); });
}
 
function save(okMsg) {
api.postWithEditToken({
action: 'edit', title: dataTitle, contentmodel: 'json',
text: JSON.stringify(data, null, 2),
summary: 'Datacheck: human verdict via confirm gadget', baserevid: baseRevId
}).done(function (res) {
if (res.edit && res.edit.newrevid) { baseRevId = res.edit.newrevid; }
render();
notify(okMsg || 'Datacheck: saved.');
}).fail(function (code) {
if (code === 'editconflict') { notify('Datacheck: edit conflict — reloading.'); fetchAndRender(); }
else { notify('Datacheck: save failed — ' + code); }
});
}
 
// Set the always-present verdict enum (unreviewed | confirmed | rejected | overridden); un-confirm /
// un-reject -> 'unreviewed'. Drops the pin + override fields so only the active verdict's fields remain.
function setStatus(rec, status, extra) {
delete rec.confirmed_rev; delete rec.override_reason; delete rec.alt_source;
rec.human_status = status || 'unreviewed';
for (var k in (extra || {})) { rec[k] = extra[k]; }
}
 
function toggleConfirm(rec) {
if (rec.human_status === 'confirmed') { setStatus(rec, 'unreviewed'); }
else { setStatus(rec, 'confirmed', { confirmed_rev: data.source_revision || null }); }
save();
}
 
function toggleReject(rec) {
if (rec.human_status === 'rejected') { setStatus(rec, 'unreviewed'); }
else { setStatus(rec, 'rejected', { confirmed_rev: data.source_revision || null }); }
save();
}
 
function correctRow(rec) {
var hint = 'measure=' + rec.measure + ', scale=' + (rec.scale || 1) +
(rec.currency ? ', ' + rec.currency : '');
var entered = window.prompt(
'Correct value for "' + rec.label + '" [' + (rec.business_line || 'Total') + '/' +
(rec.business_unit || 'Group') + ']\n(' + hint + ' — enter the stored value):', String(rec.value));
if (entered === null) { return; }
var num = parseFloat(String(entered).replace(/[,\s]/g, ''));
if (isNaN(num)) { notify('Datacheck: not a number — ' + entered); return; }
var reason = window.prompt('Reason (optional):', rec.override_reason || 'manual correction') || 'manual correction';
setStatus(rec, 'overridden', { value: num, confirmed_rev: data.source_revision || null, override_reason: reason });
save('Datacheck: override saved (' + num + ').');
}
 
// One <button> per action cell (styled as .rt-btn in Common.css); the active verdict's button is filled.
function btn(glyph, title, active, variant, handler) {
var b = document.createElement('button');
b.type = 'button'; b.textContent = glyph; b.title = title;
b.className = 'rt-btn rt-btn--' + variant + (active ? ' is-active' : '');
b.onclick = function (e) { e.preventDefault(); handler(); };
return b;
}
function fill(cell, node) { cell.innerHTML = ''; cell.appendChild(node); }
 
function render() {
if (!data || !data.records) { return; }
var n = data.records.length;
if (confirmCells.length !== n || rejectCells.length !== n ||
overrideCells.length !== n || statusCells.length !== n) {
notify('Datacheck: table out of sync with the data page — reload the page.'); return;
}
Array.prototype.forEach.call(confirmCells, function (cCell, i) {
var rec = data.records[i], status = rec.human_status || 'unreviewed';
fill(cCell, btn('✓', status === 'confirmed' ? 'Confirmed — click to un-confirm' : 'Confirm',
status === 'confirmed', 'confirm', function () { toggleConfirm(rec); }));
fill(rejectCells[i], btn('✗',
status === 'rejected' ? 'Rejected — click to clear' : 'Reject (wrong, no value yet)',
status === 'rejected', 'reject', function () { toggleReject(rec); }));
fill(overrideCells[i], btn('✎', 'Correct — enter the right number (override)',
status === 'overridden', 'override', function () { correctRow(rec); }));
var s = statusCells[i];
s.className = 'rt-status rt-status-' + status;
s.textContent = (status === 'confirmed') ? '✓ confirmed'
: (status === 'rejected') ? '✗ rejected'
: (status === 'overridden') ? ('✎ overridden → ' + rec.value)
: 'unreviewed';
});
}
 
fetchAndRender();
}, function (e) { mw.log('Datacheck: mediawiki.api failed to load', e); });
});
 
 
/* ── Datacheck term_map review gadget ────────────────────────────────────────
On a Datacheck: page that renders Module:TermMap in review mode, turn each row's
.tm-validate / .tm-redo controls into Validate / Redo buttons. Each click prompts
for a comment (REQUIRED) and writes review_status + comment + reviewed_by/at into the
matching Data:term_map.json entry — keyed by the row's hidden .tm-key (the JSON key),
under the REVIEWER'S OWN session (no bot creds). Reviews survive a redeploy via
deploy.py term_map_data merge-forward. Anonymous users see the badge + comment only. */
$(function () {
if (!(window.mw && mw.config) || mw.config.get('wgNamespaceNumber') !== 3006) { return; }
var vCells = document.querySelectorAll('.tm-validate');
if (!vCells.length) { return; } // not a term_map review page
if (!mw.config.get('wgUserName')) { mw.log('TermMap review: log in to enable controls.'); return; }
 
var marker = document.querySelector('.tm-data-title');
var dataTitle = marker ? (marker.textContent || '').trim() : 'Data:term_map.json';
 
function notify(msg) { if (mw.notify) { mw.notify(msg); } else { mw.log(msg); } }
function nowIso() { return new Date().toISOString().slice(0, 19) + 'Z'; }
 
mw.loader.using(['mediawiki.api']).then(function () {
var api = new mw.Api(), data = null, baseRevId = null, rows = [];
 
function collect() { // one entry per review row, mapped by .tm-key
rows = [];
Array.prototype.forEach.call(vCells, function (vCell) {
var tr = vCell.closest ? vCell.closest('tr') : null;
if (!tr) { return; }
var keyEl = tr.querySelector('.tm-key');
rows.push({
key: keyEl ? (keyEl.textContent || '').trim() : '',
vCell: vCell, rCell: tr.querySelector('.tm-redo'),
badge: tr.querySelector('.rt-status'), comment: tr.querySelector('.tm-comment')
});
});
}
 
function fetchAndRender() {
api.get({ action: 'query', prop: 'revisions', rvprop: 'content|ids',
rvslots: 'main', titles: dataTitle, formatversion: 2 }).done(function (res) {
var page = res.query && res.query.pages && res.query.pages[0];
var rev = page && page.revisions && page.revisions[0];
if (!rev) { notify('TermMap: data page not found — ' + dataTitle); return; }
baseRevId = rev.revid;
var content = rev.slots ? rev.slots.main.content : rev.content;
try { data = JSON.parse(content); }
catch (e) { notify('TermMap: bad JSON in ' + dataTitle); return; }
render();
}).fail(function (code) { notify('TermMap: load failed — ' + code); });
}
 
function save(okMsg) {
api.postWithEditToken({
action: 'edit', title: dataTitle, contentmodel: 'json',
text: JSON.stringify(data, null, 4),
summary: 'TermMap review: human verdict via review gadget', baserevid: baseRevId
}).done(function (res) {
if (res.edit && res.edit.newrevid) { baseRevId = res.edit.newrevid; }
render();
notify(okMsg || 'TermMap: saved.');
}).fail(function (code) {
if (code === 'editconflict') { notify('TermMap: edit conflict — reloading.'); fetchAndRender(); }
else { notify('TermMap: save failed — ' + code); }
});
}
 
function setReview(rec, status, comment) {
rec.review_status = status;
rec.comment = comment;
rec.reviewed_by = mw.config.get('wgUserName');
rec.reviewed_at = nowIso();
}
 
function act(rec, status) {
var verb = (status === 'validated') ? 'Validate' : 'Redo';
var entered = window.prompt(verb + ' — why? (stored as the review comment)', rec.comment || '');
if (entered === null) { return; } // cancelled
entered = entered.replace(/^\s+|\s+$/g, '');
if (!entered) { notify('TermMap: a comment is required.'); return; }
setReview(rec, status, entered);
save('TermMap: ' + verb.toLowerCase() + 'd.');
}
 
function btn(label, title, active, variant, handler) {
var b = document.createElement('button');
b.type = 'button'; b.textContent = label; b.title = title;
b.className = 'rt-btn rt-btn--' + variant + (active ? ' is-active' : '');
b.onclick = function (e) { e.preventDefault(); handler(); };
return b;
}
function fill(cell, node) { if (cell) { cell.innerHTML = ''; cell.appendChild(node); } }
 
function render() {
if (!data) { return; }
rows.forEach(function (r) {
var rec = data[r.key];
if (!rec) { return; }
var status = rec.review_status || 'unreviewed';
fill(r.vCell, btn('✓', status === 'validated' ? 'Validated — click to edit the comment' : 'Validate (with a reason)',
status === 'validated', 'confirm', function () { act(rec, 'validated'); }));
fill(r.rCell, btn('↻', status === 'redo' ? 'Marked redo — click to edit the comment' : 'Redo (with a reason)',
status === 'redo', 'override', function () { act(rec, 'redo'); }));
if (r.badge) {
r.badge.className = 'rt-status rt-status-' + status;
r.badge.textContent = (status === 'validated') ? '✓ validated' : (status === 'redo') ? '↻ redo' : 'unreviewed';
}
if (r.comment) { r.comment.textContent = rec.comment || ''; }
});
}
 
collect();
fetchAndRender();
}, function (e) { mw.log('TermMap review: mediawiki.api failed to load', e); });
});
 
 
/* ── Hide DEEP (nested) level-6 headings from the sidebar (Vector) TOC ────────
The doc pages carry repeated h6 sub-entries that clutter the TOC. MediaWiki's
TOC classes (vector-toc-level-N) encode only a COMPACTED nesting depth, not
the original tag, so CSS can't target h6 — resolve each entry to its body
heading instead. We hide ONLY NESTED h6: a TOP-LEVEL section that happens to
be h6 (e.g. Cover / Audit Information) is KEPT, because hiding a numbered
top-level entry leaves a gap in MediaWiki's static TOC numbers (0 -> 3). */
(function () {
function headingFor(anchor) {
if (!anchor) { return null; }
var el = document.getElementById(anchor);
if (!el) {
try { el = document.getElementById(decodeURIComponent(anchor)); } catch (e) {}
}
if (!el) { return null; }
if (el.matches && el.matches('h1,h2,h3,h4,h5,h6')) { return el; }
return el.closest ? el.closest('h1,h2,h3,h4,h5,h6') : null;
}
function pruneTocH6() {
var items = document.querySelectorAll('.vector-toc .vector-toc-list-item');
Array.prototype.forEach.call(items, function (li) {
var a = li.querySelector('a.vector-toc-link');
if (!a) { return; }
var href = a.getAttribute('href') || '';
if (href.charAt(0) !== '#' || href.length < 2) { return; }
var h = headingFor(href.slice(1));
if (!h || h.tagName !== 'H6') { return; }
// Only hide NESTED h6 (deep repeated sub-entries). A top-level h6 section
// is kept so the top-level numbering stays contiguous.
var nested = li.parentElement && li.parentElement.closest &&
li.parentElement.closest('.vector-toc-list-item');
if (nested) { li.style.display = 'none'; }
});
}
// After hiding nested h6 entries, a parent whose children were ALL h6 keeps a
// dangling expand/collapse chevron with nothing left to reveal — hide those
// toggles (and restore any that still have a visible child, on a re-run).
function hideEmptyToggles() {
var items = document.querySelectorAll('.vector-toc .vector-toc-list-item');
Array.prototype.forEach.call(items, function (li) {
var toggle = li.querySelector(':scope > .vector-toc-toggle');
if (!toggle) { return; }
var childList = li.querySelector(':scope > .vector-toc-list');
var visible = false;
if (childList) {
Array.prototype.forEach.call(
childList.querySelectorAll(':scope > .vector-toc-list-item'),
function (k) { if (k.style.display !== 'none') { visible = true; } }
);
}
toggle.style.display = visible ? '' : 'none';
});
}
function run() { pruneTocH6(); hideEmptyToggles(); }
if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', run);
} else {
run();
}
// Vector can lazily (re)build the pinned TOC; re-run on its content hook.
if (window.mw && mw.hook) { mw.hook('wikipage.content').add(run); }
})();