油猴脚本API

油猴文档 本地开发调试设置 深入浅出 Greasemonkey 这个类似油猴，但是火狐上的，有pdf可下 跨页面传值的方式 跨页面传值-这个应该是操作storage

补充：设置chrome采用默认打印设置，静默打印不弹框

用户脚本头，用于放在脚本开头的注释部分，代表了脚本本身的一些信息，如在哪些页面被调用，有哪些权限等

The name of the script. 脚本名称

Internationalization is done by adding an appendix naming the locale. 国际化是通过添加一个命名区域的附录来完成的。(用于展示不同语言的脚本名称，见下面)

Code:

The namespace of the script. 脚本的命名空间

The script version. This is used for the update check, in case the script is not installed from userscript.org or TM has problems to retrieve the scripts meta data. 脚本版本。用于更新检查，以防不是从userscript.org 或 TM(即 tampermonkey 油猴本身) 安装脚本的用户在检索脚本元数据时遇到问题。

The scripts author. 脚本作者

A short significant description. 简短而有意义的描述。

Internationalization is done by adding an appendix naming the locale. 国际化是通过添加一个命名语言环境的附录来完成的(如下:)

Code:

The authors homepage that is used at the options page to link from the scripts name to the given page. Please note that if the @namespace tag starts with 'http://' its content will be used for this too. 用于设置访问脚本作者主页的链接，位于油猴的控制面板对应脚本的主页项。请注意，如果@namespace标记以“http://”开头，则其内容也将用于此目的。

The script icon in low res. 低分辨率的脚本图标。

This scripts icon in 64x64 pixels. If this tag, but @icon is given the @icon image will be scaled at some places at the options page. 此脚本图标为64x64像素。如果这个标签，但是给了 @icon ，@icon 图像将在选项页的某些地方缩放。？？？

An update URL for the userscript. Note: a @version tag is required to make update checks work. 用户脚本的更新URL。 注意：需要 @version 标记才能进行更新检查。

Defines the URL where the script will be downloaded from when an update was detected. If the value none is used, then no update check will be done. 定义检测到更新时将从中下载脚本的URL。如果使用值none，则不会执行更新检查。

Defines the URL where the user can report issues and get personal support. 定义用户可以在其中报告问题和获得个人支持的URL。

The pages on that a script should run. Multiple tag instances are allowed. Please note that @include doesn't support the URL hash parameter. You have to match the path without the hash parameter and make use of window.onurlchange

脚本应该运行的页面。允许多个标记实例。 请注意，@include不支持URL散列参数(即URL中带有md5之类的参数，用来检查URL指定的文件是否匹配)。必须匹配不带哈希参数的路径，同时要使用 window.onurlchange(监听url改变的权限，见@grant部分)

Code:

More or less equal to the @include tag. You can get more information here . Note: the '' statement is not yet supported and the scheme part also accepts 'http*😕/'.

Multiple tag instances are allowed.

类似于@include标记。更多信息 注意：尚不支持“”语句，并且方案部分也接受“http*：//”。

允许多个标记实例。

@match 和 @include 是有一点区别的 match更严格一点，它对 * 的含义设定了更严格的规则，具体怎么个严格法？鬼知道

Exclude URLs even it they are included by @include or @match . Multiple tag instances are allowed.

排除URL，即使它们被@include或@match包含。 允许多个标记实例。

Points to a JavaScript file that is loaded and executed before the script itself starts running. Note: the scripts loaded via @require and their "use strict" statements might influence the userscript's strict mode!

指定在脚本本身开始运行之前就要加载并执行的JavaScript文件。 注意：通过@require加载的脚本及其“use strict”语句可能会影响用户脚本的严格模式！

Code:

Please check the sub-resource integrity section for more information how to ensure integrity. Multiple tag instances are allowed. 有关如何确保完整性的更多信息，请查看子资源完整性部分。允许多个标记实例。

Preloads resources that can by accessed via GM_getResourceURL and GM_getResourceText by the script. 预加载可以通过脚本通过GM_getResourceURL和GM_getResourceText访问的资源。

Code:

Please check the sub-resource integrity section for more information how to ensure integrity. Multiple tag instances are allowed. 有关如何确保完整性的更多信息，请查看子资源完整性部分。允许多个标记实例。

This tag defines the domains (no top-level domains) including subdomains which are allowed to be retrieved by GM_xmlhttpRequest 此tag用于定义域名（不包括顶级域），包括允许GM_xmlhttpRequest检索的子域

Code:

can have the following values: 可选值如下

If it's not possible to declare all domains a userscript might connect to then it's a good practice to do the following: Declare all known or at least all common domains that might be connected by the script. This way the confirmation dialog can be avoided for most of the users. 如果无法声明用户脚本可能连接到的所有域，那么最好执行以下操作： 声明脚本可能连接的所有已知域或至少所有公共域。这样可以避免大多数用户使用确认对话框。

Additionally add "@connect *" to the script. By doing so Tampermonkey will still ask the user whether the next connection to a not mentioned domain is allowed, but also offer a "Always allow all domains" button. If the user clicks at this button then all future requests will be permitted automatically. 另外在脚本中添加“@connect *”。这样做，Tampermonkey仍然会询问用户是否允许下一次连接到未提及的域，但也会 提供一个“始终允许所有域”按钮。如果用户单击此按钮，则将自动允许所有未来的请求。

Users can also whitelist all requests by adding '*' to the user domain whitelist at the script settings tab. 用户还可以通过将“*”添加到“脚本设置”选项卡上的“用户域白名单”来将所有请求列入白名单。

Notes:

注意： 初始和最终的网址都将被检查！ 为了向后兼容，@domain标记也一如既往地进行了解析。

Multiple tag instances are allowed. 允许多个标记实例。

Defines the moment the script is injected. In opposition to other script handlers, @run-at defines the first possible moment a script wants to run. This means it may happen, that a script that uses the @require tag may be executed after the document is already loaded, cause fetching the required script took that long. Anyhow, all DOMNodeInserted and DOMContentLoaded events that happended after the given injection moment are cached and delivered to the script when it is injected.

定义注入脚本的时刻。与其他脚本处理程序相反，@run at 定义了脚本想要运行的第一个可能时刻。这意味着可能会发生这样的情况：使用@require标记的脚本可能会在文档已经加载之后执行，因为获取所需的脚本需要很长时间。无论如何，在给定的注入时刻之后发生的所有 DOMNodeInserted 和 DOMContentLoaded 事件都会被缓存，并在注入脚本时传递给脚本。

Code:

The script will be injected as fast as possible. 脚本将尽快注入。

Code:

The script will be injected if the body element exists. 如果body元素存在，脚本将被注入。

Code:

The script will be injected when or after the DOMContentLoaded event was dispatched. 在调度DOMContentLoaded事件时或之后将注入脚本。

Code:

The script will be injected after the DOMContentLoaded event was dispatched. This is the default value if no @run-at tag is given. 在调度DOMContentLoaded事件之后，将注入脚本。如果没有给出@run at标记，这是默认值。

Code:

The script will be injected if it is clicked at the browser context menu (desktop Chrome-based browsers only). Note: all @include and @exclude statements will be ignored if this value is used, but this may change in the future.

如果在浏览器上下文菜单中单击脚本（仅限于基于Chrome的桌面浏览器），则会注入脚本。 注意：如果使用此值，所有@include和@exclude语句都将被忽略，但这可能会在将来更改。

@grant is used to whitelist GM_* functions, the unsafeWindow object and some powerful window functions. If no @grant tag is given TM guesses the scripts needs. @grant (授予)用于白名单 GM_* 函数、unsafeWindow 对象和一些强大的窗口函数。如果没有给@grant标记，TM 将猜测脚本需要什么。

Code:

Since closing and focusing tabs is a powerful feature this needs to be added to the @grant statements as well. If a script runs on a single-page application, then it can use window.onurlchange to listen for URL changes:

由于关闭和聚焦选项卡(浏览器页面)是一项强大的功能，因此需要将其添加到@grant语句中。 如果脚本在单页应用程序上运行，那么它可以使用 window.onurlchange 来侦听URL更改：

Code:

If @grant is followed by 'none' the sandbox is disabled and the script will run directly at the page context. In this mode no GM_* function but the GM_info property will be available. 如果@grant后跟着“none”，那么沙盒将被禁用，脚本将直接在页面上下文中运行。在这种模式下，没有 GM_* 函数，但是GM_info属性可用。

Code:

This tag allows script developers to disclose whether they monetize their scripts. It is for example required by GreasyFork. 这个标签允许脚本开发人员披露他们是否将脚本货币化(通过脚本盈利)。例如，GreasyFork 脚本网站 需要这个标签。

Syntax:

can have the following values:

Code:

Internationalization is done by adding an appendix naming the locale. 国际化是通过添加一个命名语言环境的附录来完成的(见前文说明)。

This tag makes the script running on the main pages, but not at iframes. 此标记使脚本在主页上运行，但不在iframe(即一个页面内嵌套的页面，详见html内容)上运行。

This tag is ignored because, it is not needed at Google Chrome/Chromium. 这个标签被忽略了，因为Google Chrome/Chromium不需要它。

At the moment TM tries to detect whether a script was written in knowledge of Google Chrome/Chromium by looking for the @match tag, but not every script uses it. That's why TM supports this tag to disable all optimizations that might be necessary to run scripts written for Firefox/Greasemonkey. To keep this tag extensible you can to add the browser name that can be handled by the script.

目前，TM通过查找@match标记来检测脚本是否是在Google Chrome/Chromium的规范下编写的，但并不是每个脚本都使用它。这就是为什么TM支持用这个标签来禁用所有的优化，因为为了能够运行那些专为 Firefox/Greasemonkey 编写的脚本这么做可能是必须的。如果要保持此标记的可扩展性，可以通过添加可由脚本处理的浏览器名称来实现。

Code:

The unsafeWindow object provides full access to the pages javascript functions and variables. unsafeWindow对象提供对页面的javascript函数和变量的完全访问。

子资源完整性

The hash component of the URL of @resource and @require tags can be used for this purpose. @resource和@require标记的URL的哈希组件可用于此目的。

Code:

TM supports MD5 hashes as a fallback natively, all other (SHA-1, SHA-256, SHA-384 and SHA-512) depend on window.crypto. In case multiple hashes (separated by comma or semicolon) are given the last currently supported one is used by TM. If the content of the external resource doesn't match the selected hash, then the resource is not delivered to the userscript. All hashes need to be encoded in hex or Base64 format.

TM 支持MD5哈希作为后备默认，所有其他哈希（SHA-1、SHA-256、SHA-384和SHA-512）依赖于window.crypto. 如果给出了多个散列（用逗号或分号分隔），则TM将使用当前支持的最后一个散列。如果外部资源的内容与所选哈希不匹配，则资源不会传递到用户脚本。所有哈希都需要以十六进制或Base64格式编码。

Adds the given style to the document and returns the injected style element. 将给定的样式添加到文档并返回注入的样式元素。

Creates an HTML element specified by 'tag_name' and applies all given 'attributes' and returns the injected HTML element. If a 'parent_node' is given, then it is attached to it or to document head or body otherwise. 创建一个由“tag_name”指定的HTML元素，应用所有给定的“属性”，并返回注入的HTML元素。如果给定了“父节点”，则它将附加到该节点否则附加到文档头或文档体。

For suitable 'attributes', please consult the appropriate documentation. For example: 合适的“属性”，请参阅相应的文档。例如：

Code:

Note: this feature is experimental and the API may change. 注意：此功能是实验性的，API可能会更改。

Deletes 'name' from storage. 从存储器中删除指定name(变量？)。

List all names of the storage. 列出存储的所有name(变量？)。

Adds a change listener to the storage and returns the listener ID. 'name' is the name of the observed variable. The 'remote' argument of the callback function shows whether this value was modified from the instance of another tab (true) or within this script instance (false). Therefore this functionality can be used by scripts of different browser tabs to communicate with each other.

将一个变动监听器添加到存储并返回监听器ID。 “name”是被监测变量的名称。 回调函数的“remote”参数显示此变量是从另一个选项卡的实例修改的（true），还是在此脚本实例中修改的（false）。 因此，浏览器不同选项卡的脚本可以使用此功能相互通信。

Removes a change listener by its ID. 删除指定ID的变动侦听器。

Set the value of 'name' to the storage. 设置指定变量的值

Get the value of 'name' from storage. 获取指定变量的值

Log a message to the console. 写日志到控制台

Get the content of a predefined @resource tag at the script header. 获取脚本开头预定义的@resource标签的内容。

Get the base64 encoded URI of a predefined @resource tag at the script header. 获取脚本开头处预定义的@resource标记的base64编码URI。

Register a menu to be displayed at the Tampermonkey menu at pages where this script runs and returns a menu command ID. 注册一个菜单显示在运行此脚本的页面上的Tampermonkey菜单上，并返回菜单命令ID。

Unregister a menu command that was previously registered by GM_registerMenuCommand with the given menu command ID. 取消注册上面注册的菜单命令，通过上面得到的命令ID

Open a new tab with this url. The options object can have the following properties: 使用此url打开新选项卡。options对象可以具有以下属性：

Otherwise the new tab is just appended. loadInBackground has the opposite meaning of active and was added to achieve Greasemonkey 3.x compatibility. If neither active nor loadInBackground is given, then the tab will not be focused. This function returns an object with the function close, the listener onclose and a flag called closed.

否则，将只是打开新选项卡。loadInBackground与active的含义相反，添加它是为了实现Greasemonkey 3.x(见前，一种专为火狐浏览器编写的脚本)兼容性。如果既不提供active也不提供loadInBackground，则选项卡将不会被聚焦。此函数返回一个对象，其中包含close函数、onclose侦听器和一个名为closed的标志。

Make an xmlHttpRequest. 进行xmlHttp请求

Property of details: details属性的详情

Returns an object with the following property: xmlHttp请求返回具有以下属性的对象：

Note: the synchronous flag at details is not supported 注意：details 不支持 同步 标志

Important: if you want to use this method then please also check the documentation about @connect. 重要提示：如果您想使用此方法，请同时查看有关@connect的文档。

Downloads a given URL to the local disk. 将给定的URL下载到本地磁盘。

details can have the following attributes: details 可以具有以下属性：

The download argument of the onerror callback can have the following attributes: 下载参数onerror 回调可以有以下属性

Returns an object with the following property: 下载请求返回具有以下属性的对象：

Depending on the download mode GM_info provides a property called downloadMode which is set to one of the following values: native, disabled or browser. 根据下载模式，GM_info 提供一个名为 downloadMode 的属性，该属性为以下值之一：native、disabled 或 browser。

Get a object that is persistent as long as this tab is open. 获取一个在选项卡打开期间能一直存在的(选项卡？)对象。

Save the tab object to reopen it after a page unload. 保存选项卡对象以在页面卸载后重新打开它

Get all tab objects as a hash to communicate with other script instances. 将所有选项卡对象作为散列获取，以便与其他脚本实例通信。

Shows a HTML5 Desktop notification and/or highlight the current tab. 显示HTML5桌面通知和/或突出显示当前选项卡。

details can have the following attributes: details 可以具有以下属性：

All parameters do exactly the same like their corresponding details property pendant. 所有参数的作用与其对应的details属性完全相同。

Copies data into the clipboard. The parameter info can be an object like "{ type: 'text', mimetype: 'text/plain'}" or just a string expressing the type ("text" or "html"). 将数据复制到剪贴板。参数 info 可以是一个类似于“{type:'text'，mimetype:'text/plain'}”的对象，也可以只是一个表示(一种)类型的字符串（"text"或"html"）。

Get some info about the script and TM. The object might look like this: 获取一些关于脚本和TM的信息。对象可能如下所示：

Code:

Tampermonkey supports this way of storing meta data. TM tries to automatically detect whether a script needs this compatibility option to be enabled. Tampermonkey支持这种存储元数据的方式。TM尝试自动检测脚本是否需要启用此兼容性选项。