Help:Gadgets

Inkipedia's gadgets

A list of gadgets employed is available at Special:Gadgets.

Gadgets are made up of JavaScript and/or CSS Snippets located on pages in the MediaWiki namespace. Each gadget is defined by a line in MediaWiki:Gadgets-definition, providing a name and description for the gadget, and a list of the JS and CSS snippets that it uses.

Since gadgets reside in the MediaWiki namespace (the list defining the gadgets as well as the actual code snippets), only Administrators and Interface administrators can edit the code. This is intended, as JavaScript code can be used to hijack accounts or spy on people.

Creating new gadgets

1. Go to MediaWiki:Gadgets-definition.
2. Add a new entry for your gadget. For example: * MyCoolGadget[ResourceLoader|default]|MyCoolGadget.js
   • This entry creates a new gadget named "MyCoolGadget" and specifies that it should be loaded by default using ResourceLoader.
   • Adding the default keyword in the definition entry enables by default for all users.
   • It's also a good idea to list the dependencies, such as jquery and mw.api where appropriate.
3. Create a new page for your gadget's JavaScript code at MediaWiki:Gadget-MyCoolGadget.js.
   • If you already have JS code, paste this into the new page.
4. Create a new page for your gadget's description shown in preferences at MediaWiki:Gadget-MyCoolGadget. (Note the missing .js).
5. Save and Test. Remember to clear your browser cache or perform a hard refresh to see the changes.

• Each section in the definitions file corresponds to MediaWiki:gadget-section-NameOfTheSection, e.g. MediaWiki:gadget-section-appearance.

See also

• Extension:Gadgets manual
• ResourceLoader manual
• Gadget usage