MediaWiki:Gadget-PreloadTemplates.js: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
no edit summary
(+de, better skin support)
No edit summary
 
(46 intermediate revisions by 12 users not shown)
Line 3: Line 3:
//  ================================
//  ================================
/*  @author Grunny  
/*  @author Grunny  
     From http://harrypotter.wikia.com/wiki/MediaWiki:Wikia.js
     From https://harrypotter.wikia.com/wiki/MediaWiki:Wikia.js
     edited by leviathan_89
     edited by leviathan_89


Line 12: Line 12:
*/
*/


$(function() {
(function() {
    'use strict';
    var mwc = mw.config.get([
        'wgAction',
        'wgFormattedNamespaces',
        'wgNamespaceNumber'
    ]),
    $module = $('div#wpSummaryLabel'), // UCP source editors
    $moduleOld = $('div.module_content:first'); // Old Non-UCP Source Editor


     // Run conditions
     // Run conditions
     if (   wgAction != 'edit' ||
     if (mwc.wgNamespaceNumber === 8) {
            (!$('div.module_content').length && skin == 'oasis') ||
        console.log('[PreloadTemplates]: page is not supported.');
            (!$('div.editButtons').length && skin == 'monobook') ||
            mw.config.get('wgNamespaceNumber') == 8 // MediaWiki:
        ) {
         return;
         return;
     }
     }
      
     console.log('[PreloadTemplates]: version 1.06 - 07/2021.');
 
     // =================
     // =================
     //  Configuration
     //  Configuration
     // =================
     // =================
     var config = {
     var config = {
            list: null,
        list: window.preloadTemplates_list || 'MediaWiki:Custom-PreloadTemplates',
            subpage: null
        subpage: window.preloadTemplates_subpage || 'preload'
        };
     }, i18n, $main, $help;
 
    // Checking user's custom settings
    config.list = ( typeof preloadTemplates_list == 'string' ) ? preloadTemplates_list : 'MediaWiki:Custom-PreloadTemplates';
    config.subpage = ( typeof preloadTemplates_subpage == 'string' ) ? preloadTemplates_subpage : 'preload';
 
 
    // ========
    //  i18n
    // ========
    var lang = mw.config.get('wgUserLanguage');
    var splitLang = lang.split('-')[0];
    var i18n = {
            // English
            en: {
                preload: 'Preload template:',
                choose: '(choose)',
                help: 'Select a template to insert its preloaded syntax at the current position ',
                devWiki: 'Check the documentation on Dev Wiki',
                error: 'No valid syntax found at $1 or page is missing.'
            },
            // German
            de: {
                preload: 'Preload-Vorlage:',
                choose: '(Auswählen)',
                help: 'Wähle eine Textvorlage, die an der aktuellen Position eingefügt werden soll',
                devWiki: 'Lies die Dokumenation im Dev-Wiki',
                error: 'Keine gültige Syntax unter $1 gefunden bzw. keine Seite.'
            },
            // Italian
            it: {
                preload: 'Precarica un template:',
                choose: '(scegli)',
                help: 'Seleziona un template per inserire la sua sintassi precaricata nella posizione corrente',
                devWiki: 'Controlla la documentazione su Dev Wiki',
                error: 'Nessuna sintassi valida trovata su $1 o la pagina è mancante.'
            },
            // Polish
            pl: {
                preload: 'Gotowy szablon:',
                choose: '(wybierz)',
                help: 'Wybierz przygotowany szablon, aby wstawić kod w obecnym miejscu',
                devWiki: 'Zobacz dokumentację na Dev Wiki',
                error: 'Nie znaleziono odpowiedniej składni w $1 lub strona nie istnieje.'
            }
     };
 
    // Select language
    // Check if user's language is present
    if (typeof i18n[lang] === 'object') {
        $.extend( i18n, i18n.en, i18n[lang] );
    } else {
        // Check to see if the parent language has a translation, example pt-br -> pt
        if (typeof i18n[splitLang] === 'object') {
            $.extend( i18n, i18n.en, i18n[splitLang] );
        } else {
        // Fallback to English
        $.extend( i18n, i18n.en );
        }
    }
    // END i18n


     // =============
     // =============
     //  Execution  
     //  Functions  
     // =============
     // =============
   
    // Variables
    var namespace = mw.config.get('wgFormattedNamespaces')['10'];
    var $preloadOptionsHtml;
    var preloadOptionsList;
    var defaultOption = '<option selected disabled>' + i18n.choose + '</option>';
    var preloadHelp = '<span style="display:inline-block; vertical-align:middle; cursor:help; margin-left:5px;" class="sprite question"><a href="http://dev.wikia.com/wiki/PreloadTemplates" target="_blank" title="' + i18n.devWiki + '" style="display:inline-block; width:12px; height:12px;"></a></span>';


     // Append HTML container
     // Get plain message from i18n
     if (skin === 'oasis') {
     function msg(message) {
         $('div.module_content:first').append('<div id="preload-templates" style="display:block; padding:0 10px;"><h3 style="font-size:14px;">' + i18n.preload + '</h4></div>');
         return i18n.msg(message).plain();
    } else {
        $('div.editButtons').append('<div id="preload-templates" style="display:block; float:right; padding:10px;">' + i18n.preload + '&nbsp;</div>');
     }
     }


     // Create template list
     // Parse MediaWiki code to allow the use of includeonly and noninclude tags in the preload page
     // Get list
     function parseMW(source){
    $.get(wgScript, {
        return source.replace(/<includeonly>(\n)?|(\n)?<\/includeonly>|\s*<noinclude>[^]*?<\/noinclude>/g, '');
            title: mw.util.wikiUrlencode(config.list), // Encode string for eventual special characters
    }
            action: 'raw',
            ctype: 'text/plain'
    }).done( function(listData) {
            var listDataParsed = parseMW(listData); // Parse data for MediaWiki tags
            var lines = listDataParsed.split('\n'); // Split data in lines


            // Display error if no valid data is present
    // Error alert
            if ( listDataParsed === '' ) {
    function notFound(page){
                $('div#preload-templates').append( i18n.error.replace('$1' , '"<a href="/wiki/' + mw.util.wikiUrlencode(config.list) + '">' + config.list + '</a>"') ).append(preloadHelp);
        alert(i18n.msg('error', '"' + page + '"').plain());
                return;
    }
            }
           
            // Building the list HTML
            for (var i in lines) {
                var title;
                var string;


                // Ignore empty lines
    // Inserts text at the cursor's current position - originally from Wookieepedia
                if (lines[i].trim() === '') {
    function insertAtCursor(myField, myValue) {
                    continue;
        if (document.selection) {
                }
             // IE support
                // Text in a list is the template name
             myField.focus();
                if (lines[i].indexOf('*') === 0) {
            window.sel = document.selection.createRange();
                    title = lines[i].substring(1).trim();
             window.sel.text = myValue;
                    $preloadOptionsHtml += '<option value="' + title + '">' + title + '</option>';
        } else if ( myField.selectionStart || myField.selectionStart === 0 ) {
                } else {
            // MOZILLA/NETSCAPE support
                    // Rest are normal strings
            var startPos = myField.selectionStart,
                    string = lines[i];
                 endPos = myField.selectionEnd;
                    $preloadOptionsHtml += '<option disabled>' + string + '</option>';
             myField.value = myField.value.substring(0, startPos) +
                }
                myValue +
            }
                myField.value.substring(endPos, myField.value.length);
               
        } else {
             // Build list HTML
            myField.value += myValue;
             preloadOptionsList = $('<select />').attr('id', 'pt-list').attr('title', i18n.help).css('max-width' , '220px').html(defaultOption + $preloadOptionsHtml).change(function() {
        }
                    var templateTitle = $(this).val();
     }
                   
                    // Restore default option
                    $('#pt-list option:first-child').prop('selected', true);
 
                    // Preload the template on click
                    getPreloadPage(templateTitle);
                });
 
            // Append template list and messageges
             $('div#preload-templates').append(preloadOptionsList).append(preloadHelp);
 
            // Import required CSS for monobook
            if (skin === 'monobook') {
                // Importing sprite for monobook
                $('.sprite.question').css({
                    'background-image': 'url(http://slot1.images.wikia.nocookie.net/__cb1475164013/common/skins/shared/images/sprite.png)',
                    'background-position': '-1144px -20px',
                    'background-color': 'transparent',
                    'background-repeat': 'no-repeat',
                    'height': '12px',
                    'width': '12px'
                 });
             }
    }).fail( function(){
        // Add an error if failed to retrieve list
        $('div#preload-templates').append( i18n.error.replace('$1' , '"<a href="/wiki/' + mw.util.wikiUrlencode(config.list) + '">' + config.list + '</a>"') ).append(preloadHelp);
    });
 
    // =============
    //  Functions 
     // =============


     // Get preload text and add it to the text area
     // Get preload text and add it to the text area
     function getPreloadPage(title) {
     function getPreloadPage(title) {
         var page = namespace + ':' + title + '/' + config.subpage;
         // check if subpage is standard or is case by case
       
        var namespace = (function() {
         $.get(wgScript, {
        if (typeof window.preloadTemplates_namespace == 'undefined') return mwc.wgFormattedNamespaces['10'];
                 title: mw.util.wikiUrlencode(page), // Encode string for eventual special characters
        if (typeof mwc.wgFormattedNamespaces[window.preloadTemplates_namespace] != 'undefined') return mwc.wgFormattedNamespaces[window.preloadTemplates_namespace];
        for (var key in mwc.wgFormattedNamespaces) {
        if (mwc.wgFormattedNamespaces[key] == window.preloadTemplates_namespace) return mwc.wgFormattedNamespaces[key];
        }
        return mwc.wgFormattedNamespaces['10'];
        })();
        var namespacePagename = (function() {
        if (namespace) return namespace + ':';
        return '';
        })();
        var page = config.subpage === 'case-by-case' ?
            namespacePagename + title :
            namespacePagename + title + '/' + config.subpage;
 
         $.get(mw.util.wikiScript(), {
                 title: page,
                 action: 'raw',
                 action: 'raw',
                 ctype: 'text/plain'
                 ctype: 'text/plain'
Line 191: Line 101:
             // Parse some MediaWiki tags
             // Parse some MediaWiki tags
             var preloadDataParsed = parseMW(preloadData);
             var preloadDataParsed = parseMW(preloadData);
           
             // Display error if no useful data is present
             // Display error if no useful data is present
             if ( preloadDataParsed === '' ) {
             if (preloadDataParsed === '') {
                 notFound(page);
                 notFound(page);
                 return;
                 return;
Line 199: Line 108:


             // Insert syntax
             // Insert syntax
             if (document.getElementById('wpTextbox1')) {
             var cke = document.getElementsByClassName('cke_source'),
                 insertAtCursor(document.getElementById('wpTextbox1'), preloadDataParsed);
                textbox = document.getElementById('wpTextbox1'),
                cm = $(".CodeMirror").get(0);
            if (window.ve && ve.init && ve.init.target && ve.init.target.active) {
                // UCP Visual Editor (Source mode)
                ve.init.target
                    .getSurface()
                    .getModel().
                    getFragment()
                    .insertContent(preloadDataParsed);
            } else if (cke.length) {
                // Visual editor
                 insertAtCursor(cke[0], preloadDataParsed);
            } else if (cm){
                // text editor with syntex heighting
                var cmEditor = cm.CodeMirror;
                var cmdDoc = cmEditor.getDoc();
                cmdDoc.replaceRange(preloadDataParsed, cmdDoc.getCursor());
            }
            else if(textbox) {
                insertAtCursor(textbox, preloadDataParsed);
             } else {
             } else {
                 // Visual editor
                 console.warn('[PreloadTemplates] Could not find textbox to bind to');
                insertAtCursor(document.getElementsByClassName('cke_source')[0], preloadDataParsed);
             }
             }
         }).fail( function(){
         }).fail(function() {
             notFound(page);
             notFound(page);
         });
         });
     }
     }


    // Inserts text at the cursor's current position - originally from Wookieepedia
     function appendModule() {
     function insertAtCursor(myField, myValue) {
        var $moduleNew = $('.ve-ui-summaryPanel-summaryInputField');
    //IE support
        // Appending HTML to editor
         if (document.selection) {
         if ( $module.length ) {  
             myField.focus();
             $module.after($main);         // UCP source editors
             sel = document.selection.createRange();
        } else if ( $moduleOld.length ) {
             sel.text = myValue;
             $moduleOld.append($main);       // Old Non-UCP Source Editor
        } else if ( $moduleNew.length ) {
             $moduleNew.append($main);
         }
         }
         //MOZILLA/NETSCAPE support
    }
         else if (myField.selectionStart || myField.selectionStart == '0') {
 
             var startPos = myField.selectionStart;
// Add selector to editor
            var endPos = myField.selectionEnd;
    function preInit(i18nData) {
            myField.value = myField.value.substring(0, startPos) +
        i18n = i18nData;
                 myValue +
        $main = $('<div>', { id: 'preload-templates' });
                 myField.value.substring(endPos, myField.value.length);
         $main.append($('<span>', {
         } else {
            text: msg('preload')
             myField.value += myValue;
        }));
        $help = $('<div>', {
            id: 'pt-help'
        }).append($('<a>', {
            target: '_blank',
            href: 'https://dev.fandom.com/wiki/PreloadTemplates',
            title: msg('devWiki'),
            text: '?'
        }));
        appendModule();
    }
 
    function listHTML(parsed) {
         return mw.html.element('option', {
            selected: true,
            disabled: true
        }, msg('choose')) + parsed.split('\n').map(function(line) {
            // Ignore empty lines
            if (line.trim() === '') {
                return '';
            }
            // Text in a list is the template name
             if (line.indexOf('*') === 0) {
                var title = line.substring(1).trim();
 
                // Text after pipe is display name
                if (title.indexOf('|') !== -1) {
                    var parts = title.split('|');
                    return mw.html.element('option', {
                        value: parts[0].trim()
                    }, parts[1].trim());
                } else {
                    return mw.html.element('option', {
                        value: title
                    }, title);
                }
            } else {
                 // Rest are normal strings
                 return mw.html.element('option', {
                    disabled: true
                }, line.trim());
            }
        }).join();
    }
 
    // =================
    //  Initialization 
    // =================
 
    // If the initialization failed
    function initFail() {
         $main.append(
            i18n.msg(
                'error',
                mw.html.element('a', {
                    href: mw.util.getUrl(config.list)
                }, config.list)
             ).plain(),
            $help
        );
    }
 
    function init(listData) {
        var parsed = parseMW(listData); // Parse data for MediaWiki tags
 
        // Display error if no valid data is present
        if (parsed === '') {
            initFail();
            return;
         }
         }
        // Append template list and messages
        $main.append(
            $('<select>', {
                id: 'pt-list',
                title: msg('help'),
                html: listHTML(parsed)
            }).change(function() {
                var $this = $(this),
                    val = $this.val();
                // Restore default option
                $this.find('option:first-child').prop('selected', true);
                // Preload the template on click
                getPreloadPage(val);
            }),
            $help
        );
     }
     }
      
 
     // Parse MediaWiki code to allow the use of incudeoonly and noninclude tags in the preload page
     // ===========
     function parseMW(source){
     //   Imports 
         var parsed = source.replace(/<includeonly>(\n)?|(\n)?<\/includeonly>|\s*<noinclude>[^]*<\/noinclude>/g, '');
    // ===========
          
     /*if (!window.dev || !window.dev.i18n) {
        return parsed;
         importArticle({
            type: 'script',
            article: 'u:dev:MediaWiki:I18n-js/code.js'
         });
     }
     }
      
     importArticle({
     // Error alert
        type: 'style',
     function notFound(page){
        article: 'u:dev:MediaWiki:PreloadTemplates.css'
         var message = i18n.error.replace('$1' , '"' + page + '"');
     });*/
       
 
         alert(message);
     mw.hook('dev.i18n').add(function(i18no) {
     }
         $.when(
});
            i18no.loadMessages('PreloadTemplates'),
            mw.loader.using('mediawiki.util')
        ).then(function(i18nData) {
            preInit(i18nData);
            mw.hook('ve.activationComplete').add(appendModule);
            $.get(mw.util.wikiScript(), {
                title: config.list,
                action: 'raw',
                ctype: 'text/plain'
            }).done(init).fail(initFail);
         });
     });
 
})();
Cookies help us deliver our services. By using our services, you agree to our use of cookies.