From Wikipedia, the free encyclopedia
Note: After saving, you have to bypass your browser's cache to see the changes. Google Chrome, Firefox, Microsoft Edge and Safari: Hold down the ⇧ Shift key and click the Reload toolbar button. For details and instructions about other browsers, see Wikipedia:Bypass your cache.

function formatCitations(vertical) {

    var txt = document.editform.wpTextbox1;

 

    // Fill an array with one entry per each recognized citation template

    // Note: the regex should be changed to allow parameter values that are themselves templates,

    // e.g. {{cite book | author = John Doe | title = The Book | year = 1234 | ref = {{sfnRef|Doe (1234)}} | isbn = 0-12345-678-9 }}

    // I got as far as this: /(\{\{[Cc]it(?:ation|(?:ar|e) [a-z ]+)\s*)(\|\s*[^=]+=\s*(?:\{\{)?.+(?:\}\})?\s*)+(\}\})/g

    var originalTemplates = txt.value.match(/\{\{[Cc]it(ation|(ar|e) [a-z ]+) *\n? *\|[^{}]+\}\}/g);

    // Duplicate the array, for editing. We need to keep the original strings for the replacement step

    var tweakedTemplates  = originalTemplates.slice();



    for(var i = 0; i < originalTemplates.length; i++) {

        if(vertical) {

            // Fill an array with one entry per each parameter for this citation template

            var originalParams = originalTemplatesi].match(/ *\n? *\| *\n? *[^ =]+ *= */g);

            // Create array to be filled with the cleaned-up parameters.

            // We need to keep the original strings for the replacement step.

            var tweakedParams = [];



            var maxWidth = 0;

            for(var j = 0; j < originalParams.length; j++){

                // Get rid of the delimiters and spaces, keep only the parameter string

                tweakedParamsj = originalParamsj].match(/[a-z1-9_-]+/)[0];

                // Calculate the length of the longest parameter

                maxWidth = (tweakedParamsj].length>maxWidth) ? tweakedParamsj].length : maxWidth;

            }

            maxWidth++; // We need an extra one because Array(n).join(' ') will produce a string with n-1 chars



            // Generate the aligned versions of the parameters (with padding before the equal signs)

            for(var k = 0; k < originalParams.length; k++) {

                var numSpaces = maxWidth - tweakedParamsk].length;

                var alignedParam = "\n  | " + tweakedParamsk + new Array(numSpaces).join(" ") + " = ";

                // Replace the original parameters with the tweaked ones

                tweakedTemplatesi = tweakedTemplatesi].replace (originalParamsk], alignedParam);

            }



            // Also align the }}

            tweakedTemplatesi = tweakedTemplatesi].replace(/ *\n? *\}\}/g,"\n  }}"); 

            // Replace the original templates with the tweaked versions

            txt.value = txt.value.replace(originalTemplatesi], tweakedTemplatesi]); 

        } else {

            // Remove newlines

            tweakedTemplatesi = tweakedTemplatesi].replace(/\n/g, "");

            // Normalize spaces around the pipes and equal signs

            tweakedTemplatesi = tweakedTemplatesi].replace(/ *\| *([a-z1-9_-]+) *= */g," |$1 = ");

            // Remove potencial extra spaces before template ends

            tweakedTemplatesi = tweakedTemplatesi].replace(/ *\}\}$/," }}");

            txt.value = txt.value.replace(originalTemplatesi], tweakedTemplatesi]);                                      

        }

    }



    // Update the edit summary

    var sum = document.editform.wpSummary;

    var summary = vertical ? "convert citation templates to vertical format, for readability" : "harmonize whitespace in citation templates" ;

    summary += " (using [[w:en:User:Waldir/formatcitations.js|Regex citation formatter]])";

    if (sum.value.indexOf(summary) == -1) {

        if (sum.value.match(/[^\*\/\s][^\/\s]?\s*$/)) {

            sum.value += "; ";

        }

        sum.value += summary;

    }

    if(!vertical) { document.editform.wpMinoredit.checked = true; }

}



$(function () {

    if(document.forms.editform) {

    	mw.loader.using( 'mediawiki.util'], function() {

	        mw.util.addPortletLink('p-cactions', 'javascript:formatCitations(false)', '{{}}', 'ca-formatcitations', 'Format citations: add whitespace', '-', '');

	        mw.util.addPortletLink('p-cactions', 'javascript:formatCitations(true)', '{{}}+', 'ca-formatcitations-vertical', 'Formats citations vertically', '-', '');

    	});

    }

});