MediaWiki:Common.js: Difference between revisions

Revision as of 12:12, 29 February 2024

/* Any JavaScript here will be loaded for all users on every page load. */
/**
 * Dynamic Navigation Bars. See [[Wikipedia:NavFrame]]
 * 
 * Based on script from en.wikipedia.org, 2008-09-15.
 *
 * @source www.mediawiki.org/wiki/MediaWiki:Gadget-NavFrame.js
 * @maintainer Helder.wiki, 2012–2013
 * @maintainer Krinkle, 2013
 */
( function () {

// Set up the words in your language
var collapseCaption = 'hide';
var expandCaption = 'show';

var navigationBarHide = '[' + collapseCaption + ']';
var navigationBarShow = '[' + expandCaption + ']';

/**
 * Shows and hides content and picture (if available) of navigation bars.
 *
 * @param {number} indexNavigationBar The index of navigation bar to be toggled
 * @param {jQuery.Event} e Event object
 */
function toggleNavigationBar( indexNavigationBar, e ) {
	var navChild,
		navToggle = document.getElementById( 'NavToggle' + indexNavigationBar ),
		navFrame = document.getElementById( 'NavFrame' + indexNavigationBar );

	// Prevent browser from jumping to href "#"
	e.preventDefault();

	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;
	}
}

/**
 * Adds show/hide-button to navigation bars.
 *
 * @param {jQuery} $content
 */
function createNavigationBarToggleButton( $content ) {
	var i, j, navChild, navToggle, navToggleText, isCollapsed,
		indexNavigationBar = 0;
	// iterate over all < div >-elements
	var $divs = $content.find( 'div.NavFrame' );
	$divs.each( function ( i, navFrame ) {
		indexNavigationBar++;
		navToggle = document.createElement( 'a' );
		navToggle.className = 'NavToggle';
		navToggle.setAttribute( 'id', 'NavToggle' + indexNavigationBar );
		navToggle.setAttribute( 'href', '#' );
		$( navToggle ).on( 'click', $.proxy( toggleNavigationBar, null, indexNavigationBar ) );

		isCollapsed = $( navFrame ).hasClass( 'collapsed' );
		// backwards compatibility for old technique where the collapsed class was not yet used
		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';
				}
			}
		}
		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 ( 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 );

}());

/**
 * 
 * Side bar customization
 * 
 */
function ModifySidebar( action, section, name, link ) {
	try {
		switch ( section ) {
			case 'languages':
				var target = 'p-lang';
				break;
			case 'toolbox':
				var target = 'p-tb';
				break;
			case 'navigation':
				var target = 'p-navigation';
				break;
			default:
				var target = 'p-' + section;
				break;
		}

		if ( action == 'add' ) {
			var node = document.getElementById( target )
							   .getElementsByTagName( 'div' )[0]
							   .getElementsByTagName( 'ul' )[0];

			var aNode = document.createElement( 'a' );
			var liNode = document.createElement( 'li' );

			aNode.appendChild( document.createTextNode( name ) );
			aNode.setAttribute( 'href', link );
			liNode.appendChild( aNode );
			liNode.className = 'plainlinks';
			node.appendChild( liNode );
		}

		if ( action == 'remove' ) {
			var list = document.getElementById( target )
							   .getElementsByTagName( 'div' )[0]
							   .getElementsByTagName( 'ul' )[0];

			var listelements = list.getElementsByTagName( 'li' );

			for ( var i = 0; i < listelements.length; i++ ) {
				if (
					listelements[i].getElementsByTagName( 'a' )[0].innerHTML == name ||
					listelements[i].getElementsByTagName( 'a' )[0].href == link
				)
				{
					list.removeChild( listelements[i] );
				}
			}
		}


	} catch( e ) {
		// let's just ignore what's happened
		return;
	}
}

function CustomizeModificationsOfSidebar() {
	// adds [[Special:CategoryTree|Special:CategoryTree]] to toolbox
	ModifySidebar( 'add', 'toolbox', 'List of uploaded files', 'https://en.prolewiki.org/wiki/Special:ListFiles' );
}

jQuery( CustomizeModificationsOfSidebar );


/**
	* Append edit button to non-logged in users that redirects to Request Account.
	* Only applies to Citizen because anon users use Citizen by default and can't change it
	* DISABLED on jan 6 2024 due to non-use. Can be re-enabled by removing the comment lines
**/
/*
(function($, mw) {
    // Wait for the DOM to be ready
    $(document).ready(function() {
        // Check if the user is anonymous, i.e. not logged in
        if (mw.user.isAnon()) {
            // Create the HTML for the "request account" edit button. Styled in MediaWiki:Citizen.css
            var requestAccountEditBtn = '<li id="ca-request-account" class="mw-list-item">' +
                '<a href="/wiki/Special:RequestAccount" title="Edit page">Make a correction</a>' +
                '</li>';

            // Insert the button after the #ca-history element
            $('#ca-history').after(requestAccountEditBtn);
        }
    });
})(jQuery, mediaWiki);
*/

/**
	* Append icons to Citizen sidebar starting under Megamenu (drawer)
**/
/* Library */
(function($, mw) {
    // Wait for the DOM to be ready
    $(document).ready(function() {
            var libraryLink = '<a class="citizen-header__item sidebar-library" href="/wiki/ProleWiki:Library" title="Library"><div class="citizen-header__button"></div></a>';
    
            $('div.citizen-drawer.citizen-header__item.citizen-menu-checkbox-container').after(libraryLink);
    });
})(jQuery, mediaWiki);

/* Essays*/
(function($, mw) {
    // Wait for the DOM to be ready
    $(document).ready(function() {
            var essaysLink = '<a class="citizen-header__item sidebar-essays" href="/wiki/ProleWiki:Essays" title="Essays"><div class="citizen-header__button"></div></a>';
    
            $('.sidebar-library').after(essaysLink);
    });
})(jQuery, mediaWiki);

/* Upload file icon */
(function($, mw) {
    // Wait for the DOM to be ready
    $(document).ready(function() {
        if (!mw.user.isAnon()) {
            // Create the HTML for the "Upload file" icon + link
            var uploadFileIcon = '<a class="citizen-header__item sidebar-upload" href="/wiki/Special:Upload" title="Upload file"><div class="citizen-header__button"></div></a>';
    
            // Insert the icon HTML after the existing icon container element
            $('.sidebar-essays').after(uploadFileIcon);
        }
    });
})(jQuery, mediaWiki);

/**
 * Append hyperlink icon in headings so it's easier to copy the link
**/
(function($, mw) {
    // Wait for the DOM to be ready
    $(document).ready(function() {
        // Loop through all the section headings and subheadings
        /*$('.section-heading .mw-headline, .section-subheading .mw-headline').each(function() {*/
        $('.section-subheading .mw-headline').each(function() {
            // Get the section title
            var sectionTitle = $(this).text();
            
            // Replace spaces with underscores in the section title
            var sectionTitleWithUnderscores = sectionTitle.replace(/ /g, '_');
            
            // Create the HTML for the hyperlink button
            var hyperlinkButton = '<a class="heading-hyperlink mw-editsection-visualeditor citizen-editsection-icon mw-ui-icon-wikimedia-link" href="/wiki/' + mw.config.get('wgPageName') + '#' + sectionTitleWithUnderscores + '" title="' + sectionTitle + '"></a>';

            // Insert the button HTML after the section heading or subheading
            $(this).after(hyperlinkButton);
        });
    });
})(jQuery, mediaWiki);

// If we're on the Collection page and are still rendering:
if ($("#renderingProgress").length) {
  // Refresh in 5 seconds:
  setTimeout(location.reload.bind(location), 5000);
}