Actions

MediaWiki

Difference between revisions of "Common.js"

From Joomla! Documentation

m (tracking down a fix for js error)
m (updating js for collapsing tables and navigation bars)
 
Line 36: Line 36:
 
}
 
}
  
/** Collapsible tables *********************************************************
+
/**
 +
* Collapsible tables *********************************************************
 
  *
 
  *
  * Description: Allows tables to be collapsed, showing only the header. See
+
  * Description: Allows tables to be collapsed, showing only the header. See
  *               [[Wikipedia:NavFrame]].
+
  *             [[Wikipedia:NavFrame]].
  * Maintainers: [[User:R. Koot]]
+
  * Maintainers: [[User:R. Koot]]
 
  */
 
  */
 
   
 
   
 
var autoCollapse = 2;
 
var autoCollapse = 2;
var collapseCaption = "hide";
+
var collapseCaption = 'hide';
var expandCaption = "show";
+
var expandCaption = 'show';
 
   
 
   
window.collapseTable = function( tableIndex ){
+
window.collapseTable = function ( 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 ) {
Line 56: Line 57:
 
   
 
   
 
     var Rows = Table.rows;
 
     var Rows = Table.rows;
 +
    var i;
 
   
 
   
     if ( Button.firstChild.data == collapseCaption ) {
+
     if ( Button.firstChild.data === collapseCaption ) {
         for ( var i = 1; i < Rows.length; i++ ) {
+
         for ( i = 1; i < Rows.length; i++ ) {
             Rows[i].style.display = "none";
+
             Rows[i].style.display = 'none';
 
         }
 
         }
 
         Button.firstChild.data = expandCaption;
 
         Button.firstChild.data = expandCaption;
 
     } else {
 
     } else {
         for ( var i = 1; i < Rows.length; i++ ) {
+
         for ( i = 1; i < Rows.length; i++ ) {
 
             Rows[i].style.display = Rows[0].style.display;
 
             Rows[i].style.display = Rows[0].style.display;
 
         }
 
         }
 
         Button.firstChild.data = collapseCaption;
 
         Button.firstChild.data = collapseCaption;
 
     }
 
     }
}
+
};
 
   
 
   
function createCollapseButtons(){
+
function createCollapseButtons() {
 
     var tableIndex = 0;
 
     var tableIndex = 0;
     var NavigationBoxes = new Object();
+
     var NavigationBoxes = {};
     var Tables = document.getElementsByTagName( "table" );
+
     var Tables = document.getElementsByTagName( 'table' );
 +
    var i;
 +
 +
    function handleButtonLink( index, e ) {
 +
        window.collapseTable( index );
 +
        e.preventDefault();
 +
    }
 
   
 
   
     for ( var i = 0; i < Tables.length; i++ ) {
+
     for ( i = 0; i < Tables.length; i++ ) {
         if ( hasClass( Tables[i], "collapsible" ) ) {
+
         if ( $( Tables[i] ).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 = Tables[i].getElementsByTagName( 'tr' )[0];
             if (!HeaderRow) continue;
+
             if ( !HeaderRow ) continue;
             var Header = HeaderRow.getElementsByTagName( "th" )[0];
+
             var Header = HeaderRow.getElementsByTagName( 'th' )[0];
             if (!Header) continue;
+
             if ( !Header ) continue;
 
   
 
   
 
             NavigationBoxes[ tableIndex ] = Tables[i];
 
             NavigationBoxes[ tableIndex ] = Tables[i];
             Tables[i].setAttribute( "id", "collapsibleTable" + tableIndex );
+
             Tables[i].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 );
 
   
 
   
             Button.className = "collapseButton";  //Styles are declared in Common.css
+
             Button.className = 'collapseButton';  /* Styles are declared in Common.css */
 
   
 
   
 
             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", "#" );
+
             ButtonLink.setAttribute( 'href', '#' );
             addHandler( ButtonLink,  "click", new Function( "evt", "collapseTable(" + tableIndex + " ); return killEvt( evt );") );
+
             $( ButtonLink ).on( 'click', $.proxy( handleButtonLink, ButtonLink, tableIndex ) );
 
             ButtonLink.appendChild( ButtonText );
 
             ButtonLink.appendChild( ButtonText );
 
   
 
   
             Button.appendChild( document.createTextNode( "[" ) );
+
             Button.appendChild( document.createTextNode( '[' ) );
 
             Button.appendChild( ButtonLink );
 
             Button.appendChild( ButtonLink );
             Button.appendChild( document.createTextNode( "]" ) );
+
             Button.appendChild( document.createTextNode( ']' ) );
 
   
 
   
 
             Header.insertBefore( Button, Header.firstChild );
 
             Header.insertBefore( Button, Header.firstChild );
Line 108: Line 116:
 
     }
 
     }
 
   
 
   
     for ( var i = 0;  i < tableIndex; i++ ) {
+
     for ( i = 0;  i < tableIndex; i++ ) {
         if ( hasClass( NavigationBoxes[i], "collapsed" ) || ( tableIndex >= autoCollapse && hasClass( NavigationBoxes[i], "autocollapse" ) ) ) {
+
         if ( $( NavigationBoxes[i] ).hasClass( 'collapsed' ) || ( tableIndex >= autoCollapse && $( NavigationBoxes[i] ).hasClass( 'autocollapse' ) ) ) {
             collapseTable( i );
+
             window.collapseTable( i );
 
         }  
 
         }  
         else if ( hasClass( NavigationBoxes[i], "innercollapse" ) ) {
+
         else if ( $( NavigationBoxes[i] ).hasClass ( 'innercollapse' ) ) {
 
             var element = NavigationBoxes[i];
 
             var element = NavigationBoxes[i];
             while (element = element.parentNode) {
+
             while ((element = element.parentNode)) {
                 if ( hasClass( element, "outercollapse" ) ) {
+
                 if ( $( element ).hasClass( 'outercollapse' ) ) {
                     collapseTable ( i );
+
                     window.collapseTable ( i );
 
                     break;
 
                     break;
 
                 }
 
                 }
Line 126: Line 134:
 
$( createCollapseButtons );
 
$( createCollapseButtons );
 
   
 
   
+
/**
/** Dynamic Navigation Bars (experimental) *************************************
+
* 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 + ']';
 
   
 
   
// shows and hides content and picture (if available) of navigation bars
+
/**
// Parameters:
+
* Shows and hides content and picture (if available) of navigation bars
//     indexNavigationBar: the index of navigation bar to be toggled
+
* Parameters:
window.toggleNavigationBar = function(indexNavigationBar){
+
*     indexNavigationBar: the index of navigation bar to be toggled
     var NavToggle = document.getElementById("NavToggle" + indexNavigationBar);
+
**/
     var NavFrame = document.getElementById("NavFrame" + indexNavigationBar);
+
window.toggleNavigationBar = function ( indexNavigationBar, event ) {
 +
     var NavToggle = document.getElementById( 'NavToggle' + indexNavigationBar );
 +
     var NavFrame = document.getElementById( 'NavFrame' + indexNavigationBar );
 +
    var NavChild;
 
   
 
   
     if (!NavFrame || !NavToggle) {
+
     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';
 
             }
 
             }
Line 157: Line 168:
 
     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 166: Line 177:
 
         NavToggle.firstChild.data = NavigationBarHide;
 
         NavToggle.firstChild.data = NavigationBarHide;
 
     }
 
     }
}
+
 +
    event.preventDefault();
 +
};
 
   
 
   
 
/* adds show/hide-button to navigation bars */
 
/* adds show/hide-button to navigation bars */
Line 221: Line 234:
 
         }
 
         }
 
     }
 
     }
}  
+
}
 +
 
$( createNavigationBarToggleButton );
 
$( createNavigationBarToggleButton );
  

Latest revision as of 13:24, 26 May 2013

/* Any JavaScript here will be loaded for all users on every page load. */
/**
 * Keep code in MediaWiki:Common.js to a minimum as it is unconditionally
 * loaded for all users on every wiki page. If possible create a gadget that is
 * enabled by default instead of adding it here (since gadgets are fully
 * optimized ResourceLoader modules with possibility to add dependencies etc.)
 *
 * Since common.js isn't a gadget, there is no place to declare its
 * dependencies, so we have to lazy load them with mw.loader.using on demand and
 * then execute the rest in the callback. In most cases these dependencies will
 * be loaded (or loading) already and the callback will not be delayed. In case a
 * dependency hasn't arrived yet it'll make sure those are loaded before this.
 */
 
mw.loader.using( 'mediawiki.util', function() {
/* Begin of mw.loader.using callback */
 
/**
 * Redirect User:Name/skin.js and skin.css to the current skin's pages
 * (unless the 'skin' page really exists)
 * @source: http://www.mediawiki.org/wiki/Snippets/Redirect_skin.js
 * @rev: 2
 */
if ( mw.config.get( 'wgArticleId' ) === 0 && mw.config.get( 'wgNamespaceNumber' ) == 2 ) {
	var titleParts = mw.config.get( 'wgPageName' ).split( '/' );
	// Make sure there was a part before and after the slash
	// And that the latter is 'skin.js' or 'skin.css'
	if ( titleParts.length == 2 ) {
		var userSkinPage = titleParts.shift() + '/' + mw.config.get( 'skin' );
		if ( titleParts.slice(-1) == 'skin.js' ) {
			window.location.href = mw.util.wikiGetlink( userSkinPage + '.js' );
		} else if ( titleParts.slice(-1) == 'skin.css' ) {
			window.location.href = mw.util.wikiGetlink( userSkinPage + '.css' );
		}
	}
}
 
/**
 * Collapsible tables *********************************************************
 *
 * Description: Allows tables to be collapsed, showing only the header. See
 *              [[Wikipedia:NavFrame]].
 * Maintainers: [[User:R. Koot]]
 */
 
var autoCollapse = 2;
var collapseCaption = 'hide';
var expandCaption = 'show';
 
window.collapseTable = function ( tableIndex ) {
    var Button = document.getElementById( 'collapseButton' + tableIndex );
    var Table = document.getElementById( 'collapsibleTable' + tableIndex );
 
    if ( !Table || !Button ) {
        return false;
    }
 
    var Rows = Table.rows;
    var i;
 
    if ( Button.firstChild.data === collapseCaption ) {
        for ( i = 1; i < Rows.length; i++ ) {
            Rows[i].style.display = 'none';
        }
        Button.firstChild.data = expandCaption;
    } else {
        for ( i = 1; i < Rows.length; i++ ) {
            Rows[i].style.display = Rows[0].style.display;
        }
        Button.firstChild.data = collapseCaption;
    }
};
 
function createCollapseButtons() {
    var tableIndex = 0;
    var NavigationBoxes = {};
    var Tables = document.getElementsByTagName( 'table' );
    var i;
 
    function handleButtonLink( index, e ) {
        window.collapseTable( index );
        e.preventDefault();
    }
 
    for ( i = 0; i < Tables.length; i++ ) {
        if ( $( Tables[i] ).hasClass( 'collapsible' ) ) {
 
            /* only add button and increment count if there is a header row to work with */
            var HeaderRow = Tables[i].getElementsByTagName( 'tr' )[0];
            if ( !HeaderRow ) continue;
            var Header = HeaderRow.getElementsByTagName( 'th' )[0];
            if ( !Header ) continue;
 
            NavigationBoxes[ tableIndex ] = Tables[i];
            Tables[i].setAttribute( 'id', 'collapsibleTable' + tableIndex );
 
            var Button     = document.createElement( 'span' );
            var ButtonLink = document.createElement( 'a' );
            var ButtonText = document.createTextNode( collapseCaption );
 
            Button.className = 'collapseButton';  /* Styles are declared in Common.css */
 
            ButtonLink.style.color = Header.style.color;
            ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex );
            ButtonLink.setAttribute( 'href', '#' );
            $( ButtonLink ).on( 'click', $.proxy( handleButtonLink, ButtonLink, tableIndex ) );
            ButtonLink.appendChild( ButtonText );
 
            Button.appendChild( document.createTextNode( '[' ) );
            Button.appendChild( ButtonLink );
            Button.appendChild( document.createTextNode( ']' ) );
 
            Header.insertBefore( Button, Header.firstChild );
            tableIndex++;
        }
    }
 
    for ( i = 0;  i < tableIndex; i++ ) {
        if ( $( NavigationBoxes[i] ).hasClass( 'collapsed' ) || ( tableIndex >= autoCollapse && $( NavigationBoxes[i] ).hasClass( 'autocollapse' ) ) ) {
            window.collapseTable( i );
        } 
        else if ( $( NavigationBoxes[i] ).hasClass ( 'innercollapse' ) ) {
            var element = NavigationBoxes[i];
            while ((element = element.parentNode)) {
                if ( $( element ).hasClass( 'outercollapse' ) ) {
                    window.collapseTable ( i );
                    break;
                }
            }
        }
    }
}
 
$( createCollapseButtons );
 
/**
 * Dynamic Navigation Bars (experimental)
 *
 * Description: See [[Wikipedia:NavFrame]].
 * Maintainers: UNMAINTAINED
 */
 
/* set up the words in your language */
var NavigationBarHide = '[' + collapseCaption + ']';
var NavigationBarShow = '[' + expandCaption + ']';
 
/**
 * Shows and hides content and picture (if available) of navigation bars
 * Parameters:
 *     indexNavigationBar: the index of navigation bar to be toggled
 **/
window.toggleNavigationBar = function ( indexNavigationBar, event ) {
    var NavToggle = document.getElementById( 'NavToggle' + indexNavigationBar );
    var NavFrame = document.getElementById( 'NavFrame' + indexNavigationBar );
    var NavChild;
 
    if ( !NavFrame || !NavToggle ) {
        return false;
    }
 
    /* if shown now */
    if ( NavToggle.firstChild.data === NavigationBarHide ) {
        for ( NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling ) {
            if ( $( NavChild ).hasClass( 'NavContent' ) || $( NavChild ).hasClass( 'NavPic' ) ) {
                NavChild.style.display = 'none';
            }
        }
    NavToggle.firstChild.data = NavigationBarShow;
 
    /* if hidden now */
    } else if ( NavToggle.firstChild.data === NavigationBarShow ) {
        for ( NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling ) {
            if ( $( NavChild ).hasClass( 'NavContent' ) || $( NavChild ).hasClass( 'NavPic' ) ) {
                NavChild.style.display = 'block';
            }
        }
        NavToggle.firstChild.data = NavigationBarHide;
    }
 
    event.preventDefault();
};
 
/* adds show/hide-button to navigation bars */
function createNavigationBarToggleButton() {
    var indexNavigationBar = 0;
    var NavFrame;
    var NavChild;
    /* iterate over all < div >-elements */
    var divs = document.getElementsByTagName( 'div' );
    for ( var i = 0; (NavFrame = divs[i]); i++ ) {
        /* if found a navigation bar */
        if ( $( NavFrame ).hasClass( 'NavFrame' ) ) {
 
            indexNavigationBar++;
            var NavToggle = document.createElement( 'a' );
            NavToggle.className = 'NavToggle';
            NavToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar );
            NavToggle.setAttribute( 'href', '#' );
            $( NavToggle ).on( 'click', $.proxy( window.toggleNavigationBar, window, indexNavigationBar ) );
 
            var isCollapsed = $( NavFrame ).hasClass( 'collapsed' );
            /**
             * 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"
             * to all the NavPic/NavContent elements.  Since this was bad for accessibility (no way to make
             * the content visible without JavaScript support), the new recommended way is to add the class
             * "collapsed" to the NavFrame itself, just like with collapsible tables.
             */
            for ( NavChild = NavFrame.firstChild; NavChild != null && !isCollapsed; NavChild = NavChild.nextSibling ) {
                if ( $( NavChild ).hasClass( 'NavPic' ) || $( NavChild ).hasClass( 'NavContent' ) ) {
                    if ( NavChild.style.display === 'none' ) {
                        isCollapsed = true;
                    }
                }
            }
            if ( isCollapsed ) {
                for ( NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling ) {
                    if ( $( NavChild ).hasClass( 'NavPic' ) || $( NavChild ).hasClass( 'NavContent' ) ) {
                        NavChild.style.display = 'none';
                    }
                }
            }
            var NavToggleText = document.createTextNode( isCollapsed ? NavigationBarShow : NavigationBarHide );
            NavToggle.appendChild( NavToggleText );
 
            /* 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++ ) {
                if ( $( NavFrame.childNodes[j] ).hasClass( 'NavHead' ) ) {
                    NavToggle.style.color = NavFrame.childNodes[j].style.color;
                    NavFrame.childNodes[j].appendChild( NavToggle );
                }
            }
            NavFrame.setAttribute( 'id', 'NavFrame' + indexNavigationBar );
        }
    }
}
 
$( createNavigationBarToggleButton );
 
/* End of mw.loader.using callback */
} );
/* DO NOT ADD CODE BELOW THIS LINE */