MediaWiki:Common.js: Difference between revisions

Till Kraemer (talk | contribs)
Created page with "→‎Any JavaScript here will be loaded for all users on every page load.: if ( /^MediaWiki(\/.+)?$/.test( wgPageName ) && wgAction == "view" ) { addOnloadHook(function()..."
 
Till Kraemer (talk | contribs)
Undo revision 18969 by Till Kraemer (talk)
 
(4 intermediate revisions by the same user not shown)
Line 38: Line 38:
}
}
/* End of includePage */
/* End of includePage */
// makeCollapsible (remove when deployed)
importStylesheet('MediaWiki:JQuery-makeCollapsible.css');
importScript('MediaWiki:JQuery-makeCollapsible.js');


/* Including extra .js pages */  
/* Including extra .js pages */  
Line 60: Line 55:
/* End of extra pages */
/* End of extra pages */


/** Collapsible tables *********************************************************
/**
* Collapsible tables
*
* Allows tables to be collapsed, showing only the header. See [[Help:Collapsing]].
  *
  *
  * Description: Allows tables to be collapsed, showing only the header. See
  * @version 2.0.3 (2014-03-14)
  *                         http://www.mediawiki.org/wiki/Manual:Collapsible_tables.
  * @source https://www.mediawiki.org/wiki/MediaWiki:Gadget-collapsibleTables.js
  * Maintainers: [[en:User:R. Koot]]
  * @author [[User:R. Koot]]
* @author [[User:Krinkle]]
* @deprecated Since MediaWiki 1.20: Use class="mw-collapsible" instead which
* is supported in MediaWiki core.
  */
  */
 
var autoCollapse = 2;
var autoCollapse = 2;
var collapseCaption = 'Hide';
var collapseCaption = 'hide';
var expandCaption = 'Show';
var expandCaption = 'show';
var tableIndex = 0;
 
function collapseTable( tableIndex ) {
function collapseTable( tableIndex ) {
        var Button = document.getElementById( 'collapseButton' + tableIndex );
    var Button = document.getElementById( 'collapseButton' + tableIndex );
        var Table = document.getElementById( 'collapsibleTable' + tableIndex );
    var Table = document.getElementById( 'collapsibleTable' + tableIndex );
 
        if ( !Table || !Button ) {
    if ( !Table || !Button ) {
                return false;
        return false;
    }
 
    var Rows = Table.rows;
    var i;
    var $row0 = $(Rows[0]);
 
    if ( Button.firstChild.data === collapseCaption ) {
        for ( i = 1; i < Rows.length; i++ ) {
            Rows[i].style.display = 'none';
         }
         }
         Button.firstChild.data = expandCaption;
        var Rows = Table.rows;
    } else {
        for ( i = 1; i < Rows.length; i++ ) {
         if ( Button.firstChild.data == collapseCaption ) {
            Rows[i].style.display = $row0.css( 'display' );
                for ( var i = 1; i < Rows.length; i++ ) {
                        Rows[i].style.display = 'none';
                }
                Button.firstChild.data = expandCaption;
        } else {
                for ( var i = 1; i < Rows.length; i++ ) {
                        Rows[i].style.display = Rows[0].style.display;
                }
                Button.firstChild.data = collapseCaption;
         }
         }
        Button.firstChild.data = collapseCaption;
    }
}
function createClickHandler( tableIndex ) {
    return function ( e ) {
        e.preventDefault();
        collapseTable( tableIndex );
    };
}
}
 
function createCollapseButtons() {
function createCollapseButtons( $content ) {
        var tableIndex = 0;
    var NavigationBoxes = {};
        var NavigationBoxes = new Object();
    var $Tables = $content.find( 'table' );
        var Tables = document.getElementsByTagName( 'table' );
    var i;
 
        for ( var i = 0; i < Tables.length; i++ ) {
    $Tables.each( function( i, table ) {
                if ( hasClass( Tables[i], 'collapsible' ) ) {
        if ( $(table).hasClass( 'collapsible' ) ) {
 
                        /* only add button and increment count if there is a header row to work with */
            /* only add button and increment count if there is a header row to work with */
                        var HeaderRow = Tables[i].getElementsByTagName( 'tr' )[0];
            var HeaderRow = table.getElementsByTagName( 'tr' )[0];
                        if ( !HeaderRow ) {
            if ( !HeaderRow ) {
                                continue;
                return;
                        }
            }
                        var Header = HeaderRow.getElementsByTagName( 'th' )[0];
            var Header = table.getElementsByTagName( 'th' )[0];
                        if ( !Header ) {
            if ( !Header ) {
                                continue;
                return;
                        }
            }
 
                        NavigationBoxes[tableIndex] = Tables[i];
            NavigationBoxes[ tableIndex ] = table;
                        Tables[i].setAttribute( 'id', 'collapsibleTable' + tableIndex );
            table.setAttribute( 'id', 'collapsibleTable' + tableIndex );
 
                        var Button = document.createElement( 'span' );
            var Button     = document.createElement( 'span' );
                        var ButtonLink = document.createElement( 'a' );
            var ButtonLink = document.createElement( 'a' );
                        var ButtonText = document.createTextNode( collapseCaption );
            var ButtonText = document.createTextNode( collapseCaption );
            // Styles are declared in [[MediaWiki:Common.css]]
                        Button.className = 'collapseButton'; // Styles are declared in [[MediaWiki:Common.css]]
            Button.className = 'collapseButton';
 
                        ButtonLink.style.color = Header.style.color;
            ButtonLink.style.color = Header.style.color;
                        ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex );
            ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex );
                        ButtonLink.setAttribute( 'href', "javascript:collapseTable(" + tableIndex + ");" );
            ButtonLink.setAttribute( 'href', '#' );
                        ButtonLink.appendChild( ButtonText );
            $( ButtonLink ).on( 'click', createClickHandler( tableIndex ) );
            ButtonLink.appendChild( ButtonText );
                        Button.appendChild( document.createTextNode( '[' ) );
 
                        Button.appendChild( ButtonLink );
            Button.appendChild( document.createTextNode( '[' ) );
                        Button.appendChild( document.createTextNode( ']' ) );
            Button.appendChild( ButtonLink );
            Button.appendChild( document.createTextNode( ']' ) );
                        Header.insertBefore( Button, Header.childNodes[0] );
 
                        tableIndex++;
            Header.insertBefore( Button, Header.firstChild );
                }
            tableIndex++;
        }
    } );
 
    for ( i = 0;  i < tableIndex; i++ ) {
        if ( $( NavigationBoxes[i] ).hasClass( 'collapsed' ) ||
            ( tableIndex >= autoCollapse && $( NavigationBoxes[i] ).hasClass( 'autocollapse' ) )
        ) {
            collapseTable( i );
         }
         }
         else if ( $( NavigationBoxes[i] ).hasClass ( 'innercollapse' ) ) {
         for ( var i = 0;  i < tableIndex; i++ ) {
            var element = NavigationBoxes[i];
                if ( hasClass( NavigationBoxes[i], 'collapsed' ) || ( tableIndex >= autoCollapse && hasClass( NavigationBoxes[i], 'autocollapse' ) ) ) {
            while ((element = element.parentNode)) {
                        collapseTable( i );
                if ( $( element ).hasClass( 'outercollapse' ) ) {
                } else if ( hasClass( NavigationBoxes[i], 'innercollapse' ) ) {
                    collapseTable ( i );
                        var element = NavigationBoxes[i];
                    break;
                        while ( element = element.parentNode ) {
                                if ( hasClass( element, 'outercollapse' ) ) {
                                        collapseTable( i );
                                        break;
                                }
                        }
                 }
                 }
            }
         }
         }
    }
}
}
 
addOnloadHook( createCollapseButtons );
mw.hook( 'wikipage.content' ).add( createCollapseButtons );
 
/** Test if an element has a certain class **************************************
/**
* Add support to mw-collapsible for autocollapse, innercollapse and outercollapse
  *
  *
* Description: Uses regular expressions and caching for better performance.
  * Maintainers: TheDJ
  * Maintainers: [[User:Mike Dillon]], [[User:R. Koot]], [[User:SG]]
  */
  */
function mwCollapsibleSetup( $collapsibleContent ) {
var hasClass = ( function() {
var $element,
        var reCache = {};
autoCollapseThreshold = 2;
        return function( element, className ) {
$.each( $collapsibleContent, function (index, element) {
                return ( reCache[className] ? reCache[className] : ( reCache[className] = new RegExp( "(?:\\s|^)" + className + "(?:\\s|$)" ) ) ).test( element.className );
$element = $( element );
        };
if ( index > autoCollapseThreshold && $element.hasClass( 'autocollapse' ) ) {
})();
$element.data( 'mw-collapsible' ).collapse();
} else if ( $element.hasClass( 'innercollapse' ) ) {
/** Dynamic Navigation Bars (experimental) *************************************
if ( $element.parents( '.outercollapse' ).length > 0 ) {
$element.data( 'mw-collapsible' ).collapse();
}
}
} );
}
 
mw.hook( 'wikipage.collapsibleContent' ).add( mwCollapsibleSetup );
 
/**
* Dynamic Navigation Bars (experimental)
  *
  *
  * Description: See [[Wikipedia:NavFrame]].
  * Description: See [[Wikipedia:NavFrame]].
  * Maintainers: UNMAINTAINED
  * Maintainers: UNMAINTAINED
  */
  */
 
// set up the words in your language
/* set up the words in your language */
var NavigationBarHide = '[' + collapseCaption + ']';
var NavigationBarHide = '[' + collapseCaption + ']';
var NavigationBarShow = '[' + expandCaption + ']';
var NavigationBarShow = '[' + expandCaption + ']';
var indexNavigationBar = 0;
// shows and hides content and picture (if available) of navigation bars
 
// Parameters:
/**
//     indexNavigationBar: the index of navigation bar to be toggled
* Shows and hides content and picture (if available) of navigation bars
function toggleNavigationBar(indexNavigationBar){
* Parameters:
     var NavToggle = document.getElementById("NavToggle" + indexNavigationBar);
*     indexNavigationBar: the index of navigation bar to be toggled
     var NavFrame = document.getElementById("NavFrame" + indexNavigationBar);
**/
window.toggleNavigationBar = function ( indexNavigationBar, event ) {
     if (!NavFrame || !NavToggle) {
     var NavToggle = document.getElementById( 'NavToggle' + indexNavigationBar );
     var NavFrame = document.getElementById( 'NavFrame' + indexNavigationBar );
    var NavChild;
 
     if ( !NavFrame || !NavToggle ) {
         return false;
         return false;
     }
     }
 
     // if shown now
     /* if shown now */
     if (NavToggle.firstChild.data == NavigationBarHide) {
     if ( NavToggle.firstChild.data === NavigationBarHide ) {
         for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling) {
         for ( NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling ) {
             if (hasClass(NavChild, 'NavContent') || hasClass(NavChild, 'NavPic')) {
             if ( $( NavChild ).hasClass( 'NavContent' ) || $( NavChild ).hasClass( 'NavPic' ) ) {
                 NavChild.style.display = 'none';
                 NavChild.style.display = 'none';
             }
             }
         }
         }
     NavToggle.firstChild.data = NavigationBarShow;
     NavToggle.firstChild.data = NavigationBarShow;
 
     // if hidden now
     /* if hidden now */
     } else if (NavToggle.firstChild.data == NavigationBarShow) {
     } else if ( NavToggle.firstChild.data === NavigationBarShow ) {
         for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling) {
         for ( NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling ) {
             if (hasClass(NavChild, 'NavContent') || hasClass(NavChild, 'NavPic')) {
             if ( $( NavChild ).hasClass( 'NavContent' ) || $( NavChild ).hasClass( 'NavPic' ) ) {
                 NavChild.style.display = 'block';
                 NavChild.style.display = 'block';
             }
             }
Line 204: Line 233:
         NavToggle.firstChild.data = NavigationBarHide;
         NavToggle.firstChild.data = NavigationBarHide;
     }
     }
}
 
    event.preventDefault();
// adds show/hide-button to navigation bars
};
function createNavigationBarToggleButton(){
 
     var indexNavigationBar = 0;
/* adds show/hide-button to navigation bars */
     // iterate over all < div >-elements  
function createNavigationBarToggleButton( $content ) {
     var divs = document.getElementsByTagName("div");
     var NavChild;
     for (var i = 0; NavFrame = divs[i]; i++) {
     /* iterate over all < div >-elements */
         // if found a navigation bar
     var $divs = $content.find( 'div' );
         if (hasClass(NavFrame, "NavFrame")) {
     $divs.each( function ( i, NavFrame ) {
         /* if found a navigation bar */
         if ( $( NavFrame ).hasClass( 'NavFrame' ) ) {
 
             indexNavigationBar++;
             indexNavigationBar++;
             var NavToggle = document.createElement("a");
             var NavToggle = document.createElement( 'a' );
             NavToggle.className = 'NavToggle';
             NavToggle.className = 'NavToggle';
             NavToggle.setAttribute('id', 'NavToggle' + indexNavigationBar);
             NavToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar );
             NavToggle.setAttribute('href', 'javascript:toggleNavigationBar(' + indexNavigationBar + ');');
             NavToggle.setAttribute( 'href', '#' );
            $( NavToggle ).on( 'click', $.proxy( window.toggleNavigationBar, window, indexNavigationBar ) );
             var isCollapsed = hasClass( NavFrame, "collapsed" );
 
             /*
             var isCollapsed = $( NavFrame ).hasClass( 'collapsed' );
             /**
             * Check if any children are already hidden.  This loop is here for backwards compatibility:
             * Check if any children are already hidden.  This loop is here for backwards compatibility:
             * the old way of making NavFrames start out collapsed was to manually add style="display:none"
             * the old way of making NavFrames start out collapsed was to manually add style="display:none"
Line 229: Line 261:
             * "collapsed" to the NavFrame itself, just like with collapsible tables.
             * "collapsed" to the NavFrame itself, just like with collapsible tables.
             */
             */
             for (var NavChild = NavFrame.firstChild; NavChild != null && !isCollapsed; NavChild = NavChild.nextSibling) {
             for ( NavChild = NavFrame.firstChild; NavChild != null && !isCollapsed; NavChild = NavChild.nextSibling ) {
                 if ( hasClass( NavChild, 'NavPic' ) || hasClass( NavChild, 'NavContent' ) ) {
                 if ( $( NavChild ).hasClass( 'NavPic' ) || $( NavChild ).hasClass( 'NavContent' ) ) {
                     if ( NavChild.style.display == 'none' ) {
                     if ( NavChild.style.display === 'none' ) {
                         isCollapsed = true;
                         isCollapsed = true;
                     }
                     }
                 }
                 }
             }
             }
             if (isCollapsed) {
             if ( isCollapsed ) {
                 for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling) {
                 for ( NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling ) {
                     if ( hasClass( NavChild, 'NavPic' ) || hasClass( NavChild, 'NavContent' ) ) {
                     if ( $( NavChild ).hasClass( 'NavPic' ) || $( NavChild ).hasClass( 'NavContent' ) ) {
                         NavChild.style.display = 'none';
                         NavChild.style.display = 'none';
                     }
                     }
                 }
                 }
             }
             }
             var NavToggleText = document.createTextNode(isCollapsed ? NavigationBarShow : NavigationBarHide);
             var NavToggleText = document.createTextNode( isCollapsed ? NavigationBarShow : NavigationBarHide );
             NavToggle.appendChild(NavToggleText);
             NavToggle.appendChild( NavToggleText );
 
             // Find the NavHead and attach the toggle link (Must be this complicated because Moz's firstChild handling is borked)
             /* Find the NavHead and attach the toggle link (Must be this complicated because Moz's firstChild handling is borked) */
             for(var j=0; j < NavFrame.childNodes.length; j++) {
             for( var j = 0; j < NavFrame.childNodes.length; j++ ) {
                 if (hasClass(NavFrame.childNodes[j], "NavHead")) {
                 if ( $( NavFrame.childNodes[j] ).hasClass( 'NavHead' ) ) {
                     NavToggle.style.color = NavFrame.childNodes[j].style.color;
                     NavToggle.style.color = NavFrame.childNodes[j].style.color;
                     NavFrame.childNodes[j].appendChild(NavToggle);
                     NavFrame.childNodes[j].appendChild( NavToggle );
                 }
                 }
             }
             }
             NavFrame.setAttribute('id', 'NavFrame' + indexNavigationBar);
             NavFrame.setAttribute( 'id', 'NavFrame' + indexNavigationBar );
         }
         }
     }
     } );
}
}
 
$( createNavigationBarToggleButton );
mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton );