Include and exclude rules: Difference between revisions
No edit summary |
|||
| Line 1: | Line 1: | ||
[[User script]]s specify include and exclude rules in the [[metadata block]]. The script will execute if it matches any include rule, as long as it does not match an exclude rule. The rules are URLs, which can have a "wildcard" asterisk (*), which matches any string. For example: <code><nowiki>http://www.example.com/foo/*</nowiki></code> will match <code><nowiki>http://www.example.com/foo/bar</nowiki></code> and <code><nowiki>http://www.example.com/foo/</nowiki></code>, but not <code><nowiki>http://www.example.com/baz/</nowiki></code>. A rule can have several wildcards or none, in which case the rule must match the entire URL exactly. Exclude rules look the same, and prevent the script from being executed. An example: | [[User script]]s specify include and exclude rules in the [[metadata block]]. The script will execute if it matches any include rule, as long as it does not match an exclude rule. The rules are URLs, which can have a "wildcard" asterisk (*), which matches any string including the empty string. For example: <code><nowiki>http://www.example.com/foo/*</nowiki></code> will match <code><nowiki>http://www.example.com/foo/bar</nowiki></code> and <code><nowiki>http://www.example.com/foo/</nowiki></code>, but not <code><nowiki>http://www.example.com/baz/</nowiki></code>. A rule can have several wildcards or none, in which case the rule must match the entire URL exactly. Exclude rules look the same, and prevent the script from being executed. An example: | ||
// ==UserScript== | // ==UserScript== | ||
Revision as of 09:38, 24 February 2007
User scripts specify include and exclude rules in the metadata block. The script will execute if it matches any include rule, as long as it does not match an exclude rule. The rules are URLs, which can have a "wildcard" asterisk (*), which matches any string including the empty string. For example: http://www.example.com/foo/* will match http://www.example.com/foo/bar and http://www.example.com/foo/, but not http://www.example.com/baz/. A rule can have several wildcards or none, in which case the rule must match the entire URL exactly. Exclude rules look the same, and prevent the script from being executed. An example:
// ==UserScript== // @include http://www.example.com/foo/* // @include http://www.example.org/*.bar // @exclude http://www.example.com/foo/baz // ==/UserScript==
If no include rule is provided, @include * is assumed. That is, every URL will be matched.
Magic TLD
The only special syntax besides the wildcard is .tld. An include such as http://www.example.tld/* will match any top level domain, such as www.example.com, www.example.org, www.example.co.uk, and so on. One must be careful with this, to not accidentally leak data to a site that they did not mean to match. This list of tld:s includes a myriad of dual-segment tld:s (such as ca.us, aeroport.fr and kyoto.jp), beside the plain country or category codes (com, jp, se). For a full list see the Magic TLD page.
