Skip to content

Commit c7e6646

Browse files
committed
Update document according to jeremyn's suggestion
1 parent 9b5a0ad commit c7e6646

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

docs/en_US/rulesets.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,12 @@ The "host" parameter is a regexp specifying which domains should have their cook
7575

7676
We use an [automated checker](https://github.com/hiviah/https-everywhere-checker) to run some basic tests on all rulesets. This is described in more detail in our [Ruleset Testing](https://github.com/EFForg/https-everywhere/blob/master/ruleset-testing.md) document, but in short there are two parts: Your ruleset must have enough test URLs to cover all the various types of URL covered by your rules. And each of those test URLs must load, both before rewriting and after rewriting. Every target host tag generates an implicit test URL unless it contains a wildcard. You can add additional test URLs manually using the `<test url="..."/>` tag. The test URLs you add this way should be real pages loaded from the site, or real images, CSS, and Javascript if you have rules that specifically affect those resources.
7777

78-
Previously, you can manually test the ruleset by placing it in the `HTTPSEverywhereUserRules/` subdirectory in [the Firefox profile directory](http://kb.mozillazine.org/Profile_folder_-_Firefox), and then restarting Firefox. However, this feature is no longer supported and will not be supported with the HTTPS Everywhere WebExtensions. This is because there is no longer any way to do arbitrary file reads from within WebExtensions.
78+
You can test rulesets in the browser using a hidden debugging page, but please be aware that this approach should only be used for debugging purposes and should not be used for setting up personal custom rules. You can access the hidden debugging page this way:
7979

80-
Currently, you can still do the testing using a hidden debugging page, but please be aware that this approach should only be used for debugging purposes and should not be used for setting up personal custom rules. You can access the hidden debugging page in Firefox through `about:addons` > HTTPS Everywhere preferences > click under `General Settings` > press <kbd>Ctrl-Z</kbd>, or in Chrome by pressing <kbd>Ctrl-Z</kbd> in the equivalent place. It doesn't appear to work in the current version of the Tor Browser, however.
80+
* Firefox: `about:addons` > HTTPS Everywhere preferences > click under `General Settings` > press <kbd>Ctrl-Z</kbd>
81+
* Chromium/Chrome: `chrome://extensions/` > HTTPS Everywhere options > click under `General Settings` > press <kbd>Ctrl-Z</kbd>
82+
83+
You might need to disable popup blocking for the page to appear. Once you have you loaded the page, you might find it convenient to bookmark it for later use.
8184

8285
If you&apos;ve tested your rule and are sure it would be of use to the world at large, submit it as a [pull request](https://help.github.com/articles/using-pull-requests/) on our [GitHub repository](https://github.com/EFForg/https-everywhere/) or send it to the rulesets mailing list at `https-everywhere-rules AT eff.org`. Please be aware that this is a public and publicly-archived mailing list.
8386

@@ -102,8 +105,4 @@ You can add more details, like a link to a bug report, in the comments for the f
102105

103106
Some rulesets may trigger active mixed content (i.e. scripts loaded over HTTP instead of HTTPS). This type of mixed content is blocked in both [Chrome](https://trac.torproject.org/projects/tor/ticket/6975) and Firefox, before HTTPS Everywhere has a chance to rewrite the URLs to an HTTPS version. This generally breaks the site. However, the Tor Browser doesn&apos;t block mixed content, in order to allow HTTPS Everywhere to try and rewrite the URLs to an HTTPS version.
104107

105-
To enable a rule only on platforms that allow mixed content (currently only the Tor Browser), you can add a `platform="mixedcontent"` attribute to the ruleset element.
106-
107-
#### [Rulesets](#rulesets)
108-
109-
For customized rules, one can still use the User Interface of HTTPS Everywhere, specifically, by clicking on the HTTPS Everywhere icon and then click `Add a rule for this site`.
108+
To enable a rule only on platforms that allow mixed content (currently only the Tor Browser), you can add a `platform="mixedcontent"` attribute to the ruleset element.

0 commit comments

Comments
 (0)