Jump to content

User:The Transhumanist/OutlineAnnotator.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 - not yet functional)

AnnotateOutline = Annotate Outline

When completed,
this script will add an annotation for all the list items in the
current outline that do not already have one, fetching them from
the leads of the respective articles linked to in the entries.


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.

*/

// Start off with a bodyguard function to reserve mw and $ (see Explanatory notes on talk page).
( 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() {
        
        // During testing, so that alerts don't pop up all the time,
        // Run this script only if "Outline " is in the page title
		if (document.title.indexOf("Outline ") != -1) {

			// BODY OF PROGRAM GOES HERE

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


// </syntaxhighlight>