Check-in [96814a40b4]
Overview
Comment: | Update configuration dialog help pages. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA1: |
96814a40b476ff77b6f01ded40b4ff27 |
User & Date: | mario on 2015-03-26 20:59:33 |
Other Links: | manifest | tags |
Context
2015-03-27
| ||
19:33 | Experimental plugin for bookmarking stations in RadioTray. (Doesn't work yet, feature request for `addRadio()` in RT.) But at least works the other way round already, displays radiotray stations in bookmarks category. check-in: d4c3eccf15 user: mario tags: trunk | |
2015-03-26
| ||
20:59 | Update configuration dialog help pages. check-in: 96814a40b4 user: mario tags: trunk | |
18:51 | Explain audio player configuration with more examples, detail options for streamripper recording. check-in: 803cb52d3f user: mario tags: trunk | |
Changes
Modified help/action_recording.page from [2662913d47] to [b83df63689].
︙ | ︙ | |||
8 9 10 11 12 13 14 | <link type="guide" xref="index#functions"/> <desc>Save radio songs as MP3 files via streamripper.</desc> </info> <title>Recording</title> <p>Most stations that stream MP3 or OGG music can be recorded. This is accomplished through | | | | | 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | <link type="guide" xref="index#functions"/> <desc>Save radio songs as MP3 files via streamripper.</desc> </info> <title>Recording</title> <p>Most stations that stream MP3 or OGG music can be recorded. This is accomplished through the command-line tool "streamripper". If you select a station and press <gui style="button">● record</gui>, a console window should appear, where streamripper shows its progress.</p> <section> <title>Streamripper</title> <p>The <cmd>xterm -e</cmd> prefix brings up the terminal popup, to follow streamrippers progress. Remove that for silent downloads.</p> <table shade="rows" rules="rows cols"> <thead> <tr><td><p>Format</p></td> <td><p>Application</p></td></tr> </thead> <tr><td><p><var>audio/*</var></p></td> <td><p><cmd>xterm -e streamripper %srv</cmd></p></td></tr> </table> <p>To configure a default download directory, use the <cmd>-d</cmd> option to streamripper. For example <cmd>xterm -e "streamripper -d /media/music/"</cmd> would use an absolute path. Else it downloads to the current working directory (often your HOME path).</p> </section> <section> <title>fIcy/fPls</title> <p>As alternative to streamripper, check out <link href="http://freshcode.club/projects/ficy">fIcy/fPls</link> |
︙ | ︙ | |||
47 48 49 50 51 52 53 54 55 | <title>Youtube-DL</title> <p>The recording settings have a specific entry for "video/youtube" URLs. To configure a specific download directory, use <cmd>xterm -e "cd /media/music ; youtube-dl %srv"</cmd> for example. (The <cmd>cd</cmd> trick works with streamripper too.)</p> </section> </page> | > > > > > > > > > > > > | 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 | <title>Youtube-DL</title> <p>The recording settings have a specific entry for "video/youtube" URLs. To configure a specific download directory, use <cmd>xterm -e "cd /media/music ; youtube-dl %srv"</cmd> for example. (The <cmd>cd</cmd> trick works with streamripper too.)</p> </section> <section> <title>Wget for MOD files</title> <p>To download audio files from The MOD Archive directly, you can define a few custom handlers. Scroll/click on the empty row in the recording apps table. There create a new recording MIME type <var>audio/mod+zip</var> with a command like <cmd>xterm -e wget %srv</cmd>. Copy it alike for <var>audio/it+zip</var> and <var>audio/xm+zip</var> to cover the most common file types. Using <cmd>curl</cmd> would also work of course. </p> </section> </page> |
Modified help/channels.page from [0404c7d7b1] to [e25889019f].
1 2 3 4 5 6 7 8 9 10 11 12 | <page xmlns="http://projectmallard.org/1.0/" type="guide" id="channels"> <info> <link type="guide" xref="index#browsing"/> <desc>Switching through the channel tabs, different radio directory services.</desc> </info> <title>Channels</title> <p>The tabs in the main window represent the music directory | | < > > > | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 | <page xmlns="http://projectmallard.org/1.0/" type="guide" id="channels"> <info> <link type="guide" xref="index#browsing"/> <desc>Switching through the channel tabs, different radio directory services.</desc> </info> <title>Channels</title> <p>The tabs in the main window represent the music directory channels/services. Each lists categories/genres and their associated radios/streams.</p> <media type="image" mime="image/png" src="img/channels.png">Tabs</media> <p>The notebook tabs can also be repositioned with <guiseq><gui>Edit</gui> <gui>Channel tab position</gui> <gui>Left</gui></guiseq>.</p> <p>If you first select a channel tab, the categories should appear or be loading. Otherwise:</p> <steps> <item><p>Select a channel tab</p></item> <item><p>Choose <guiseq><gui>Channel</gui> <gui>Reload categories...</gui></guiseq></p></item> <item><p>Pick a category/genre from the overview, left.</p></item> </steps> <p>Individual channels provide different music/radio information. The table views are mostly identical in each tab. Some views may rename columns, or remove them alltogether.</p> <section id="list"> <title>Available channels</title> </section> <section id="homepage"> |
︙ | ︙ |
Modified help/config_apps.page from [d350332b6e] to [c46ba2ba34].
︙ | ︙ | |||
18 19 20 21 22 23 24 | <table shade="rows" rules="rows cols"> <tr><td><p><app>Audacious</app></p></td> <td><p><cmd>audacious %m3u</cmd></p></td> <td><p>audio</p></td></tr> <tr><td><p><app>XMMS2</app></p></td> <td><p><cmd>xmms2 %m3u</cmd></p></td> <td><p>audio</p></td></tr> <tr><td><p><app>Amarok</app></p></td> <td><p><cmd>amarok -l %pls</cmd></p></td> <td><p>audio</p></td></tr> <tr><td><p><app>Exaile</app></p></td> <td><p><cmd>exaile %m3u</cmd></p></td> <td><p>audio</p></td></tr> <tr><td><p><app>Amarok</app></p></td> <td><p><cmd>amarok -l %pls</cmd></p></td> <td><p>audio</p></td></tr> <tr><td><p><app>mplayer</app></p></td> <td><p><cmd>mplayer %srv</cmd></p></td> <td><p>console</p></td></tr> | | | | | 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | <table shade="rows" rules="rows cols"> <tr><td><p><app>Audacious</app></p></td> <td><p><cmd>audacious %m3u</cmd></p></td> <td><p>audio</p></td></tr> <tr><td><p><app>XMMS2</app></p></td> <td><p><cmd>xmms2 %m3u</cmd></p></td> <td><p>audio</p></td></tr> <tr><td><p><app>Amarok</app></p></td> <td><p><cmd>amarok -l %pls</cmd></p></td> <td><p>audio</p></td></tr> <tr><td><p><app>Exaile</app></p></td> <td><p><cmd>exaile %m3u</cmd></p></td> <td><p>audio</p></td></tr> <tr><td><p><app>Amarok</app></p></td> <td><p><cmd>amarok -l %pls</cmd></p></td> <td><p>audio</p></td></tr> <tr><td><p><app>mplayer</app></p></td> <td><p><cmd>mplayer %srv</cmd></p></td> <td><p>console</p></td></tr> <tr><td><p><app>VLC</app></p></td> <td><p><cmd>vlc %u</cmd></p></td> <td><p>video</p></td></tr> <tr><td><p><app>Totem</app></p></td> <td><p><cmd>totem %u</cmd></p></td> <td><p>video</p></td></tr> <tr><td><p><app>Media Player</app></p></td> <td><p><cmd>mplayer2.exe %pls</cmd></p></td> <td><p>Win32</p></td></tr> </table> <p>Some audio players open a second instance when you actually want to switch radios. In this case it's a common workaround to write <code>pkill vlc ; vlc %u</code> instead, which ends the previous player process and starts it anew. For VLC there's however also the <code>--one-instance</code> option, which sometimes works better. (And sometimes not.)</p> <p>Some applications, like Rhythmbox or Banshee, are primarily audio browsers, not players, and cannot be invoked with a play URL by other apps. This makes them less suitable for use with streamtuner2.</p> <section id="placeholders"> <title>URL placeholders</title> <p>Any listed application can be invoked with a different kind of URL or filename.be invoked with a play URL by other apps. Which to use often depends on the application.</p> <table shade="rows" rules="rows cols"> |
︙ | ︙ |
Modified help/configuration.page from [8b69bffa16] to [8010e28e83].
1 2 3 4 5 6 7 8 9 10 11 12 | <page xmlns="http://projectmallard.org/1.0/" type="guide" group="first" id="configuration"> <info> <link type="guide" xref="index#configuration"/> <desc><key>F12</key> brings up the options window with the Player, Display, System and Plugin sections.</desc> </info> <title>Settings dialog</title> | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | <page xmlns="http://projectmallard.org/1.0/" type="guide" group="first" id="configuration"> <info> <link type="guide" xref="index#configuration"/> <desc><key>F12</key> brings up the options window with the Player, Display, System and Plugin sections.</desc> </info> <title>Settings dialog</title> <p>There are various options for streamtuner2, available under <guiseq><gui>Edit</gui> <gui>Preferences</gui></guiseq> or via <key>F12</key>. </p> <terms> <title>It's separated into three main areas.</title> <item> <title>Player</title> <p>Lists audio formats and the audio player applications, or recording tools below. |
︙ | ︙ | |||
48 49 50 51 52 53 54 | <tr><td><p><var>audio/*</var></p></td> <td><p><cmd>vlc --one-instance</cmd></p></td></tr> <tr><td><p><var>video/*</var></p></td> <td><p><cmd>totem</cmd></p></td></tr> <tr><td><p><var>video/youtube</var></p></td> <td><p><cmd>vlc %srv</cmd></p></td></tr> </table> <p>Application names are always lowercase binary names. Double click an entry to edit it.</p> | | < | | 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | <tr><td><p><var>audio/*</var></p></td> <td><p><cmd>vlc --one-instance</cmd></p></td></tr> <tr><td><p><var>video/*</var></p></td> <td><p><cmd>totem</cmd></p></td></tr> <tr><td><p><var>video/youtube</var></p></td> <td><p><cmd>vlc %srv</cmd></p></td></tr> </table> <p>Application names are always lowercase binary names. Double click an entry to edit it.</p> <p>After the application name, you can use a placeholder like "<var>%pls</var>" (default), or "<var>%m3u</var>" and "<var>%src</var>". See <link xref="config_apps#placeholders">placeholders</link>.</p> <p>Catch-all entries like <var>*/*</var> or a generic <var>audio/*</var> entry allow to configure a default player. While <var>video/youtube</var> is specific to the Youtube channel. And <var>url/http</var> a psdeudo MIME type to configure a web browser (for station homepages).</p> </section> <section id="recording"> |
︙ | ︙ | |||
76 77 78 79 80 81 82 | <p>To define a target directory, you can add commandline arguments to each. Also it's typically helpful to leave the xterm prefix on, so you can follow the processing state. (Alternatively to xterm there is x-terminal-emulator, or rxvt, gnome-terminal, xfce4-terminal, etc.)</p> </section> <section id="gui"> | > | | > > > | | > | | < > > > | < > > > > > > > > > > > > > > > > > > < > | > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > < > > > > | | > > > > | > > > > > > | | > > < < < | > < > | | 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | <p>To define a target directory, you can add commandline arguments to each. Also it's typically helpful to leave the xterm prefix on, so you can follow the processing state. (Alternatively to xterm there is x-terminal-emulator, or rxvt, gnome-terminal, xfce4-terminal, etc.)</p> </section> <section id="gui"> <title>Display/GUI options</title> <terms> <title>Display settings</title> <item> <title>Display favicons</title> <p>The options for the favicons define if station entries should show little icons. Not all stations have one, so you might as well turn this off to conserve a little memory.</p> </item> <item> <title>Load favicons</title> <p>When starting to play a station, its homepage favicon is automatically retrieved in the background. It's not going to be displayed right away, but after you reload the category/station list. Alternatively use <guiseq><gui>Channel</gui> <gui>Update favicons...</gui></guiseq> to update all station icons at once.</p> </item> <item> <title>Show bookmark star</title> <p>Bookmarked stations will be marked with a ★ star in all other station lists / categories. That doesn't often work for the same station entry from two different channel services / tabs though.</p> </item> <item> <title>Gtk+ theme</title> <p>Be careful. While Gtk allows to select a different theme per application, not all themes work right away. Switching the theme might hang streamtuner2. Just restart if that happens.</p> </item> <item> <title>Save window states</title> <p>Automatically remember window size, selected channel tab, categories, or selected station. Also keeps the width of station list columns. If disabled, you can manually save the current layout/selections via <guiseq><gui>Edit</gui> <gui>Save States</gui></guiseq>.</p> </item> </terms> <terms> <title>Station loading</title> <item> <title>Prefer HTML traversing (PyQuery) over regex</title> <p>Some channels provide proper APIs to fetch station lists. Others are just websites, that require scraping listings out. Most channel tabs provide two alternative methods for that. The DOM/HTML selection method is sometimes more reliable. As fallback streamtuner2 plugins often use a regex to match text. Occassionally the regex method is actually more reliable, because directory services often use frightful unstructured HTML. If available, both methods are tried. You can influence the order with this setting.</p> </item> <item> <title>[<input>250</input>] Limit stream number</title> <p> Constraints the length of station lists per category. The number of stations setting is not honored by all channel plugins. Often it's not possible to load more or fewer station entries. Some plugins have own settings (in the 'Plugins' section) even. For the major plugins this however limits how much scroll text appears in the stream lists.</p> </item> <item> <title>Retain deleted stations</title> <p>When enabled, keeps old station entries when updating/reloading a category/genre. Services often forget stations or throws them out when inavailable. With this option enabled, these entries are kept in streamtuner2 as strikethrough entries (often at the end of the list).</p> </item> <item> <title>Update favouries from freshened URLs</title> <p>Streaming URLs in bookmarked stations get renewed on category reloads/updates. This isn't very reliable, as often station titles change together with the streaming URLs.</p> </item> <item> <title>google station homepages</title> <p>When playing a station that doesn't have a homepage entry, streamtuner2 tries to google the station title. The found URL is then used/kept as station homepage. (Btw, station titles like www.mymusicstation.com are automatically mapped to homepage URLs already.)</p> </item> </terms> <terms> <title>System</title> <item> <title>Temporary files</title> <p>Streamtuner2 creates temporary .m3u files, if an audio player is configured to use %m3u files instead of %pls or %srv URLs. For archival purposes, you might want to set a dedicated directory for this. Leave this to the default /tmp else.</p> </item> <item> <title>Config directory</title> <p>Is where streamtuner2 keeps its settings.json and channel caches, favicons, etc. You can't set this in the config dialog. This is just for display. Set the XDG_CONFIG_HOME environment variable to adapt.</p> </item> <item> <title>Enable debug messages</title> <p>If you start streamtuner2 from a terminal window (xterm/rxvt), you can get a load of state and processing or debug infos. Enable this only for testing, as it might slow down station rendering.</p> </item> </terms> </section> <section id="plugins"> <title>Plugin and Channel settings</title> <p>This tab lists all available channel and feature plugins. Mark checkboxes for those plugins you want to enable. You have to restart Streamtuner2 for any changes here to take effect.</p> <p>Each channel plugin may come with its own set of addition configuration settings below.</p> <p>If you want to find out more about the short option descriptions (most settings are checkboxes), please have a look into the channels directory /usr/share/streamtuner2/channels/ and corresponding *.py files. These are readable, and sometimes contain more information.</p> </section> </page> |
Modified help/glossary.page from [c0edfeac9e] to [fdb0bc7317].
︙ | ︙ | |||
33 34 35 36 37 38 39 | <p>Music genres are represented as "categories" in the left pane. Every channel groups its music stations into some structure.</p> </item> <item> <title>URL</title> <p>URL stands for "Uniform Resource Locator" | | | | | | < | 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | <p>Music genres are represented as "categories" in the left pane. Every channel groups its music stations into some structure.</p> </item> <item> <title>URL</title> <p>URL stands for "Uniform Resource Locator" and simply refers to something retrievable hyperlinks or web addresses like http://www.example.org/. Radio stations/streams are stored as URLs internally. The more generic hipster term "URI" (long superseded by "IRI" anyway) makes less sense in this context, because ISBN: or MailTo: references aren't overly useful for such purposes.</p> </item> <item> <title>Radio</title> <p>Plays music. Sometimes interrupted by advertisements. </p> </item> |
︙ | ︙ |
Modified help/index.page from [d36cba89d4] to [83ef1ebd5d].
︙ | ︙ | |||
28 29 30 31 32 33 34 | </section> <section id="extra" style="2column"> <title>Additional features</title> </section> <section id="footer"> | | | | | 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | </section> <section id="extra" style="2column"> <title>Additional features</title> </section> <section id="footer"> <p>You can get additional help from the online forum. See <guiseq><gui>Help</gui> <gui>Forum</gui></guiseq>.</p> <p>This documentation was last updated for available functions in streamtuner2 version 2.1.4, as of March 2015.</p> </section> </page> |
Modified help/technical.page from [3e15edff15] to [dc272f5824].
︙ | ︙ | |||
12 13 14 15 16 17 18 19 20 21 22 23 24 25 | <section id="dependecies"> <terms> <title>Dependencies</title> <item><p>Python 2.7 or 3.x</p></item> <item><p>PyGtk or PyGI</p></item> <item><p>Gtk2 or Gtk3</p></item> </terms> <terms> <title>Soft dependencies</title> <item><p>Python-LXML</p></item> <item><p>Python-PyQuery</p></item> <item><p>Python-Kronos</p></item> <item><p>Audacious</p></item> | > | 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <section id="dependecies"> <terms> <title>Dependencies</title> <item><p>Python 2.7 or 3.x</p></item> <item><p>PyGtk or PyGI</p></item> <item><p>Gtk2 or Gtk3</p></item> <item><p>Requests/urllib3</p></item> </terms> <terms> <title>Soft dependencies</title> <item><p>Python-LXML</p></item> <item><p>Python-PyQuery</p></item> <item><p>Python-Kronos</p></item> <item><p>Audacious</p></item> |
︙ | ︙ |