Help:Customizing toolbars

The left sidebar and the top personal toolbar can be customized by editing Special:MyPage/skin.js or Special:MyPage/common.js. skin.js applies to only the current skin, where common.js globally applies to all skins.

Overview

General usage:

mw.util.addPortletLink( 'portletId', 'href', 'text', 'id', 'tooltip', 'accesskey', 'nextnode');

Where:

• mw.util.addPortletLink: the ResourceLoader module to add links to the portlets.
• portletId: portlet id— the section where the new menu item is to be placed. Valid values:
  • p-navigation: Navigation section in left sidebar
  • p-interaction: Interaction section in left sidebar
  • p-tb: Toolbox section in left sidebar
  • coll-print_export: Print/export section in left sidebar
  • p-personal Personal toolbar at the top of the page
• href: Link to the Wikipedia or eternal page
• text: Text that displays
• id: HTML id (optional)
• tooltip: Tooltip to display on mouseover (optional)
• accesskey: Shortcut key press (optional)
• nextnode: Existing portlet link to place the new portlet link before (optional)

The optional fields must be included in the above order. To skip a field without changing it, use the value null.

Href

Links to Wikipedia pages are of the form '/wiki/page name'; example: '/wiki/Special:NewPages'.

External links are formatted using the full URL; example: 'http://example.org'.

There are a number of configuration variables that can be used to create more complex links:

• wgArticlePath: Local path, starting at the root, to reference articles, containing a "$1" placeholder that may be replaced by a page title to get a valid URL to that page.
• wgPageName: The full name of the page, including the localized namespace name, if the namespace has a name (the main namespace (number 0) doesn't), and with blanks replaced by underscores.
• wgServer: The server URL, not terminated by "/".

Given a valid page title title, a valid URL may be constructed using wgArticlePath.replace('$1', title)

wgServer+wgArticlePath.replace("$1", "Special:ArticleFeedbackv5/"+wgPageName)

Examples

Wherever username is shown, replace it with the desired user name; likewise, replace pagename with the desired page name.

Add portlet to a user subpage on the left toolbar:

mw.util.addPortletLink ('p-tb', '/wiki/User:username/pagename', 'My pagename');

Add portlet to Special:NewPages on the left toolbar:

mw.util.addPortletLink ('p-tb', '/wiki/Special:NewPages', 'New Pages');

Open the current page in Checklinks on the left toolbar:

mw.util.addPortletLink ('p-tb', 'http://toolserver.org/~dispenser/cgi-bin/webchecklinks.py/' + wgPageName
   + '?client=script&citeweb=on&overwrite=&limit=20&lang=' + wgContentLanguage, 'Checklinks');

Open the current page in Reflinks on the left toolbar:

mw.util.addPortletLink ('p-tb', 'http://toolserver.org/~dispenser/cgi-bin/reflinks.py?lang=' + wgContentLanguage + "&page=' + wgPageName + '&autoclick=wpPreview', 'Reflinks');

Open page in Reflinks, on the personal toolbar; formatted in multiple lines:

mw.util.addPortletLink(
'p-personal',
'http://toolserver.org/~dispenser/cgi-bin/reflinks.py?lang=' + wgContentLanguage + "&page=' + wgPageName + '&autoclick=wpPreview',
'Reflinks');

Add a portlet to open user subpages to the personal toolbar, placed before the Preferences portlet:

 mw.util.addPortletLink(
 'p-personal',
 '/wiki/Special:PrefixIndex/User:username',
 'subpages',
 'pt-subpages',
 'Your subpages',
 null,
 '#pt-preferences'
 );