Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Terminology and formatting changes #6

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

geoff2k
Copy link

@geoff2k geoff2k commented Jun 2, 2024

Raison d'être

I'm a recent qBittorrent user and use keyboard shortcuts whenever I can. Searches using terms like "qbittorrent keyboard shortcuts" surprisingly did not point me to any official documentation, as the official documentation had the shortcut in a section called "Hotkeys".

I made the following changes:

  • changing the header from "HotKeys" to both include the term "keyboard shortcuts" and be a question to be consistent with the other headers
  • improving (IMO) the section on cfprefsd for OSX
  • Fixing some formatting consistency (punctuation, whitespace)
  • Slight wording changes that read better (mostly pluralization)
  • And most importantly: uppercase the B in qBittorrent 😉

@@ -42,15 +42,15 @@ If not, please file a request at your GNU/Linux distribution's issue tracker.

== Is it legal to use qBittorrent? ==
qBittorrent is a peer to peer (P2P) file sharing software.<br />
Although the software is '''perfectly legal''', it may be illegal to download restricted content with this software, depending on the law in your country.
Although the software is '''perfectly legal''', it may be illegal to download restricted content with this software, depending on the laws in your country.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe "law" is an appropriate term as it is used in the meaning of "legislation", IIRC.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be a regionalism. FWIW, to my Canadian/US ear "laws in your country" just sounds right , but I don't have a style guide reference to point to. Per google the "laws" version appears in 3.9MM pages, and the "law" version appears in 900k. Can redact.

@@ -129,7 +128,7 @@ Light theme:
* Black for torrents in allocating or stalled(up and down) status
* Royal Blue (rgb(65, 105, 225)) for torrents in uploading or forced uploading status
* Salmon (rgb(250, 128, 114)) for torrents in paused(downloading) status
* Dark Blue (rgb(0, 0, 139)) for torrents in completed (paused seeding) status
* Dark Blue (rgb(0, 0, 139)) for torrents in completed(paused seeding) status
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't believe that omiting space in this case is correct punctuation.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's consistent with the other uses in this list (e.g. lines 131, 129) and the inconsistency stood out to me. Should I change all the others to have a space as well?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I change all the others to have a space as well?

IMO, yes (except inappropriate cases like rgb(0, 0, 139)).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in e4a6e9f

@@ -138,15 +137,15 @@ Dark theme:
* Gray 80 (rgb(204, 204, 204)) for torrents in allocating or stalled(up and down) status
* Steel Blue 1 (rgb(99, 184, 255)) for torrents in uploading or forced uploading status
* Salmon (rgb(250, 128, 114)) for torrents in paused(downloading) status
* Steel Blue 3 (rgb(79, 148, 205)) for torrents in completed (paused seeding) status
* Steel Blue 3 (rgb(79, 148, 205)) for torrents in completed(paused seeding) status
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same as above.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(ditto) 😄

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in e4a6e9f

@@ -271,7 +270,7 @@ A Dutch step by step tutorial can be found [https://www.duken.nl/forums/handleid

See [https://web.archive.org/web/20090320211618/http://btfaq.com:80/serve/cache/23.html this page] for definitions of BitTorrent terms.

== Hotkeys ==
== What hotkeys/keyboard shortcuts are available? ==
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This list is incomplete IIRC.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair -- could we get this version out and then create an issue to fill out the list? If those are already documented somewhere, happy to pull them in, but if it requires code-discovery, I'd like to punt that effort if possible.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can change the description as you see fit if you want

Ctrl+F = Toggle focus between "Filter torrents..." and "Filter files..." also applies in search engine and new torrent dialog
Ctrl+E = same as above except for new torrent dialog

When focused in:
Peer list:
Ctrl+C = Copy all selected peers in this form "IP:PORT" one per line
Del = Ban peer

HTTP sources:
Del = Delete selected URL sources
F2 = Edit selected URL sources

RSS:
F2 = Edit selected rule/feed
Del = Delete selected rule/feed

Content:
Enter/Return = Open file/folder
F2 = Rename file/folder

Trackers:
F2 = Edit tracker (only the last one during multi-selection)
Del = Delete selected trackers
Ctrl+C = Copy selected trackers URLs

Transfer list:
Shift+Del = Delete torrent+files
Enter/Return = Double click action
Ctrl+M = Force start selected torrents (looks like Mac uses the same hotkey for minimize)

Everywhere:
F1 (or Ctrl+? for Mac) = Open the wiki page
Ctrl+i = Open statistics dialog
Alt+1 = Transfer list tab
Alt+2 = Search engine tab
Alt+3 = RSS tab

Bonus:
Ctrl + B = browse to a location in some fields (wasn't everywhere some time ago, not sure now)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants