User:The Transhumanist/OutlineViewTOCToggler.js

// <syntaxhighlight lang="javascript">

/* 
OutlineViewTOCToggle.js: provides the "TOC" menu item to hide/show the table of 
contents on outline pages. The script operates in the Vector skin only.

Version 0.9 -- under development.

This script is based on ]:
https://en.wikipedia.org/w/index.php?title=User:The_Transhumanist/StripSearch.js&oldid=809395804
which in turn used the core control structure and subroutines from
]:
https://en.wikipedia.org/w/index.php?title=User:The_Transhumanist/OutlineViewAnnotationToggler.js&oldid=807301505

Brief comments are provided within the sourcecode 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 (they follow the closing curly bracket - see the end of the script)

	// ============== Load dependencies ============== 
	mw.loader.using( , function () {
	
    // ============== 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 "Outline of " is in the page title
			if (document.title.indexOf("Outline of ") != -1) {

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

    	        //var SRDetailSwitch; 
    	        var TOCSwitch; 

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

                // get the value of our status variable from memory
                // (this tells us what mode to start in)
                // "TOC" stands for "table of contents"
                var TOCStatus = localStorage.getItem('TOCStatus');

				// Core control construct:				
                // run the function corresponding to the current status
                if ( TOCStatus === "hide" ) {
                    TOCHide();
                } else {
                    TOCShow();
                }
            }
        }

        // ======================== 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 hide the TOC ==============
        function TOCHide() {
            // store status so it persists across page loads
            localStorage.setItem("TOCStatus", "hide");

			// Hide the TOC (per http://api.jquery.com/hide)
			$('#toc').hide();

            // now we have to update the menu item 
            // (referred to in this script as "TOCSwitch"). 
            // To do that, first we remove it (if it exists):  
            if ( TOCSwitch ) {
                TOCSwitch.parentNode.removeChild(TOCSwitch);
            }

            // and then we create it (or its replacement) from scratch:
            TOCSwitch = mw.util.addPortletLink( 'p-tb', '#', 'TOC \(show\)', 'Show table of contents' );

            // make the menu item clickable by binding it to a click handler
            // (which activates the actions between the curly brackets when clicked):
            $( TOCSwitch ).click( function ( e ) {
                e.preventDefault();     // prevents any default action -- we want only the following action to run: 
                TOCShow();
            } );
        }
   
        // ============ Function to show search results detail ==============
        function TOCShow() {
            // store status so it persists across page loads
            localStorage.setItem("TOCStatus", "show");

			// Show the TOC (per http://api.jquery.com/show)
			$('#toc').show();

            // now we have to update the menu item 
            // (referred to in this script as "TOCSwitch"). 
            // To do that, first we remove it (if it exists):  
            if ( TOCSwitch ) {
                TOCSwitch.parentNode.removeChild(TOCSwitch);
            }

            // and then we create it (or its replacement) from scratch:
            TOCSwitch = mw.util.addPortletLink( 'p-tb', '#', 'TOC \(hide\)', 'Hide table of contents' );

            $( TOCSwitch ).click( function ( e ) {
                e.preventDefault();     // prevents any default action -- we want only the following action to run:
                TOCHide();
            } );
        }
    } );
    } );
}( mediaWiki, jQuery ) );
// </syntaxhighlight>