Difference between revisions of "MediaWiki:Common.js"
Jump to navigation
Jump to search
Bugman admin (talk | contribs) (Updated the NavFrame back to the current version at https://en.wikipedia.org/wiki/MediaWiki:Common.js (this syntax is now supported with MediaWiki 1.25.3).) |
Bugman admin (talk | contribs) (Switched to the Wikipedia version for collapsible tables and NavFrames, from http://wiki.flightgear.org/MediaWiki:Common.js, as the current version is not fully functional.) |
||
Line 6: | Line 6: | ||
/** | /** | ||
− | * | + | * Collapsible tables ********************************************************* |
− | |||
− | |||
* | * | ||
− | * | + | * Description: Allows tables to be collapsed, showing only the header. |
− | |||
− | |||
*/ | */ | ||
− | + | ||
− | + | var autoCollapse = 2; | |
− | |||
var collapseCaption = 'hide'; | var collapseCaption = 'hide'; | ||
var expandCaption = 'show'; | var expandCaption = 'show'; | ||
− | + | ||
− | var | + | window.collapseTable = function ( tableIndex ) { |
− | var | + | 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; | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | mw.hook( 'wikipage.content' ).add( createCollapseButtons ); | ||
+ | |||
+ | /** Dynamic Navigation Bars (experimental) ************************************* | ||
* | * | ||
− | * | + | * Description: See [[Wikipedia:NavFrame]]. |
− | * | + | * Maintainers: UNMAINTAINED |
*/ | */ | ||
− | function | + | |
− | + | // 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){ | |
− | + | var NavToggle = document.getElementById("NavToggle" + indexNavigationBar); | |
− | + | var NavFrame = document.getElementById("NavFrame" + indexNavigationBar); | |
− | + | ||
− | + | if (!NavFrame || !NavToggle) { | |
− | + | return false; | |
− | + | } | |
− | + | ||
− | + | // if shown now | |
− | + | if (NavToggle.firstChild.data == NavigationBarHide) { | |
− | + | for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling) { | |
− | + | if (hasClass(NavChild, 'NavContent') || hasClass(NavChild, 'NavPic')) { | |
− | + | NavChild.style.display = 'none'; | |
− | + | } | |
− | + | } | |
− | + | NavToggle.firstChild.data = NavigationBarShow; | |
− | + | ||
− | + | // if hidden now | |
− | + | } else if (NavToggle.firstChild.data == NavigationBarShow) { | |
− | + | for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling) { | |
− | + | if (hasClass(NavChild, 'NavContent') || hasClass(NavChild, 'NavPic')) { | |
− | + | NavChild.style.display = 'block'; | |
− | + | } | |
− | + | } | |
− | + | NavToggle.firstChild.data = NavigationBarHide; | |
+ | } | ||
} | } | ||
− | + | ||
− | / | + | // adds show/hide-button to navigation bars |
− | + | function createNavigationBarToggleButton(){ | |
− | + | var indexNavigationBar = 0; | |
− | + | // iterate over all < div >-elements | |
− | + | var divs = document.getElementsByTagName("div"); | |
− | function createNavigationBarToggleButton( | + | for (var i = 0; NavFrame = divs[i]; i++) { |
− | + | // if found a navigation bar | |
− | + | if (hasClass(NavFrame, "NavFrame")) { | |
− | + | ||
− | + | indexNavigationBar++; | |
− | + | var NavToggle = document.createElement("a"); | |
− | + | NavToggle.className = 'NavToggle'; | |
− | + | NavToggle.setAttribute('id', 'NavToggle' + indexNavigationBar); | |
− | + | NavToggle.setAttribute('href', 'javascript:toggleNavigationBar(' + indexNavigationBar + ');'); | |
− | + | ||
− | + | var isCollapsed = hasClass( NavFrame, "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 (var NavChild = NavFrame.firstChild; NavChild != null && !isCollapsed; NavChild = NavChild.nextSibling) { | |
− | + | if ( hasClass( NavChild, 'NavPic' ) || hasClass( NavChild, 'NavContent' ) ) { | |
− | + | if ( NavChild.style.display == 'none' ) { | |
− | + | isCollapsed = true; | |
− | + | } | |
− | + | } | |
− | + | } | |
− | + | if (isCollapsed) { | |
− | + | for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling) { | |
− | + | if ( hasClass( NavChild, 'NavPic' ) || hasClass( NavChild, '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 (hasClass(NavFrame.childNodes[j], "NavHead")) { | ||
+ | NavToggle.style.color = NavFrame.childNodes[j].style.color; | ||
+ | NavFrame.childNodes[j].appendChild(NavToggle); | ||
+ | } | ||
+ | } | ||
+ | NavFrame.setAttribute('id', 'NavFrame' + indexNavigationBar); | ||
+ | } | ||
+ | } | ||
} | } | ||
− | + | ||
− | + | $( createNavigationBarToggleButton ); | |
− | |||
− | |||
Revision as of 21:08, 20 October 2015
/* Any JavaScript here will be loaded for all users on every page load. */
/* Improvements for the HarvardReferences Mediawiki extension. */
importScript('HarvardReferences.js');
/**
* Collapsible tables *********************************************************
*
* Description: Allows tables to be collapsed, showing only the header.
*/
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;
}
}
}
}
}
mw.hook( 'wikipage.content' ).add( 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){
var NavToggle = document.getElementById("NavToggle" + indexNavigationBar);
var NavFrame = document.getElementById("NavFrame" + indexNavigationBar);
if (!NavFrame || !NavToggle) {
return false;
}
// if shown now
if (NavToggle.firstChild.data == NavigationBarHide) {
for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling) {
if (hasClass(NavChild, 'NavContent') || hasClass(NavChild, 'NavPic')) {
NavChild.style.display = 'none';
}
}
NavToggle.firstChild.data = NavigationBarShow;
// if hidden now
} else if (NavToggle.firstChild.data == NavigationBarShow) {
for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling) {
if (hasClass(NavChild, 'NavContent') || hasClass(NavChild, 'NavPic')) {
NavChild.style.display = 'block';
}
}
NavToggle.firstChild.data = NavigationBarHide;
}
}
// adds show/hide-button to navigation bars
function createNavigationBarToggleButton(){
var indexNavigationBar = 0;
// iterate over all < div >-elements
var divs = document.getElementsByTagName("div");
for (var i = 0; NavFrame = divs[i]; i++) {
// if found a navigation bar
if (hasClass(NavFrame, "NavFrame")) {
indexNavigationBar++;
var NavToggle = document.createElement("a");
NavToggle.className = 'NavToggle';
NavToggle.setAttribute('id', 'NavToggle' + indexNavigationBar);
NavToggle.setAttribute('href', 'javascript:toggleNavigationBar(' + indexNavigationBar + ');');
var isCollapsed = hasClass( NavFrame, "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 (var NavChild = NavFrame.firstChild; NavChild != null && !isCollapsed; NavChild = NavChild.nextSibling) {
if ( hasClass( NavChild, 'NavPic' ) || hasClass( NavChild, 'NavContent' ) ) {
if ( NavChild.style.display == 'none' ) {
isCollapsed = true;
}
}
}
if (isCollapsed) {
for (var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling) {
if ( hasClass( NavChild, 'NavPic' ) || hasClass( NavChild, '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 (hasClass(NavFrame.childNodes[j], "NavHead")) {
NavToggle.style.color = NavFrame.childNodes[j].style.color;
NavFrame.childNodes[j].appendChild(NavToggle);
}
}
NavFrame.setAttribute('id', 'NavFrame' + indexNavigationBar);
}
}
}
$( createNavigationBarToggleButton );
/* Test function, for testing if js works */
(function () {
var myElement = document.getElementById('mw-testing');
myElement.innerHTML = 'This is test HTML';
}());