Extension:Gadgets

This page is a translated version of the page Extension:Gadgets and the translation is 36% complete.
Diese Erweiterung ist üblicherweise in MediaWiki 1.18 und darüber enthalten. Daher muss sie nicht erneut heruntergeladen werden. Allerdings müssen die folgenden Anweisungen trotzdem beachtet werden.
MediaWiki-Erweiterungen
OOjs UI icon advanced-invert.svg
Gadgets
Freigabestatus: stabil
Screenshot-gadgets-tab-vector-skin.png
Einbindung MeinWiki , Spezialseite , API
Beschreibung Erlaubt Nutzern die JS-basierenden, vom Nutzer bereitgestellten "Helferlein" auf ihrer Einstellungsseite zu aktivieren.
Autor(en) Daniel Kinzler (DuesentriebDiskussion)
Kompatibilitätspolitik Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.19+
Lizenz GNU General Public License 2.0 oder neuer
Herunterladen
README
Beispiel Wikimedia Commons: Überblick der Helferlein, Benutzereinstellungen (klicke auf "Helferlein"; du musst dafür natürlich hier angemeldet sein)
  • $wgGadgetsRepoClass
  • $wgSpecialGadgetUsageActiveUsers
  • gadgets-edit
  • gadgets-definition-edit
Übersetze die Gadgets-Erweiterung, wenn sie auf translatewiki.net verfügbar ist

Prüfe die Benutzungs- und Versionsmatrix.

Probleme Offene Aufgaben · Einen Fehler melden

Die Gadgets-Erweiterung bietet eine Möglichkeit für Benutzer, JavaScript- oder CSS-basierte "Helferlein" auszuwählen, welche andere Wiki-Benutzer anbieten.

Helferlein (in der englischsprachigen Version "Gadgets" genannt) werden aus JavaScript- und/oder CSS-Snippets zusammengesetzt, die auf den Seiten im MediaWiki-Namensraum vorhanden sind. Jedes Helferlein wird durch eine Zeile in der MediaWiki:Gadgets-definition bestimmt. Diese enthält einen Namen und eine Beschreibung für das Helferlein sowie die Liste der von ihm verwendeten JS- oder CSS-Schnipsel (siehe Abschnitt Verwendung unten).

Seit dem die Helferlein sich im MediaWiki-Namensraum (die Liste der Definition des Helferleins als auch die tatsächlichen Code-Schnipsel) befinden, können nur Sysops (aka Wiki-Admins) den Code bearbeiten. Dies ist, wie es sein soll: Nur von der Wiki-Gemeinschaft besonders vertraute Benutzer sollten im Stande sein, JavaScript-Code zu editieren, der von anderen Benutzern verwendet wird, da JavaScript leicht verwendet werden kann, um Zugangsdaten oder andere sensible Daten auszuspionieren.

Installation

  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens Gadgets im Ordner extensions/ ablegen.
  • Folgenden Code am Ende deiner LocalSettings.php hinzufügen:
    wfLoadExtension( 'Gadgets' );
    
  •   Erledigt – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Für Benutzer, die MediaWiki in der Version 1.24 und früher betreiben:

Die oben stehenden Anweisungen beschreiben die neue Installationsanweisung für diese Erweiterung unter der Verwendung von wfLoadExtension(). Wird diese Erweiterung in einer dieser früheren Versionen (MediaWiki 1.24 und früher)  – an Stelle von wfLoadExtension( 'Gadgets' ); – installiert, benutze:

require_once "$IP/extensions/Gadgets/Gadgets.php";

Verwendung

 
Selection of some gadgets at the user preferences in de.wikipedia

There are two ways to define gadgets depending on the $wgGadgetsRepoClass. If It is 'MediaWikiGadgetsDefinitionRepo' (the default value), the list of available gadgets is defined on MediaWiki:Gadgets-definition. In an alternative way, Gadget definitions are defined on pages in the Gadget definition namespace when $wgGadgetsRepoClass is set to 'GadgetDefinitionNamespaceRepo'.

  Achtung: Migration of the existing gadget definitions is not yet supported, so you will lose previously defined gadgets after changing this option.

Once created with at least one valid gadget, gadgets defined there show up in the "Gadgets" section of Special:Preferences, so users can pick the gadgets they would like to use. An overview of the gadgets defined by MediaWiki:Gadgets-definition is also shown on Special:Gadgets, along with links to the respective system messages, for easy editing. Statistics for non-default gadget usage can be seen at Special:GadgetUsage.

Format

Die MediaWiki-Gadgets-Definition verwenden

Each line in MediaWiki:Gadgets-definition that starts with one or more "*" (asterisks) characters defines a gadget; it must have the following form:

 * gadget_name [options (can be omitted)] | Seitennamen

The first field ("gadget_name" in the example) is the gadget's internal name, and references a system message (MediaWiki:Gadget-gadget_name in the example) that contains a short description of the gadget, using wiki syntax.

The internal name is used as part of the name of a form field and must follow the rules defined for NAME attribute values. This means it must begin with a basic Latin letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens (-), underscores (_), colons (:), and periods (.).

Optionsformat:

[Option1 | Option2 | ... OptionN]

whitespace can be omitted. A single option can either consist of a single option name (in this case it is a flag option), or contain a comma-separated list of values:

option = value1, value2, value3

Beispiele:

 * mygadget[ResourceLoader]|mygadget.js|mygadget.css

oder

 * mygadget[ResourceLoader|package]| mygadget.js | mygadget-Foo.js | mygadget-data.json | mygadget.css

oder

* mygadget[ ResourceLoader | rights=foo, bar ] | mygadget.js | mygadget.css

Using Gadget Definition Namespace

Creation of the Gadget definition:mygadget page and putting in it the below JSON code have the same effect as mygadget[ ResourceLoader | rights=foo, bar ] | mygadget.js | mygadget.css.

{
	"settings": {
		"rights": [ "foo", "bar" ],
		"default": false,
		"package": false,
		"hidden": false,
		"skins": [],
		"actions": [],
		"category": ""
	},
	"module": {
		"scripts": [ "mygadget.js" ],
		"styles": [ "mygadget.css" ],
		"datas": [],
		"peers": [],
		"dependencies": [],
		"messages": [],
		"type": ""
	}
}

In above example, the Gadget:Mygadget.js and the Gadget:mygadget.css are used. Remember the ResourceLoader option is always true in the gadget definition namespace.

User rights

This extension adds two new user rights, gadgets-edit and gadgets-definition-edit, which by default aren't given to any group.

You can add the following in your LocalSettings.php to provide the appropriate permissions for users who are within the interface-admin group. Editing pages in the Gadget namespace requires the gadgets-edit right and editing pages in the Gadget definition namespace requires the gadgets-definition-edit right.

$wgGroupPermissions['interface-admin']['gadgets-edit'] = true;
$wgGroupPermissions['interface-admin']['gadgets-definition-edit'] = true;


Optionen

Name Parameter Beschreibung Seit
ResourceLoader Keine Marks gadget's scripts as compatible with ResourceLoader . ?
dependencies Kommagetrennte Modulnamen Siehe die Liste der Standardmodulen. Note that this option has no effect if current gadget has no ResourceLoader-compatible resources (i.e. no styles and scripts not marked as compatible). ?
rights Comma-separated privilege names Make the gadget available (and visible in preferences) only to users who have the specified privileges. ?
hidden Keine Hide the gadget from the Preferences page. This can be used in two ways:
  • Enable a gadget by default without ability to disable (as modular alternative to Common.js). Note that you need to add both: hidden | default to load a module for all users.
  • Gadgets that are not meant for end-users, but rather are meant to be loaded by other gadgets. For example to allow two gadgets to re-use the same internal code, or to register the "core" part of a gadget that only loads on certain pages.
1.28
skins Comma-separated skin names Make the gadget available (and visible in preferences) only to users who use the specified skins. Before MediaWiki 1.32 it was taking into consideration the skin set in preferences for the user, not the current displayed one (like when adding ?useskin=monobook in the URL, task T199478). ?
actions Comma-separated action names Make the gadget available only on the specified page actions. E.g. actions = edit, history to load a gadget only while editing and on history pages.
Specifying edit action will also load it on action=submit. Invalid actions effectively disable the gadget since it can't be run anywhere.
1.38-wmf.16
default Keine Enable the gadget by default for everyone (including IPs). Registered users can still disable it in their preferences. 1.18
package Keine Mark this gadget as packaged. In this mode, only the first JavaScript page will be executed. Other pages can be imported by using the require() function. This mode also enables use of JSON pages, which cannot be included otherwise. 1.38-wmf.16
targets desktop (Standard), mobile oder desktop,mobile Setzt die/das ResourceLoader -Ziel(e) für das Helferlein. gerrit:60954
type styles oder general Use styles for modules that only modify styling for elements already on the page (e.g. when customizing the skin, layout, or article content). It will cause the CSS files of the module to be included from the page HTML instead of being loaded via JavaScript. For details, see ResourceLoader/Migration guide (users)#Gadget type.
Using styles will not load in any specified JavaScript files. For gadgets that modify styling for elements through both JavaScript and CSS, two individual gadget definitions are required.
1.28
peers Comma-separated module names Require CSS-only gadgets (which usually would be hidden). These gadgets will be loaded sooner than by dependencies, and will be loaded even if JavaScript is disabled. For details, see ResourceLoader/Migration guide (users)#Gadget peers. 1.29.0-wmf.11
(pre-release)
supportsUrlLoad Keine | true | false Make the gadget available to be loaded with the ?withgadget URL query parameter. 1.38
top Keine (entfernt in 1.29) Makes the gadget to be top-loaded. This should be used sparingly, but may be needed for some initialization stuff like registering plugins with VisualEditor. gerrit:75506

You can specify extra dependencies for your gadgets, for example:

* mygadget[ResourceLoader|dependencies=jquery.ui, jquery.effects.clip]|mygadget.js|mygadget.css

Here, we ask ResourceLoader to load modules jquery.ui and jquery.effects.clip with mygadget. Note that gadgets can't depend on scripts from pages, static files or external URLs, only on modules already registered in ResourceLoader. To make a script from a page depend on another script from a page, each should be a gadget which registers itself as a module in ResourceLoader, then they can be made to have dependencies using the following syntax:

* childgadget[ResourceLoader|dependencies=ext.gadget.parentgadget]|childgadget.js

To enable a gadget by default, use "default":

* mygadget[ResourceLoader|default|dependencies=mediawiki.util]|mygadget.js|mygadget.css

To make the gadget available only to users with appropriate permissions, set the rights option, for example:

* ImprovedDeletion [rights=delete] | ImprovedDeletion.js

Makes the gadget available only to users who can actually delete pages.

Note that restrictions are based on permissions, not user groups like administrators or bureaucrats.

Here are some real examples:

* modrollback[ResourceLoader|rights=rollback]|modrollback.js
* UTCLiveClock[ResourceLoader|rights=purge]|UTCLiveClock.js
* Ajax_sysop[ResourceLoader|rights=patrol,rollback,markbotedits,delete]|Ajax_sysop.js

Seiten

The remaining fields on the line refer to the JavaScript, CSS or JSON code that makes up the gadget, contained in system messages (MediaWiki:Gadget-mygadget.js and MediaWiki:Gadget-mygadget.css in the example); the names of those messages must end with ".js" or ".css", respectively.

A gadget can use any number of code messages, specifically, common code can be put into a code message used by several gadgets, in addition to their own specific code, e.g:

 * frobinator[ResourceLoader]|commonStuff.js|frob.js|frob.css|pretty.css
 * l33t[ResourceLoader]|commonStuff.js|tools.js|l33t.js
 * foobar[ResourceLoader|package]|foo.js|bar.js|foobar.json

Please note that if your code contains strings that could be interpreted as wiki syntax (e.g. the signature code ~~~~), you may want to enclose your code into ‎<nowiki>...‎</nowiki> and put these tags in JavaScript or CSS comments so they're not interpreted when actually used.

See the first and last lines of MediaWiki:Gadget-externalsearch-bar.js for an example.

Abschnitte

The list of gadgets in MediaWiki:Gadgets-definition can be broken into sections using lines that start and end with two or more "=" (equals) characters, enclosing the name of a system message that defines the section's name, for example:

 == interface-gadgets ==

This would define a new section, with the title defined on the page MediaWiki:Gadget-section-interface-gadgets.

Popular gadgets

See meta:Gadgets for gadgets which are popular in Wikimedia communities.

Siehe auch