User:Erutuon/scripts/footnoteCleanup.js: Difference between revisions

Content deleted Content added
attempt an escaping function
set event handler below definition of event handler (JavaScript hoisting of variable declarations is bizarre and the previous code might be wrong, but I don't know)
 
(39 intermediate revisions by the same user not shown)
Line 1:
/* <nowiki>
var namespaceNumber = mw.config.values.wgNamespaceNumber;
 
Moves refs and citation needed tags after punctuation.
if ( namespaceNumber === 0 )
*/
 
const namespaceNumber = mw.config.get("wgNamespaceNumber");
 
// Add a link just above the edit box, if you're in the main or Draft namespace.
if ( namespaceNumber === 0 || namespaceNumber === 118 )
{
mw.loader.load("//en.wiktionary.org/w/index.php?title=User:Erutuon/styles/wikitext-cleanup.css&action=raw&ctype=text/css", "text/css");
$("#editform").prepend('<div id="footnote-cleanup"><a href="javascript:cleanupFootnotes()">clean up footnotes</a></div>');
}
function escape(text, regexString, escapeTable, i)
{
var regex = new RegEx(regexString, "g");
text = text.replace(
regex,
function(match)
{
escapeTable[i] = match;
replacement = "%%" + i + "%%";
i += 1;
return replacement;
}
);
return text;
}
 
var cleanUpFootnotes = function cleanupFootnotes()
{
var textbox = $("#wpTextbox1");
if ( textbox )
{
var oldContentstextbox = textbox.val$("#wpTextbox1");
if ( !textbox )
return;
const oldContents = textbox.val();
var contents = oldContents;
// Escape ref tags.
var escaped = [];
var i = 0;
var replacements = [];
var count = 0;
var escape = function(text, regexString)
{
var regex = new RegExp(regexString, "g");
text = text.replace(
regex,
function(match)
{
escaped[i] = match;
var replacement = "%%" + i + "%%";
i += 1;
return replacement;
}
);
return text;
};
var puncRegex = /((?:%%\d+%%)+)([\.\,\;\:\"]{1,3})/g;
var reorder = function(match, capture1, capture2)
{
count += 1;
var replacement = capture2 + capture1;
replacements.push(replacement);
return replacement;
};
var fixPunctuationPlacement = function(text)
{
while ( puncRegex.test(text) )
text = text.replace(
/((?:%%\d+%%)+)([\.\,\;\:\"]{1,3})/g,
reorder
);
return text;
};
/* Escape various things:
ref tags */
contents = escape(
contents,
"<ref[^>]*>[^<]+<\\/ref>",
);
escaped,
contents = escape(
i
contents,
"<ref[^\\/]+\\/>"
);
// citation needed
contents = escape(
contents,
"\\{\\{(?:[Cc]itation needed|[Cc]n|[Ff]act|[Cc]b|[Cc]tn|[Rr]ef\\?)\\|[^\}]+\\}\\}"
);
contents = fixPunctuationPlacement(contents);
// footnote templates
/* Handles up to one level of nested templates.
Any more, and there may be problems. */
contents = escape(
contents,
"\\{\\{(?:sfn|efn|rfn)\\|(?:[^\\}]*?(?:\\{\\{[^\\}]+\\}\\})?)+\\}\\}"
);
Line 46 ⟶ 97:
}
contents = fixPunctuationPlacement(contents);
var count = 0;
var replacements = [];
if ( count > 0 ) {
mw.notify(count + " correction" + ( ( count > 1 && "s" ) || "" ) + " made: " + replacements.join());
}
/* Unescape the various things escaped above.
This has to be done twice, since escaping was done twice. */
contents = contents.replace(
/((?:%%(\d+)%%)+)([\.\,\;\:\)]{1,3})/g,
function(matchwholematch, capture1,number) capture2){
number = Number(number);
{
countreturn += 1escaped[number];
var replacement = capture2 + capture1;
replacements.push(replacement);
return replacement;
}
);
mw.notify(i + " corrections made: " + replacements.join());
contents = contents.replace(
/%%(\d+)%%/g,
Line 73 ⟶ 124:
if ( isUnchanged )
{
mw.notify("No misplaced footnotes or tagging templates were found.");
}
Line 79 ⟶ 130:
$("#wpSummary").val(function(index, summary)
{
var addition = "made sure refs are after punctuation with [[User:Erutuon/footnoteCleanup.js|JavaScript]]; see [[WP:REFPUNC]]";
mw.notify(summary);
const afterSectionName = summary.match(/^(?:\/\*[^\*]+\*\/)?\s*(.+)/);
var addition = "made sure refs are after punctuation with [[User:Erutuon/footnoteCleanup.js|JavaScript]]";
afterSectionName = summary.match(/^\/\*[^\*]+\*\/\s+(.+)/);
if ( afterSectionName && afterSectionName[1].length > 1 )
Line 90 ⟶ 139:
}
if ( !isUnchanged && ( !afterSectionName || !afterSectionName[1].includes(addition) ) )
{
return summary + addition;
}else
return summary;
}
);
};
if ( !$("#wikitext-cleanup-button-wrapper").length )
$("#editform").prepend('<div id="wikitext-cleanup-button-wrapper"></div>');
$("#wikitext-cleanup-button-wrapper")
.append(`<div id="footnote-cleanup" class="wikitext-cleanup-button">clean up footnotes</div>`);
$("#footnote-cleanup")
.click(cleanUpFootnotes);
}
 
// </nowiki>