Jump to content

User:The Transhumanist/ViewAsOutline-Article.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 under development - partially functional)

What it does: when completed, this script will provide a menu item in the sidebar 
menu that, when clicked, will convert list components on the current view of 
the current page into pastable wikicode outline format. That is, as bullet list 
entries with asterisks and square brackets, ready to be copied into an edit window. 
To undo it, reload the page.

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. (Not ready yet.)

*/

// ============== 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() {
        
		// Load dependencies
		mw.loader.using( ['mediawiki.util'], function () {

			// ============== activation filters ==============
	        // Only activate on Vector skin
	        if ( mw.config.get( 'skin' ) === 'vector' ) {

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

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

        	    $( function() {
            	    VAOAMenuItem();
				} );
			}

	        // ======================== Subroutines ===========================
	        // Functions (aka subroutines) are activated only when they are called.
	    	// Below are the functions called in the core control structure of the program above.
	    	// They are placed at the end of the program, so that the script's flow 
	    	// is easier to follow.

	       	// ============ Function to expand unexpanded categories in the tree ==============

	       	function VAOAMenuItem() {
				// Create linked menu item
				var portletlink = mw.util.addPortletLink('p-tb', '#', 'Article as OL', 'art-as-OL', 'View article with pastable outline features');
				// Bind click handler
				$(portletlink).click( function(e) {
					e.preventDefault();     // prevents any default action -- we want only the following actions to run:

					// Do some stuff when clicked...

					// Make the bullets go bye bye
					$( "ul" ).css( {"list-style-type":"none", "list-style-image":"none"} );

					

				});     // end of function(e) (click handler)
	   		}
		});
   	} );
}( mediaWiki, jQuery ) );

// </syntaxhighlight>