summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFlorian Bruhin <me@the-compiler.org>2022-12-13 09:05:32 +0100
committerFlorian Bruhin <me@the-compiler.org>2022-12-13 09:05:32 +0100
commitb4d32e04f42d0c4994a234105f01aabe0aba6ce0 (patch)
tree388355af97e3c41020a1c996bac844dbcf4bae6b /doc
parentac761234c9de65bd6b25ae8b2eeae0828c98a99c (diff)
parent5afc8a68191160f8d5c74b92874a0032d3c1996e (diff)
downloadqutebrowser-b4d32e04f42d0c4994a234105f01aabe0aba6ce0.tar.gz
qutebrowser-b4d32e04f42d0c4994a234105f01aabe0aba6ce0.zip
Merge branch 'master' into qt6-v2
Diffstat (limited to 'doc')
-rw-r--r--doc/changelog.asciidoc29
-rw-r--r--doc/faq.asciidoc4
-rw-r--r--doc/install.asciidoc22
3 files changed, 25 insertions, 30 deletions
diff --git a/doc/changelog.asciidoc b/doc/changelog.asciidoc
index 6d740fe3f..c4fb2d106 100644
--- a/doc/changelog.asciidoc
+++ b/doc/changelog.asciidoc
@@ -127,6 +127,13 @@ Fixed
v2.5.3 (unreleased)
-------------------
+Added
+~~~~~
+
+- New `array_at` quirk, polyfilling the
+ https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/at[`Array.at` method],
+ which is needed by various websites, but only natively available with Qt 6.2.
+
Fixed
~~~~~
@@ -599,13 +606,13 @@ Changed
- When a shown message replaces an existing related one (e.g. for zoom levels),
the replacing now also works even if a different message was shown in between.
- The `.redirect(...)` method on interceptors now supports an
- `ignore_unsupported=True` argument which supresses exceptions if a request could
+ `ignore_unsupported=True` argument which suppresses exceptions if a request could
not be redirected. Note, however, that it is still not public API.
- When the `--config-py` argument is used, no warning about a missing
`config.load_autoconfig` is shown anymore, as the argument is typically used
for temporarily testing a config.
- The internal `_autosave` session used for crash recovery is now only saved
- once per minute, since saving it for every page load is a noticable performance
+ once per minute, since saving it for every page load is a noticeable performance
issue.
- The `readability-js` userscript now displays a small header with page
information.
@@ -1033,7 +1040,7 @@ Changed
- `config.py` files now are required to have either
`config.load_autoconfig(False)` (don't load `autoconfig.yml`) or
`config.load_autoconfig()` (do load `autoconfig.yml`) in them.
-- Various host-blocking settings have been renamed to accomodate the new ABP-like
+- Various host-blocking settings have been renamed to accommodate the new ABP-like
adblocker:
* `content.host_blocking.enabled` -> `content.blocking.enabled` (controlling both blockers)
* `content.host_blocking.whitelist` -> `content.blocking.whitelist` (controlling both blockers)
@@ -1209,11 +1216,11 @@ Fixed
~~~~~
- Setting the `content.headers.referer` setting to `same-domain` (the default)
- was supposed to truncate referers to only the host with QtWebEngine.
+ was supposed to truncate referrers to only the host with QtWebEngine.
Unfortunately, this functionality broke in Qt 5.14. It works properly again
with this release, including a test so this won't happen again.
- With QtWebEngine 5.15, setting the `content.headers.referer` setting to
- `never` did still send referers. This is now fixed as well.
+ `never` did still send referrers. This is now fixed as well.
- In v1.14.0, a regression was introduced, causing a crash when qutebrowser was
closed after opening a download with PDF.js. This is now fixed.
- With Qt 5.12, the `Object.fromEntries` JavaScript API is unavailable (it was
@@ -1230,7 +1237,7 @@ Fixed
conversion was shown. This is now fixed.
- Ever since Qt 5.11, fetching more completion data when that data is loaded
lazily (such as with history) and the last visible item is selected was broken.
- The exact reason is currently unknown, but this release adds a tenative fix.
+ The exact reason is currently unknown, but this release adds a tentative fix.
- When PgUp/PgDown were used to go beyond the last visible item, the above issue
caused a crash, which is now also fixed.
- As a workaround for an overzealous Microsoft Defender false-positive detecting
@@ -1346,9 +1353,9 @@ Changed
which fixes issues with e.g. formulas on Wikipedia.
- The `readability-js` userscript now adds some CSS to improve the reader mode
styling in various scenarios:
- * Images are now shrinked to the page width, similarly to what Firefox' reader
+ * Images are now shrunk to the page width, similarly to what Firefox' reader
mode does.
- * Some images ore now displayed as block (rather than inline) which is what
+ * Some images are now displayed as block (rather than inline) which is what
Firefox' reader mode does as well.
* Blockquotes are now styled more distinctively, again based on the Firefox
reader mode.
@@ -3170,7 +3177,7 @@ Fixed
- Fix workaround for black screens or crashes with Nvidia cards
- Handle a filesystem going read-only gracefully
- Fix crash when setting `fonts.monospace`
-- Fix list options not being modifyable via `.append()` in `config.py`
+- Fix list options not being modifiable via `.append()` in `config.py`
- Mark the content.notifications setting as QtWebKit only correctly
- Fix wrong rendering of keys like `<back>` in the completion
@@ -3206,7 +3213,7 @@ Major changes
* New dependency on the QtSql module and Qt sqlite support.
* New dependency on the https://www.attrs.org/[attrs] project (packaged as
`python-attr` in some distributions).
- * The depedency on PyOpenGL (when using QtWebEngine) got removed. Note
+ * The dependency on PyOpenGL (when using QtWebEngine) got removed. Note
that PyQt5.QtOpenGL is still a dependency.
* PyQt5.QtOpenGL is now always required, even with QtWebKit.
- The QtWebEngine backend is now used by default. Note this means that
@@ -4427,7 +4434,7 @@ Changed
* Add `-s`/`--space` argument to `:set-cmd-text` (as `:set-cmd-text "foo "` will now set the literal text `"foo "`)
- Ignore `;;` for splitting with some commands like `:bind`.
- Add unbound (new) default keybindings to config. This also adds a new `<unbound>` special command.
- * To unbind a command keybinding without binding it to a new key, you now have to bind it to `<unbound>` or it'll be readded automatically.
+ * To unbind a command keybinding without binding it to a new key, you now have to bind it to `<unbound>` or it'll be re-added automatically.
- If an SSL error is raised multiple times with the same error/certificate/host/scheme/port, the user is only asked once.
- Jump to last instead of first item when pressing Shift-Tab the first time in the completion.
- Add a fullscreen keybinding.
diff --git a/doc/faq.asciidoc b/doc/faq.asciidoc
index bcbd0d29a..61f787d3d 100644
--- a/doc/faq.asciidoc
+++ b/doc/faq.asciidoc
@@ -170,7 +170,7 @@ text/html; qutebrowser %s; needsterminal; nametemplate=%s.html
----
+
Note that you might want to add additional options to qutebrowser, so that it
-runs as a seperate instance configured to disable JavaScript and avoid network
+runs as a separate instance configured to disable JavaScript and avoid network
requests, in order to avoid privacy leaks when reading mails. The easiest way
to do so is by specifying a non-existent proxy server, e.g.:
+
@@ -376,7 +376,7 @@ There is a total of four possible approaches to get dark websites:
How do I make copy to clipboard buttons work?::
You can `:set content.javascript.clipboard access` to allow this globally (not
-recommended!), or `:set -u some.domain content.javascript.clipboad access` if
+recommended!), or `:set -u some.domain content.javascript.clipboard access` if
you want to limit the setting to `some.domain`.
diff --git a/doc/install.asciidoc b/doc/install.asciidoc
index 4b1d5bfff..da211d850 100644
--- a/doc/install.asciidoc
+++ b/doc/install.asciidoc
@@ -48,7 +48,7 @@ instructions!
Note you'll need some basic libraries to use the virtualenv-installed PyQt:
----
-# apt install --no-install-recommends git ca-certificates python3 python3-venv asciidoc libglib2.0-0 libgl1 libfontconfig1 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-shape0 libxcb-xfixes0 libxcb-xinerama0 libxcb-xkb1 libxkbcommon-x11-0 libdbus-1-3 libyaml-dev gcc python3-dev libnss3 libasound2
+# apt install --no-install-recommends git ca-certificates python3 python3-venv libglib2.0-0 libgl1 libfontconfig1 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-shape0 libxcb-xfixes0 libxcb-xinerama0 libxcb-xkb1 libxkbcommon-x11-0 libdbus-1-3 libyaml-dev gcc python3-dev libnss3 libasound2
----
// FIXME not needed anymore?
@@ -72,7 +72,7 @@ qutebrowser in a virtualenv>> with a newer PyQt/Qt binary instead.
Note you'll need some basic libraries to use the virtualenv-installed PyQt:
----
-# apt install --no-install-recommends git ca-certificates python3 python3-venv asciidoc libglib2.0-0 libgl1 libfontconfig1 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-shape0 libxcb-xfixes0 libxcb-xinerama0 libxcb-xkb1 libxkbcommon-x11-0 libdbus-1-3 libyaml-dev gcc python3-dev libnss3 libasound2
+# apt install --no-install-recommends git ca-certificates python3 python3-venv libglib2.0-0 libgl1 libfontconfig1 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-shape0 libxcb-xfixes0 libxcb-xinerama0 libxcb-xkb1 libxkbcommon-x11-0 libdbus-1-3 libyaml-dev gcc python3-dev libnss3 libasound2
----
Ubuntu 20.04 LTS / Linux Mint 20 (or newer)
@@ -93,7 +93,7 @@ Additional hints
this for you):
+
----
-# apt install --no-install-recommends asciidoc
+$ pip install -r misc/requirements/requirements-docs.txt # or install asciidoc manually
$ python3 scripts/asciidoc2html.py
----
@@ -292,7 +292,7 @@ Nightly builds
If you want to test out new features before an official qutebrowser release, automated
https://github.com/qutebrowser/qutebrowser/actions/workflows/nightly.yml[nightly
-builds] are available. To download them, open the lastest run (usually the first one),
+builds] are available. To download them, open the latest run (usually the first one),
then download the archive at the bottom of the page.
Those builds also include variants with debug logging enabled, which can be useful to
@@ -369,7 +369,7 @@ Nightly builds
If you want to test out new features before an official qutebrowser release, automated
https://github.com/qutebrowser/qutebrowser/actions/workflows/nightly.yml[nightly
-builds] are available. To download them, open the lastest run (usually the first one),
+builds] are available. To download them, open the latest run (usually the first one),
then download the archive at the bottom of the page.
Those builds also include variants with debug logging enabled, which can be useful to
@@ -514,18 +514,6 @@ You can create a simple wrapper script to start qutebrowser somewhere in your
~/path/to/qutebrowser/.venv/bin/python3 -m qutebrowser "$@"
----
-Building the docs
-~~~~~~~~~~~~~~~~~
-
-To build the documentation, install `asciidoc` (note that LaTeX which comes as
-optional/recommended dependency with some distributions is not required).
-
-Then, run:
-
-----
-$ python3 scripts/asciidoc2html.py
-----
-
Updating
~~~~~~~~