這是 Greasy Fork 會讀取的 使用者腳本 meta keys 的清單。腳本中可以有不在此清單中的 key,也會存在使用者安裝的腳本中,但不會對 Greasy Fork 的介面有任何效果。
- §
@name
- 腳本名稱,用來作為標題與連結中使用,必填。
- §
@name:XX-YY
- 此腳本在不同語系中的名稱,XX 是 ISO 639-1 的兩字母代碼 ,YY 則是非必要的 ISO 3166 國家代碼。當使用者在符合的語系中瀏覽時就會蓋過
@name
顯示。 - §
@description
- 必須在腳本名稱下方以文字說明腳本內容。
- §
@description:XX-YY
- 此腳本在不同語系中的描述,XX 是 ISO 639-1 的兩字母代碼 ,YY 則是非必要的 ISO 3166 國家代碼。當使用者在符合的語系中瀏覽時就會蓋過
@description
顯示。 - §
@namespace
- 使用者腳本管理器將會透過
@namespace
與@name
的組合來判斷是否已安裝該腳本。Greasy Fork 要求必填此欄位,若於更新時修改了此欄位也會警告您。 - §
@version
- Identifier for a specific version of a script in Mozilla version format. Version is displayed on a script's info page. Greasy Fork requires this field and will warn if it's decremented or if it's not incremented when the script's code changes.
- §
@include
,@exclude
,@match
- 描述腳本所欲執行的頁面。此清單將被處理並顯示於腳本資訊頁用以分類腳本。每個腳本必須有一個
@相符
或@包含
。於此閱讀格式。 - §
@require
- Includes external JavaScript into a script. See rules for code including external scripts. If you use subresource integrity hashes (see info here and here), Greasy Fork will alert you if your hashes do not match the content at the URL you use.
- §
@resource
- Includes an external resource (JavaScript, CSS, images, etc.) into a script. See rules for code including external scripts. If you use subresource integrity hashes (see info here and here), Greasy Fork will alert you if your hashes do not match the content at the URL you use.
- §
@updateURL
,@installURL
,@downloadURL
- 描述使用者腳本管理器要從何取得更新。Greasy Fork 將會移除這些更新網址,目的是讓從 Greasy Fork 安裝的腳本只能由 Greasy Fork 更新。
- §
@license
- By posting your script to Greasy Fork, you give others permission to install and use it. The license describes whether and how people are allowed to modify and distribute your script. License is displayed on a script's info page.
@license
can be:- The name of a license (for example,
@license GPL3
). Using a "Full name" or "Identifier" from the SPDX License List is recommended. - The conditions under which you allow use (for example
@license You can modify as long as you credit me
, though using a pre-existing license is recommended. - A copyright statement (for example
@license Copyright MyName
) if you don't want to release under a license. - Omitted entirely, which is the same as having a copyright statement, but less clear to users.
- The name of a license (for example,
- §
@supportURL
- 使用者能取得腳本的技術支援之處(例如:臭蟲追蹤系統、討論區、電子郵件信箱等等)。技術支援網址將會顯示在腳本的反饋頁。
- §
@contributionURL
- 腳本作者的捐贈網址。捐贈網址會顯示在腳本的反饋頁。網址可以是 http、https 或者比特幣協議網址。例如:要連結到 PayPal 捐贈頁面,可使用 https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=your.email.here@example.com&item_name=Greasy+Fork+donation 的格式,請用您自己的電子郵件位址替代前述範例的位址。
- §
@contributionAmount
- 建議的捐贈金額,與
@contributionURL
一起使用。 - §
@compatible
- 標示此腳本與哪些瀏覽器相容。相容性資訊將會顯示在腳本的頁面。可使用例如:
@compatible firefox 必須停用彈出型視窗封鎖器
的格式來記錄關於相容性的其他資訊。可使用的瀏覽器有:firefox
,chrome
,opera
,safari
,edge
。 - §
@incompatible
- 標示此腳本與哪些瀏覽器不相容。相容性資訊將會顯示在腳本的頁面。可使用例如:
@incompatible firefox 從 Firefox 23 起失效
的格式來記錄關於相容性的其他資訊。可使用的瀏覽器有:firefox
,chrome
,opera
,safari
,edge
。 - §
@antifeature
- Discloses features in a script that are there to benefit the author, not the user. The format of this key is
@antifeature type description
. type is required, description is optional. Read here for info on the types read by Greasy Fork. - §
@antifeature:XX-YY
- An
@antifeature
described in a specific locale, where XX is an ISO 639-1 2-letter code and YY is an optional ISO 3166 country code. Overrides@antifeature
s of the same type when the user is browsing in a matching locale.