Difference between revisions of "MediaWiki:Common.js"

From The Antarian Rangers
Jump to: navigation, search
(copied from http://www.mediawiki.org/wiki/MediaWiki:Common.js)
 
(Replaced content with "Any JavaScript here will be loaded for all users on every page load.: ")
Line 1: Line 1:
 
/* Any JavaScript here will be loaded for all users on every page load. */
 
/* Any JavaScript here will be loaded for all users on every page load. */
 
/* Any JavaScript here will be loaded for all users on every page load. */
 
 
// Add "mainpage" class to the body element
 
if ( wgMainPageTitle === wgPageName && wgAction === 'view' ) {
 
$( document ).ready( function() {
 
document.body.className += ' mainpage';
 
});
 
}
 
 
// switches for scripts
 
// TODO: migrate to JSConfig
 
// var load_extratabs = true;
 
var load_edittools = true;
 
 
// extra drop down menu on editing for adding special characters
 
importScript( 'MediaWiki:Edittools.js' );
 
 
// Editpage scripts
 
if( wgAction == 'edit' || wgAction == 'submit' ) {
 
importScript( 'MediaWiki:Editpage.js' );
 
}
 
 
/* End of extra pages */
 
 
/* Test if an element has a certain class **************************************
 
*
 
* From English Wikipedia, 2008-09-15
 
*
 
* Description: Uses regular expressions and caching for better performance.
 
* Maintainers: [[User:Mike Dillon]], [[User:R. Koot]], [[User:SG]]
 
*/
 
var hasClass = (function() {
 
var reCache = {};
 
return function( element, className ) {
 
return ( reCache[className] ? reCache[className] : ( reCache[className] = new RegExp( "(?:\\s|^)" + className + "(?:\\s|$)" ) ) ).test( element.className );
 
};
 
})();
 
 
/** Collapsible tables *********************************************************
 
*
 
* From English Wikipedia, 2008-09-15
 
* @deprecated: Do not use this in new constructions, use class="mw-collapsible" instead
 
*
 
*  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';
 
 
function collapseTable( tableIndex ) {
 
var Button = document.getElementById( 'collapseButton' + tableIndex );
 
var Table = document.getElementById( 'collapsibleTable' + tableIndex );
 
 
if ( !Table || !Button ) {
 
return false;
 
}
 
 
var Rows = Table.rows;
 
 
if ( Button.firstChild.data == collapseCaption ) {
 
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;
 
}
 
}
 
 
function createCollapseButtons(){
 
var tableIndex = 0;
 
var NavigationBoxes = new Object();
 
var Tables = document.getElementsByTagName( 'table' );
 
 
for ( var i = 0; i < Tables.length; i++ ) {
 
if ( hasClass( Tables[i], '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.style.styleFloat = 'right';
 
Button.style.cssFloat = 'right';
 
Button.style.fontWeight = 'normal';
 
Button.style.textAlign = 'right';
 
Button.style.width = '6em';
 
 
ButtonLink.style.color = Header.style.color;
 
ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex );
 
ButtonLink.setAttribute( 'href', "javascript:collapseTable(" + tableIndex + ");" );
 
ButtonLink.appendChild( ButtonText );
 
 
Button.appendChild( document.createTextNode( '[' ) );
 
Button.appendChild( ButtonLink );
 
Button.appendChild( document.createTextNode( ']' ) );
 
 
Header.insertBefore( Button, Header.childNodes[0] );
 
tableIndex++;
 
}
 
    }
 
 
for ( var i = 0;  i < tableIndex; i++ ) {
 
if ( hasClass( NavigationBoxes[i], 'collapsed' ) || ( tableIndex >= autoCollapse && hasClass( NavigationBoxes[i], 'autocollapse' ) ) ) {
 
collapseTable( i );
 
}
 
}
 
}
 
 
addOnloadHook( createCollapseButtons );
 
 
/** Dynamic Navigation Bars (experimental) *************************************
 
*
 
* From English Wikipedia, 2008-09-15
 
*
 
*  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
 
function toggleNavigationBar( 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, 'NavPic' ) ) {
 
NavChild.style.display = 'none';
 
}
 
if ( hasClass( NavChild, 'NavContent' ) ) {
 
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, 'NavPic' ) ) {
 
NavChild.style.display = 'block';
 
}
 
if( hasClass( NavChild, 'NavContent' ) ) {
 
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 NavToggleText = document.createTextNode( NavigationBarHide );
 
for( var NavChild = NavFrame.firstChild; NavChild != null; NavChild = NavChild.nextSibling ) {
 
if ( hasClass( NavChild, 'NavPic' ) || hasClass( NavChild, 'NavContent' ) ) {
 
if( NavChild.style.display == 'none' ) {
 
NavToggleText = document.createTextNode( NavigationBarShow );
 
break;
 
}
 
}
 
}
 
 
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' ) ) {
 
NavFrame.childNodes[j].appendChild( NavToggle );
 
}
 
}
 
NavFrame.setAttribute( 'id', 'NavFrame' + indexNavigationBar );
 
}
 
}
 
}
 
addOnloadHook( createNavigationBarToggleButton );
 
 
/**
 
* Hide prefix in category
 
*
 
* @source: http://www.mediawiki.org/wiki/Snippets/Hide_prefix_in_category
 
* @rev: 1
 
* @author: Krinkle
 
*/
 
var $tplHideCategoryPrefix = $( '#mw-cat-hideprefix' );
 
if ( $tplHideCategoryPrefix.length ) {
 
var prefix = $tplHideCategoryPrefix.text();
 
$( '#mw-pages' ).find( 'a' ).text( function( i, val ){
 
return val.replace( new RegExp( '^' + $.escapeRE( prefix ) ), '' );
 
});
 
}
 
 
/**
 
* Load the CodeReview 'tooltips' gadget on [[MediaWiki roadmap]] subpages,
 
* so it's available for the revision reports where it's particularly useful
 
* @author: Happy-melon
 
*/
 
if( mw.config.get( 'wgPageName' ).match( /^MediaWiki_roadmap/ ) ) {
 
mw.loader.using( ['ext.codereview.tooltips'], function(){} );
 
}
 
 
/**
 
* Load withJS and withCSS
 
*
 
* @source: www.mediawiki.org/wiki/Snippets/Load_JS_and_CSS_by_URL#Load_withJS_and_withCSS
 
* @rev: 1
 
* @author: Krinkle
 
*/
 
/* withJS */
 
var extraJS = mw.util.getParamValue( 'withJS' );
 
if ( extraJS ) {
 
// Disallow some characters in file name
 
if ( extraJS.match( /^MediaWiki:[^&<>=%#]*\.js$/ ) ) {
 
importScript( extraJS );
 
// Don't use alert but the jsMsg system. Run jsMsg only once the DOM is ready.
 
} else {
 
$( document ).ready( function() {
 
jsMsg( extraJS + ' script not allowed to be loaded.', 'error' );
 
} );
 
}
 
}
 
/* withCSS */
 
var extraCSS = mw.util.getParamValue( 'withCSS' );
 
if ( extraCSS ) {
 
// Disallow some characters in file name
 
if ( extraCSS.match( /^MediaWiki:[^&<>=%#]*\.css$/ ) ) {
 
importStylesheet( extraCSS );
 
// Don't use alert but the jsMsg system. Run jsMsg only once the DOM is ready.
 
} else {
 
$( document ).ready( function() {
 
jsMsg( extraCSS + ' stylesheet not allowed to be loaded.', 'error' );
 
} );
 
}
 
}
 

Revision as of 01:41, 17 January 2012

/* Any JavaScript here will be loaded for all users on every page load. */