Skip to content

Commit

Permalink
- Shortcuts window:
Browse files Browse the repository at this point in the history
  * implementing "r" (load saved) and "d" (load default)
  * TAB is not accepted as a shortcut
  * digits (1-9) will be asscpted
  * the window will close only by pressing the Cancel button
- DEVEL: updating what_tag to use get__shortcuts_and_classes.py
- updating docs
  • Loading branch information
s-n-g committed Dec 4, 2024
1 parent 874e1f1 commit 308dbb1
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ <h2 id="table-of-contents">Table of Contents <span style="padding-left: 10px;"><
<li><a href="#controls">Controls</a>
<ul>
<li><a href="#global-shortcuts">Global shortcuts</a></li>
<li><a href="#customizing-key-bindings">Customizing key bindings</a></li>
</ul></li>
<li><a href="#html-help">HTML help</a></li>
<li><a href="#pyradio-modes">PyRadio Modes</a>
Expand Down Expand Up @@ -142,6 +143,7 @@ <h2 id="table-of-contents">Table of Contents <span style="padding-left: 10px;"><
<ul>
<li><a href="#remote-control-client">Remote Control Client</a></li>
</ul></li>
<li><a href="#playing-a-station-in-the-terminal">Playing a station in the terminal</a></li>
<li><a href="#debug-mode">Debug mode</a></li>
<li><a href="#reporting-bugs">Reporting bugs</a></li>
<li><a href="#packaging-pyradio">Packaging PyRadio</a></li>
Expand All @@ -159,6 +161,7 @@ <h2 id="features">Features <span style="padding-left: 10px;"><sup style="font-si
<li>Station editor (add/edit) with <a href="#cjk-characters-support">CJK characters support</a></li>
<li>Configuration editor</li>
<li>Search function</li>
<li>Customizable key bindings</li>
<li>Easy installation / updating</li>
<li>Runs on Linux, macOS and Windows</li>
</ul>
Expand All @@ -184,6 +187,13 @@ <h2 id="requirements">Requirements <span style="padding-left: 10px;"><sup style=
<h2 id="changelog">Changelog <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
<pre style="height: 200px;">

2024-10-17 s-n-g
* version 0.9.3.11.2 (BUG FIX) - 0.9.3.12-beta2
* Implementing the Shortcuts Window, making it possible to customize
PyRadio's key bindings
* fixing install.py (#262)
* implementing #252

2024-10-17 s-n-g
* version 0.9.3.11.1 (BUG FIX) - 0.9.3.12-beta1
* adding -sdd (--show_dirs) command line parameter
Expand Down Expand Up @@ -1319,9 +1329,9 @@ <h2 id="installation">Installation <span style="padding-left: 10px;"><sup style=
Furthermore, please refrain from using any third-party packaging methods, such as <strong>Snap</strong> or <strong>AppImage</strong>. I am not affiliated with these services or projects, and I cannot guarantee the functionality or version of <strong>PyRadio</strong> provided through them. Additionally, I am unable to offer support for any issues related to these packaging methods.</p>
<h2 id="command-line-options">Command line options <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
<pre># pyradio -h
Usage: pyradio [-h] [-c CONFIG_DIR] [-p [STATION_NUMBER]] [-u PLAYER] [-l]
[-lt] [-sds] [-sd] [-od] [-pc] [-d] [-ul] [-us] [-U] [-R] [-V]
[-ls] [-s PLAYLIST] [-tlp] [-t THEME] [--show-themes]
Usage: pyradio [-h] [-c CONFIG_DIR] [-p [STATION_NUMBER]] [-x] [-u PLAYER]
[-l] [-lt] [-sds] [-sd] [-od] [-pc] [-d] [-ul] [-us] [-U] [-R]
[-V] [-ls] [-s PLAYLIST] [-tlp] [-t THEME] [--show-themes]
[--no-themes] [--write-theme IN_THEME OUT_THEME,]
[--terminal TERMINAL] [--terminal-param TERMINAL_PARAM] [-oc]
[-sc] [-cc] [-gc] [-r] [-or] [-lr] [-mkv MKV_FILE]
Expand All @@ -1339,6 +1349,9 @@ <h2 id="command-line-options">Command line options <span style="padding-left: 10
-p [STATION_NUMBER], --play [STATION_NUMBER]
Start and play.The value is num station or empty for
random.
-x, --external-player
Play station in external player. Can be combined with
--play.
-u PLAYER, --use-player PLAYER
Use specified player. A comma-separated list can be
used to specify detection order. Supported players:
Expand Down Expand Up @@ -1437,6 +1450,7 @@ <h2 id="command-line-options">Command line options <span style="padding-left: 10
a message that it is already running).
</pre>
<h2 id="controls">Controls <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
<p>The following list shows a <strong>default</strong> key bindings list used within the program.</p>
<pre> Main window Playlists window Themes window
-------------------------------------------------------------------------------------------------------------------------------------
Up/Down/j/k/
Expand Down Expand Up @@ -1529,6 +1543,9 @@ <h3 id="global-shortcuts">Global shortcuts</h3>
<p><strong>Notes</strong></p>
<p class="indented">[1] Function not available when in <strong>Playlist</strong> and <strong>Registers</strong> mode. More info on <em>PyRadio’s modes</em> below.</p>
<p class="indented">[2] Function not available in the <strong>RadioBrowser</strong> Search window.</p>
<h3 id="customizing-key-bindings">Customizing key bindings</h3>
<p><strong>PyRadio</strong> provides the possibility to customize the key bindings above.</p>
<p>Just open the configuration window and navigate to <strong>Keyboard Shortcuts</strong>. Please do read the help screen provided therein (press “*?” to get to it).</p>
<h2 id="html-help">HTML help <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
<p>While in <strong>PyRadio</strong> main window, one can open the HTML (offline) help using “<strong>\h</strong>”.</p>
<p>This is just a helper function for windows users who cannot use the man pages, but is still available for all platforms.</p>
Expand Down Expand Up @@ -2136,6 +2153,12 @@ <h2 id="remote-control-server">Remote Control Server <span style="padding-left:
<h3 id="remote-control-client">Remote Control Client</h3>
<p><strong>PyRadio</strong> comes with its own client, which will make it easier to communicate with the <strong>Remote Control Server</strong>.</p>
<p>For more information, please refer to <a href="client.html">the relevant page</a>.</p>
<h2 id="playing-a-station-in-the-terminal">Playing a station in the terminal <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
<p>A user request <a target="_blank" href="https://github.com/coderholic/pyradio/issues/252">Shortcut to quit pyradio and launch standalone player (e.g. mpv) with currently selected station</a> lead to the possibility to use any player in the terminal.</p>
<p>This action will be triggered by pressing “<em>X</em>”.</p>
<p>After the player stops, <strong>PyRadio</strong> will stop as well.</p>
<p style="margin: 1.5em 4em 0 4em; text-indent: -2.5em;"><strong>Note:</strong> On Windows, <strong>mpv</strong> and <strong>VLC</strong> will open a new player window instead of executing in the terminal.</p>
<p>In addition, a command line parameter has been added “<em>-x</em>” (“<em>–exteranl-player</em>”) which when used in conjuction with the “<em>-p</em>” (“<em>–play</em>”) command line parameter, will instruct <strong>PyRadio</strong> to play a station and terminate after the playback stops.</p>
<h2 id="debug-mode">Debug mode <span style="padding-left: 10px;"><sup style="font-size: 50%"><a href="#" title="Go to top of the page">Top</a></sup></span></h2>
<p>Adding the “<strong>-d</strong>” option to the command line will instruct <strong>PyRadio</strong> to enter <em>Debug mode</em>, which means that it will print debug messages to a file. This file will always reside in the user’s home directory and will be named <em>pyradio.log</em>.</p>
<p>In case of a bug or a glitch, please include this file to the issue you will <a target="_blank" href="https://github.com/coderholic/pyradio/issues">open at github</a>.</p>
Expand Down

0 comments on commit 308dbb1

Please sign in to comment.