User:The Transhumanist/ViewAsOutline-Category.js

From Wikipedia, the free encyclopedia
Note: After saving, you have to bypass your browser's cache to see the changes. Google Chrome, Firefox, Microsoft Edge and Safari: Hold down the ⇧ Shift key and click the Reload toolbar button. For details and instructions about other browsers, see Wikipedia:Bypass your cache.
// <syntaxhighlight lang="javascript">

/*

(Script is operational - needs testing on many pages)

ViewAsOutline-Category.js

What it does:

This script removes the bullets and then inserts wikicode formatting 
(asterisks and double square brackets) for the list items on  
Category pages, and the h3 headings, so that the links can be easily copied and 
pasted into list and outline pages being edited.

Brief comments are provided within the source code below. For extensive explanatory 
notes on what the source code does and how it works, see the Script's workshop on 
the talk page.

*/

// ============== Set up ==============

// Start off with a bodyguard function to reserve the aliases mw and $
( function ( mw, $ ) {

    // we can now rely on mw and $ within the safety of our “bodyguard” function, to mean 
    // "mediawiki" and "jQuery", respectively

    // ============== ready() event listener/handler ==============
    // below is jQuery short-hand for $(document).ready(function() { ... });
    // it makes the rest of the script wait until the page's DOM is loaded and ready
    $(function() {
        
		// ============== activation filters ==============
        // Only activate on Vector skin
        if ( mw.config.get( 'skin' ) === 'vector' ) {

	        // Run this script only if "Category" is in the page title
			if (document.title.indexOf("Category") != -1) {

				// End of set up
			
        	    // =================== Prep work =====================
				
				// Variable declarations, etc., go here

            	// ================= Core program ================= 

                $( function() {

					// BODY OF PROGRAM
					// Make the bullets go bye bye
					$( "#mw-pages" ).find( "ul" ).css( {"list-style-type":"none", "list-style-image":"none"} );

					// Make the h3 headings go bye bye
					$( "#mw-pages" ).find( "h3" ).remove();

					// for all uls of id mw-pages, wrap the page names with *[[]] - links go between the double square brackets
					// (development note: add Brackets class to prevent matching same entries again)
					var mwPagesUls = $( "#mw-pages" ).find( "ul" );
					var i;
					for (i = 0; i < mwPagesUls.length; i++) {
					    mwPagesUls[i].outerHTML = mwPagesUls[i].outerHTML.replace(/(<a.*?(<\/a>))/g,'* [[$1]]');
					}

				} );
			}
        }
    } );
}( mediaWiki, jQuery ) );

// </syntaxhighlight>