diff --git a/_site/content/posts/modules/clocks.md b/_site/content/posts/modules/clocks.md index cff31493..0c0f702b 100644 --- a/_site/content/posts/modules/clocks.md +++ b/_site/content/posts/modules/clocks.md @@ -52,13 +52,13 @@ clocks: ``` ### Attributes -`colors.even`
-Define the text color for even-numbered rows (2, 4, 6...).
+`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...).
+`colors.rows.odd`
+Define the foreground color for the odd-numbered rows.
Values: Any X11 color name. diff --git a/_site/content/posts/modules/gcal.md b/_site/content/posts/modules/gcal.md index 503043db..b20b77dd 100644 --- a/_site/content/posts/modules/gcal.md +++ b/_site/content/posts/modules/gcal.md @@ -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.
Values: Any displayable unicode character. +`displayLocation`
+Whether or not to display the location of the calendar event.
+Values: `true`, `false`. + +`displayResponseStatus`
+Whether or not to display your response status to the calendar event. +
+Values: `true`, `false`. + +`email`
+The email address associated with your Google account. Necessary for +determining `responseStatus`.
+Values: A valid email address string. + `enabled`
Whether or not this module is executed and if its data displayed onscreen.
Values: `true`, `false`. @@ -101,3 +118,4 @@ Values: A positive integer, `0..n`. `secretFile`
Your Google client secret JSON file.
Values: A string representing a file path to the JSON secret file. + diff --git a/_site/content/posts/modules/jira.md b/_site/content/posts/modules/jira.md index 013d1b1a..326a91d4 100644 --- a/_site/content/posts/modules/jira.md +++ b/_site/content/posts/modules/jira.md @@ -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`
+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.
+Values: A valid email address string. `enabled`
Determines whether or not this module is executed and if its data displayed onscreen.
@@ -56,9 +74,11 @@ Values: `true`, `false`. Defines where in the grid this module's widget will be displayed.
`project`
+The Jira project to fetch information for.
`refreshInterval`
How often, in seconds, this module will update its data.
Values: A positive integer, `0..n`. `username`
+Your Jira username.
diff --git a/docs/index.xml b/docs/index.xml index 9cbc17bf..ed3dd24d 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -17,14 +17,12 @@ Thu, 10 May 2018 12:41:50 -0700 http://wtfutil.com/posts/modules/todo/ - Description Source Code wtf/todo/ Required ENV Variables None. -Keyboard Commands A basic, interactive todo list. -Configuration todo:checkedIcon:"X"colors:checked:grayhighlight:fore:"black"back:"orange"enabled:truefilename:"todo.yml"position:top:2left:2height:2width:1refreshInterval:3600 Attributes checkedIcon The icon used to denote a “checked” 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 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’s help window. +Key: j Action: Select the next item in the list. @@ -36,8 +34,10 @@ filename The name for the todo file. 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:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:trueposition:top:4left:1height:1width:2project:"CORE"refreshInterval:900username:"chris.cummer" 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’s widget will be displayed. project refreshInterval How often, in seconds, this module will update its data. +Configuration jira:colors:rows:even:"lightblue"odd:"white"domain:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:trueposition:top:4left:1height:1width:2project:"CORE"refreshInterval:900username:"chris.cummer" 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. @@ -50,7 +50,7 @@ position Defines where in the grid this module’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:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.wtf/gcal/client_secret.json" Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name. +Configuration gcal:colors:title:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"displayResponseStatus:trueemail:"chriscummer@me.com"enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.wtf/gcal/client_secret.json"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. @@ -109,8 +109,8 @@ Key: → Action: Show the next weather location. Source Code wtf/textfile/ Required ENV Variables None. Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: o Action: Opens the text file in whichever text editor is associated with that file type. -Configuration textfile:enabled:truefilename:"notes.md"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. +Configuration textfile:enabled:truefilePath:"~/Desktop/notes.md"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. @@ -172,8 +172,8 @@ position Defines where in the grid this module’s widget will be displa 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:"lightblue"odd:"white"enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:"Europe/Paris"Barcelona:"Europe/Madrid"Dubai:"Asia/Dubai"UTC:"Etc/UTC"Vancouver:"America/Vancouver"Toronto:"America/Toronto"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" Attributes colors.even Define the text color for even-numbered rows (2, 4, 6…). Values: Any X11 color name. -colors.odd Define the text color for the odd-numbered rows (1, 3, 5…). Values: Any X11 color name. +Configuration clocks:colors:rows:even:"lightblue"odd:"white"enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:"Europe/Paris"Barcelona:"Europe/Madrid"Dubai:"Asia/Dubai"UTC:"Etc/UTC"Vancouver:"America/Vancouver"Toronto:"America/Toronto"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" 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. diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 0bd3cf1e..85d7b3c7 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -17,14 +17,12 @@ Thu, 10 May 2018 12:41:50 -0700 http://wtfutil.com/posts/modules/todo/ - Description Source Code wtf/todo/ Required ENV Variables None. -Keyboard Commands A basic, interactive todo list. -Configuration todo:checkedIcon:"X"colors:checked:grayhighlight:fore:"black"back:"orange"enabled:truefilename:"todo.yml"position:top:2left:2height:2width:1refreshInterval:3600 Attributes checkedIcon The icon used to denote a “checked” 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 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’s help window. +Key: j Action: Select the next item in the list. @@ -36,8 +34,10 @@ filename The name for the todo file. 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:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:trueposition:top:4left:1height:1width:2project:"CORE"refreshInterval:900username:"chris.cummer" 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’s widget will be displayed. project refreshInterval How often, in seconds, this module will update its data. +Configuration jira:colors:rows:even:"lightblue"odd:"white"domain:"https://umbrellacorp.atlassian.net"email:"chriscummer@me.com"enabled:trueposition:top:4left:1height:1width:2project:"CORE"refreshInterval:900username:"chris.cummer" 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. @@ -50,7 +50,7 @@ position Defines where in the grid this module’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:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.wtf/gcal/client_secret.json" Attributes colors.title The default colour for calendar event titles. Values: Any X11 color name. +Configuration gcal:colors:title:"red"description:"lightblue"highlights:-['1on1|1\/11','green']-['apple|google|aws','blue']-['interview|meet','magenta']-['lunch','yellow']past:"gray"conflictIcon:"🚨"currentIcon:"💥"displayResponseStatus:trueemail:"chriscummer@me.com"enabled:trueeventCount:12position:top:0left:0height:4width:1refreshInterval:300secretFile:"~/.wtf/gcal/client_secret.json"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. @@ -109,8 +109,8 @@ Key: → Action: Show the next weather location. Source Code wtf/textfile/ Required ENV Variables None. Keyboard Commands Key: / Action: Open/close the widget’s help window. Key: o Action: Opens the text file in whichever text editor is associated with that file type. -Configuration textfile:enabled:truefilename:"notes.md"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. +Configuration textfile:enabled:truefilePath:"~/Desktop/notes.md"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. @@ -172,8 +172,8 @@ position Defines where in the grid this module’s widget will be displa 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:"lightblue"odd:"white"enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:"Europe/Paris"Barcelona:"Europe/Madrid"Dubai:"Asia/Dubai"UTC:"Etc/UTC"Vancouver:"America/Vancouver"Toronto:"America/Toronto"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" Attributes colors.even Define the text color for even-numbered rows (2, 4, 6…). Values: Any X11 color name. -colors.odd Define the text color for the odd-numbered rows (1, 3, 5…). Values: Any X11 color name. +Configuration clocks:colors:rows:even:"lightblue"odd:"white"enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:"Europe/Paris"Barcelona:"Europe/Madrid"Dubai:"Asia/Dubai"UTC:"Etc/UTC"Vancouver:"America/Vancouver"Toronto:"America/Toronto"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" 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. diff --git a/docs/posts/modules/clocks/index.html b/docs/posts/modules/clocks/index.html index 9816d9cf..6ec3c525 100644 --- a/docs/posts/modules/clocks/index.html +++ b/docs/posts/modules/clocks/index.html @@ -147,13 +147,13 @@ sort: "alphabetical"

Attributes

-

colors.even
-Define the text color for even-numbered rows (2, 4, 6…).
+

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…).
+

colors.rows.odd
+Define the foreground color for the odd-numbered rows.
Values: Any X11 color name.

diff --git a/docs/posts/modules/gcal/index.html b/docs/posts/modules/gcal/index.html index c4524cca..f102f13e 100644 --- a/docs/posts/modules/gcal/index.html +++ b/docs/posts/modules/gcal/index.html @@ -139,6 +139,8 @@ past: "gray" conflictIcon: "🚨" currentIcon: "💥" + displayResponseStatus: true + email: "chriscummer@me.com" enabled: true eventCount: 12 position: @@ -147,7 +149,8 @@ height: 4 width: 1 refreshInterval: 300 - secretFile: "~/.wtf/gcal/client_secret.json" + secretFile: "~/.wtf/gcal/client_secret.json" + withLocation: true

Attributes

colors.title
@@ -177,6 +180,20 @@ Values: Any displayable unicode character.

The icon displayed beside the current calendar event.
Values: Any displayable unicode character.

+

displayLocation
+Whether or not to display the location of the calendar event.
+Values: true, false.

+ +

displayResponseStatus
+Whether or not to display your response status to the calendar event. +
+Values: true, false.

+ +

email
+The email address associated with your Google account. Necessary for +determining responseStatus.
+Values: A valid email address string.

+

enabled
Whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

diff --git a/docs/posts/modules/jira/index.html b/docs/posts/modules/jira/index.html index b6879072..f749d1b4 100644 --- a/docs/posts/modules/jira/index.html +++ b/docs/posts/modules/jira/index.html @@ -125,6 +125,10 @@

Configuration

jira:
+  colors:
+    rows:
+      even: "lightblue"
+      odd: "white"
   domain: "https://umbrellacorp.atlassian.net"
   email: "chriscummer@me.com"
   enabled: true
@@ -138,9 +142,23 @@
   username: "chris.cummer"

Attributes

-

domain

+

colors.rows.even
+Define the foreground color for even-numbered rows.
+Values: Any X11 +color name.

-

email

+

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.
+Values: A valid email address string.

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
@@ -149,13 +167,15 @@ Values: true, false.

position
Defines where in the grid this module’s widget will be displayed.

-

project

+

project
+The Jira project to fetch information for.

refreshInterval
How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

-

username

+

username
+Your Jira username.

diff --git a/docs/posts/modules/textfile/index.html b/docs/posts/modules/textfile/index.html index e141be99..cf6664cb 100644 --- a/docs/posts/modules/textfile/index.html +++ b/docs/posts/modules/textfile/index.html @@ -129,7 +129,7 @@

Configuration

textfile:
   enabled: true
-  filename: "notes.md"
+  filePath: "~/Desktop/notes.md"
   position:
     top: 5
     left: 4
@@ -142,10 +142,8 @@
 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. 

-Note: Currently this file must reside in the ~/.wtf/ directory.
-This is a known bug.

+
filePath 

+The path to the file to be displayed in the widget. 

 
 
position 

 Defines where in the grid this module’s widget will be displayed. 

diff --git a/docs/posts/modules/todo/index.html b/docs/posts/modules/todo/index.html
index 30994c3d..8c8df017 100644
--- a/docs/posts/modules/todo/index.html
+++ b/docs/posts/modules/todo/index.html
@@ -100,7 +100,7 @@
       
       
       

-       1 min read 
+       2 min read
@@ -108,6 +108,8 @@

Description

+

An interactive todo list.

+

todo screenshot

Source Code

@@ -118,7 +120,47 @@

Keyboard Commands

-

A basic, interactive todo list.

+

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’s help window.

+ +

Key: j
+Action: Select the next item in the list.

+ +

Key: k
+Action: Select the previous item in the list.

+ +

Key: n
+Action: Create a new list item.

+ +

Key: o
+Action: Opens the todo list file in +whichever text editor is associated with that file type.

+ +

Key: ↓
+Action: Select the next item in the list.

+ +

Key: ↑
+Action: Select the previous item in the list.

+ +

Key: Ctrl-d
+Action: Delete the selected item.

+ +

Key: Ctrl-J
+Action: Move the selected item down the list.

+ +

Key: Ctrl-K
+Action: Move the selected item up the list.

Configuration

todo:
diff --git a/gcal/widget.go b/gcal/widget.go
index f4242cac..d2b1fd11 100644
--- a/gcal/widget.go
+++ b/gcal/widget.go
@@ -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 ""
 	}