User:The Transhumanist/ViewAsOutline-Article.js
Appearance
Code that you insert on this page could contain malicious content capable of compromising your account. If you import a script from another page with "importScript", "mw.loader.load", "iusc", or "lusc", take note that this causes you to dynamically load a remote script, which could be changed by others. Editors are responsible for all edits and actions they perform, including by scripts. User scripts are not centrally supported and may malfunction or become inoperable due to software changes. A guide to help you find broken scripts is available. If you are unsure whether code you are adding to this page is safe, you can ask at the appropriate village pump. This code will be executed when previewing this page. |
![]() | Documentation for this user script can be added at User:The Transhumanist/ViewAsOutline-Article. |
// <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>