Help:Extension:GlobalCssJs

From MediaWiki.org
Jump to: navigation, search

The GlobalCssJs extension allow users to create a JavaScript page and a CSS page to be loaded in every wiki of a wiki farm. If you go to Preferences > Appearance on any wiki where the extension is enabled you'll find links to your global scripts and style sheets:

On Wikimedia wikis, these global customizations are hosted on Meta-wiki.

Global scripts[edit | edit source]

Variables[edit | edit source]

When adding scripts to your global.js, be aware that, as with gadgets, variables declared with "var example" are not attached to the window object: they are local variables whose scope is a wrapper function inserted by ResourceLoader to implement the global module (which is called "ext.globalcssjs.user"). Therefore, if you plan to move a local script to the global module, and it needs to define global variables, make sure you use the syntax "window.example" to declare them.

Example[edit | edit source]

/* Any JavaScript added to this page will be loaded on all wikis where you have an account. */
window.myConfig = true;
// [[wikipedia:User:Lupin/popups]]
window.popupAdminLinks = true;
mw.loader.load( '//en.wikipedia.org/w/index.php?title=User:Lupin/popups.js&action=raw&ctype=text/javascript' );

Per-wiki customization[edit | edit source]

Example[edit | edit source]

/* Any JavaScript added to this page will be loaded on all wikis where you have an account. */
// Define a few functions
function onMultiLingualWikis(){
	// ...
}
function onWikibooks(){
	// ...
}
function onFrench(){
	// ...
}
function onRuWikisource(){
	// ...
}
function onEveryWiki(){
	mw.loader.load( '//www.mediawiki.org/w/index.php?title=MediaWiki:Gadget-UTCLiveClock.js&action=raw&ctype=text/javascript' );
}
onEveryWiki();
if ( /^(mediawiki|wikidata|meta|commons)wiki$/.test( mw.config.get( 'wgDBname' ) ) ) {
	onMultiLingualWikis();
} else if ( /wikibooks$/.test( mw.config.get( 'wgDBname' ) ) ) {
	onWikibooks();
} else if ( mw.config.get( 'wgContentLanguage' ) === 'fr' ) {
	onFrench();
} else if ( mw.config.get( 'wgDBname' ) === 'ruwikisource' ) {
	onRuWikisource();
}

To exclude a wiki[edit | edit source]

If you want to exclude a specific wiki, E.g. English Wikisource, you can wrap all or part of your global.js with:

if ( mw.config.get("wgDBname") !== "enwikisource" ) {
	// Whatever JavaScript you want to run on all wikis but enwikisource, goes here
}

Example: Set a global interface language[edit | edit source]

/* Change language to German */
mw.loader.using("mediawiki.user", function() {
	if ( mw.user.options.get('language') !== 'de' ) {
		mw.loader.load("mediawiki.notify");
		( new mw.Api() ).postWithToken( 'options', {
			action: "options",
			change: "language=de"
		} ).done( function() {
			mw.loader.using("mediawiki.notify", function(){
				mw.notify( "Language has been changed to German. Please refresh the page." );
			} );
		} );
	} else {
		console.log('Language already set to German!');
	}
} );

Global style sheets[edit | edit source]

Note: Any @import ... lines must be at the top.

Example[edit | edit source]

/* Any CSS added to this page will be loaded on all wikis where you have an account. */
 
/* Hide a few elements of the interface */
#n-help,
#footer {
	display: none !important;
}

Per-skin customization[edit | edit source]

Currently the extension does not provide global CSS/JS for specific skins, but it is possible to customize the appearance of a specific skin globally by using classes such as "skin-vector" and "skin-monobook", which are added to the body element automatically by MediaWiki.

Example[edit | edit source]

/* Any CSS added to this page will be loaded on all wikis where you have an account. */
 
/* Hide a few elements of the interface on vector skin */
.skin-vector #n-help,
.skin-vector #footer {
	display: none !important;
}
 
/* Bold the sidebar interwiki links to Enwiki/Simple, and interproject links to Commons/WikiVoyage */
.interwiki-en, .interwiki-simple, .wb-otherproject-commons, .wb-otherproject-wikivoyage {
        font-weight: bold;
}