mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
More documentation for Clocks, GCal, and Jira.
This commit is contained in:
parent
2ecd5e4b84
commit
40ca748b8d
@ -52,13 +52,13 @@ clocks:
|
|||||||
```
|
```
|
||||||
### Attributes
|
### Attributes
|
||||||
|
|
||||||
`colors.even` <br />
|
`colors.rows.even` <br />
|
||||||
Define the text color for even-numbered rows (2, 4, 6...). <br />
|
Define the foreground color for even-numbered rows. <br />
|
||||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||||
color name</a>.
|
color name</a>.
|
||||||
|
|
||||||
`colors.odd` <br />
|
`colors.rows.odd` <br />
|
||||||
Define the text color for the odd-numbered rows (1, 3, 5...). <br />
|
Define the foreground color for the odd-numbered rows. <br />
|
||||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||||
color name</a>.
|
color name</a>.
|
||||||
|
|
||||||
|
@ -43,6 +43,8 @@ gcal:
|
|||||||
past: "gray"
|
past: "gray"
|
||||||
conflictIcon: "🚨"
|
conflictIcon: "🚨"
|
||||||
currentIcon: "💥"
|
currentIcon: "💥"
|
||||||
|
displayResponseStatus: true
|
||||||
|
email: "chriscummer@me.com"
|
||||||
enabled: true
|
enabled: true
|
||||||
eventCount: 12
|
eventCount: 12
|
||||||
position:
|
position:
|
||||||
@ -52,6 +54,7 @@ gcal:
|
|||||||
width: 1
|
width: 1
|
||||||
refreshInterval: 300
|
refreshInterval: 300
|
||||||
secretFile: "~/.wtf/gcal/client_secret.json"
|
secretFile: "~/.wtf/gcal/client_secret.json"
|
||||||
|
withLocation: true
|
||||||
```
|
```
|
||||||
|
|
||||||
### Attributes
|
### Attributes
|
||||||
@ -83,6 +86,20 @@ Values: Any displayable unicode character.
|
|||||||
The icon displayed beside the current calendar event. <br />
|
The icon displayed beside the current calendar event. <br />
|
||||||
Values: Any displayable unicode character.
|
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 />
|
`enabled` <br />
|
||||||
Whether or not this module is executed and if its data displayed onscreen. <br />
|
Whether or not this module is executed and if its data displayed onscreen. <br />
|
||||||
Values: `true`, `false`.
|
Values: `true`, `false`.
|
||||||
@ -101,3 +118,4 @@ Values: A positive integer, `0..n`.
|
|||||||
`secretFile` <br />
|
`secretFile` <br />
|
||||||
Your <a href="https://developers.google.com/calendar/quickstart/go">Google client secret</a> JSON file. <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.
|
Values: A string representing a file path to the JSON secret file.
|
||||||
|
|
||||||
|
@ -29,6 +29,10 @@ None.
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
jira:
|
jira:
|
||||||
|
colors:
|
||||||
|
rows:
|
||||||
|
even: "lightblue"
|
||||||
|
odd: "white"
|
||||||
domain: "https://umbrellacorp.atlassian.net"
|
domain: "https://umbrellacorp.atlassian.net"
|
||||||
email: "chriscummer@me.com"
|
email: "chriscummer@me.com"
|
||||||
enabled: true
|
enabled: true
|
||||||
@ -44,9 +48,23 @@ jira:
|
|||||||
|
|
||||||
### Attributes
|
### 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 />
|
`domain` <br />
|
||||||
|
Your Jira corporate domain. <br />
|
||||||
|
Values: A valid URI.
|
||||||
|
|
||||||
`email` <br />
|
`email` <br />
|
||||||
|
The email address associated with your Jira account. <br />
|
||||||
|
Values: A valid email address string.
|
||||||
|
|
||||||
`enabled` <br />
|
`enabled` <br />
|
||||||
Determines whether or not this module is executed and if its data displayed onscreen. <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 />
|
Defines where in the grid this module's widget will be displayed. <br />
|
||||||
|
|
||||||
`project` <br />
|
`project` <br />
|
||||||
|
The Jira project to fetch information for. <br />
|
||||||
|
|
||||||
`refreshInterval` <br />
|
`refreshInterval` <br />
|
||||||
How often, in seconds, this module will update its data. <br />
|
How often, in seconds, this module will update its data. <br />
|
||||||
Values: A positive integer, `0..n`.
|
Values: A positive integer, `0..n`.
|
||||||
|
|
||||||
`username` <br />
|
`username` <br />
|
||||||
|
Your Jira username. <br />
|
||||||
|
@ -17,14 +17,12 @@
|
|||||||
<pubDate>Thu, 10 May 2018 12:41:50 -0700</pubDate>
|
<pubDate>Thu, 10 May 2018 12:41:50 -0700</pubDate>
|
||||||
|
|
||||||
<guid>http://wtfutil.com/posts/modules/todo/</guid>
|
<guid>http://wtfutil.com/posts/modules/todo/</guid>
|
||||||
<description>Description Source Code wtf/todo/ Required ENV Variables None.
|
<description>Description An interactive todo list.
|
||||||
Keyboard Commands A basic, interactive todo list.
|
Source Code wtf/todo/ Required ENV Variables None.
|
||||||
Configuration todo:checkedIcon:&#34;X&#34;colors:checked:grayhighlight:fore:&#34;black&#34;back:&#34;orange&#34;enabled:truefilename:&#34;todo.yml&#34;position:top:2left:2height:2width:1refreshInterval:3600 Attributes checkedIcon The icon used to denote a &ldquo;checked&rdquo; todo item. Values: Any displayable unicode character.
|
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.
|
||||||
colors.checked Values: Any X11 color name.
|
Key: [space] Action: Check/uncheck the selected item.
|
||||||
colors.highlight.fore Values: Any X11 color name.
|
Key: / Action: Open/close the widget&rsquo;s help window.
|
||||||
colors.highlight.back Values: Any X11 color name.
|
Key: j Action: Select the next item in the list.</description>
|
||||||
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>
|
|
||||||
</item>
|
</item>
|
||||||
|
|
||||||
<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.
|
<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.
|
Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key.
|
||||||
Keyboard Commands None.
|
Keyboard Commands None.
|
||||||
Configuration jira:domain:&#34;https://umbrellacorp.atlassian.net&#34;email:&#34;chriscummer@me.com&#34;enabled:trueposition:top:4left:1height:1width:2project:&#34;CORE&#34;refreshInterval:900username:&#34;chris.cummer&#34; Attributes domain email enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
|
Configuration jira:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;domain:&#34;https://umbrellacorp.atlassian.net&#34;email:&#34;chriscummer@me.com&#34;enabled:trueposition:top:4left:1height:1width:2project:&#34;CORE&#34;refreshInterval:900username:&#34;chris.cummer&#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
|
||||||
position Defines where in the grid this module&rsquo;s widget will be displayed. project refreshInterval How often, in seconds, this module will update its data.</description>
|
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>
|
||||||
|
|
||||||
<item>
|
<item>
|
||||||
@ -50,7 +50,7 @@ position Defines where in the grid this module&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.
|
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.
|
Key: WTF_GOOGLE_CAL_CLIENT_SECRET Value: Your Google API client secret.
|
||||||
Keyboard Commands None.
|
Keyboard Commands None.
|
||||||
Configuration gcal:colors:title:&#34;red&#34;description:&#34;lightblue&#34;highlights:-[&#39;1on1|1\/11&#39;,&#39;green&#39;]-[&#39;apple|google|aws&#39;,&#39;blue&#39;]-[&#39;interview|meet&#39;,&#39;magenta&#39;]-[&#39;lunch&#39;,&#39;yellow&#39;]past:&#34;gray&#34;conflictIcon:&#34;🚨&#34;currentIcon:&#34;💥&#34;enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:&#34;~/.wtf/gcal/client_secret.json&#34; Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.
|
Configuration gcal:colors:title:&#34;red&#34;description:&#34;lightblue&#34;highlights:-[&#39;1on1|1\/11&#39;,&#39;green&#39;]-[&#39;apple|google|aws&#39;,&#39;blue&#39;]-[&#39;interview|meet&#39;,&#39;magenta&#39;]-[&#39;lunch&#39;,&#39;yellow&#39;]past:&#34;gray&#34;conflictIcon:&#34;🚨&#34;currentIcon:&#34;💥&#34;displayResponseStatus:trueemail:&#34;chriscummer@me.com&#34;enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:&#34;~/.wtf/gcal/client_secret.json&#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.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>
|
colors.highlights A list of arrays that define a regular expression pattern and a color.</description>
|
||||||
</item>
|
</item>
|
||||||
@ -109,8 +109,8 @@ Key: → Action: Show the next weather location.</description>
|
|||||||
Source Code wtf/textfile/ Required ENV Variables None.
|
Source Code wtf/textfile/ Required ENV Variables None.
|
||||||
Keyboard Commands Key: / Action: Open/close the widget&rsquo;s help window.
|
Keyboard Commands Key: / Action: Open/close the widget&rsquo;s help window.
|
||||||
Key: o Action: Opens the text file in whichever text editor is associated with that file type.
|
Key: o Action: Opens the text file in whichever text editor is associated with that file type.
|
||||||
Configuration textfile:enabled:truefilename:&#34;notes.md&#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.
|
Configuration textfile:enabled:truefilePath:&#34;~/Desktop/notes.md&#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>
|
filePath The path to the file to be displayed in the widget.</description>
|
||||||
</item>
|
</item>
|
||||||
|
|
||||||
<item>
|
<item>
|
||||||
@ -172,8 +172,8 @@ position Defines where in the grid this module&rsquo;s widget will be displa
|
|||||||
<description>Description Displays a configurable list of world clocks, the local time, and date.
|
<description>Description Displays a configurable list of world clocks, the local time, and date.
|
||||||
Source Code wtf/clocks/ Required ENV Variables None.
|
Source Code wtf/clocks/ Required ENV Variables None.
|
||||||
Keyboard Commands None.
|
Keyboard Commands None.
|
||||||
Configuration clocks:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&#34;Europe/Paris&#34;Barcelona:&#34;Europe/Madrid&#34;Dubai:&#34;Asia/Dubai&#34;UTC:&#34;Etc/UTC&#34;Vancouver:&#34;America/Vancouver&#34;Toronto:&#34;America/Toronto&#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&#34;alphabetical&#34; Attributes colors.even Define the text color for even-numbered rows (2, 4, 6&hellip;). Values: Any X11 color name.
|
Configuration clocks:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&#34;Europe/Paris&#34;Barcelona:&#34;Europe/Madrid&#34;Dubai:&#34;Asia/Dubai&#34;UTC:&#34;Etc/UTC&#34;Vancouver:&#34;America/Vancouver&#34;Toronto:&#34;America/Toronto&#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&#34;alphabetical&#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
|
||||||
colors.odd Define the text color for the odd-numbered rows (1, 3, 5&hellip;). 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>
|
enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
|
||||||
</item>
|
</item>
|
||||||
|
|
||||||
|
@ -17,14 +17,12 @@
|
|||||||
<pubDate>Thu, 10 May 2018 12:41:50 -0700</pubDate>
|
<pubDate>Thu, 10 May 2018 12:41:50 -0700</pubDate>
|
||||||
|
|
||||||
<guid>http://wtfutil.com/posts/modules/todo/</guid>
|
<guid>http://wtfutil.com/posts/modules/todo/</guid>
|
||||||
<description>Description Source Code wtf/todo/ Required ENV Variables None.
|
<description>Description An interactive todo list.
|
||||||
Keyboard Commands A basic, interactive todo list.
|
Source Code wtf/todo/ Required ENV Variables None.
|
||||||
Configuration todo:checkedIcon:&#34;X&#34;colors:checked:grayhighlight:fore:&#34;black&#34;back:&#34;orange&#34;enabled:truefilename:&#34;todo.yml&#34;position:top:2left:2height:2width:1refreshInterval:3600 Attributes checkedIcon The icon used to denote a &ldquo;checked&rdquo; todo item. Values: Any displayable unicode character.
|
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.
|
||||||
colors.checked Values: Any X11 color name.
|
Key: [space] Action: Check/uncheck the selected item.
|
||||||
colors.highlight.fore Values: Any X11 color name.
|
Key: / Action: Open/close the widget&rsquo;s help window.
|
||||||
colors.highlight.back Values: Any X11 color name.
|
Key: j Action: Select the next item in the list.</description>
|
||||||
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>
|
|
||||||
</item>
|
</item>
|
||||||
|
|
||||||
<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.
|
<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.
|
Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key.
|
||||||
Keyboard Commands None.
|
Keyboard Commands None.
|
||||||
Configuration jira:domain:&#34;https://umbrellacorp.atlassian.net&#34;email:&#34;chriscummer@me.com&#34;enabled:trueposition:top:4left:1height:1width:2project:&#34;CORE&#34;refreshInterval:900username:&#34;chris.cummer&#34; Attributes domain email enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
|
Configuration jira:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;domain:&#34;https://umbrellacorp.atlassian.net&#34;email:&#34;chriscummer@me.com&#34;enabled:trueposition:top:4left:1height:1width:2project:&#34;CORE&#34;refreshInterval:900username:&#34;chris.cummer&#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
|
||||||
position Defines where in the grid this module&rsquo;s widget will be displayed. project refreshInterval How often, in seconds, this module will update its data.</description>
|
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>
|
||||||
|
|
||||||
<item>
|
<item>
|
||||||
@ -50,7 +50,7 @@ position Defines where in the grid this module&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.
|
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.
|
Key: WTF_GOOGLE_CAL_CLIENT_SECRET Value: Your Google API client secret.
|
||||||
Keyboard Commands None.
|
Keyboard Commands None.
|
||||||
Configuration gcal:colors:title:&#34;red&#34;description:&#34;lightblue&#34;highlights:-[&#39;1on1|1\/11&#39;,&#39;green&#39;]-[&#39;apple|google|aws&#39;,&#39;blue&#39;]-[&#39;interview|meet&#39;,&#39;magenta&#39;]-[&#39;lunch&#39;,&#39;yellow&#39;]past:&#34;gray&#34;conflictIcon:&#34;🚨&#34;currentIcon:&#34;💥&#34;enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:&#34;~/.wtf/gcal/client_secret.json&#34; Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name.
|
Configuration gcal:colors:title:&#34;red&#34;description:&#34;lightblue&#34;highlights:-[&#39;1on1|1\/11&#39;,&#39;green&#39;]-[&#39;apple|google|aws&#39;,&#39;blue&#39;]-[&#39;interview|meet&#39;,&#39;magenta&#39;]-[&#39;lunch&#39;,&#39;yellow&#39;]past:&#34;gray&#34;conflictIcon:&#34;🚨&#34;currentIcon:&#34;💥&#34;displayResponseStatus:trueemail:&#34;chriscummer@me.com&#34;enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:&#34;~/.wtf/gcal/client_secret.json&#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.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>
|
colors.highlights A list of arrays that define a regular expression pattern and a color.</description>
|
||||||
</item>
|
</item>
|
||||||
@ -109,8 +109,8 @@ Key: → Action: Show the next weather location.</description>
|
|||||||
Source Code wtf/textfile/ Required ENV Variables None.
|
Source Code wtf/textfile/ Required ENV Variables None.
|
||||||
Keyboard Commands Key: / Action: Open/close the widget&rsquo;s help window.
|
Keyboard Commands Key: / Action: Open/close the widget&rsquo;s help window.
|
||||||
Key: o Action: Opens the text file in whichever text editor is associated with that file type.
|
Key: o Action: Opens the text file in whichever text editor is associated with that file type.
|
||||||
Configuration textfile:enabled:truefilename:&#34;notes.md&#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.
|
Configuration textfile:enabled:truefilePath:&#34;~/Desktop/notes.md&#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>
|
filePath The path to the file to be displayed in the widget.</description>
|
||||||
</item>
|
</item>
|
||||||
|
|
||||||
<item>
|
<item>
|
||||||
@ -172,8 +172,8 @@ position Defines where in the grid this module&rsquo;s widget will be displa
|
|||||||
<description>Description Displays a configurable list of world clocks, the local time, and date.
|
<description>Description Displays a configurable list of world clocks, the local time, and date.
|
||||||
Source Code wtf/clocks/ Required ENV Variables None.
|
Source Code wtf/clocks/ Required ENV Variables None.
|
||||||
Keyboard Commands None.
|
Keyboard Commands None.
|
||||||
Configuration clocks:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&#34;Europe/Paris&#34;Barcelona:&#34;Europe/Madrid&#34;Dubai:&#34;Asia/Dubai&#34;UTC:&#34;Etc/UTC&#34;Vancouver:&#34;America/Vancouver&#34;Toronto:&#34;America/Toronto&#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&#34;alphabetical&#34; Attributes colors.even Define the text color for even-numbered rows (2, 4, 6&hellip;). Values: Any X11 color name.
|
Configuration clocks:colors:rows:even:&#34;lightblue&#34;odd:&#34;white&#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:&#34;Europe/Paris&#34;Barcelona:&#34;Europe/Madrid&#34;Dubai:&#34;Asia/Dubai&#34;UTC:&#34;Etc/UTC&#34;Vancouver:&#34;America/Vancouver&#34;Toronto:&#34;America/Toronto&#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:&#34;alphabetical&#34; Attributes colors.rows.even Define the foreground color for even-numbered rows. Values: Any X11 color name.
|
||||||
colors.odd Define the text color for the odd-numbered rows (1, 3, 5&hellip;). 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>
|
enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
|
||||||
</item>
|
</item>
|
||||||
|
|
||||||
|
@ -147,13 +147,13 @@
|
|||||||
</span><span class="w"> </span>sort<span class="p">:</span><span class="w"> </span><span class="s2">"alphabetical"</span></code></pre></div>
|
</span><span class="w"> </span>sort<span class="p">:</span><span class="w"> </span><span class="s2">"alphabetical"</span></code></pre></div>
|
||||||
<h3 id="attributes">Attributes</h3>
|
<h3 id="attributes">Attributes</h3>
|
||||||
|
|
||||||
<p><code>colors.even</code> <br />
|
<p><code>colors.rows.even</code> <br />
|
||||||
Define the text color for even-numbered rows (2, 4, 6…). <br />
|
Define the foreground color for even-numbered rows. <br />
|
||||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||||
color name</a>.</p>
|
color name</a>.</p>
|
||||||
|
|
||||||
<p><code>colors.odd</code> <br />
|
<p><code>colors.rows.odd</code> <br />
|
||||||
Define the text color for the odd-numbered rows (1, 3, 5…). <br />
|
Define the foreground color for the odd-numbered rows. <br />
|
||||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||||
color name</a>.</p>
|
color name</a>.</p>
|
||||||
|
|
||||||
|
@ -139,6 +139,8 @@
|
|||||||
</span><span class="w"> </span>past<span class="p">:</span><span class="w"> </span><span class="s2">"gray"</span><span class="w">
|
</span><span class="w"> </span>past<span class="p">:</span><span class="w"> </span><span class="s2">"gray"</span><span class="w">
|
||||||
</span><span class="w"> </span>conflictIcon<span class="p">:</span><span class="w"> </span><span class="s2">"🚨"</span><span class="w">
|
</span><span class="w"> </span>conflictIcon<span class="p">:</span><span class="w"> </span><span class="s2">"🚨"</span><span class="w">
|
||||||
</span><span class="w"> </span>currentIcon<span class="p">:</span><span class="w"> </span><span class="s2">"💥"</span><span class="w">
|
</span><span class="w"> </span>currentIcon<span class="p">:</span><span class="w"> </span><span class="s2">"💥"</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">"chriscummer@me.com"</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>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>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">
|
</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>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>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>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">"~/.wtf/gcal/client_secret.json"</span></code></pre></div>
|
</span><span class="w"> </span>secretFile<span class="p">:</span><span class="w"> </span><span class="s2">"~/.wtf/gcal/client_secret.json"</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>
|
<h3 id="attributes">Attributes</h3>
|
||||||
|
|
||||||
<p><code>colors.title</code> <br />
|
<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 />
|
The icon displayed beside the current calendar event. <br />
|
||||||
Values: Any displayable unicode character.</p>
|
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 />
|
<p><code>enabled</code> <br />
|
||||||
Whether or not this module is executed and if its data displayed onscreen. <br />
|
Whether or not this module is executed and if its data displayed onscreen. <br />
|
||||||
Values: <code>true</code>, <code>false</code>.</p>
|
Values: <code>true</code>, <code>false</code>.</p>
|
||||||
|
@ -125,6 +125,10 @@
|
|||||||
|
|
||||||
<h2 id="configuration">Configuration</h2>
|
<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">
|
<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">"lightblue"</span><span class="w">
|
||||||
|
</span><span class="w"> </span>odd<span class="p">:</span><span class="w"> </span><span class="s2">"white"</span><span class="w">
|
||||||
</span><span class="w"> </span>domain<span class="p">:</span><span class="w"> </span><span class="s2">"https://umbrellacorp.atlassian.net"</span><span class="w">
|
</span><span class="w"> </span>domain<span class="p">:</span><span class="w"> </span><span class="s2">"https://umbrellacorp.atlassian.net"</span><span class="w">
|
||||||
</span><span class="w"> </span>email<span class="p">:</span><span class="w"> </span><span class="s2">"chriscummer@me.com"</span><span class="w">
|
</span><span class="w"> </span>email<span class="p">:</span><span class="w"> </span><span class="s2">"chriscummer@me.com"</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>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">"chris.cummer"</span></code></pre></div>
|
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">"chris.cummer"</span></code></pre></div>
|
||||||
<h3 id="attributes">Attributes</h3>
|
<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 />
|
<p><code>enabled</code> <br />
|
||||||
Determines whether or not this module is executed and if its data displayed onscreen. <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 />
|
<p><code>position</code> <br />
|
||||||
Defines where in the grid this module’s widget will be displayed. <br /></p>
|
Defines where in the grid this module’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 />
|
<p><code>refreshInterval</code> <br />
|
||||||
How often, in seconds, this module will update its data. <br />
|
How often, in seconds, this module will update its data. <br />
|
||||||
Values: A positive integer, <code>0..n</code>.</p>
|
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>
|
||||||
<div class="footer">
|
<div class="footer">
|
||||||
|
@ -129,7 +129,7 @@
|
|||||||
<h2 id="configuration">Configuration</h2>
|
<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">
|
<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>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">"notes.md"</span><span class="w">
|
</span><span class="w"> </span>filePath<span class="p">:</span><span class="w"> </span><span class="s2">"~/Desktop/notes.md"</span><span class="w">
|
||||||
</span><span class="w"> </span>position<span class="p">:</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>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">
|
</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 />
|
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||||
Values: <code>true</code>, <code>false</code>.</p>
|
Values: <code>true</code>, <code>false</code>.</p>
|
||||||
|
|
||||||
<p><code>filename</code> <br />
|
<p><code>filePath</code> <br />
|
||||||
The name of the file to be displayed in the widget. <br />
|
The path to the file to be displayed in the widget. <br /></p>
|
||||||
<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>position</code> <br />
|
<p><code>position</code> <br />
|
||||||
Defines where in the grid this module’s widget will be displayed. <br /></p>
|
Defines where in the grid this module’s widget will be displayed. <br /></p>
|
||||||
|
@ -100,7 +100,7 @@
|
|||||||
|
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<i class="fas fa-clock"></i> 1 min read
|
<i class="fas fa-clock"></i> 2 min read
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -108,6 +108,8 @@
|
|||||||
|
|
||||||
<h2 id="description">Description</h2>
|
<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>
|
<p><img src="/imgs/modules/todo.png" width="320" height="388" alt="todo screenshot" /></p>
|
||||||
|
|
||||||
<h2 id="source-code">Source Code</h2>
|
<h2 id="source-code">Source Code</h2>
|
||||||
@ -118,7 +120,47 @@
|
|||||||
|
|
||||||
<h2 id="keyboard-commands">Keyboard Commands</h2>
|
<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’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>
|
<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">
|
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">todo<span class="p">:</span><span class="w">
|
||||||
|
@ -179,7 +179,7 @@ func (widget *Widget) titleColor(event *calendar.Event) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (widget *Widget) location(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 ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user