Internet radio browser GUI for music/video streams from various directory services.

⌈⌋ branch:  streamtuner2


Check-in [2ac7d822d9]

Overview
Comment:Link separate pages in feature plugin list.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 2ac7d822d9e7468974faf1f17975b464d93fab28
User & Date: mario on 2015-05-27 21:42:15
Other Links: manifest | tags
Context
2015-06-01
21:43
Add missing pages to HTML manual version. check-in: 9d10307ec9 user: mario tags: trunk
2015-05-27
21:42
Link separate pages in feature plugin list. check-in: 2ac7d822d9 user: mario tags: trunk
16:02
Remove some "topic" links, as the Mallard breadcrumbs became overbearing. check-in: aab52a4d0d user: mario tags: trunk
Changes

Modified help/contrib_features.page from [840a039b02] to [cfccc790ac].

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
..
67
68
69
70
71
72
73













74
75
76
77
78
79
80
81
82
83
84
85
86
87


88
89

90
91
92
93
94
95
96
97
98
<p>Some channels provide lower-quality audio streams. In particular
Xiph lists some awful radio stations. And this plugin helps filtering
those out of station lists.</p>
<list>
 <item><p>MP3 streams often start to sound okay at 96kbit/s.</p></item>
 <item><p>Whereas OGG Vorbis or AAC are sometimes acceptable at 64kbit/s already.</p></item>
</list>
<note style="warning"><p>Note that you may end up with empty channel lists
altogether if you set these options too high. Some channels provide all
their streams with 64kbit/s only.</p></note>
</section>

<section>
<title>Channel toolbar link</title>
<p>Adds a toolbar entry which shows the current channel/directory
service title and its homepage link. Such as:</p>
<code><span style="bold">Shoutcast</span>
<link href="http://shoutcast.com/">//shoutcast.com/</link>
</code>
<p>It depends on the "update window title" option being enabled.</p>
</section>

<section>
<title>Export all stations</title>
<p>There's an "Export All" plugin available. It adds an entry under
................................................................................
<p>This plugin merely masks Streamtuner2 as an ordinary web browser when retrieving station lists.</p>
<list>
 <item><p> It's technically unneeded, as ST2 isn't stressful to directory websites and not blocked anywhere. </p></item>
 <item><p>It's only useful as additional privacy feature really, but shouldn't be used habitually. </p></item>
</list>
</section>
















<section>
<title>Downloadable contrib/ feature plugins</title>

<p>The <link xref="pluginmanager2">Plugin Manager</link> lists further
feature pluginsand in the <key>📦 Add</key> tab.</p>

<terms>
  <item>
    <title><p>Soundcloud streaming</p></title>
    <p>Enables playback of soundcloud.com links in the Reddit plugin.
    Homepage links are transformed into direct MP3 streaming addresses
    on playback. This plugin registers a "audio/soundcloud" pseudo


    type. Alternatively you could use <link
    href="http://github.com/rekado/soundCLI">soundcli</link> of course.</p>

  </item>
  <item>
    <title><p>dev_faulthandler</p></title>
    <p>This is a pure development plugin, meant to debug ST2 crashes.</p>
  </item>
</terms>
</section>

</page>







|

|






|
|







 







>
>
>
>
>
>
>
>
>
>
>
>
>


|


|
|






|
>
>
|
|
>









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
..
67
68
69
70
71
72
73
74
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
<p>Some channels provide lower-quality audio streams. In particular
Xiph lists some awful radio stations. And this plugin helps filtering
those out of station lists.</p>
<list>
 <item><p>MP3 streams often start to sound okay at 96kbit/s.</p></item>
 <item><p>Whereas OGG Vorbis or AAC are sometimes acceptable at 64kbit/s already.</p></item>
</list>
<p>Note that you may end up with empty channel lists
altogether if you set these options too high. Some channels provide all
their streams with 64kbit/s only.</p>
</section>

<section>
<title>Channel toolbar link</title>
<p>Adds a toolbar entry which shows the current channel/directory
service title and its homepage link. Such as:</p>
<code><span style="bold">  ▶    ●    🏠     Shoutcast</span>
play rcrd  hmpg   <link href="http://shoutcast.com/">//shoutcast.com/</link>
</code>
<p>It depends on the "update window title" option being enabled.</p>
</section>

<section>
<title>Export all stations</title>
<p>There's an "Export All" plugin available. It adds an entry under
................................................................................
<p>This plugin merely masks Streamtuner2 as an ordinary web browser when retrieving station lists.</p>
<list>
 <item><p> It's technically unneeded, as ST2 isn't stressful to directory websites and not blocked anywhere. </p></item>
 <item><p>It's only useful as additional privacy feature really, but shouldn't be used habitually. </p></item>
</list>
</section>

<section>
 <title>Other feature plugins</title>
 <list>
   <item><p><link xref="dragndrop">Drag and Drop</link></p></item>
   <item><p><link xref="favicon">Favicons</link></p></item>
   <item><p><link xref="global_key">Global key shortcut</link></p></item>
   <item><p><link xref="timer">Timer</link></p></item>
 </list>
 <p>The "<link xref="search">search</link>",
 "<link xref="configuration">configwin</link>" and
 "<link xref="edit">streamedit</link>" plugins are considered
 built-ins and cannot be disabled.</p>
</section>


<section id="contrib">
<title>Downloadable contrib/ feature plugins</title>

<p>The <link xref="pluginmanager2">Plugin Manager</link> lists other
available feature plugins in the <key>📦 Add</key> tab.</p>

<terms>
  <item>
    <title><p>Soundcloud streaming</p></title>
    <p>Enables playback of soundcloud.com links in the Reddit plugin.
    Homepage links are transformed into direct MP3 streaming addresses
    on playback.</p>
    <note><p>Depends on python-soundcloud, which you can install per
    <cmd>pip install soundcloud</cmd>.</p></note>
    <p> Alternatively you could configure an external player like <link
    href="http://github.com/rekado/soundCLI">soundcli</link> of course.
    Use the pseudo type "audio/soundcloud" for the player settings table.</p>
  </item>
  <item>
    <title><p>dev_faulthandler</p></title>
    <p>This is a pure development plugin, meant to debug ST2 crashes.</p>
  </item>
</terms>
</section>

</page>

Modified help/technical.page from [6056a4e67a] to [14dbf267ca].

13
14
15
16
17
18
19

20
21
22
23
24
25
26

27
28
29
30
31
32
33
..
56
57
58
59
60
61
62




63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
..
84
85
86
87
88
89
90
91
92
93
94
95
	<section id="dependecies">
        <terms>
  	  <title>Dependencies</title>
          <item><p><link action="install:python">Python 2.7 or 3.x</link></p></item>
          <item><p><link action="install:python-gtk2">PyGtk or PyGI</link></p></item>
          <item><p>Gtk2 or Gtk3</p></item>
          <item><p><link action="install:python-requests">Requests/urllib3</link></p></item>

	</terms>
        <terms>
  	  <title>Soft dependencies</title>
          <item><p><link action="install:python-lxml">Python-LXML</link></p></item>
          <item><p><link action="install:python-pyquery">Python-PyQuery</link></p></item>
          <item><p>Python-Kronos</p></item>
          <item><p>Audacious</p></item>

	</terms>
	</section>


	<section id="config_files">
  	  <title>Configuration files</title>
        <terms>
................................................................................
            <title><file>~/.config/streamtuner2/cache/***.json</file></title>
            <p>JSON files for stream lists in each channel.</p>
          </item>
          <item>
            <title><file>~/.config/streamtuner2/icons/*.png</file></title>
            <p>Holds downloaded favicons for station homepages.</p>
          </item>




	</terms>
	</section>


	<section id="install_dirs">
  	  <title>Installation spread</title>
        <terms>
          <item>
            <title><file>/usr/bin/streamtuner2</file></title>
            <p>Is the main binary.</p>
          </item>
          <item>
            <title><file>/usr/share/streamtuner2/</file></title>
            <p>Contains the individual ST2 python modules, and plugins in channels/. Also packages in pyquery/, but which is only used if the according modules aren't installed by the distribution.</p>
          </item>
          <item>
            <title><file>/usr/share/doc/streamtuner2/</file></title>
................................................................................


	<section id="license">
	<title>Public Domain</title>
	<p>The majority of code distributed with ST2 is placed into the Public Domain; meaning
        no licensing requirement and all code can be copied, modified
	and distributed unrestrictively.</p>
        <p>The bundled kronos.py and requests/ library are NOT however.</p>
	</section>


</page>







>





|
|
>







 







>
>
>
>









|







 







|




13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
..
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
..
90
91
92
93
94
95
96
97
98
99
100
101
	<section id="dependecies">
        <terms>
  	  <title>Dependencies</title>
          <item><p><link action="install:python">Python 2.7 or 3.x</link></p></item>
          <item><p><link action="install:python-gtk2">PyGtk or PyGI</link></p></item>
          <item><p>Gtk2 or Gtk3</p></item>
          <item><p><link action="install:python-requests">Requests/urllib3</link></p></item>
          <item><p><link action="install:python-imaging">PIL/Pillow</link></p></item>
	</terms>
        <terms>
  	  <title>Soft dependencies</title>
          <item><p><link action="install:python-lxml">Python-LXML</link></p></item>
          <item><p><link action="install:python-pyquery">Python-PyQuery</link></p></item>
          <item><p>Audacious/VLC or any other player</p></item>
          <item><p>Streamripper or fIcy</p></item>
          <item><p>youtube-dl</p></item>
	</terms>
	</section>


	<section id="config_files">
  	  <title>Configuration files</title>
        <terms>
................................................................................
            <title><file>~/.config/streamtuner2/cache/***.json</file></title>
            <p>JSON files for stream lists in each channel.</p>
          </item>
          <item>
            <title><file>~/.config/streamtuner2/icons/*.png</file></title>
            <p>Holds downloaded favicons for station homepages.</p>
          </item>
          <item>
            <title><file>~/.config/streamtuner2/plugins/*.py</file></title>
            <p>Contain downloaded contrib/ plugins.</p>
          </item>
	</terms>
	</section>


	<section id="install_dirs">
  	  <title>Installation spread</title>
        <terms>
          <item>
            <title><file>/usr/bin/streamtuner2</file></title>
            <p>Associates the main binary.</p>
          </item>
          <item>
            <title><file>/usr/share/streamtuner2/</file></title>
            <p>Contains the individual ST2 python modules, and plugins in channels/. Also packages in pyquery/, but which is only used if the according modules aren't installed by the distribution.</p>
          </item>
          <item>
            <title><file>/usr/share/doc/streamtuner2/</file></title>
................................................................................


	<section id="license">
	<title>Public Domain</title>
	<p>The majority of code distributed with ST2 is placed into the Public Domain; meaning
        no licensing requirement and all code can be copied, modified
	and distributed unrestrictively.</p>
        <note><p>The bundled kronos.py and requests/ library are NOT however.</p></note>
	</section>


</page>