Расширение:Гаджеты
 Статус релиза: стабильно |
|
|---|---|
 |
|
| Реализация | MyWiki, Служебная страница, API |
| Описание | Allow users to enable JS-based, user-provided gadgets from their preferences page |
| Автор(ы) | Daniel Kinzler (Duesentriebобсуждение) |
| Политика совместимости | Snapshots releases along with MediaWiki. Master is not backward compatible. |
| MediaWiki | 1.19+ |
| Лицензия | GNU General Public License 2.0 или позднее |
| Скачать | README |
| Пример | Wikimedia Commons: Gadget overview, user preferences (click "Gadgets"; you need to be logged in of course) |
|
|
| Ежеквартальные загрузки | 116 (Ranked 55th) |
| Использование общедоступными вики | 4,529 (Ranked 177th) |
| Переведите расширение Gadgets, если оно доступно на translatewiki.net | |
| Проблемы | Открытые задачи · Сообщить об ошибке |
The Gadgets extension provides a way for users to pick JavaScript or CSS based "gadgets" that other wiki users provide.
Gadgets are made up of JavaScript and/or CSS Сниппеты 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 (see the Usage section below).
Since Gadgets reside in the MediaWiki namespace (the list defining the gadgets as well as the actual code snippets), only sysops (interface admins from 1.32) can edit the code. This is as it should be: only users especially trusted by the wiki community should be able to edit JavaScript code that is used by other users, since JavaScript can easily be used to hijack accounts or spy on people.
Установка
- Скачайте и распакуйте файл(ы) в папку с названием
Gadgetsв вашей папкеextensions/.
Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets - Добавьте следующий код в конце вашего файла LocalSettings.php:
wfLoadExtension( 'Gadgets' );
Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.
Использование
Once MediaWiki:Gadgets-definition is created with at least one valid gadget, a new "Gadgets" section will be shown on Special:Preferences for all users. Users can enable the gadgets they would like to use there. An overview of gadgets currently defined by MediaWiki:Gadgets-definition is also rendered on Special:Gadgets, along with helpful links to the relevant localisation and script/style pages for easy creation or editing. Statistics about gadget preferences are available at Special:GadgetUsage.
Формат определения
Each line on the MediaWiki:Gadgets-definition page should start with a "*" (asterisk) character to define a gadget. The line takes the following format:
* mygadget [опции] | названия страниц
The first field ("mygadget" in the example) is the gadget's internal name. The label for the preferences page comes from an interface message page (MediaWiki:Gadget-mygadget) where the proper name and a short description can be written, which also allows wikitext markup to be used.
[A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens (-), underscores (_), and periods (.). The reason for this limitation is that the internal name must be valid as the name of an HTML form name, as MediaWiki interface message key, and as ResourceLoader module name.Формат опций:
[ResourceLoader | опция1 | опция2 | ... опцияN]
The ResourceLoader flag is required unless the gadget contains only styles. Options that are "flags" only need to have their name written to be turned on. Options that need a value are followed by an equals sign and a comma-separated list of values. All whitespace is optional and may be omitted.
[ResourceLoader | myflag | mykey = value1, value2, value3 ]
Примеры:
* mygadget[ResourceLoader]|mygadget.js|mygadget.css
или
* mygadget[ResourceLoader|package]| mygadget.js | mygadget-Foo.js | mygadget-data.json | mygadget.css
или
* mygadget[ ResourceLoader | rights=foo, bar ] | mygadget.js | mygadget.css
Using Gadget Definition Namespace
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'.
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.
Опции
| Имя | Параметры | Описание | С |
|---|---|---|---|
ResourceLoader |
Нет | Marks gadget's scripts as compatible with Загрузчик ресурсов. | 1.17 (r76527) |
dependencies
|
Разделённые запятой названия модулей | These modules will be loaded before the scripts of this gadget execute. См. список модулей по умолчанию. | 1.17 (r76639) |
rights
|
Разделённые запятой названия привилегий | Make the gadget available (and visible in preferences) only to users who have the specified privileges. | 1.18 (r85268) |
hidden
|
Нет | Скрыть гаджет со страницы Настройки. Это может использоваться двумя способами:
|
1.28 |
skins
|
Разделённые запятой названия тем оформления | 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, задача T199478). Use of
skins should be a last resort, and should be restricted to specialized code which relies on DOM manipulated which is used in the absence of non-standardized APIs that are not served by the methods listed on ResourceLoader/Core modules. |
1.19 (r100509) |
actions
|
Разделённые запятой названия действий | 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 (gerrit:747112) |
namespaces
|
Comma-separated namespace numbers | Make the gadget available only on the specified namespaces. E.g. namespaces = 0, 2 to load a gadget only in mainspace and user namespace.
|
1.41 (gerrit:624517) |
contentModels
|
Comma-separated content models | Make the gadget available on pages with the given content models. E.g. contentModels = wikitext to load a gadget only on wikitext pages.
|
1.41 (gerrit:922062) |
default
|
Нет | Enable the gadget by default for everyone (including IPs). Registered users can still disable it in their preferences. | 1.18 (r85902) |
package
|
Нет | 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 |
targets
|
desktop (по умолчанию), mobile или desktop,mobile
|
(удалено в 1.42.0-wmf.16) Set the Загрузчик ресурсов target(s) for the gadget.
Do not use
targets, instead use skins where absolutely necessary. |
1.21 (gerrit:60954) |
type
|
styles (default for CSS-only gadgets) or general (default otherwise)
|
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. Подробнее см. 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
|
Разделённые запятой названия модулей | These CSS-only gadgets will be loaded together with this gadget. These gadgets will be loaded before any dependencies, and their styles will be applied even if JavaScript is disabled. Подробнее см. ResourceLoader/Migration guide (users)#Gadget peers.
|
1.29.0 |
supportsUrlLoad
|
Нет | true | false | Make the gadget available to be loaded with the ?withgadget URL query parameter.
|
1.38 |
requiresES6
|
None | (удалено в 1.42.0-wmf.13) Allow use of ES6 syntax (ES2015) in the gadget. Enabling this means server-side syntax validation is skipped for the gadget. Any ES6-requiring gadgets are loaded together in a single web request, which isolates failures due to invalid or unsupported syntax to those gadgets only, without affecting other gadgets and MediaWiki software features. It is recommended to use a tool like ESLint to ensure only valid ES6 syntax is used. Conflicts with default.
|
1.40.0-wmf.7 (gerrit:758086) |
|
Нет | (удалено в 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. | 1.22 (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
Чтобы включить гаджет по умолчанию, используйте «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.
Вот несколько реальных примеров:
* modrollback[ResourceLoader|rights=rollback]|modrollback.js * UTCLiveClock[ResourceLoader|rights=purge]|UTCLiveClock.js * Ajax_sysop[ResourceLoader|rights=patrol,rollback,markbotedits,delete]|Ajax_sysop.js
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;
Страницы
The remaining fields on the definition line refer to the JavaScript, CSS or JSON source pages that makes up the gadget module. These are stored in the MediaWiki namespace as interface messages (MediaWiki:Gadget-mygadget.js and MediaWiki:Gadget-mygadget.css in the example). The page names must end with ".css", ".js", or ".json" respectively.
A gadget can use any number of source pages, e.g:
* frobinator[ResourceLoader]|frob.js|frob.css|pretty.css * l33t[ResourceLoader]|l33t.js * foobar[ResourceLoader|package]|foo.js|bar.js|foobar-data.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.
Разделы
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.
См. также
- Special:Gadgets – lists all the gadgets and a brief description of each
- Extension:Gadgets/Roadmap
- Менеджер гаджетов
- Extension:Widgets
- Сниппеты
| Это расширение используется в одном или нескольких проектах Викимедиа. Вероятно, это означает, что расширение стабильно и работает достаточно хорошо, чтобы использоваться такими сайтами с высоким трафиком. Найдите название этого расширения в файлах конфигурации Викимедиа CommonSettings.php и InitialiseSettings.php, чтобы узнать, где оно установлено. Полный список расширений, установленных на конкретной вики, можно увидеть на странице Special:Version wiki. |
| Это расширение включено в следующие вики-фермы/хостинги и/или пакеты: Это не исчерпывающий список. Некоторые вики-фермы/хостинги и/или пакеты могут содержать это расширение, даже если они не перечислены здесь. Всегда сверяйтесь со своими вики-фермами/хостингами или комплектами/бандлами для подтверждения. |