Difference between revisions of "MediaWiki:Common.js"

From relax wiki
Jump to navigation Jump to search
(Added the javascript to support the NavFrame element.)
(Added support for collapsible tables (from Wikipedia MediaWiki:Common.js).)
Line 10: Line 10:
  
 
/**
 
/**
  * Dynamic Navigation Bars. See [[Wikipedia:NavFrame]]
+
  * Collapsible tables
*
 
* Based on script from en.wikipedia.org, 2008-09-15.
 
 
  *
 
  *
  * @source www.mediawiki.org/wiki/MediaWiki:Gadget-NavFrame.js
+
* Allows tables to be collapsed, showing only the header. See [[Wikipedia:NavFrame]].
  * @maintainer Helder.wiki, 2012–2013
+
*
  * @maintainer Krinkle, 2013
+
* @version 2.0.3 (2014-03-14)
 +
  * @source https://www.mediawiki.org/wiki/MediaWiki:Gadget-collapsibleTables.js
 +
  * @author [[User:R. Koot]]
 +
  * @author [[User:Krinkle]]
 +
* @deprecated Since MediaWiki 1.20: Use class="mw-collapsible" instead which
 +
* is supported in MediaWiki core.
 
  */
 
  */
( function () {
 
  
// Set up the words in your language
+
var autoCollapse = 2;
 
var collapseCaption = 'hide';
 
var collapseCaption = 'hide';
 
var expandCaption = 'show';
 
var expandCaption = 'show';
 +
var tableIndex = 0;
 +
 +
function collapseTable( 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 createClickHandler( tableIndex ) {
 +
    return function ( e ) {
 +
        e.preventDefault();
 +
        collapseTable( tableIndex );
 +
    };
 +
}
 +
 +
function createCollapseButtons( $content ) {
 +
    var NavigationBoxes = {};
 +
    var $Tables = $content.find( 'table' );
 +
    var i;
 +
 +
    $Tables.each( function( i, table ) {
 +
        if ( $(table).hasClass( 'collapsible' ) ) {
  
var navigationBarHide = '[' + collapseCaption + ']';
+
            /* only add button and increment count if there is a header row to work with */
var navigationBarShow = '[' + expandCaption + ']';
+
            var HeaderRow = table.getElementsByTagName( 'tr' )[0];
 +
            if ( !HeaderRow ) {
 +
                return;
 +
            }
 +
            var Header = table.getElementsByTagName( 'th' )[0];
 +
            if ( !Header ) {
 +
                return;
 +
            }
  
/**
+
            NavigationBoxes[ tableIndex ] = table;
* Shows and hides content and picture (if available) of navigation bars.
+
            table.setAttribute( 'id', 'collapsibleTable' + tableIndex );
*
+
 
* @param {number} indexNavigationBar The index of navigation bar to be toggled
+
            var Button    = document.createElement( 'span' );
* @param {jQuery.Event} e Event object
+
            var ButtonLink = document.createElement( 'a' );
*/
+
            var ButtonText = document.createTextNode( collapseCaption );
function toggleNavigationBar( indexNavigationBar, e ) {
+
            // Styles are declared in [[MediaWiki:Common.css]]
var navChild,
+
            Button.className = 'collapseButton';
navToggle = document.getElementById( 'NavToggle' + indexNavigationBar ),
 
navFrame = document.getElementById( 'NavFrame' + indexNavigationBar );
 
  
// Prevent browser from jumping to href "#"
+
            ButtonLink.style.color = Header.style.color;
e.preventDefault();
+
            ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex );
 +
            ButtonLink.setAttribute( 'href', '#' );
 +
            $( ButtonLink ).on( 'click', createClickHandler( tableIndex ) );
 +
            ButtonLink.appendChild( ButtonText );
  
if ( !navFrame || !navToggle ) {
+
            Button.appendChild( document.createTextNode( '[' ) );
return false;
+
            Button.appendChild( ButtonLink );
}
+
            Button.appendChild( document.createTextNode( ']' ) );
  
// If shown now
+
            Header.insertBefore( Button, Header.firstChild );
if ( navToggle.firstChild.data == navigationBarHide ) {
+
            tableIndex++;
for ( 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
+
    for ( i = 0; i < tableIndex; i++ ) {
} else if ( navToggle.firstChild.data == navigationBarShow ) {
+
        if ( $( NavigationBoxes[i] ).hasClass( 'collapsed' ) ||
for ( navChild = navFrame.firstChild; navChild != null; navChild = navChild.nextSibling ) {
+
            ( tableIndex >= autoCollapse && $( NavigationBoxes[i] ).hasClass( 'autocollapse' ) )
if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
+
        ) {
navChild.style.display = 'block';
+
            collapseTable( i );
}
+
        }
}
+
        else if ( $( NavigationBoxes[i] ).hasClass ( 'innercollapse' ) ) {
navToggle.firstChild.data = navigationBarHide;
+
            var element = NavigationBoxes[i];
}
+
            while ((element = element.parentNode)) {
 +
                if ( $( element ).hasClass( 'outercollapse' ) ) {
 +
                    collapseTable ( i );
 +
                    break;
 +
                }
 +
            }
 +
        }
 +
    }
 
}
 
}
 +
 +
mw.hook( 'wikipage.content' ).add( createCollapseButtons );
  
 
/**
 
/**
  * Adds show/hide-button to navigation bars.
+
  * Dynamic Navigation Bars (experimental)
 
  *
 
  *
  * @param {jQuery} $content
+
  * Description: See [[Wikipedia:NavFrame]].
 +
* Maintainers: UNMAINTAINED
 
  */
 
  */
 +
 +
/* set up the words in your language */
 +
var NavigationBarHide = '[' + collapseCaption + ']';
 +
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
 +
**/
 +
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( $content ) {
 
function createNavigationBarToggleButton( $content ) {
var i, j, navFrame, navToggle, navToggleText, navChild,
+
    var NavChild;
indexNavigationBar = 0,
+
    /* iterate over all < div >-elements */
navFrames = $content.find( 'div.NavFrame' ).toArray();
+
    var $divs = $content.find( 'div' );
 +
    $divs.each( function ( i, NavFrame ) {
 +
        /* if found a navigation bar */
 +
        if ( $( NavFrame ).hasClass( 'NavFrame' ) ) {
  
// Iterate over all (new) nav frames
+
            indexNavigationBar++;
for ( i = 0; i < navFrames.length; i++ ) {
+
            var NavToggle = document.createElement( 'a' );
navFrame = navFrames[i];
+
            NavToggle.className = 'NavToggle';
// If found a navigation bar
+
            NavToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar );
indexNavigationBar++;
+
            NavToggle.setAttribute( 'href', '#' );
navToggle = document.createElement( 'a' );
+
            $( NavToggle ).on( 'click', $.proxy( window.toggleNavigationBar, window, indexNavigationBar ) );
navToggle.className = 'NavToggle';
 
navToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar );
 
navToggle.setAttribute( 'href', '#' );
 
$( navToggle ).on( 'click', $.proxy( toggleNavigationBar, null, indexNavigationBar ) );
 
  
navToggleText = document.createTextNode( navigationBarHide );
+
            var isCollapsed = $( NavFrame ).hasClass( 'collapsed' );
for ( navChild = navFrame.firstChild; navChild != null; navChild = navChild.nextSibling ) {
+
            /**
if ( $( navChild ).hasClass( 'NavPic' ) || $( navChild ).hasClass( 'NavContent' ) ) {
+
            * Check if any children are already hidden.  This loop is here for backwards compatibility:
if ( navChild.style.display == 'none' ) {
+
            * the old way of making NavFrames start out collapsed was to manually add style="display:none"
navToggleText = document.createTextNode( navigationBarShow );
+
            * to all the NavPic/NavContent elements.  Since this was bad for accessibility (no way to make
break;
+
            * 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 );
  
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 ( j = 0; j < navFrame.childNodes.length; j++ ) {
+
                if ( $( NavFrame.childNodes[j] ).hasClass( 'NavHead' ) ) {
if ( $( navFrame.childNodes[j] ).hasClass( 'NavHead' ) ) {
+
                    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 );
}
+
        }
 +
    } );
 
}
 
}
  
 
mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton );
 
mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton );
 
}());
 

Revision as of 11:25, 17 October 2015

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


/* Improvements for the HarvardReferences Mediawiki extension. */
importScript('HarvardReferences.js');
importScript('HarvardReferences/HarvardReferences.js');
importScript('extensions/HarvardReferences/HarvardReferences.js');
importScript('/www/wiki.nmr-relax.com/extensions/HarvardReferences/HarvardReferences.js');
importScript('http:/wiki.nmr-relax.com/extensions/HarvardReferences/HarvardReferences.js');

/**
 * Collapsible tables
 *
 * Allows tables to be collapsed, showing only the header. See [[Wikipedia:NavFrame]].
 *
 * @version 2.0.3 (2014-03-14)
 * @source https://www.mediawiki.org/wiki/MediaWiki:Gadget-collapsibleTables.js
 * @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 collapseCaption = 'hide';
var expandCaption = 'show';
var tableIndex = 0;

function collapseTable( 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 createClickHandler( tableIndex ) {
    return function ( e ) {
        e.preventDefault();
        collapseTable( tableIndex );
    };
}

function createCollapseButtons( $content ) {
    var NavigationBoxes = {};
    var $Tables = $content.find( 'table' );
    var i;

    $Tables.each( function( i, table ) {
        if ( $(table).hasClass( 'collapsible' ) ) {

            /* only add button and increment count if there is a header row to work with */
            var HeaderRow = table.getElementsByTagName( 'tr' )[0];
            if ( !HeaderRow ) {
                return;
            }
            var Header = table.getElementsByTagName( 'th' )[0];
            if ( !Header ) {
                return;
            }

            NavigationBoxes[ tableIndex ] = table;
            table.setAttribute( 'id', 'collapsibleTable' + tableIndex );

            var Button     = document.createElement( 'span' );
            var ButtonLink = document.createElement( 'a' );
            var ButtonText = document.createTextNode( collapseCaption );
            // Styles are declared in [[MediaWiki:Common.css]]
            Button.className = 'collapseButton';

            ButtonLink.style.color = Header.style.color;
            ButtonLink.setAttribute( 'id', 'collapseButton' + tableIndex );
            ButtonLink.setAttribute( 'href', '#' );
            $( ButtonLink ).on( 'click', createClickHandler( 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' ) )
        ) {
            collapseTable( i );
        }
        else if ( $( NavigationBoxes[i] ).hasClass ( 'innercollapse' ) ) {
            var element = NavigationBoxes[i];
            while ((element = element.parentNode)) {
                if ( $( element ).hasClass( 'outercollapse' ) ) {
                    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 + ']';
var indexNavigationBar = 0;

/**
 * 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( $content ) {
    var NavChild;
    /* iterate over all < div >-elements */
    var $divs = $content.find( 'div' );
    $divs.each( function ( i, NavFrame ) {
        /* 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 );
        }
    } );
}

mw.hook( 'wikipage.content' ).add( createNavigationBarToggleButton );