1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

Add details to Spotify documentation

This commit is contained in:
Chris Cummer 2018-10-03 10:33:10 -07:00
parent 065c38ddc1
commit cb29167ad1
8 changed files with 206 additions and 108 deletions

View File

@ -19,13 +19,14 @@ wtf/spotify/
<span class="caption">Action:</span> Open/close the widget's help window. <span class="caption">Action:</span> Open/close the widget's help window.
<span class="caption">Key:</span> `space` <br /> <span class="caption">Key:</span> `space` <br />
<span class="caption">Action:</span> <span class="caption">Action:</span> Play/pause the currently-selected
track
<span class="caption">Key:</span> `h` <br /> <span class="caption">Key:</span> `h` <br />
<span class="caption">Action:</span> <span class="caption">Action:</span> Play previous song
<span class="caption">Key:</span> `l` <br /> <span class="caption">Key:</span> `l` <br />
<span class="caption">Action:</span> <span class="caption">Action:</span> Play next song
## Configuration ## Configuration

View File

@ -141,35 +141,6 @@
CmdRunner CmdRunner
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/cryptocurrencies/" class="dd-item haschildren
">
<div>
<a href="/modules/cryptocurrencies/">Crypo Currencies</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/bittrex/">
Bittrex
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/blockfolio/">
Blockfolio
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/cryptolive/">
CryptoLive
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/datadog/" class="dd-item"> <li data-nav-id="/modules/datadog/" class="dd-item">
<div> <div>
@ -212,28 +183,6 @@
Gitter Gitter
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/google/" class="dd-item haschildren
">
<div>
<a href="/modules/google/">Google Apps</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/google/gcal/" class="dd-item">
<div>
<a href="/modules/google/gcal/">
Google Calendar
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
<div>
<a href="/modules/google/gspreadsheet/">
Google Spreadsheets
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/hackernews/" class="dd-item"> <li data-nav-id="/modules/hackernews/" class="dd-item">
<div> <div>
@ -241,28 +190,6 @@
Hacker News Hacker News
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/ipaddress/" class="dd-item haschildren
">
<div>
<a href="/modules/ipaddress/">IP Addresses</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/ipaddress/ipapi/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipapi/">
IP-API
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/ipaddress/ipinfo/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipinfo/">
IPInfo
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/jenkins/" class="dd-item"> <li data-nav-id="/modules/jenkins/" class="dd-item">
<div> <div>
@ -361,28 +288,6 @@
Twitter Twitter
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/weather_services/" class="dd-item haschildren
">
<div>
<a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
<div>
<a href="/modules/weather_services/prettyweather/">
Pretty Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/weather/" class="dd-item">
<div>
<a href="/modules/weather_services/weather/">
Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/zendesk/" class="dd-item"> <li data-nav-id="/modules/zendesk/" class="dd-item">
<div> <div>

2
docs/index.json vendored
View File

@ -249,7 +249,7 @@
"title": "Spotify", "title": "Spotify",
"tags": [], "tags": [],
"description": "", "description": "",
"content": " Control the Spotify client.\nSource Code wtf/spotify/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: space Action:\nKey: h Action:\nKey: l Action:\nConfiguration spotify:enabled:trueposition:top:1left:2height:1width:1refreshInterval:0 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n" "content": " Control the Spotify client.\nSource Code wtf/spotify/ Keyboard Commands Key: / Action: Open/close the widget\u0026rsquo;s help window.\nKey: space Action: Play/pause the currently-selected track\nKey: h Action: Play previous song\nKey: l Action: Play next song\nConfiguration spotify:enabled:trueposition:top:1left:2height:1width:1refreshInterval:0 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\n"
}, },
{ {
"uri": "https://wtfutil.com/modules/textfile/", "uri": "https://wtfutil.com/modules/textfile/",

6
docs/index.xml vendored
View File

@ -418,9 +418,9 @@ Wifi Network The name of the current network Whether or not the network uses enc
<guid>https://wtfutil.com/modules/spotify/</guid> <guid>https://wtfutil.com/modules/spotify/</guid>
<description>Control the Spotify client. <description>Control the Spotify client.
Source Code wtf/spotify/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window. Source Code wtf/spotify/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: space Action: Key: space Action: Play/pause the currently-selected track
Key: h Action: Key: h Action: Play previous song
Key: l Action: Key: l Action: Play next song
Configuration spotify:enabled:trueposition:top:1left:2height:1width:1refreshInterval:0 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. Configuration spotify:enabled:trueposition:top:1left:2height:1width:1refreshInterval:0 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description> position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description>
</item> </item>

View File

@ -141,6 +141,35 @@
CmdRunner CmdRunner
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/cryptocurrencies/" class="dd-item haschildren
">
<div>
<a href="/modules/cryptocurrencies/">Crypo Currencies</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/bittrex/">
Bittrex
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/blockfolio/">
Blockfolio
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/cryptolive/">
CryptoLive
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/datadog/" class="dd-item"> <li data-nav-id="/modules/datadog/" class="dd-item">
<div> <div>
@ -183,6 +212,28 @@
Gitter Gitter
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/google/" class="dd-item haschildren
">
<div>
<a href="/modules/google/">Google Apps</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/google/gcal/" class="dd-item">
<div>
<a href="/modules/google/gcal/">
Google Calendar
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
<div>
<a href="/modules/google/gspreadsheet/">
Google Spreadsheets
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/hackernews/" class="dd-item"> <li data-nav-id="/modules/hackernews/" class="dd-item">
<div> <div>
@ -190,6 +241,28 @@
Hacker News Hacker News
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/ipaddress/" class="dd-item haschildren
">
<div>
<a href="/modules/ipaddress/">IP Addresses</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/ipaddress/ipapi/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipapi/">
IP-API
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/ipaddress/ipinfo/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipinfo/">
IPInfo
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/jenkins/" class="dd-item"> <li data-nav-id="/modules/jenkins/" class="dd-item">
<div> <div>
@ -288,6 +361,28 @@
Twitter Twitter
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/weather_services/" class="dd-item haschildren
">
<div>
<a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
<div>
<a href="/modules/weather_services/prettyweather/">
Pretty Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/weather/" class="dd-item">
<div>
<a href="/modules/weather_services/weather/">
Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/zendesk/" class="dd-item"> <li data-nav-id="/modules/zendesk/" class="dd-item">
<div> <div>

View File

@ -141,6 +141,36 @@
CmdRunner CmdRunner
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/cryptocurrencies/" class="dd-item parent haschildren
">
<div>
<a href="/modules/cryptocurrencies/">Crypo Currencies</a>
<i class="fa fa-angle-down fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/cryptocurrencies/bittrex/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/bittrex/">
Bittrex
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/blockfolio/" class="dd-item">
<div>
<a href="/modules/cryptocurrencies/blockfolio/">
Blockfolio
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/cryptocurrencies/cryptolive/" class="dd-item active">
<div>
<a href="/modules/cryptocurrencies/cryptolive/">
CryptoLive
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/datadog/" class="dd-item"> <li data-nav-id="/modules/datadog/" class="dd-item">
<div> <div>
@ -183,6 +213,28 @@
Gitter Gitter
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/google/" class="dd-item haschildren
">
<div>
<a href="/modules/google/">Google Apps</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/google/gcal/" class="dd-item">
<div>
<a href="/modules/google/gcal/">
Google Calendar
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/google/gspreadsheet/" class="dd-item">
<div>
<a href="/modules/google/gspreadsheet/">
Google Spreadsheets
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/hackernews/" class="dd-item"> <li data-nav-id="/modules/hackernews/" class="dd-item">
<div> <div>
@ -190,6 +242,28 @@
Hacker News Hacker News
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/ipaddress/" class="dd-item haschildren
">
<div>
<a href="/modules/ipaddress/">IP Addresses</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/ipaddress/ipapi/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipapi/">
IP-API
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/ipaddress/ipinfo/" class="dd-item">
<div>
<a href="/modules/ipaddress/ipinfo/">
IPInfo
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/jenkins/" class="dd-item"> <li data-nav-id="/modules/jenkins/" class="dd-item">
<div> <div>
@ -288,6 +362,28 @@
Twitter Twitter
</a><i class="fa fa-circle-thin read-icon"></i> </a><i class="fa fa-circle-thin read-icon"></i>
</div> </div>
</li>
<li data-nav-id="/modules/weather_services/" class="dd-item haschildren
">
<div>
<a href="/modules/weather_services/">Weather Services</a><i class="fa fa-angle-right fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
</div>
<ul>
<li data-nav-id="/modules/weather_services/prettyweather/" class="dd-item">
<div>
<a href="/modules/weather_services/prettyweather/">
Pretty Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
<li data-nav-id="/modules/weather_services/weather/" class="dd-item">
<div>
<a href="/modules/weather_services/weather/">
Weather
</a><i class="fa fa-circle-thin read-icon"></i>
</div>
</li>
</ul>
</li> </li>
<li data-nav-id="/modules/zendesk/" class="dd-item"> <li data-nav-id="/modules/zendesk/" class="dd-item">
<div> <div>

View File

@ -268,9 +268,9 @@ Wifi Network The name of the current network Whether or not the network uses enc
<guid>https://wtfutil.com/modules/spotify/</guid> <guid>https://wtfutil.com/modules/spotify/</guid>
<description>Control the Spotify client. <description>Control the Spotify client.
Source Code wtf/spotify/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window. Source Code wtf/spotify/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: space Action: Key: space Action: Play/pause the currently-selected track
Key: h Action: Key: h Action: Play previous song
Key: l Action: Key: l Action: Play next song
Configuration spotify:enabled:trueposition:top:1left:2height:1width:1refreshInterval:0 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. Configuration spotify:enabled:trueposition:top:1left:2height:1width:1refreshInterval:0 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description> position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description>
</item> </item>

View File

@ -490,13 +490,14 @@
<span class="caption">Action:</span> Open/close the widget&rsquo;s help window.</p> <span class="caption">Action:</span> Open/close the widget&rsquo;s help window.</p>
<p><span class="caption">Key:</span> <code>space</code> <br /> <p><span class="caption">Key:</span> <code>space</code> <br />
<span class="caption">Action:</span></p> <span class="caption">Action:</span> Play/pause the currently-selected
track</p>
<p><span class="caption">Key:</span> <code>h</code> <br /> <p><span class="caption">Key:</span> <code>h</code> <br />
<span class="caption">Action:</span></p> <span class="caption">Action:</span> Play previous song</p>
<p><span class="caption">Key:</span> <code>l</code> <br /> <p><span class="caption">Key:</span> <code>l</code> <br />
<span class="caption">Action:</span></p> <span class="caption">Action:</span> Play next song</p>
<h2 id="configuration">Configuration</h2> <h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">spotify<span class="p">:</span><span class="w"> <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">spotify<span class="p">:</span><span class="w">