From 9fe227b419c64068c0774a13ac17ca0b92d9e312 Mon Sep 17 00:00:00 2001 From: girst Date: Sun, 22 Nov 2020 16:43:11 +0100 Subject: [PATCH] Update documentation - remove outdated information - fix link tag spelling - document userchrome pref - note Nightly Fission experiment --- documentation/CONTRIBUTING-CODE.md | 7 ++----- documentation/config-file.md | 2 +- documentation/known-bugs.md | 23 +++++++++++++---------- documentation/questions-and-answers.md | 22 ---------------------- documentation/styling.md | 17 +++++++++++------ documentation/tools.md | 3 ++- 6 files changed, 29 insertions(+), 45 deletions(-) diff --git a/documentation/CONTRIBUTING-CODE.md b/documentation/CONTRIBUTING-CODE.md index 99d51d2..0c095ed 100644 --- a/documentation/CONTRIBUTING-CODE.md +++ b/documentation/CONTRIBUTING-CODE.md @@ -18,11 +18,9 @@ That’s completely OK. ## Code -Create a new topic branch, based on either master or develop. +Create a new topic branch. git checkout -b my-topic-branch master - # or - git checkout -b my-topic-branch develop Code! Try to follow these simple rules: @@ -52,7 +50,6 @@ Break up your pull request in several commits if necessary. The first line of commit messages should be a short summary. If needed, add a blank line and then a nicely formatted markdown description. -Finally send a pull request to same branch as you based your topic branch on -(master or develop). +Finally send a pull request. [tools.md]: tools.md diff --git a/documentation/config-file.md b/documentation/config-file.md index 42a62f2..64bc6fe 100644 --- a/documentation/config-file.md +++ b/documentation/config-file.md @@ -213,4 +213,4 @@ Weakening the sandbox by setting `security.sandbox.content.level` to 2 is not recommended, as this will open up a [potentially devastating security hole]. [undocumented prefs]: https://hg.mozilla.org/mozilla-central/file/c31591e0b66f277398bee74da03c49e8f8a0ede0/dom/ipc/ContentChild.cpp#l1701 -[potentially devesatating security hole]: https://bugzilla.mozilla.org/show_bug.cgi?id=1221148#c30 +[potentially devastating security hole]: https://bugzilla.mozilla.org/show_bug.cgi?id=1221148#c30 diff --git a/documentation/known-bugs.md b/documentation/known-bugs.md index 231de6d..041b723 100644 --- a/documentation/known-bugs.md +++ b/documentation/known-bugs.md @@ -21,17 +21,22 @@ The [new RDM] does not have this bug; it can be enabled by switching ## Fission -**Affected**: (future versions) +**Affected**: some Nightly users, future versions **Workaround**: `fission.autostart;false` With [Fission] enabled, VimFx can't inspect out-of-process iframes. -Fission is not (yet) turned on by default, but can be disabled by switching -`fission.autostart` to `false` in `about:config`. With Fission, VimFx cannot -place hint markers or determine whether an editable element is active in iframes -from a different domain to the top document. We will instead enter insert mode -whenever such an iframe is active (so input elements are usable; click outside -the iframe to let VimFx re-gain control). +Fission, sometimes called *Site Isolation*, is not (yet) turned on by default, +but can be disabled by switching `fission.autostart` to `false` in +`about:config`. With Fission, VimFx cannot place hint markers or determine +whether an editable element is active in iframes from a different domain to the +top document. We will instead enter insert mode whenever such an iframe is +active (so input elements are usable; hit Escape or click outside the iframe to +let VimFx re-gain control). + + For some as-of-yet undetermined reason, the addon sometimes breaks after installation (or upgrade). Fastest way to restart Firefox is pressing -`` to open the browser console, then `` to restart. -Alternatively, navigate to `about:profiles` and hit the *Restart normally* -button. +`` to open the browser console, then `` to restart. diff --git a/documentation/questions-and-answers.md b/documentation/questions-and-answers.md index 48dac51..59134e5 100644 --- a/documentation/questions-and-answers.md +++ b/documentation/questions-and-answers.md @@ -143,25 +143,3 @@ command to click without using the mouse. One of VimFx’s key features is to embrace standard Firefox features. As long as Firefox’s Find Bar doesn’t support for example reverse search (Vim’s `?` command) or regex search, VimFx won’t either. - -## Switching between tabs works oddly when [NoScript] is installed! - -This is a [known bug][noscript-bug] in NoScript. To work around it, either -switch to multi-process Firefox or set `noscript.clearClick.rapidFireCheck` to -`false` in [about:config]. - -You’re not really missing out security-wise by disabling -`noscript.clearClick.rapidFireCheck`. All it does is preventing one specific, -less common type of “clickjacking” attack, that isn’t even mentioned in -NoScript’s [ClearClick] documentation. It is, however, quickly mentionend in a -[blog post][hackademix-clickjacking] by NoScript’s author (which links to -another site explaining the attack in more detail). - -See also [issue 588]. - -[NoScript]: https://noscript.net/ -[noscript-bug]: https://forums.informaction.com/viewtopic.php?f=10&t=21597 -[about:config]: http://kb.mozillazine.org/About:config -[ClearClick]: https://noscript.net/faq/#clearclick -[hackademix-clickjacking]: https://hackademix.net/2011/07/11/fancy-clickjacking-tougher-noscript/ -[issue 588]: https://github.com/akhodakivskiy/VimFx/issues/588 diff --git a/documentation/styling.md b/documentation/styling.md index 7c96480..e5e300a 100644 --- a/documentation/styling.md +++ b/documentation/styling.md @@ -4,10 +4,14 @@ It is possible to change the style of VimFx’s hint markers (such as the font size), help dialog and button with CSS. In fact, using the techniques shown here you can re-style almost _any_ part of Firefox. -1. Copy stuff from the below examples or from [style.css] into [userChrome.css] - or a new [Stylish] style. You get far just by copying and pasting. +1. Copy stuff from the below examples or from [style.css] into [userChrome.css]. + You get far just by copying and pasting. -2. Make sure that the following code is at the top of the file: +2. Since Firefox 69, you must set + `toolkit.legacyUserProfileCustomizations.stylesheets` in `about:config` to + `true`. + +3. Make sure that the following code is at the top of the file: ```css @namespace url(http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul); @@ -15,15 +19,16 @@ you can re-style almost _any_ part of Firefox. It makes sure that your CSS only affects the browser UI and not web pages. -3. Adjust the CSS to your likings. Make sure to end lines with `!important;`, so +4. Adjust the CSS to your likings. Make sure to end lines with `!important;`, so that they override VimFx’s default styles properly. If you use `userChrome.css` you need to restart Firefox for your changes to take -effect, while Stylish applies them instantly. +effect. Since Firefox 69, you have to enable `userChrome.css` by setting +`toolkit.legacyUserProfileCustomizations.stylesheets` to `true` in +`about:config`. [style.css]: ../extension/skin/style.css [userChrome.css]: http://kb.mozillazine.org/UserChrome.css -[Stylish]: https://addons.mozilla.org/firefox/addon/stylish/ ## Examples diff --git a/documentation/tools.md b/documentation/tools.md index 971d812..cc8958b 100644 --- a/documentation/tools.md +++ b/documentation/tools.md @@ -160,7 +160,8 @@ Run `./release` with argument `minor` or `patch`, which does the following for y - Updates the version in `package.json`. - Adds a heading with the new version number and today’s date at the top of - `CHANGELOG.md`. + `CHANGELOG.md`, and the summary of commits since the last version. Then + opens an editor and waits to let you modify the changelog. - Commits `CHANGELOG.md` and `package.json`. - Tags the commit. - Lints the code and builds an xpi. -- 2.39.3