MediaWiki:Gadget-charinsert-core.js

/**
 * Copied from [[mw:User:Alex Smotrov/edittools.js]], modified for use on the English Wikipedia.
 *
 * Configuration (to be set from [[Special:MyPage/common.js]]):
 *   window.charinsertCustom – Object. Merged into the default charinsert list. For example, setting
 *       this to { Symbols: '‽' } will add the interrobang to the end of the Symbols section.
 *   window.editToolsRecall – Boolean. Set true to create a recall switch.
 *   window.charinsertDontMove – Boolean. Set true to leave the box in its default position, rather
 *       than moving it above the edit summary.
 *   window.updateEditTools() – Function. Call after updating window.charinsertCustom to regenerate the
 *       EditTools window.
 */
/* global jQuery, mw, charinsertCustom */

window.updateEditTools = function () {
};

jQuery( document ).ready( function ( $ ) {
    var EditTools = {
        // Entries prefixed with ␥ (U+2425 SYMBOL FOR DELETE FORM TWO) will not appear in the article namespace (namespace 0).
        // Please make any changes to [[MediaWiki:Edittools]] as well, however, instead of using the ␥ symbol, use {{#ifeq:{{NAMESPACE}}|{{ns:0}}| | }}.
        charinsert: {
            'GATE templates': '␥ Editorial_projects: {\{LexiconCreatedBy}} {\{LexiconCreatedBy/Citation}} {\{MonumentaCreatedBy}} {\{MonumentaCreatedBy/Citation}} ␥  Sidenotes: {\{Sidenotes.begin|+}} {\{Left.sidenote|+}} {\{Right.sidenote|+}} {\{Sidenotes.end}} ␥ Pages_creation: {\{PlacePage}} ' ,
            'Advanced footnotes': '␥ Comment_footnote: <ref.group="comment-notes">+</ref>  {\{reflist|group=comment-notes}} ␥ Text_footnote: <ref.group="text-notes">+</ref>  {\{reflist|group=text-notes}}' ␥ Loci_footnote: <ref.group="loci-notes">+</ref>  {\{reflist|group=loci-notes}}',
            'Wiki markup': '{\{+}}  {\{\{+}}}  |  [+]  [\[+]]  [\[Category:+]]  #REDIRECT.[\[+]]  <code>+</code>  <blockquote>+</blockquote>  <includeonly>+</includeonly>  <noinclude>+</noinclude>  <nowiki>+</nowiki>  <!--.+_--> <code><nowiki>+</nowiki></code>',
			'Planets': '☉ ☽︎ ☿ ♀ ♂ ♃ ♄',
            'Math and logic': '− × ÷ ⋅ ° ∗ ∘ ± ∓ ≤ ≥ ≠ ≡ ≅ ≜ ≝ ≐ ≃ ≈ ⊕ ⊗ ⇐ ⇔ ⇒ ∞ ← ↔ → ≪ ≫ ∝ √ ∤ ≀ ◅ ▻ ⋉ ⋊ ⋈ ∴ ∵ ↦ ¬ ∧ ∨ ⊻ ∀ ∃ ∈ ∉ ∋ ⊆ ⊈ ⊊ ⊂ ⊄ ⊇ ⊉ ⊋ ⊃ ⊅ ∪ ∩ ∑ ∏ ∐ ′ ∫ ∬ ∭ ∮ ∇ ∂ ∆ ∅ ℂ ℍ ℕ ℙ ℚ ℝ ℤ ℵ ⌊ ⌋ ⌈ ⌉ ⊤ ⊥ ⊢ ⊣ ⊧ □ ∠ ⟨ ⟩ <math>+</math> {\{math|+}} {\{mvar|+}} {\{frac|+|}} {\{sfrac|+|}}'
        },

        charinsertDivider: "\240",

        cookieName: 'edittoolscharsubset',

        createEditTools: function ( placeholder ) {
            var sel, id;
            var box = document.createElement( "div" );
            var prevSubset = 0, curSubset = 0;
            box.id = "editpage-specialchars";
            box.title = 'Click on the character or tag to insert it into the edit window';

            // append user-defined sets
            if ( window.charinsertCustom ) {
                for ( id in charinsertCustom ) {
                    if ( !EditTools.charinsert[id] ) {
                        EditTools.charinsert[id] = '';
                    }
                }
            }

            // create drop-down select
            sel = document.createElement( 'select' );
            for ( id in EditTools.charinsert ) {
                sel.options[sel.options.length] = new Option( id, id );
            }
            sel.selectedIndex = 0;
            sel.style.marginRight = '.3em';
            sel.title = 'Choose character subset';
            sel.onchange = sel.onkeyup = selectSubset;
            box.appendChild( sel );

            // create "recall" switch
            if ( window.editToolsRecall ) {
                var recall = document.createElement( 'span' );
                recall.appendChild( document.createTextNode( '↕' ) ); // ↔
                recall.onclick = function() {
                    sel.selectedIndex = prevSubset;
                    selectSubset();
                };
                with ( recall.style ) {
                    cssFloat = styleFloat = 'left';
                    marginRight = '5px';
                    cursor = 'pointer';
                }
                box.appendChild( recall );
            }

            // load latest selection from cookies
            try {
                var cookieRe = new RegExp( "(?:^|;)\\s*" + EditTools.cookieName + "=(\\d+)\\s*(?:;|$)" );
                var m = cookieRe.exec( document.cookie );
                if ( m && m.length > 1 && parseInt( m[1] ) < sel.options.length ) {
                    sel.selectedIndex = parseInt( m[1] );
                }
            } catch ( err ) {
                // ignore
            }

            placeholder.parentNode.replaceChild( box, placeholder );
            selectSubset();
            return;

            function selectSubset() {
                // remember previous (for "recall" button)
                prevSubset = curSubset;
                curSubset = sel.selectedIndex;
                //save into cookies for persistence
                try {
                    var expires = new Date();
                    expires.setTime( expires.getTime() + 30 * 24 * 60 * 60 * 1000 );  // + 30 days
                    document.cookie = EditTools.cookieName + "=" + curSubset + ";path=/;expires=" + expires.toUTCString();
                } catch ( err ) {
                    // ignore
                }
                //hide other subsets
                var pp = box.getElementsByTagName( 'p' ) ;
                for ( var i = 0; i < pp.length; i++ ) {
                    pp[i].style.display = 'none';
                }
                //show/create current subset
                var id = sel.options[curSubset].value;
                var p = document.getElementById( id );
                if ( !p ) {
                    p = document.createElement( 'p' );
                    p.className = "nowraplinks";
                    p.id = id;
                    if ( id == 'Arabic' || id == 'Hebrew' ) {
                        p.style.fontSize = '120%';
                        p.dir = 'rtl';
                    }
                    var tokens = EditTools.charinsert[id];
                    if ( window.charinsertCustom && charinsertCustom[id] ) {
                        if ( tokens.length > 0 ) {
                            tokens += ' ';
                        }
                        tokens += charinsertCustom[id];
                    }
                    EditTools.createTokens( p, tokens );
                    box.appendChild( p );
                }
                p.style.display = 'inline';
            }
        },

        createTokens: function ( paragraph, str ) {
            var tokens = str.split( ' ' ), token, i, n;
            for ( i = 0; i < tokens.length; i++ ) {
                token = tokens[i];
                n = token.indexOf( '+' );
                if ( token.charAt( 0 ) === '␥' ) {
                    if ( token.length > 1 && mw.config.get( 'wgNamespaceNumber' ) === 0 ) {
                        continue;
                    } else {
                        token = token.substring( 1 );
                    }
                }
                if ( token == '' || token == '_' ) {
                    addText( EditTools.charinsertDivider + ' ' );
                } else if ( token == '\n' ) {
                    paragraph.appendChild( document.createElement( 'br' ) );
                } else if ( token == '___' ) {
                    paragraph.appendChild( document.createElement( 'hr' ) );
                } else if ( token.charAt( token.length-1 ) == ':' ) { // : at the end means just text
                    addBold( token );
                } else if ( n == 0 ) { // +<tag>  ->   <tag>+</tag>
                    addLink( token.substring( 1 ), '</' + token.substring( 2 ), token.substring( 1 ) );
                } else if ( n > 0 ) { // <tag>+</tag>
                    addLink( token.substring( 0, n ), token.substring( n+1 ) );
                } else if ( token.length > 2 && token.charCodeAt( 0 ) > 127 ) { // a string of insertable characters
                    for ( var j = 0; j < token.length; j++ ) {
                        addLink( token.charAt( j ), '' );
                    }
                } else {
                    addLink( token, '' );
                }
            }
            return;

            function addLink( tagOpen, tagClose, name ) {
                var handler;
                var dle = tagOpen.indexOf( '\x10' );
                if ( dle > 0 ) {
                    var path = tagOpen.substring( dle + 1 ).split( '.' );
                    tagOpen = tagOpen.substring( 0, dle );
                    handler = window;
                    for ( var i = 0; i < path.length; i++ ) {
                        handler = handler[path[i]];
                    }
                } else {
                    tagOpen = tagOpen.replace( /\./g,' ' );
                    tagClose = tagClose ? tagClose.replace( /_/g,' ' ) : '';
                    handler = new Function(
                        "evt",
                        "mw.toolbar.insertTags('" + tagOpen + "', '" + tagClose + "', ''); evt.preventDefault(); return false;"
                    );
                }
                var a = document.createElement( 'a' );
                name = name || tagOpen + tagClose;
                name = name.replace( /\\n/g,'' );
                a.appendChild( document.createTextNode( name ) );
                a.href = "#";
                $( a ).click( handler );
                paragraph.appendChild( a );
                addText( ' ' );
            }

            function addBold( text ) {
                var b = document.createElement( 'b' );
                b.appendChild( document.createTextNode( text.replace( /_/g,' ' ) ) );
                paragraph.appendChild( b );
                addText( ' ' );
            }
            function addText( txt ) {
                paragraph.appendChild( document.createTextNode( txt ) );
            }
        },

        last_active_textfield: null,

        registerTextField: function ( evt ) {
            var e = evt || window.event;
            var node = e.target || e.srcElement;
            if ( !node ) {
                return;
            }
            EditTools.last_active_textfield = node.id;
            return true;
        },

        getTextArea: function () {
            var txtarea = null;
            if ( EditTools.last_active_textfield && EditTools.last_active_textfield != "" )
                txtarea = document.getElementById( EditTools.last_active_textfield );
            if ( !txtarea ) {
                // Fallback option: old behaviour
                if ( document.editform ) {
                    txtarea = document.editform.wpTextbox1;
                } else {
                    // Some alternate form? Take the first one we can find
                    txtarea = document.getElementsByTagName( 'textarea' );
                    if ( txtarea.length > 0 ) {
                        txtarea = txtarea[0];
                    } else {
                        txtarea = null;
                    }
                }
            }
            return txtarea;
        },

        setup: function () {
            var placeholder;
            if ( $( '#editpage-specialchars' ).length ) {
                placeholder = $( '#editpage-specialchars' )[0];
            } else {
                placeholder = $( '<div id="editpage-specialchars"> </div>' ).prependTo( '.mw-editTools' )[0];
            }
            if ( !placeholder ) {
                return;
            }
            if ( !window.charinsertDontMove ) {
                $( '.editOptions' ).before( placeholder );
            }
            EditTools.createEditTools( placeholder );
            window.updateEditTools = function () {
                EditTools.createEditTools( $( '#editpage-specialchars' )[0] );
            };
        }

    }; // end EditTools

    EditTools.setup();
} );