Movatterモバイル変換

[0]ホーム
URL:

Jump to content
WikipediaThe Free Encyclopedia
Search

Wikipedia:Gadget

From Wikipedia, the free encyclopedia
(Redirected fromWikipedia:GADGET)
icon
Wikipedia information page
This is aninformation page.
It is not anencyclopedic article, nor one ofWikipedia's policies or guidelines; rather, its purpose is to explain certain aspects of Wikipedia's norms, customs, technicalities, or practices. It may reflect differing levels ofconsensus andvetting.
You take full responsibility for any actions taken using any gadget. You must read andunderstand all relevantWikipedia policies and abide by them when using this tool; failure to do so may result in beingblocked from editing.

AWikipedia gadget is aJavaScript program and/or aCSSsnippet that can be enabled simply by checking an option in yourpreferences. The gadget's function is provided by theMediaWiki extensionGadgets.

Many gadgets started out asuser scripts. Once a user script is approved as a gadget, it is removed fromWikipedia:User scripts/List. The currently installed gadgets are listed atSpecial:Gadgets.

General criteria for gadgets

[edit]

In order to be deployed on the English language Wikipedia, gadgets should generally pass the following conditions:

  1. Gadgetsmust work if just included with no further configuration. They can be configurable viapersonal common.js, but must work unconfigured.
  2. Gadgetsmust be compatible with all major browsers, i.e., they must not terminate with errors.
  3. Gadgetsshould be functional in most major browsers (cross-browser compatibility). Exceptions must be clearly stated.
  4. Duplication of gadgetsshould only be made if it is reasonable.
  5. Collections of scriptsshould be split if they have disparate functions.
  6. Gadgets requiring permissionsmust be marked and must fail gracefully if the permissions aren't present.
  7. Gadgets only working in some skinsmust be marked as such if that data is available.

Gadgets that are marked as default and load for large groups of users haveadditional criteria they need to conform to.

Proposals

[edit]

New gadgets should be proposed atthe technical Village Pump.

Historically, new gadgets were proposed ata subpage of this page, but that page was marked historical due to low participation. Also, existingWikiProject User scripts used to beevaluated for conversion to gadgets, but that process has also been marked historical.

Installation

[edit]

Gadgets can be installed after discussion at thetechnical section of the village pump byinterface administrators in the following way:

  1. Add theheader below and the script code to MediaWiki:Gadget-scriptname.js
  2. Optionally, add theheader below andCSS code to MediaWiki:Gadget-scriptname.css
  3. Add a script description to MediaWiki:Gadget-scriptname. Please link to the script home and/or help page and state browser requirements if needed.
  4. Add toMediaWiki:Gadgets-definition under the appropriate heading
    * scriptname|scriptname.js[|scriptname.css|otherscript.js|...]

The gadget should now appear onSpecial:Gadgets.

Comments

[edit]

Comments or warnings can be added to the gadget description templates in two ways:

  • noinclude tag (visible on description page with links):<noinclude> comment </noinclude>
  • HTML comments (visible in source text only):<!-- comment -->

Comments added in this way will be automatically discarded during the page creation process.

Header

[edit]

The following header is to be added to the gadget files:

/*  _____________________________________________________________________________ * |                                                                             | * |                    === WARNING: GLOBAL GADGET FILE ===                      | * |                  Changes to this page affect many users.                    | * | Please discuss changes on the talk page or on [[WT:Gadget]] before editing. | * |_____________________________________________________________________________| * * Imported from version XXXX as of DATE from [[SCRIPT_SOURCE]] * SHORT_DESCRIPTION, see [[SCRIPT_HOME_PAGE]] */

Default gadgets

[edit]

A gadget withdefault keyword is enabled for all Wikipedia visitors and only registered users can disable it.A gadget with[default|rights=minoredit] description would be automatically enabled only for registered users.

Criteria

[edit]

Gadgets that are enabled by default for all users have to comply with stricter rules. These are essentially the same rules that apply to all default shipped code. This is because users have no active choice in them being enabled and the gadgets can impact the performance, security and stability of the entire website. These gadgets should:

  • Have been reviewed by an experienced JavaScript developer (generally an interface admin).
  • Be "well maintained".
  • Conform with theThird-party resources policy.
  • Be written to run efficiently, i.e. with as little code as required. If full functionality of the gadget requires a lot of JavaScript code, then this code should be loaded conditionally and lazily, or only on demand (click to load).
  • Cause noaccessibility problems.
  • Not be required for content to be readable, except for styles-only gadgets.
  • Not interfere with printing pages.
  • Comply with the current security and privacy standards.

This list should not be considered exhaustive.

Template gadgets

[edit]

Template gadgets are a special category of default gadgets. These gadgets only run on pages in explicit trigger categories, generally controlled by adding a template to a page. Trigger categories should be move-protected as they are integrated with the definition.

Currently installed gadgets

[edit]

Users can browse a list of all available gadgets in the gadgets section of their preferences page:

Preferences →Gadgets

SeeSpecial:Gadgets for a list of all active gadgets and links to their script files.

Pros and cons of changing a user script to a gadget

[edit]

Pros

[edit]
  • Adds the script toSpecial:Preferences, which makes installing it much easier.
  • Adds the script toSpecial:Preferences, which will help with marketing the script and boost install counts over time.
  • Gives the user script to the community, makinginterface administrators more likely to grant edit requests from other users, reducing the need to fork the user script if the maintainer goes inactive.
  • Ability to mark it as a "default gadget", which will load for everyone.
  • TheResourceLoader modules and CSS the script depends on load on page load, allowing the script to be ready faster.

Especially once a user script has a lot of users...

  • Gadgets provideminification and bundling with other gadgets, which reduces file sizes and HTTP traffic.
  • Possible protection against hacking. Interface administrators all have two factor authentication, and are removed if they become inactive. A regular maintainer might go inactive then have their account compromised at a later date.
  • Possible protection against a rogue user script developer. Interface administrators have gone throughRFA and are possibly less likely to go rogue.

Cons

[edit]
  • Allows use of JavaScript features up toES7 only. A few ES8 features like async–await can be used with therequiresES6 flag.
  • If the maintainer is not an interface administrator, they will now need to make{{Edit interface-protected}} requests in order to make any code changes, slowing down development.
  • Lots of steps. Need to make sure the maintainer is OK with it, get consensus atWP:VPT, then get an interface administrator to set everything up. May need a plan to switch everyone over from the old user script to the gadget. If there is any concern about bugs, may need to do a staggered rollout.

See also

[edit]
General
technical help
Special
page-related
Wikitext
Links anddiffs
Media files: images,
videos and sounds
Other graphics
Templates and
Lua modules
Data structure
HTML andCSS
Customisation
and tools
Automated editing
Retrieved from "https://en.wikipedia.org/w/index.php?title=Wikipedia:Gadget&oldid=1307549283"
Categories:
[8]ページ先頭
©2009-2025 Movatter.jp