Wikipedia

User:PleaseStand/segregate-refs-dev.js: Difference between revisions

Browse history interactively
← Previous edit
Content deleted Content added
updating to warn against accidentally deleting ref codes
add refsDiv directly under #editform, not within .wikiEditor-ui (fixes overlap issue)
 
(37 intermediate revisions by the same user not shown)
Line 1:
//<pre><nowiki>
 
/* segregate-refs.js: A user script to simplify editing of articles
using inline ref tags with the Cite.php extension to MediaWiki.
Copyright (c) 2010, PleaseStand
This software is licensed under these licenses:
1. Creative Commons Attribution-Share Alike 3.0 Unported License
(see <http://creativecommons.org/licenses/by-sa/3.0/> for the text)
2. GNU Free Documentation License, any published version.
(see <http://www.gnu.org/copyleft/fdl.html> for the text)
3. Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
You may select the license(s) of your choice if you wish to copy, modify, or
distribute this software. If you modify the software and do not wish to
license your changes under one or more of the licenses, please remove
the license(s) from the list above.
*/
 
/*global window, addOnloadHook, addHandlerSegregateRefsJsL10n, SegregateRefsJsL10nSegregateRefsJsAllowConversion,
SegregateRefsJsEmptyRefsWarningGiven, SegregateRefsJsAllowConversion,
wikEdUseWikEd, WikEdUpdateTextarea, WikEdUpdateFrame*/
 
// <nowiki>
 
// Translate the right-hand side of these if necessary.
Line 37 ⟶ 36:
// var SegregateRefsJsL10n = {
var SegregateRefsJsMsgs = {
version: 1.11,
buttonText: "Segregate refs for editing",
buttonStyle: "background: #dfd;",
buttonConvertText: "Migrate article to LDR",
buttonConvertStyle: "background: #fdd;",
autoWord: "Auto",
convertRefsWarning: "WARNING: You need consensus to migrate an article to list-defined references format (LDR) BEFORE you do so.\n\nClick Cancel now if consensus has not been established in favor of this migration. If there is consensus to make the conversion, click OK to do so.",
emptyRefsWarning: "IMPORTANT: This page includes one or more named " +
groupPrompt: "Please enter the name of a group (as it appears in the wikitext, including any quotes). Leave this blank if unsure.",
"footnotes of which the first occurrence(s) have no contents, which is " +
refsHeader: "Inline footnotes",
"not best practice. This script does not harm such footnotes, however " +
convertHeader: "Generated refs list",
"you should be aware that this script ONLY CHECKS THE FIRST REF TAG " +
refsCommentComplete: "<!-- Converted to LDR format\n using [[User:PleaseStand/References segregator]] -->\n\n",
"it finds for the actual citation or note text, and you must work within " +
convertSummary: "Converted footnotes to LDR format (using [[User:PleaseStand/References segregator|segregate-refs]])",
"this limitation. Any change to the empty ref tag will replace the " +
convertFurther: "This script has done most of the work. However, you still need to do the following:\n\n* Insert the refs list in the new textbox into the proper place in the wikitext.\n* If converting a special group, optionally remove the group attributes.\n* Replace all autogenerated names with human-generated names.\n\nYou can do the above with the Find/Replace command in many text editors. (Always use the quoted form of the attributes.) Then, paste the text back into the edit form and save the page.",
"footnote entirely and leave the old note text hidden.\n\n" +
integrateWarning: "The refs listed below are missing from the text. If you continue, they will be permanently deleted. Are you sure?\n\nUnused refs: "
"BEFORE concluding from the footnotes list that a ref is in fact empty, " +
"please manually check all identically-named ref tags for the contents. " +
"\n\nDo you acknowledge this limitation of the script? DO NOT CLICK OK " +
"UNTIL YOU HAVE READ THE ABOVE INFORMATION.",
convertRefsWarning: "WARNING: You need consensus to migrate an article " +
"to list-defined references format (LDR) BEFORE you do so.\n\nClick " +
"Cancel now if consensus has not been established in favor of this " +
"migration. If there is consensus to make the conversion, click OK to " +
"do so.",
groupPrompt: "Please enter the name of a group (as it appears in the " +
"wikitext, including any quotes). Leave this blank if unsure.",
refsHeader: "Inline footnotes",
convertHeader: "Generated refs list",
refsCommentIncomplete: "<!-- This list of footnotes may be incomplete. " +
"Do not use for conversion purposes. -->\n\n",
refsCommentComplete: "<!-- Converted to LDR format\n" +
" using [[User:PleaseStand/References segregator]] -->\n\n",
convertSummary: "Converted footnotes to LDR format (using " +
"[[User:PleaseStand/References segregator|segregate-refs]])",
convertFurther: "This script has done most of the work. However, you still " +
"need to do the following:\n\n* Insert the refs list in the new textbox " +
"into the proper place in the wikitext.\n* If converting a special " +
"group, optionally remove the group attributes.\n* Replace all " +
"autogenerated names with human-generated names.\n\nYou can do the above " +
"with the Find/Replace command in many text editors. (Always use the " +
"quoted form of the attributes.) Then, paste the text back into the edit " +
"form and save the page.",
integrateWarning: "The refs listed below are missing from the text. If you " +
"continue, they will be permanently deleted. Are you sure?\n\nUnused refs: "
};
 
( function ( $ ) {
// Begin encapsulation (prevent interference with other scripts)
function SegregateRefsJs(){
 
var editForm, refsDiv, refsH2, mainTextbox, refsTextbox, randPrefix, messages,
// Semi-global variables (private to this script)
refsButton, convertButton, unloadHandlerRegistered = false;
var editForm; var refsDiv; var refsH2; var mainTextbox; var refsTextbox;
var randPrefix; var messages; var refsButton; var convertButton;
 
/**
// Extend the string object with new methods
* Unquote a wikitext tag attribute.
// Begin with the prefix "Ps" to avoid name clashes
*
* @param string quotedValue
* @return string
*/
function htmlUnquote( quotedValue ) {
var d = document.createElement( 'div' );
d.innerHTML = '<input value=' + quotedValue + '></input>';
return d.firstChild.value;
}
 
/**
// Add support for setting a slice of a string.
* Quote a wikitext tag attribute, choosing single quotes versus
// (Only works with positive indices.)
* double quotes depending on which is shorter.
String.prototype.PsSetSlice = function(replacement, indexFrom, indexTo) {
*
if(typeof indexTo == "undefined") {
* @param string value
return this.slice(0, indexFrom) + replacement;
* @return string
}
*/
return this.slice(0, indexFrom) + replacement + this.slice(indexTo);
function htmlQuote( value ) {
};
var sQ, dQ;
 
value = value.replace( /\&/g, '&amp;' );
// Add support for unquoting from HTML-quoted form.
sQ = "'" + value.replace( /'/g, '&#39;' ) + "'",
String.prototype.PsHTMLUnquote = function() {
dQ = '"' + value.replace( /"/g, '&quot;' ) + '"';
// Let's use the browser's functionality for the hard work,
 
// since MediaWiki/PHP supports many different HTML entities.
return sQ.length < dQ.length ? sQ : dQ;
// (Note: innerHTML is not W3C-standard)
}
var d = window.document.createElement("div");
 
d.innerHTML = "<input value=" + this + "></input>";
// Looks for ref tags in the text, skipping problematic extension tags.
return d.firstChild.value;
// For example, "references" may contain out-of-line refs, which should be skipped.
};
function RefScanner( argWikiText ) {
this.wikiText = argWikiText;
this.refScanRegex = /(?:<!--[\s\S]*?-->|<(nowiki|source|references|ref)(?:|\s(?:[^"']|"[^"]*"|'[^']*')*?)(?:\/>|(?:>[\s\S]*?<\/\1(?:|\s[^>]*)>)))/gi;
}
 
// Get the next ref from the text.
// Add support for quoting using HTML quotes. Chooses single quotes versus
RefScanner.prototype.getRef = function () {
// double quotes depending on which is shorter.
var results;
String.prototype.PsHTMLQuote = function() {
do {
// Escape ampersands
var s results = this.replacerefScanRegex.exec(/\&/g, "&amp;"this.wikiText );
if ( !results ) {
// Try both kinds of quotes
return null;
var sQ = "'" + s.replace(/'/g, "&#39;") + "'";
}
var dQ = '"' + s.replace(/"/g, "&quot;") + '"';
if ( results[1] === undefined ) {
// Choose the shorter, preferring double quotes if equal in length
results = [0, 0];
return (sQ.length < dQ.length ? sQ : dQ);
}
} while ( results[1].toString().toLowerCase() !== 'ref' );
return results[0];
};
 
// Extracts attributes from ref tags.
// OBJECTS
function RefParser( argWikiText ) {
// This is mostly a copy of refScanRegex, except that the whole string must be a ref,
// and no more, and two parts are extracted: $1=attributes, $2=remaining portion of ref
var refParseRegex = /^<ref(|\s(?:[^"']|"[^"]*"|'[^']*')*?)(\/>|(?:>[\s\S]*?<\/ref(?:|\s[^>]*)>))$/i;
 
this.wikiText = argWikiText;
// RefScanner: Use for identifying ref tags in text. (No nested refs please)
this.parsedRef = refParseRegex.exec( this.wikiText );
function RefScanner(argWikiText) {
if ( !this.wikiTextparsedRef =) argWikiText;{
throw new Error( 'invalid ref' );
// The tags listed below other than "ref" are there for an obvious reason.
}
// NB: "references" is here to prevent out-of-line refs from being returned.
this.refScanRegex = /(?:<!--[\s\S]*?-->|<(nowiki|source|references|ref)(?:\s|(?:[^"']|"[^"]*"|'[^']*')*?)(?:\/>|(?:>[\s\S]*?<\/\1(?:|\s[^>]*)>)))/gi;
}
 
RefScanner.prototype = {
// Returns the nextGet refall foundattributes inof the texttag.
RefParser.prototype.getAttributes getRef:= function getRef() {
// In this regex, we need to extract a single name-value pair at a time.
var results = [0,0];
var attParseRegex = /\s([^\s=>]+)\s*=\s*("[^"]*"|'[^']*'|[^\s"']*)/g;
while(results[1].toString().toLowerCase() != "ref") {
if ( !this.parsedRef ) {
results = this.refScanRegex.exec(this.wikiText);
return null;
if(!results) {
}
return null;
var attributes = Object.create( null ), results;
}
while ( ( results = attParseRegex.exec( this.parsedRef[1] ) ) ) {
if(typeof results[1] == "undefined") {
attributes[results[1].toLowerCase()] = htmlUnquote( results[2] );
results = [0,0];
}
}
return attributes;
}
return results[0];
}
};
 
/**
// RefParser: Use for extracting attributes from ref tags
* Segregate refs from content.
function RefParser(argWikiText) {
*
this.wikiText = argWikiText;
* @param string argWikiText The original wikitext
// The below regex is mostly a copy of the refScanRegex above, except that
* @param string group The name of the ref group to process (default group is '')
// the whole string must be a ref, and no more, and two parts are extracted:
* @param bool caseCues Mark the original ref code locations using capitalization?
// $1=attributes, $2=remaining portion of ref
* @return Object
var refParseRegex = /^<ref(|\s(?:[^"']|"[^"]*"|'[^']*')*?)(\/>|(?:>[\s\S]*?<\/ref(?:|\s[^>]*)>))$/i;
*/
this.parsedRef = refParseRegex.exec(this.wikiText);
function segregateRefs( argWikiText, group, caseCues ) {
if(!this.parsedRef) {
var prefixChars, randNo, randPrefix, refPreferred, scanner, ref, parser, attributes,
throw new Error("invalid ref");
refGroup, refName, refStored, refEmpty, refLong, unnamedRefs = 0,
}
refNames = Object.create( null ), refCodes = [], refShort, outWikiText = '', offset = 0;
 
// Create a random prefix for autogenerated ref names
prefixChars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
randNo = Math.floor( Math.random() * ( prefixChars.length * prefixChars.length ) );
randPrefix = messages.autoWord
+ prefixChars.charAt( Math.floor( randNo / prefixChars.length ) )
+ prefixChars.charAt(randNo % prefixChars.length) +
'-';
 
// Create the beginning of the code for a preferred ref ___location
refPreferred = caseCues ? '<REF ' : '<ref ';
scanner = new RefScanner( argWikiText );
while ( ( ref = scanner.getRef() ) ) {
parser = new RefParser( ref );
attributes = parser.getAttributes();
 
refGroup = attributes.group || '';
if ( group != refGroup ) {
// The ref is in a different group
continue;
}
 
if ( attributes.name !== undefined ) {
// The ref already has a name (possibly the empty string)
refName = attributes.name;
refStored = refName in refNames;
refEmpty = parser.parsedRef[2].slice( -2 ) == '/>' ||
parser.parsedRef[2].slice( 0, 3 ) == '></';
refLong = ref;
 
} else {
// We have to autogenerate one
refName = randPrefix + ( ++unnamedRefs ).toString(10);
refStored = false;
refEmpty = false;
refLong = '<ref name=' + htmlQuote( refName ) +
parser.parsedRef[1] + parser.parsedRef[2];
}
 
if ( !refStored ) {
// Found the first ref of this name
refNames[refName] = {
code: refCodes.length,
empty: refEmpty
};
refCodes[refNames[refName].code] = refLong;
 
// Make a short code for the ref
if ( refEmpty ) {
refShort = refLong;
} else if ( refGroup === '' ) {
refShort = refPreferred + 'name=' + htmlQuote( refName ) + '/>';
} else {
refShort = refPreferred + 'name=' + htmlQuote( refName ) +
' group=' + htmlQuote( refGroup ) + '/>';
}
 
} else if ( !refEmpty && refNames[refName].empty ) {
// Already found an empty ref under this name, yet this one is non-empty
// Fill in the long code for the existing entry
refCodes[refNames[refName].code] = refLong;
refNames[refName].empty = false;
 
// Make a short code for the ref
refShort = refPreferred + 'name=' + htmlQuote( refName );
if ( refGroup !== '' ) {
refShort += ' group=' + htmlQuote( refGroup ) + '/>';
}
refShort += '/>';
 
} else {
// Leave the ref as-is
refShort = caseCues ? refLong.replace( /^<REF/, "<ref" ) : refLong;
}
 
// Replace the long code with the short code
outWikiText += argWikiText.slice( offset, scanner.refScanRegex.lastIndex - ref.length );
outWikiText += refShort;
offset = scanner.refScanRegex.lastIndex;
}
 
outWikiText += argWikiText.slice( offset );
 
return {
wikiText: outWikiText,
refCodes: refCodes,
randPrefix: randPrefix
};
}
RefParser.prototype = {
getAttributes: function getAttributes() {
// In this regex, we need to extract a single name-value pair at a time.
var attParseRegex = /\s([^\s=>]+)\s*=\s*("[^"]*"|'[^']*'|[^\s"']*)/g;
if(!this.parsedRef) {
return null;
}
var attributes = {};
while(true) {
var results = attParseRegex.exec(this.parsedRef[1]);
if(!results) {
break;
}
attributes[results[1].toLowerCase()] = results[2].PsHTMLUnquote();
}
return attributes;
}
};
 
/**
// FUNCTIONS
* Insert ref contents back into the text.
*
* @param string argWikiText The wikitext without ref contents
* @param string argRefText The ref contents
* @param string randPrefix The randPrefix value returned by segregateRefs()
* @param string caseCues The caseCues argument passed to segregateRefs()
*/
function integrateRefs(argWikiText, argRefText, randPrefix, caseCues) {
 
// Remove an autogenerated ref name if possible.
// segregateRefs: Use for segregating refs from content.
function cleanRefLong(dirtyRef) {
// If completeSearch == true, the function looks in all occurrences for ref
var cleanRegex = /^<(ref) name=(?:"[^"]*"|'[^']*'|[^\s"']*)/i;
// contents. If completeSearch == false, the function only checks the first.
return dirtyRef.replace(cleanRegex, '<$1');
// group is the reference group to limit the operation to. The empty string
}
// refers to all ungrouped refs.
 
function segregateRefs(argWikiText, completeSearch, group) {
var scanner, ref, parser, attributes, refCodes = Object.create( null ), usageFreq = Object.create( null ),
preferredRef = Object.create( null ), refLong, outWikiText = '', offset = 0;
// Create a random prefix for autogenerated ref names.
 
// in theory this has a 1/1296 probability of collision - extremely low
// First, we build an associative array of all the ref codes
var prefixChars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
// that we might need to put back into the text.
var randNo = Math.floor(Math.random() *
scanner = new RefScanner( argRefText );
(prefixChars.length * prefixChars.length));
while ( ( ref = scanner.getRef() ) ) {
randPrefix = messages.autoWord + prefixChars.charAt(Math.floor(randNo /
parser = new RefParser( ref );
prefixChars.length)) + prefixChars.charAt(randNo % prefixChars.length) +
attributes = parser.getAttributes();
"-";
if ( attributes.name !== undefined ) {
// Only use the first ref having each name
// Variables for the main code
if ( !( attributes.name in refCodes ) ) {
var scanner = new RefScanner(argWikiText);
refCodes[attributes.name] = ref;
var unnamedRefs = 0; var refNames = {}; var ref; var refStored;
}
var parser; var attributes; var refName; var refLong; var refShort;
}
var refCodes = []; var refEmpty; var emptyRefsWarningGiven = false;
}
var refGroup;
 
// Next, we build an associative array that holds the usage frequency
// Disable the empty refs warning (see below) if the user has disabled it
// of every ref name used in text, and whether there is a preferred ref,
if(typeof SegregateRefsJsEmptyRefsWarningGiven != "undefined" &&
// if caseCues are enabled.
SegregateRefsJsEmptyRefsWarningGiven) {
scanner = new RefScanner( argWikiText );
emptyRefsWarningGiven = true;
while ( ( ref = scanner.getRef() ) ) {
}
parser = new RefParser( ref );
attributes = parser.getAttributes();
while((ref = scanner.getRef())) {
if ( attributes.name !== undefined ) {
parser = new RefParser(ref);
if ( !( attributes.name in usageFreq ) ) {
attributes = parser.getAttributes();
usageFreq[attributes.name] = 1;
} else {
// First make sure that the ref is in the right group.
usageFreq[attributes.name]++;
refGroup = attributes.hasOwnProperty("group") ? attributes.group : "";
}
if(group != refGroup) {
if ( caseCues && ref.slice( 0, 4 ) == '<REF' ) {
continue;
preferredRef[attributes.name] = true;
}
}
}
// Does the ref have a name?
}
// (Note: No matter how incorrect it seems, the empty string is
 
// an acceptable ref name to the MediaWiki parser, as verified by
// Finally, we go through the text again and this time we insert the
// informal testing.)
// ref codes where we need to, but only in the first place
if(!attributes.hasOwnProperty("name")) {
// a ref name appears (or the first preferred ___location).
// Bad: it doesn't have one - create a name for it
scanner = new RefScanner( argWikiText );
refStored = false;
while ( ( ref = scanner.getRef() ) ) {
refEmpty = false;
parser = new RefParser( ref );
refName = randPrefix + (++unnamedRefs).toString(10);
attributes = parser.getAttributes();
// Change the corresponding ref code
if ( 'name' in attributes ) {
refLong = "<ref name=" + refName.PsHTMLQuote() +
// Is this name on the replacement list?
parser.parsedRef[1] + parser.parsedRef[2];
if ( attributes.name in refCodes ) {
} else {
 
// Good: it has a name.
// If we are using caseCues, and another ___location is
refName = attributes.name;
// preferred, skip to the next ref.
refLong = ref;
if ( caseCues && attributes.name in preferredRef &&
// Check if the ref name has already been seen.
ref.slice( 0, 4 ) != '<REF'
refStored = refNames.hasOwnProperty(refName);
) {
// Check if the ref has no contents.
continue;
refEmpty = (parser.parsedRef[2].slice(-2) == "/>") ||
}
(parser.parsedRef[2].slice(0, 3) == "></");
// Since this script, when not set in complete search mode, checks
// Is this name an autogenerated name?
// only the first occurrence of a ref for contents, inform the user
if ( attributes.name.slice( 0, randPrefix.length ) == randPrefix ) {
// of this limitation if it may pose a problem.
// Yes: is the name used multiple times?
if(!completeSearch && !emptyRefsWarningGiven && !refStored) {
if ( usageFreq[attributes.name] > 1 ) {
if(refEmpty) {
// Multiple: the replacement code should be the same
if(!window.confirm(messages.emptyRefsWarning)) {
// as that stored in the ref textbox.
return false;
refLong = refCodes[attributes.name];
}
} else {
emptyRefsWarningGiven = true;
// Single: replacement code must not include the name,
}
// at least not if the citation was untouched.
}
// (We don't want to add unnecessary autonames)
}
refLong = cleanRefLong( refCodes[attributes.name] );
}
// Is the ref's name unique?
} else {
if(!refStored) {
// No: the replacement code should be the same
// Unique: add it to the list of refs
// as that stored in the ref textbox.
refNames[refName] = {
// (We want to preserve all human-generated names)
code: refCodes.length,
refLong = refCodes[attributes.name];
empty: refEmpty
}
};
refCodes[refNames[refName].code] = refLong;
// MakeReplace athe short code forwith the reflong code
outWikiText += argWikiText.slice( offset, scanner.refScanRegex.lastIndex - ref.length );
if(!refGroup.length) {
outWikiText += refLong;
refShort = "<ref name=" + refName.PsHTMLQuote() + "/>";
offset = scanner.refScanRegex.lastIndex;
} else {
 
refShort = "<ref name=" + refName.PsHTMLQuote() + " " +
// Delete the name from the replacement list
"group=" + refGroup.PsHTMLQuote() + "/>";
delete refCodes[attributes.name];
}
}
// Otherwise, is the current longcode not empty?
}
// (only when in complete search mode)
}
} else if (completeSearch && !refEmpty) {
 
// Not empty: fill in the long code and make a short code
outWikiText += argWikiText.slice( offset );
refCodes[refNames[refName].code] = refLong;
 
refNames[refName].empty = false;
return {
if(!refGroup.length) {
wikiText: outWikiText,
refShort = "<ref name=" + refName.PsHTMLQuote() + "/>";
unusedRefs: refCodes
} else {
};
refShort = "<ref name=" + refName.PsHTMLQuote() + " " +
"group=" + refGroup.PsHTMLQuote() + "/>";
}
} else {
// Leave the ref as-is in the original wikitext
refShort = refLong;
}
// Replace the long code with the short code
scanner.wikiText = scanner.wikiText.PsSetSlice(refShort,
scanner.refScanRegex.lastIndex - ref.length,
scanner.refScanRegex.lastIndex);
// Update lastIndex accordingly
scanner.refScanRegex.lastIndex += refShort.length - ref.length;
}
return {
wikiText: scanner.wikiText,
refCodes: refCodes,
randPrefix: randPrefix
};
}
 
/**
// integrateRefs: Use for inserting ref contents back into text
* Clear the undo history of a textarea by removing it from the document
function integrateRefs(argWikiText, argRefText, randPrefix) {
* and then inserting it again.
*
// A function to remove an autogenerated ref name (if possible)
* @param HTMLTextareaElement ta The textarea element
function cleanRefLong(dirtyRef) {
*/
var cleanRegex = /^<(ref) name=(?:"[^"]*"|'[^']*'|[^\s"']*)/i;
function clearUndoHistory(ta) {
return dirtyRef.replace(cleanRegex, "<$1");
var pn = ta.parentNode, ns = ta.nextSibling;
}
pn.insertBefore(pn.removeChild(ta), ns);
// Variables for the main code
var scanner; var ref; var parser; var attributes; var refCodes = {};
var usageFreq = {}; var refLong;
// First, we build an associative array of all the ref codes
// that we might need to put back into the text.
scanner = new RefScanner(argRefText);
while((ref = scanner.getRef())) {
parser = new RefParser(ref);
attributes = parser.getAttributes();
if(attributes.hasOwnProperty("name")) {
// Only use the first ref with each name
if(!refCodes.hasOwnProperty(attributes.name)) {
refCodes[attributes.name] = ref;
}
}
}
// Next, we build an associative array that holds the usage frequency
// of every ref name used in text.
scanner = new RefScanner(argWikiText);
while((ref = scanner.getRef())) {
parser = new RefParser(ref);
attributes = parser.getAttributes();
if(attributes.hasOwnProperty("name")) {
if(!usageFreq.hasOwnProperty(attributes.name)) {
// We found a new name
usageFreq[attributes.name] = 1;
} else {
// We already found this name
usageFreq[attributes.name]++;
}
}
}
// Finally, we go through the text again and this time we insert the
// ref codes where we need to, but only in the first place
// a ref name appears.
scanner = new RefScanner(argWikiText);
while((ref = scanner.getRef())) {
parser = new RefParser(ref);
attributes = parser.getAttributes();
if(attributes.hasOwnProperty("name")) {
// Is this name on the replacement list?
if(refCodes.hasOwnProperty(attributes.name)) {
// Is this name an autogenerated name?
if(attributes.name.slice(0, randPrefix.length) == randPrefix) {
// Yes: is the name used multiple times?
if(usageFreq[attributes.name] > 1) {
// Multiple: the replacement code should be the same
// as that stored in the ref textbox.
refLong = refCodes[attributes.name];
} else {
// Single: replacement code must not include the name,
// at least not if the citation was untouched.
// (We don't want to add unnecessary autonames)
refLong = cleanRefLong(refCodes[attributes.name]);
}
} else {
// No: the replacement code should be the same
// as that stored in the ref textbox.
// (We want to preserve all human-generated names)
refLong = refCodes[attributes.name];
}
// Replace the short code with the long code
scanner.wikiText = scanner.wikiText.PsSetSlice(refLong,
scanner.refScanRegex.lastIndex - ref.length,
scanner.refScanRegex.lastIndex);
// Update lastIndex accordingly
scanner.refScanRegex.lastIndex += refLong.length - ref.length;
// Delete the name from the replacement list
delete refCodes[attributes.name];
}
}
}
// Return both the combined output and the ref codes that were not used.
return {wikiText: scanner.wikiText, unusedRefs: refCodes};
}
 
function submitHandlerunloadHandler(evt) {
// Local variables
var result; var, refName; var, unusedRefNamesQuoted = [];
// wikEd compatibility (frame -> textarea)
// Do the actual integration work
if(typeof wikEdUseWikEd != "undefined" && wikEdUseWikEd) {
result = integrateRefs(mainTextbox.value, refsTextbox.value,
WikEdUpdateTextarea();
randPrefix);
}
// Find all unused ref names
// Do the actual integration work
for(refName in result.unusedRefs) {
result = integrateRefs(mainTextbox.value, refsTextbox.value, randPrefix, true);
if(result.unusedRefs.hasOwnProperty(refName)) {
 
unusedRefNamesQuoted.push(refName.PsHTMLQuote());
// Find all unused ref names
}
for(refName in result.unusedRefs) {
}
unusedRefNamesQuoted.push(htmlQuote(refName));
// If any refs are unused, warn and allow the user to cancel
}
if(unusedRefNamesQuoted.length) {
// If any refs are unused, warn and allow the user to cancel;
if(!window.confirm(messages.integrateWarning +
// we do not do this on unload because it is not really possible.
unusedRefNamesQuoted.join(", ").slice(0, -2))) {
if(evt.type == "submit" && unusedRefNamesQuoted.length) {
// Don't submit form
if(!window.confirm(messages.integrateWarning +
return false;
unusedRefNamesQuoted.join(", "))) {
}
// Don't submit form
}
evt.preventDefault();
return false;
// Otherwise, update the textbox.
}
mainTextbox.value = result.wikiText;
}
// We can delete the header and refs textbox now
// Otherwise, update the textbox.
refsDiv.removeChild(refsH2);
mainTextbox.value = result.wikiText;
refsDiv.removeChild(refsTextbox);
// wikEd compatibility (textarea -> frame)
// Deactivate this submit handler and run any previously registered handler
if(typeof wikEdUseWikEd != "undefined" && wikEdUseWikEd) {
editForm.onsubmit = null;
WikEdUpdateFrame();
if(typeof editForm.PsOnsubmit == "function") {
}
editForm.onsubmit = editForm.PsOnsubmit;
editForm.onsubmit.apply(this, arguments);
// Deactivate this event handler
}
window.removeEventListener("submit", unloadHandler, false);
window.removeEventListener("unload", unloadHandler, false);
unloadHandlerRegistered = false;
// We can delete the header and refs textbox now
refsDiv.removeChild(refsH2);
refsDiv.removeChild(refsTextbox);
return true;
}
 
function refsButtonHandler() { // Called when script activated by button click
// Both buttons should disappear
// Both buttons should disappear
if(convertButton.parentNode){
if(convertButton.parentNode){
convertButton.parentNode.removeChild(convertButton);
}
}
if(refsButton.parentNode) {
refsButton.parentNode.removeChild(refsButton);
}
}
 
// wikEd compatibility (frame -> textarea)
// Do the actual segregation work and save the random prefix
if(typeof wikEdUseWikEd != "undefined" && wikEdUseWikEd) {
var segFormat = segregateRefs(mainTextbox.value, false, "");
WikEdUpdateTextarea();
if(!segFormat) {
}
return false;
}
// Do the actual segregation work and save the random prefix
randPrefix = segFormat.randPrefix;
var segFormat = segregateRefs(mainTextbox.value, "", true);
if(!segFormat) {
// wikEd compatibility (frame -> textarea)
return false;
if(typeof wikEdUseWikEd != "undefined" && wikEdUseWikEd) {
}
WikEdUpdateTextarea();
randPrefix = segFormat.randPrefix;
}
// Update the textbox
mainTextbox.value = segFormat.wikiText;
clearUndoHistory(mainTextbox);
// wikEd compatibility (textarea -> frame)
// wikEd compatibility (textarea -> frame)
if(typeof wikEdUseWikEd != "undefined" && wikEdUseWikEd) {
if(typeof wikEdUseWikEd != "undefined" && wikEdUseWikEd) {
WikEdUpdateFrame();
WikEdUpdateFrame();
}
}
// Inline refs header
// Inline refs header
refsH2 = window.document.createElement("h2");
refsH2 = document.createElement("h2");
refsH2.appendChild(window.document.createTextNode(messages.refsHeader));
refsH2.appendChild(document.createTextNode(messages.refsHeader));
// Inline refs textbox
refsH2.style.borderColor = "silver";
refsTextbox = window.document.createElement("textarea");
refsH2.style.borderStyle = "solid";
refsTextbox.id = "PsRefsTextbox";
refsH2.style.borderWidth = "1px 0";
refsTextbox.value = messages.refsCommentIncomplete +
refsH2.style.fontSize = "100%";
segFormat.refCodes.join("\n\n");
refsH2.style.fontWeight = "100%";
refsTextbox.rows = Math.floor(mainTextbox.rows / 2);
refsH2.style.lineHeight = "normal";
refsTextbox.cols = mainTextbox.cols;
refsH2.style.margin = "0";
refsH2.style.padding = "0.5em 0 0";
// Add to document
refsH2.style.textAlign = "center";
refsDiv.appendChild(refsH2);
refsDiv.appendChild(refsTextbox);
// Inline refs textbox
refsTextbox = document.createElement("textarea");
// Set up the submit handler (to integrate refs when done editing)
refsTextbox.id = "PsRefsTextbox";
if(typeof editForm.onsubmit != "undefined") {
refsTextbox.value = segFormat.refCodes.join("\n\n");
editForm.PsOnsubmit = editForm.onsubmit;
refsTextbox.rows = 12;
}
editForm.onsubmit = submitHandler;
refsTextbox.style.border = "none";
refsTextbox.style.lineHeight = "1.5em";
// Don't submit form
refsTextbox.style.margin = "0";
return false;
refsTextbox.style.resize = "vertical";
refsTextbox.style.width = "100%";
 
// Add to document
refsDiv.appendChild(refsH2);
refsDiv.appendChild(refsTextbox);
// Set up the submit handler (to integrate refs when done editing)
window.addEventListener("submit", unloadHandler, false);
window.addEventListener("unload", unloadHandler, false);
unloadHandlerRegistered = true;
// Don't submit form
return false;
}
 
function convertButtonHandler() { // Called when script activated by button click
// Display warning
if(!window.confirm(messages.convertRefsWarning)) {
return false;
}
}
// Which group?
var group = window.prompt(messages.groupPrompt, "");
if(group === null) {
return false;
}
}
group = htmlUnquote(group.PsHTMLUnquote();
// The first button should disappear
if(refsButton.parentNode) {
refsButton.parentNode.removeChild(refsButton);
}
}
// Do the actual segregation work and save the random prefix
var segFormat = segregateRefs(mainTextbox.value, truegroup, groupfalse);
if(!segFormat) {
return false;
}
}
randPrefix = segFormat.randPrefix;
// wikEd compatibility (frame -> textarea)
if(typeof wikEdUseWikEd != "undefined" && wikEdUseWikEd) {
WikEdUpdateTextarea();
}
}
// Update the textbox
mainTextbox.value = segFormat.wikiText;
clearUndoHistory(mainTextbox);
// wikEd compatibility (textarea -> frame)
// wikEd compatibility (textarea -> frame)
if(typeof wikEdUseWikEd != "undefined" && wikEdUseWikEd) {
if(typeof wikEdUseWikEd != "undefined" && wikEdUseWikEd) {
WikEdUpdateFrame();
WikEdUpdateFrame();
}
}
// Inline refs header
// Inline refs header
refsH2 = window.document.createElement("h2");
refsH2 = document.createElement("h2");
refsH2.appendChild(window.document.createTextNode(messages.convertHeader));
refsH2.style.borderColor = "silver";
// Inline refs textbox
refsH2.style.borderStyle = "solid";
if(!refsTextbox) {
refsH2.style.borderWidth = "1px 0";
// Does not exist; creating
refsH2.style.fontSize = "100%";
refsTextbox = window.document.createElement("textarea");
refsH2.style.fontWeight = "100%";
refsTextbox.id = "PsRefsTextbox";
refsH2.style.lineHeight = "normal";
refsTextbox.value = messages.refsCommentComplete +
refsH2.style.margin = "0";
segFormat.refCodes.join("\n");
refsH2.style.padding = "0.5em 0 0";
refsTextbox.rows = Math.floor(mainTextbox.rows / 2);
refsH2.style.textAlign = "center";
refsTextbox.cols = mainTextbox.cols;
// Inline refs textbox
// Add to document
if(!refsTextbox) {
refsDiv.appendChild(refsH2);
// Does not exist; creating
refsDiv.appendChild(refsTextbox);
refsTextbox = document.createElement("textarea");
} else {
refsTextbox.id = "PsRefsTextbox";
// Already exists
refsTextbox.value = messages.refsCommentComplete +
segFormat.refCodes.join("\n");
refsTextbox.rows = 12;
}
// Set a default edit summary.
window.document.getElementById("wpSummary").value = messages.convertSummary;
// Show the further instructions.
window.alert(messages.convertFurther);
// Don't submit form
return false;
}
 
refsTextbox.style.border = "none";
function loadHandler() { // This function is called on page load
refsTextbox.style.lineHeight = "1.5em";
try {
refsTextbox.style.margin = "0";
// Don't continue if the browser is Internet Explorer
refsTextbox.style.resize = "vertical";
if(window.navigator.appName == "Microsoft Internet Explorer") {
refsTextbox.style.width = "100%";
return;
}
// Add to document
refsDiv.appendChild(refsH2);
// Handle message translations
refsDiv.appendChild(refsTextbox);
messages = (typeof SegregateRefsJsL10n == "object" &&
} else {
typeof SegregateRefsJsL10n.version != "undefined" &&
// Already exists
SegregateRefsJsL10n.version == 1.11 ? SegregateRefsJsL10n :
refsTextbox.value = messages.refsCommentComplete +
SegregateRefsJsMsgs);
segFormat.refCodes.join("\n");
}
// Only activate on edit pages (that are not section edit pages)
if(!window.document.getElementById("editform") ||
// Set a default edit summary.
window.document.getElementById("editform").wpSection.value.length) {
document.getElementById("wpSummary").value = messages.convertSummary;
return;
}
// Show the further instructions.
window.alert(messages.convertFurther);
// Get the edit form
editForm = window.document.getElementById("editform");
// Don't submit form
// Get the edit box
return false;
mainTextbox = window.document.getElementById("wpTextbox1");
// Make the "segregate" button
refsButton = window.document.createElement("input");
refsButton.type = "button";
refsButton.value = messages.buttonText;
refsButton.setAttribute("style", messages.buttonStyle);
refsButton.onclick = refsButtonHandler;
// Make the "convert" button
convertButton = window.document.createElement("input");
convertButton.type = "button";
convertButton.value = messages.buttonConvertText;
convertButton.setAttribute("style", messages.buttonConvertStyle);
convertButton.onclick = convertButtonHandler;
if(typeof SegregateRefsJsAllowConversion == "undefined" ||
!SegregateRefsJsAllowConversion) {
convertButton.setAttribute("style", "display: none;");
}
// Add the refs div
refsDiv = window.document.createElement("div");
refsDiv.appendChild(refsButton);
refsDiv.appendChild(convertButton);
editForm.insertBefore(refsDiv,
window.document.getElementById("editpage-copywarn"));
} catch(e) {
}
}
 
// Register load handler
addOnloadHook(loadHandler);
 
$( function () {
} SegregateRefsJs();
 
try {
 
// Handle message translations
messages = (typeof SegregateRefsJsL10n == "object" &&
typeof SegregateRefsJsL10n.version != "undefined" &&
SegregateRefsJsL10n.version == 1.11 ? SegregateRefsJsL10n :
SegregateRefsJsMsgs);
// Only activate on edit pages (that are not section edit pages)
if(!document.getElementById("editform") ||
document.getElementById("editform").wpSection.value.length) {
return;
}
// Get the edit form
editForm = document.getElementById("editform");
// Get the edit box
mainTextbox = document.getElementById("wpTextbox1");
// Make the "segregate" button
refsButton = document.createElement("input");
refsButton.type = "button";
refsButton.value = messages.buttonText;
refsButton.setAttribute("style", messages.buttonStyle);
refsButton.onclick = refsButtonHandler;
// Make the "convert" button
convertButton = document.createElement("input");
convertButton.type = "button";
convertButton.value = messages.buttonConvertText;
convertButton.setAttribute("style", messages.buttonConvertStyle);
convertButton.onclick = convertButtonHandler;
if(typeof SegregateRefsJsAllowConversion == "undefined" ||
!SegregateRefsJsAllowConversion) {
convertButton.setAttribute("style", "display: none;");
}
// Add the refs div
refsDiv = document.createElement("div");
refsDiv.appendChild(refsButton);
refsDiv.appendChild(convertButton);
// Find position within the edit form to insert it at
var refsDivPos = mainTextbox, refsDivPosParent = refsDivPos.parentNode;
while (refsDivPosParent !== editForm) {
refsDivPos = refsDivPosParent;
refsDivPosParent = refsDivPos.parentNode;
if (!refsDivPosParent) {
refsDivPos = mainTextbox;
refsDivPosParent = refsDivPos.parentNode;
break;
}
}
refsDivPos = refsDivPos.nextSibling;
if (refsDivPos && refsDivPos.classList.contains("wikiEditor-ui-clear")) {
refsDivPos = refsDivPos.nextSibling;
}
refsDivPosParent.insertBefore(refsDiv, refsDivPos);
} catch(e) {
}
 
} );
 
})( jQuery );
 
// </nowiki></pre>
Retrieved from "https://en.wikipedia.org/wiki/User:PleaseStand/segregate-refs-dev.js"