ส่วนขยาย:แกดเจ็ต

This page is a translated version of the page Extension:Gadgets and the translation is 38% complete.
Outdated translations are marked like this.
This extension comes with MediaWiki 1.18 and above. Thus you do not have to download it again. However, you still need to follow the other instructions provided.
MediaWiki extensions manual
OOjs UI icon advanced-invert.svg
Gadgets
Release status: stable
Screenshot-gadgets-tab-vector-skin.png
Implementation MyWiki , Special page , API
Description อนุญาตให้ผู้ใช้เปิดใช้งานแกดเจ็ตที่ผู้ใช้จัดเตรียมโดย JS จากหน้าการตั้งค่า
Author(s) Daniel Kinzler (Duesentriebคุย)
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.19+
License GNU General Public License 2.0 or later
Download
README
Example Wikimedia Commons: ภาพรวมแกดเจ็ต, การตั้งค่าผู้ใช้ (คลิก 'Gadgets' คุณต้องลงชื่อเข้าใช้แน่นอน)
  • $wgGadgetsRepoClass
  • $wgSpecialGadgetUsageActiveUsers
  • gadgets-edit
  • gadgets-definition-edit
Translate the Gadgets extension if it is available at translatewiki.net

Check usage and version matrix.

Issues Open tasks · Report a bug

ส่วนขยาย Gadgets ช่วยให้ผู้ใช้สามารถเลือก 'แกดเจ็ต' ที่ใช้ JavaScript หรือ CSS ที่ผู้ใช้ Wiki รายอื่นจัดเตรียมไว้

แกดเจ็ตประกอบด้วย JavaScript และ/หรือ CSS snippets ที่อยู่บนหน้าเว็บในเนมสเปซมีเดียวิกิ แต่ละแกดเจ็ตถูกกำหนดโดยบรรทัดใน MediaWiki:Gadgets-definition โดยระบุชื่อและคำอธิบายสำหรับแกดเจ็ต และรายการของข้อมูลโค้ด JS และ CSS ที่ใช้ (ดูส่วน การใช้งาน ด้านล่าง)

เนื่องจาก Gadgets อยู่ในเนมสเปซ MediaWiki (รายการที่กำหนดแกดเจ็ตรวมถึงข้อมูลโค้ดจริง) มีเพียง sysops (ผู้ดูแลระบบส่วนต่อประสานจาก 1.32) เท่านั้นที่สามารถแก้ไขโค้ดได้ นี่เป็นอย่างที่ควรจะเป็น: เฉพาะผู้ใช้ที่ได้รับความเชื่อถือโดยเฉพาะอย่างยิ่งจากชุมชน Wiki เท่านั้นที่จะสามารถแก้ไขโค้ด JavaScript ที่ผู้ใช้รายอื่นใช้ เนื่องจาก JavaScript สามารถใช้เพื่อติดตามสอดส่องบัญชีหรือสอดแนมบุคคลอื่นได้อย่างง่ายดาย

การติดตั้ง

  • ดาวน์โหลดและวางไฟล์ลงในไดเร็กทอรีที่ชื่อ Gadgets ในโฟลเดอร์ extensions/ ของคุณ
  • เพิ่มโค้ดต่อไปนี้ไว้ที่ด้านล่างของ LocalSettings.php ของคุณ:
    wfLoadExtension( 'Gadgets' );
    
  •   สำเร็จ – ตรวจสอบที่ Special:Version บนวิกิของคุณเพื่อตรวจการติดตั้งส่วนขยาย

สำหรับมีเดียวิกิรุ่น 1.24 หรือก่อนหน้า:

ข้อมูลด้านบนมีไว้สำหรับวิธิใหม่ในการติดตั้งส่วนขยายนี้โดยใช้ wfLoadExtension() ถ้าหากต้องการติดตั้งส่วนขยายนี้ในรุ่นมีเดียวิกิของคุณ (มีเดียวิกิ 1.24 หรือก่อนหน้า) แทนการใช้ wfLoadExtension( 'Gadgets' ); คุณจะต้องใช้:

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

การใช้งาน

 
การเลือกแกดเจ็ตบางอย่างตามความชอบของผู้ใช้ใน de.wikipedia

มีสองวิธีในการกำหนดแกดเจ็ตโดยขึ้นอยู่กับ $wgGadgetsRepoClass หากเป็น 'MediaWikiGadgetsDefinitionRepo' (ค่าเริ่มต้น) รายการอุปกรณ์ที่ใช้ได้จะถูกกำหนดไว้ที่ MediaWiki:Gadgets-definition ในอีกทางหนึ่ง คำจำกัดความของ Gadget ถูกกำหนดไว้บนเพจในเนมสเปซ Gadget definition เมื่อ $wgGadgetsRepoClass ถูกตั้งค่าเป็น 'GadgetDefinitionNamespaceRepo'

  Caution: ยังไม่สนับสนุนการย้ายคำจำกัดความของแกดเจ็ตที่มีอยู่ ดังนั้นคุณจะสูญเสียแกดเจ็ตที่กำหนดไว้ก่อนหน้านี้หลังจากเปลี่ยนตัวเลือกนี้

เมื่อสร้างด้วยแกดเจ็ตที่ถูกต้องอย่างน้อยหนึ่งรายการ แกดเจ็ตที่กำหนดไว้จะแสดงในส่วน "แกดเจ็ต" ที่ Special:Preferences เพื่อให้ผู้ใช้สามารถเลือกแกดเจ็ตที่ต้องการใช้ ภาพรวมของแกดเจ็ตที่กำหนดโดย MediaWiki:Gadgets-definition จะแสดงบน Special:Gadgets พร้อมด้วยลิงก์ไปยังข้อความระบบที่เกี่ยวข้อง เพื่อให้แก้ไขได้ง่าย สถิติการใช้งานแกดเจ็ตที่ไม่ใช่ค่าเริ่มต้นสามารถดูได้ที่ Special:GadgetUsage

รูปแบบ

Using MediaWiki Gadgets Definition

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)] | ชื่อเพจ

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 (.).

รูปแบบตัวเลือก:

[ตัวเลือกที่ 1 | ตัวเลือกที่ 2 | ... ตัวเลือกN]

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

ตัวอย่าง:

 * 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

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;


ตัวเลือก

ชื่อ พารามิเตอร์ รายละเอียด ตั้งแต่
ResourceLoader ไม่มี Marks gadget's scripts as compatible with ResourceLoader . ?
dependencies Comma-separated module names See list of default modules. 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 ไม่มี 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 ไม่มี Enable the gadget by default for everyone (including IPs). Registered users can still disable it in their preferences. 1.18
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-wmf.16
targets desktop (default), mobile or desktop,mobile Set the ResourceLoader target(s) for the gadget. gerrit:60954
type styles หรือ 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 ไม่มี | true | false Make the gadget available to be loaded with the ?withgadget URL query parameter. 1.38
top ไม่มี (removed 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

หน้า

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.

ส่วน

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.

ดูเพิ่ม