taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

More documentation for Clocks, GCal, and Jira.

Browse Source
This commit is contained in:
Chris Cummer 2018-05-16 19:37:23 -07:00
parent 2ecd5e4b84
commit 40ca748b8d
11 changed files with 166 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
_site/content/posts/modules/clocks.md
View File

@ -52,13 +52,13 @@ clocks:
```
### Attributes
`colors.even` <br />
Define the text color for even-numbered rows (2, 4, 6...). <br />
`colors.rows.even` <br />
Define the foreground color for even-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`colors.odd` <br />
Define the text color for the odd-numbered rows (1, 3, 5...). <br />
`colors.rows.odd` <br />
Define the foreground color for the odd-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.

18
_site/content/posts/modules/gcal.md
View File

@ -43,6 +43,8 @@ gcal:
past: "gray"
conflictIcon: "🚨"
currentIcon: "💥"
displayResponseStatus: true
email: "chriscummer@me.com"
enabled: true
eventCount: 12
position:
@ -52,6 +54,7 @@ gcal:
width: 1
refreshInterval: 300
secretFile: "~/.wtf/gcal/client_secret.json"
withLocation: true
```
### Attributes
@ -83,6 +86,20 @@ Values: Any displayable unicode character.
The icon displayed beside the current calendar event. <br />
Values: Any displayable unicode character.
`displayLocation` <br />
Whether or not to display the location of the calendar event. <br />
Values: `true`, `false`.
`displayResponseStatus` <br />
Whether or not to display your response status to the calendar event.
<br />
Values: `true`, `false`.
`email` <br />
The email address associated with your Google account. Necessary for
determining `responseStatus`. <br />
Values: A valid email address string.
`enabled` <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
@ -101,3 +118,4 @@ Values: A positive integer, `0..n`.
`secretFile` <br />
Your <a href="https://developers.google.com/calendar/quickstart/go">Google client secret</a> JSON file. <br />
Values: A string representing a file path to the JSON secret file.

20
_site/content/posts/modules/jira.md
View File

@ -29,6 +29,10 @@ None.
```yaml
jira:
colors:
rows:
even: "lightblue"
odd: "white"
domain: "https://umbrellacorp.atlassian.net"
email: "chriscummer@me.com"
enabled: true
@ -44,9 +48,23 @@ jira:
### Attributes
`colors.rows.even` <br />
Define the foreground color for even-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`colors.rows.odd` <br />
Define the foreground color for odd-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`domain` <br />
Your Jira corporate domain. <br />
Values: A valid URI.
`email` <br />
The email address associated with your Jira account. <br />
Values: A valid email address string.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
@ -56,9 +74,11 @@ Values: `true`, `false`.
Defines where in the grid this module's widget will be displayed. <br />
`project` <br />
The Jira project to fetch information for. <br />
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, `0..n`.
`username` <br />
Your Jira username. <br />

30
docs/index.xml
View File

@ -17,14 +17,12 @@
<pubDate>Thu, 10 May 2018 12:41:50 -0700</pubDate>
<guid>http://wtfutil.com/posts/modules/todo/</guid>
<description>Description Source Code wtf/todo/ Required ENV Variables None.
Keyboard Commands A basic, interactive todo list.
Configuration todo:checkedIcon:&amp;#34;X&amp;#34;colors:checked:grayhighlight:fore:&amp;#34;black&amp;#34;back:&amp;#34;orange&amp;#34;enabled:truefilename:&amp;#34;todo.yml&amp;#34;position:top:2left:2height:2width:1refreshInterval:3600 Attributes checkedIcon The icon used to denote a &amp;ldquo;checked&amp;rdquo; todo item. Values: Any displayable unicode character.
colors.checked Values: Any X11 color name.
colors.highlight.fore Values: Any X11 color name.
colors.highlight.back Values: Any X11 color name.
enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
filename The name for the todo file.</description>
<description>Description An interactive todo list.
Source Code wtf/todo/ Required ENV Variables None.
Keyboard Commands Key: [return] Action: Edit the selected item. Action: Close the modal item dialog and save changes. Key: [esc] Action: Remove focus from the selected item. Action: Close the modal item dialog without saving changes.
Key: [space] Action: Check/uncheck the selected item.
Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: j Action: Select the next item in the list.</description>
</item>
<item>
@ -36,8 +34,10 @@ filename The name for the todo file.</description>
<description>Description Displays all Jira issues assigned to you for the specified project.
Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key.
Keyboard Commands None.
Configuration jira:domain:&amp;#34;https://umbrellacorp.atlassian.net&amp;#34;email:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueposition:top:4left:1height:1width:2project:&amp;#34;CORE&amp;#34;refreshInterval:900username:&amp;#34;chris.cummer&amp;#34; Attributes domain email 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. project refreshInterval How often, in seconds, this module will update its data.</description>
Configuration jira:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;domain:&amp;#34;https://umbrellacorp.atlassian.net&amp;#34;email:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueposition:top:4left:1height:1width:2project:&amp;#34;CORE&amp;#34;refreshInterval:900username:&amp;#34;chris.cummer&amp;#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
colors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name.
domain Your Jira corporate domain. Values: A valid URI.
email The email address associated with your Jira account.</description>
</item>
<item>
@ -50,7 +50,7 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
Source Code wtf/gcal/ Required ENV Variables Key: WTF_GOOGLE_CAL_CLIENT_ID Value: Your Google API client ID.
Key: WTF_GOOGLE_CAL_CLIENT_SECRET Value: Your Google API client secret.
Keyboard Commands None.
Configuration gcal:colors:title:&amp;#34;red&amp;#34;description:&amp;#34;lightblue&amp;#34;highlights:-[&amp;#39;1on1|1\/11&amp;#39;,&amp;#39;green&amp;#39;]-[&amp;#39;apple|google|aws&amp;#39;,&amp;#39;blue&amp;#39;]-[&amp;#39;interview|meet&amp;#39;,&amp;#39;magenta&amp;#39;]-[&amp;#39;lunch&amp;#39;,&amp;#39;yellow&amp;#39;]past:&amp;#34;gray&amp;#34;conflictIcon:&amp;#34;🚨&amp;#34;currentIcon:&amp;#34;💥&amp;#34;enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:&amp;#34;~/.wtf/gcal/client_secret.json&amp;#34; Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.
Configuration gcal:colors:title:&amp;#34;red&amp;#34;description:&amp;#34;lightblue&amp;#34;highlights:-[&amp;#39;1on1|1\/11&amp;#39;,&amp;#39;green&amp;#39;]-[&amp;#39;apple|google|aws&amp;#39;,&amp;#39;blue&amp;#39;]-[&amp;#39;interview|meet&amp;#39;,&amp;#39;magenta&amp;#39;]-[&amp;#39;lunch&amp;#39;,&amp;#39;yellow&amp;#39;]past:&amp;#34;gray&amp;#34;conflictIcon:&amp;#34;🚨&amp;#34;currentIcon:&amp;#34;💥&amp;#34;displayResponseStatus:trueemail:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:&amp;#34;~/.wtf/gcal/client_secret.json&amp;#34;withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.
colors.description The default color for calendar event descriptions. Values: Any X11 color name.
colors.highlights A list of arrays that define a regular expression pattern and a color.</description>
</item>
@ -109,8 +109,8 @@ Key: → Action: Show the next weather location.</description>
Source Code wtf/textfile/ Required ENV Variables None.
Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: o Action: Opens the text file in whichever text editor is associated with that file type.
Configuration textfile:enabled:truefilename:&amp;#34;notes.md&amp;#34;position:top:5left:4height:2width:1refreshInterval:15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
filename The name of the file to be displayed in the widget.</description>
Configuration textfile:enabled:truefilePath:&amp;#34;~/Desktop/notes.md&amp;#34;position:top:5left:4height:2width:1refreshInterval:15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
filePath The path to the file to be displayed in the widget.</description>
</item>
<item>
@ -172,8 +172,8 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
<description>Description Displays a configurable list of world clocks, the local time, and date.
Source Code wtf/clocks/ Required ENV Variables None.
Keyboard Commands None.
Configuration clocks:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&amp;#34;Europe/Paris&amp;#34;Barcelona:&amp;#34;Europe/Madrid&amp;#34;Dubai:&amp;#34;Asia/Dubai&amp;#34;UTC:&amp;#34;Etc/UTC&amp;#34;Vancouver:&amp;#34;America/Vancouver&amp;#34;Toronto:&amp;#34;America/Toronto&amp;#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&amp;#34;alphabetical&amp;#34; Attributes colors.even Define the text color for even-numbered rows (2, 4, 6&amp;hellip;). Values: Any X11 color name.
colors.odd Define the text color for the odd-numbered rows (1, 3, 5&amp;hellip;). Values: Any X11 color name.
Configuration clocks:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&amp;#34;Europe/Paris&amp;#34;Barcelona:&amp;#34;Europe/Madrid&amp;#34;Dubai:&amp;#34;Asia/Dubai&amp;#34;UTC:&amp;#34;Etc/UTC&amp;#34;Vancouver:&amp;#34;America/Vancouver&amp;#34;Toronto:&amp;#34;America/Toronto&amp;#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&amp;#34;alphabetical&amp;#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
colors.rows.odd Define the foreground color for the odd-numbered rows. Values: Any X11 color name.
enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
</item>

30
docs/posts/index.xml
View File

@ -17,14 +17,12 @@
<pubDate>Thu, 10 May 2018 12:41:50 -0700</pubDate>
<guid>http://wtfutil.com/posts/modules/todo/</guid>
<description>Description Source Code wtf/todo/ Required ENV Variables None.
Keyboard Commands A basic, interactive todo list.
Configuration todo:checkedIcon:&amp;#34;X&amp;#34;colors:checked:grayhighlight:fore:&amp;#34;black&amp;#34;back:&amp;#34;orange&amp;#34;enabled:truefilename:&amp;#34;todo.yml&amp;#34;position:top:2left:2height:2width:1refreshInterval:3600 Attributes checkedIcon The icon used to denote a &amp;ldquo;checked&amp;rdquo; todo item. Values: Any displayable unicode character.
colors.checked Values: Any X11 color name.
colors.highlight.fore Values: Any X11 color name.
colors.highlight.back Values: Any X11 color name.
enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
filename The name for the todo file.</description>
<description>Description An interactive todo list.
Source Code wtf/todo/ Required ENV Variables None.
Keyboard Commands Key: [return] Action: Edit the selected item. Action: Close the modal item dialog and save changes. Key: [esc] Action: Remove focus from the selected item. Action: Close the modal item dialog without saving changes.
Key: [space] Action: Check/uncheck the selected item.
Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: j Action: Select the next item in the list.</description>
</item>
<item>
@ -36,8 +34,10 @@ filename The name for the todo file.</description>
<description>Description Displays all Jira issues assigned to you for the specified project.
Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key.
Keyboard Commands None.
Configuration jira:domain:&amp;#34;https://umbrellacorp.atlassian.net&amp;#34;email:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueposition:top:4left:1height:1width:2project:&amp;#34;CORE&amp;#34;refreshInterval:900username:&amp;#34;chris.cummer&amp;#34; Attributes domain email 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. project refreshInterval How often, in seconds, this module will update its data.</description>
Configuration jira:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;domain:&amp;#34;https://umbrellacorp.atlassian.net&amp;#34;email:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueposition:top:4left:1height:1width:2project:&amp;#34;CORE&amp;#34;refreshInterval:900username:&amp;#34;chris.cummer&amp;#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
colors.rows.odd Define the foreground color for odd-numbered rows. Values: Any X11 color name.
domain Your Jira corporate domain. Values: A valid URI.
email The email address associated with your Jira account.</description>
</item>
<item>
@ -50,7 +50,7 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
Source Code wtf/gcal/ Required ENV Variables Key: WTF_GOOGLE_CAL_CLIENT_ID Value: Your Google API client ID.
Key: WTF_GOOGLE_CAL_CLIENT_SECRET Value: Your Google API client secret.
Keyboard Commands None.
Configuration gcal:colors:title:&amp;#34;red&amp;#34;description:&amp;#34;lightblue&amp;#34;highlights:-[&amp;#39;1on1|1\/11&amp;#39;,&amp;#39;green&amp;#39;]-[&amp;#39;apple|google|aws&amp;#39;,&amp;#39;blue&amp;#39;]-[&amp;#39;interview|meet&amp;#39;,&amp;#39;magenta&amp;#39;]-[&amp;#39;lunch&amp;#39;,&amp;#39;yellow&amp;#39;]past:&amp;#34;gray&amp;#34;conflictIcon:&amp;#34;🚨&amp;#34;currentIcon:&amp;#34;💥&amp;#34;enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:&amp;#34;~/.wtf/gcal/client_secret.json&amp;#34; Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.
Configuration gcal:colors:title:&amp;#34;red&amp;#34;description:&amp;#34;lightblue&amp;#34;highlights:-[&amp;#39;1on1|1\/11&amp;#39;,&amp;#39;green&amp;#39;]-[&amp;#39;apple|google|aws&amp;#39;,&amp;#39;blue&amp;#39;]-[&amp;#39;interview|meet&amp;#39;,&amp;#39;magenta&amp;#39;]-[&amp;#39;lunch&amp;#39;,&amp;#39;yellow&amp;#39;]past:&amp;#34;gray&amp;#34;conflictIcon:&amp;#34;🚨&amp;#34;currentIcon:&amp;#34;💥&amp;#34;displayResponseStatus:trueemail:&amp;#34;chriscummer@me.com&amp;#34;enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:&amp;#34;~/.wtf/gcal/client_secret.json&amp;#34;withLocation:true Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.
colors.description The default color for calendar event descriptions. Values: Any X11 color name.
colors.highlights A list of arrays that define a regular expression pattern and a color.</description>
</item>
@ -109,8 +109,8 @@ Key: → Action: Show the next weather location.</description>
Source Code wtf/textfile/ Required ENV Variables None.
Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: o Action: Opens the text file in whichever text editor is associated with that file type.
Configuration textfile:enabled:truefilename:&amp;#34;notes.md&amp;#34;position:top:5left:4height:2width:1refreshInterval:15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
filename The name of the file to be displayed in the widget.</description>
Configuration textfile:enabled:truefilePath:&amp;#34;~/Desktop/notes.md&amp;#34;position:top:5left:4height:2width:1refreshInterval:15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
filePath The path to the file to be displayed in the widget.</description>
</item>
<item>
@ -172,8 +172,8 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
<description>Description Displays a configurable list of world clocks, the local time, and date.
Source Code wtf/clocks/ Required ENV Variables None.
Keyboard Commands None.
Configuration clocks:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&amp;#34;Europe/Paris&amp;#34;Barcelona:&amp;#34;Europe/Madrid&amp;#34;Dubai:&amp;#34;Asia/Dubai&amp;#34;UTC:&amp;#34;Etc/UTC&amp;#34;Vancouver:&amp;#34;America/Vancouver&amp;#34;Toronto:&amp;#34;America/Toronto&amp;#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&amp;#34;alphabetical&amp;#34; Attributes colors.even Define the text color for even-numbered rows (2, 4, 6&amp;hellip;). Values: Any X11 color name.
colors.odd Define the text color for the odd-numbered rows (1, 3, 5&amp;hellip;). Values: Any X11 color name.
Configuration clocks:colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&amp;#34;Europe/Paris&amp;#34;Barcelona:&amp;#34;Europe/Madrid&amp;#34;Dubai:&amp;#34;Asia/Dubai&amp;#34;UTC:&amp;#34;Etc/UTC&amp;#34;Vancouver:&amp;#34;America/Vancouver&amp;#34;Toronto:&amp;#34;America/Toronto&amp;#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&amp;#34;alphabetical&amp;#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
colors.rows.odd Define the foreground color for the odd-numbered rows. Values: Any X11 color name.
enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
</item>

8
docs/posts/modules/clocks/index.html
View File

@ -147,13 +147,13 @@
</span><span class="w"> </span>sort<span class="p">:</span><span class="w"> </span><span class="s2">&#34;alphabetical&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>colors.even</code> <br />
Define the text color for even-numbered rows (2, 4, 6&hellip;). <br />
<p><code>colors.rows.even</code> <br />
Define the foreground color for even-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>
<p><code>colors.odd</code> <br />
Define the text color for the odd-numbered rows (1, 3, 5&hellip;). <br />
<p><code>colors.rows.odd</code> <br />
Define the foreground color for the odd-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>

19
docs/posts/modules/gcal/index.html
View File

@ -139,6 +139,8 @@
</span><span class="w"> </span>past<span class="p">:</span><span class="w"> </span><span class="s2">&#34;gray&#34;</span><span class="w">
</span><span class="w"> </span>conflictIcon<span class="p">:</span><span class="w"> </span><span class="s2">&#34;🚨&#34;</span><span class="w">
</span><span class="w"> </span>currentIcon<span class="p">:</span><span class="w"> </span><span class="s2">&#34;💥&#34;</span><span class="w">
</span><span class="w"> </span>displayResponseStatus<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>email<span class="p">:</span><span class="w"> </span><span class="s2">&#34;chriscummer@me.com&#34;</span><span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>eventCount<span class="p">:</span><span class="w"> </span><span class="m">12</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
@ -147,7 +149,8 @@
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w">
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">300</span><span class="w">
</span><span class="w"> </span>secretFile<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/.wtf/gcal/client_secret.json&#34;</span></code></pre></div>
</span><span class="w"> </span>secretFile<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/.wtf/gcal/client_secret.json&#34;</span><span class="w">
</span><span class="w"> </span>withLocation<span class="p">:</span><span class="w"> </span><span class="kc">true</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>colors.title</code> <br />
@ -177,6 +180,20 @@ Values: Any displayable unicode character.</p>
The icon displayed beside the current calendar event. <br />
Values: Any displayable unicode character.</p>
<p><code>displayLocation</code> <br />
Whether or not to display the location of the calendar event. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>displayResponseStatus</code> <br />
Whether or not to display your response status to the calendar event.
<br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>email</code> <br />
The email address associated with your Google account. Necessary for
determining <code>responseStatus</code>. <br />
Values: A valid email address string.</p>
<p><code>enabled</code> <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>

28
docs/posts/modules/jira/index.html
View File

@ -125,6 +125,10 @@
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">jira<span class="p">:</span><span class="w">
</span><span class="w"> </span>colors<span class="p">:</span><span class="w">
</span><span class="w"> </span>rows<span class="p">:</span><span class="w">
</span><span class="w"> </span>even<span class="p">:</span><span class="w"> </span><span class="s2">&#34;lightblue&#34;</span><span class="w">
</span><span class="w"> </span>odd<span class="p">:</span><span class="w"> </span><span class="s2">&#34;white&#34;</span><span class="w">
</span><span class="w"> </span>domain<span class="p">:</span><span class="w"> </span><span class="s2">&#34;https://umbrellacorp.atlassian.net&#34;</span><span class="w">
</span><span class="w"> </span>email<span class="p">:</span><span class="w"> </span><span class="s2">&#34;chriscummer@me.com&#34;</span><span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
@ -138,9 +142,23 @@
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">&#34;chris.cummer&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>domain</code> <br /></p>
<p><code>colors.rows.even</code> <br />
Define the foreground color for even-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>
<p><code>email</code> <br /></p>
<p><code>colors.rows.odd</code> <br />
Define the foreground color for odd-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>
<p><code>domain</code> <br />
Your Jira corporate domain. <br />
Values: A valid URI.</p>
<p><code>email</code> <br />
The email address associated with your Jira account. <br />
Values: A valid email address string.</p>
<p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
@ -149,13 +167,15 @@ Values: <code>true</code>, <code>false</code>.</p>
<p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>
<p><code>project</code> <br /></p>
<p><code>project</code> <br />
The Jira project to fetch information for. <br /></p>
<p><code>refreshInterval</code> <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, <code>0..n</code>.</p>
<p><code>username</code> <br /></p>
<p><code>username</code> <br />
Your Jira username. <br /></p>
</div>
<div class="footer">

8
docs/posts/modules/textfile/index.html
View File

@ -129,7 +129,7 @@
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">textfile<span class="p">:</span><span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>filename<span class="p">:</span><span class="w"> </span><span class="s2">&#34;notes.md&#34;</span><span class="w">
</span><span class="w"> </span>filePath<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/Desktop/notes.md&#34;</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">5</span><span class="w">
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w">
@ -142,10 +142,8 @@
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>filename</code> <br />
The name of the file to be displayed in the widget. <br />
<em>Note:</em> Currently this file <em>must</em> reside in the <code>~/.wtf/</code> directory.
This is a <a href="https://github.com/senorprogrammer/wtf/issues/35">known bug</a>.</p>
<p><code>filePath</code> <br />
The path to the file to be displayed in the widget. <br /></p>
<p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>

46
docs/posts/modules/todo/index.html
View File

@ -100,7 +100,7 @@
<br/>
<i class="fas fa-clock"></i> 1 min read
<i class="fas fa-clock"></i> 2 min read
</span>
</div>
@ -108,6 +108,8 @@
<h2 id="description">Description</h2>
<p>An interactive todo list.</p>
<p><img src="/imgs/modules/todo.png" width="320" height="388" alt="todo screenshot" /></p>
<h2 id="source-code">Source Code</h2>
@ -118,7 +120,47 @@
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p>A basic, interactive todo list.</p>
<p><span class="caption">Key:</span> <code>[return]</code> <br />
<span class="caption">Action:</span> Edit the selected item. <br />
<span class="caption">Action:</span> Close the modal item dialog and save changes. <br /></p>
<p><span class="caption">Key:</span> <code>[esc]</code> <br />
<span class="caption">Action:</span> Remove focus from the selected item. <br />
<span class="caption">Action:</span> Close the modal item dialog without saving changes.</p>
<p><span class="caption">Key:</span> <code>[space]</code> <br />
<span class="caption">Action:</span> Check/uncheck the selected item.</p>
<p><span class="caption">Key:</span> <code>/</code> <br />
<span class="caption">Action:</span> Open/close the widget&rsquo;s help window.</p>
<p><span class="caption">Key:</span> <code>j</code> <br />
<span class="caption">Action:</span> Select the next item in the list.</p>
<p><span class="caption">Key:</span> <code>k</code> <br />
<span class="caption">Action:</span> Select the previous item in the list.</p>
<p><span class="caption">Key:</span> <code>n</code> <br />
<span class="caption">Action:</span> Create a new list item.</p>
<p><span class="caption">Key:</span> <code>o</code> <br />
<span class="caption">Action:</span> Opens the todo list file in
whichever text editor is associated with that file type.</p>
<p><span class="caption">Key:</span> <code>↓</code> <br />
<span class="caption">Action:</span> Select the next item in the list.</p>
<p><span class="caption">Key:</span> <code>↑</code> <br />
<span class="caption">Action:</span> Select the previous item in the list.</p>
<p><span class="caption">Key:</span> <code>Ctrl-d</code> <br />
<span class="caption">Action:</span> Delete the selected item.</p>
<p><span class="caption">Key:</span> <code>Ctrl-J</code> <br />
<span class="caption">Action:</span> Move the selected item down the list.</p>
<p><span class="caption">Key:</span> <code>Ctrl-K</code> <br />
<span class="caption">Action:</span> Move the selected item up the list.</p>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">todo<span class="p">:</span><span class="w">

2
gcal/widget.go
View File

@ -179,7 +179,7 @@ func (widget *Widget) titleColor(event *calendar.Event) string {
}
func (widget *Widget) location(event *calendar.Event) string {
if Config.UBool("wtf.mods.gcal.withLocation", true) == false {
if Config.UBool("wtf.mods.gcal.displayLocation", true) == false {
return ""
}