这里有 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
- 脚本的版本标记将使用 Mozilla 版本格式 并显示于脚本的简介页面。Greasy Fork 要求填写该属性,且当用户更新脚本时没有更新版本号或降低了版本号时将发出警告。
- §
@include
,@exclude
,@match
- 描述脚本将执行的页面。该列表会被分析并展示到脚本的简介页面,以及用于脚本分类。
- §
@require
- 若需引用外部脚本到您的脚本,请参见 包含外部脚本的使用规定。
- §
@updateURL
,@installURL
,@downloadURL
- 告知用户脚本管理器应该在哪个地址获取脚本更新。Greasy Fork 将自动修改该属性使其永远通过 Greasy Fork 进行更新。
- §
@license
- 脚本所使用的许可协议名称或地址,该协议需包含用户是否允许二次分发或修改脚本的权利。不提供许可协议则表示用户仅允许个人使用且不得二次分发;该协议将在脚本的简介页面显示。
- §
@supportURL
- 用户可获得该脚本技术支持的链接地址 (如:错误反馈系统、论坛、电子邮件),该链接将显示在脚本的反馈页面。
- §
@contributionURL
- 用于捐赠脚本作者的链接,该链接将显示在脚本的反馈页面。网址可以为 http、https 或比特币协议的网址。如果您需要链接到贝宝捐赠页面,请使用例如 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
。 - §
@incompatible
- 标记此脚本与某个浏览器不兼容,兼容性信息将显示在脚本的简介页面上。您也可以添加额外的兼容说明,如
@incompatible firefox 自火狐 23 开始不兼容
这样的写法。目前能被网站识别的浏览器名称有:firefox
,chrome
,opera
,safari
。