這是 Sleazy Fork 會讀取的 使用者腳本 meta keys 的清單。腳本中可以有不在此清單中的 key,也會存在使用者安裝的腳本中,但不會對 Sleazy 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
的組合來判斷是否已安裝該腳本。Sleazy Fork 要求必填此欄位,若於更新時修改了此欄位也會警告您。 - §
@version
- 腳本特定版本的標識符,請以 Mozilla 版本格式 為準,版本號會顯示在腳本的信息頁面上。Sleazy Fork 要求填寫該屬性,並會在版本號減少或腳本代碼更改時未增加版本號時發出警告。
- §
@include
,@exclude
,@match
- 描述腳本所欲執行的頁面。此清單將被處理並顯示於腳本資訊頁用以分類腳本。每個腳本必須有一個
@相符
或@包含
。於此閱讀格式。 - §
@require
- 引入外部腳本到使用者腳本。查看關於引入外部腳本到代碼的規則。如果你使用 SRI,也就是 Sub-Resource Integrity 來記錄外部腳本哈希(更多信息請參閱 TamerMonkey 文件 與 MDN 文件),你將在你的哈希值與你連結的內容不匹配時收到來自 Sleazy Fork 的警告。
- §
@resource
- 引入外部資源(如 JavaScript、CSS、圖像等)到腳本。查看關於引入外部腳本到代碼的規則。如果你使用 SRI,也就是 Sub-Resource Integrity 來記錄外部腳本哈希(更多信息請參閱 TamerMonkey 文件 與 MDN 文件),你將在你的哈希值與你連結的內容不匹配時收到來自 Sleazy Fork 的警告。
- §
@updateURL
,@installURL
,@downloadURL
- 描述使用者腳本管理器要從何取得更新。Sleazy Fork 將會移除這些更新網址,目的是讓從 Sleazy Fork 安裝的腳本只能由 Sleazy Fork 更新。
- §
@license
- 透過在 Sleazy Fork 上發佈你的腳本,你賦予其他人安裝和使用它的權利。 許可證聲明了人們是否以及如何被允許修改和分發你的腳本,展示在腳本的信息頁面上。
@license
可以是:- 許可證的名稱(例如,
@license GPL3
)。建議使用來自 the SPDX 許可證列表 的 “全名” 或 “標識符”。 - 你允許使用的條件(例如
@license 給我署名就可以改
,雖然建議使用已有的許可證 - 版權聲明 (例如
@license Copyright 我的名字
)如果你不想在有許可證下發佈。 - 完全省略,這與具有版權聲明相同,但對使用者來說不夠清晰。
- 許可證的名稱(例如,
- §
@supportURL
- 使用者能取得腳本的技術支援之處(例如:臭蟲追蹤系統、討論區、電子郵件信箱等等)。技術支援網址將會顯示在腳本的反饋頁。
- §
@contributionURL
- 腳本作者的捐贈網址。捐贈網址會顯示在腳本的意見回饋頁。網址可以是 http、https 或者比特幣協定網址。例如:要連結到 PayPal 捐贈頁面,可使用 https://www.paypal.com/cgi-bin/[email protected]&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
- 披露會為腳本作者而非使用者帶來額外收益的功能。你可以透過在腳本的元數據中添加
@antifeature 類型 描述
值的方法披露。其中類型是必須填寫的內容,而 描述則可以留空。點擊此處瞭解 Sleazy Fork 讀取的 類型的相關信息。 - §
@antifeature:XX-YY
- 你可以使用多種語言來聲明
@antifeature
屬性,其中 XX 為 ISO 639-1 中定義的兩字母代碼,而 YY 指可選的 ISO 3166 地區代碼。@antifeature
會根據使用者瀏覽的語言而被蓋過。