Add documentation for Spotify module

nicholas-eden · Oct 3, 2018 · 065c38d · 065c38d
1 parent d5e7860
commit 065c38d
Show file tree

Hide file tree

Showing 55 changed files with 1,087 additions and 193 deletions.
diff --git a/_site/content/modules/spotify.md b/_site/content/modules/spotify.md
@@ -0,0 +1,54 @@
+---
+title: "Spotify"
+date: 2018-10-02T17:13:11-07:00
+draft: false
+weight: 205
+---
+
+Control the Spotify client.
+
+## Source Code
+
+```bash
+wtf/spotify/
+```
+
+## Keyboard Commands
+
+<span class="caption">Key:</span> `/` <br />
+<span class="caption">Action:</span> Open/close the widget's help window.
+
+<span class="caption">Key:</span> `space` <br />
+<span class="caption">Action:</span>
+
+<span class="caption">Key:</span> `h` <br />
+<span class="caption">Action:</span>
+
+<span class="caption">Key:</span> `l` <br />
+<span class="caption">Action:</span>
+
+## Configuration
+
+```yaml
+spotify:
+  enabled: true
+  position:
+    top: 1
+    left: 2
+    height: 1
+    width: 1
+  refreshInterval: 0
+```
+
+## Attributes
+
+`enabled` <br />
+Determines whether or not this module is executed and if its data displayed onscreen. <br />
+Values: `true`, `false`.
+
+`position` <br />
+Defines where in the grid this module's widget will be displayed. <br />
+
+`refreshInterval` <br />
+How often, in seconds, this module will update its data. <br />
+Values: A positive integer, `0..n`.
diff --git a/docs/404.html b/docs/404.html
@@ -311,6 +311,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>

diff --git a/docs/categories/index.html b/docs/categories/index.html
@@ -311,6 +311,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>

diff --git a/docs/configuration/attributes/index.html b/docs/configuration/attributes/index.html
@@ -312,6 +312,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>

diff --git a/docs/configuration/index.html b/docs/configuration/index.html
@@ -312,6 +312,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>

diff --git a/docs/configuration/iterm2/index.html b/docs/configuration/iterm2/index.html
@@ -312,6 +312,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>

diff --git a/docs/getting_started/glossary/index.html b/docs/getting_started/glossary/index.html
@@ -312,6 +312,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>

diff --git a/docs/getting_started/index.html b/docs/getting_started/index.html
@@ -312,6 +312,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>

diff --git a/docs/getting_started/installation/index.html b/docs/getting_started/installation/index.html
@@ -312,6 +312,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>

diff --git a/docs/index.html b/docs/index.html
@@ -311,6 +311,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>

diff --git a/docs/index.json b/docs/index.json
@@ -244,6 +244,13 @@
 	"description": "",
 	"content": " Displays some general information about the state of the machine\u0026rsquo;s wifi connection, firewall, DNS settings, and logged-in users.\nWifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour  Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled  DNS Which DNS resolvers (servers) the machine is configured to use  Users  Which users are logged into the machine. Note: Does not yet show hidden users.  Source Code wtf/security/ Configuration security:enabled:trueposition:top:1left:2height:1width:1refreshInterval:3600 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/spotify/",
+	"title": "Spotify",
+	"tags": [],
+	"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"
+},
 {
 	"uri": "https://wtfutil.com/modules/textfile/",
 	"title": "Textfile",

diff --git a/docs/index.xml b/docs/index.xml
@@ -410,6 +410,21 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
 Wifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour  Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled  DNS Which DNS resolvers (servers) the machine is configured to use  Users  Which users are logged into the machine.</description>
     </item>
 
+    <item>
+      <title>Spotify</title>
+      <link>https://wtfutil.com/modules/spotify/</link>
+      <pubDate>Tue, 02 Oct 2018 17:13:11 -0700</pubDate>
+
+      <guid>https://wtfutil.com/modules/spotify/</guid>
+      <description>Control the Spotify client.
+Source Code wtf/spotify/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
+Key: space Action:
+Key: h Action:
+Key: l Action:
+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>
+    </item>
+
     <item>
       <title>Textfile</title>
       <link>https://wtfutil.com/modules/textfile/</link>

diff --git a/docs/modules/bamboohr/index.html b/docs/modules/bamboohr/index.html
@@ -312,6 +312,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>
@@ -433,6 +440,7 @@
       <option value="/modules/opsgenie/" >- OpsGenie</option>
       <option value="/modules/power/" >- Power</option>
       <option value="/modules/security/" >- Security</option>
+      <option value="/modules/spotify/" >- Spotify</option>
       <option value="/modules/textfile/" >- Textfile</option>
       <option value="/modules/todo/" >- Todo</option>
       <option value="/modules/todoist/" >- Todoist</option>

diff --git a/docs/modules/circleci/index.html b/docs/modules/circleci/index.html
@@ -312,6 +312,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>
@@ -433,6 +440,7 @@
       <option value="/modules/opsgenie/" >- OpsGenie</option>
       <option value="/modules/power/" >- Power</option>
       <option value="/modules/security/" >- Security</option>
+      <option value="/modules/spotify/" >- Spotify</option>
       <option value="/modules/textfile/" >- Textfile</option>
       <option value="/modules/todo/" >- Todo</option>
       <option value="/modules/todoist/" >- Todoist</option>

diff --git a/docs/modules/clocks/index.html b/docs/modules/clocks/index.html
@@ -312,6 +312,13 @@
             Security
           </a><i class="fa fa-circle-thin read-icon"></i>
         </div>
+    </li>
+      <li data-nav-id="/modules/spotify/" class="dd-item">
+        <div>
+          <a href="/modules/spotify/">
+            Spotify
+          </a><i class="fa fa-circle-thin read-icon"></i>
+        </div>
     </li>
       <li data-nav-id="/modules/textfile/" class="dd-item">
         <div>
@@ -433,6 +440,7 @@
       <option value="/modules/opsgenie/" >- OpsGenie</option>
       <option value="/modules/power/" >- Power</option>
       <option value="/modules/security/" >- Security</option>
+      <option value="/modules/spotify/" >- Spotify</option>
       <option value="/modules/textfile/" >- Textfile</option>
       <option value="/modules/todo/" >- Todo</option>
       <option value="/modules/todoist/" >- Todoist</option>