diff --git a/_site/content/posts/modules.md b/_site/content/posts/modules.md index 3e1fcb8f..f190404b 100644 --- a/_site/content/posts/modules.md +++ b/_site/content/posts/modules.md @@ -30,6 +30,6 @@ Available modules:
  • OpsGenie
  • Security
  • Text File -
  • Todo +
  • Todo
  • Weather diff --git a/_site/content/posts/modules/gcal.md b/_site/content/posts/modules/gcal.md index f53718a7..503043db 100644 --- a/_site/content/posts/modules/gcal.md +++ b/_site/content/posts/modules/gcal.md @@ -57,14 +57,12 @@ gcal: ### Attributes `colors.title`
    -Specifies the default colour for calendar event titles.
    -Values: Any X11 -color name. +The default colour for calendar event titles.
    +Values: Any X11 color name. `colors.description`
    -Specifies the default color for calendar event descriptions.
    -Values: Any X11 -color name. +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. @@ -73,9 +71,8 @@ be drawn in that colour. Over-rides the default title colour.
    Values: [a valid regular expression, any X11 color name.] `colors.past`
    -Specifies the color for calendar events that have passed.
    -Values: Any X11 -color name. +The color for calendar events that have passed.
    +Values: Any X11 color name. `conflictIcon`
    The icon displayed beside calendar events that have conflicting times @@ -87,7 +84,7 @@ The icon displayed beside the current calendar event.
    Values: Any displayable unicode character. `enabled`
    -Determines whether or not this module is executed and if its data displayed onscreen.
    +Whether or not this module is executed and if its data displayed onscreen.
    Values: `true`, `false`. `eventCount`
    @@ -95,7 +92,7 @@ The number of calendar events to display.
    Values: A positive integer, `0..n`. `position`
    -Defines where in the grid this module's widget will be displayed.
    +Where in the grid this module's widget will be displayed.
    `refreshInterval`
    How often, in seconds, this module will update its data.
    diff --git a/_site/content/posts/modules/todo.md b/_site/content/posts/modules/todo.md new file mode 100644 index 00000000..d2a0fc94 --- /dev/null +++ b/_site/content/posts/modules/todo.md @@ -0,0 +1,75 @@ +--- +title: "Todo" +date: 2018-05-10T12:41:50-07:00 +draft: false +--- + +## Description + +todo screenshot + +## Source Code + +```bash +wtf/todo/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +A basic, interactive todo list. + +## Configuration + +```yaml +todo: + checkedIcon: "X" + colors: + checked: gray + highlight: + fore: "black" + back: "orange" + enabled: true + filename: "todo.yml" + position: + top: 2 + left: 2 + height: 2 + width: 1 + refreshInterval: 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.
    +*Note:* Currently this file *must* reside in the `~/.wtf/` directory. +This is a known bug.
    +Values: Any valid filename, ideally ending in `yml`. + +`position`
    +Where in the grid this module's widget will be displayed.
    + +`refreshInterval`
    +How often, in seconds, this module will update its data.
    +Values: A positive integer, `0..n`. diff --git a/_site/static/imgs/modules/todo.png b/_site/static/imgs/modules/todo.png new file mode 100644 index 00000000..dc1fd744 Binary files /dev/null and b/_site/static/imgs/modules/todo.png differ diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index f89dfb08..777e421a 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -29,7 +29,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/404.html b/docs/404.html index 689062d6..0efa1daa 100644 --- a/docs/404.html +++ b/docs/404.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/categories/index.html b/docs/categories/index.html index 9cfefd5f..520ec572 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -72,7 +72,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/imgs/modules/todo.png b/docs/imgs/modules/todo.png new file mode 100644 index 00000000..dc1fd744 Binary files /dev/null and b/docs/imgs/modules/todo.png differ diff --git a/docs/index.html b/docs/index.html index 8dae1a5c..89f71ac1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -71,7 +71,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/index.xml b/docs/index.xml index 7965dbd7..9cbc17bf 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,27 @@ Recent content on WTF Hugo -- gohugo.io en-us - Thu, 10 May 2018 10:44:35 -0700 + Thu, 10 May 2018 12:41:50 -0700 + + Todo + http://wtfutil.com/posts/modules/todo/ + 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. + + Jira http://wtfutil.com/posts/modules/jira/ @@ -34,8 +50,8 @@ 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 Specifies the default colour for calendar event titles. Values: Any X11 color name. -colors.description Specifies the default color for calendar event descriptions. 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:"💥"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. +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. diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index d00db5e6..06bc8b42 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index 7ecea40d..de5c6a8a 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/posts/index.html b/docs/posts/index.html index 50f0541c..9898e02f 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -72,7 +72,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • @@ -92,6 +92,13 @@

    Posts

    diff --git a/docs/posts/modules/clocks/index.html b/docs/posts/modules/clocks/index.html index 32822b48..9816d9cf 100644 --- a/docs/posts/modules/clocks/index.html +++ b/docs/posts/modules/clocks/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/posts/modules/gcal/index.html b/docs/posts/modules/gcal/index.html index 84c770c7..c4524cca 100644 --- a/docs/posts/modules/gcal/index.html +++ b/docs/posts/modules/gcal/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • @@ -151,14 +151,12 @@

    Attributes

    colors.title
    -Specifies the default colour for calendar event titles.
    -Values: Any X11 -color name.

    +The default colour for calendar event titles.
    +Values: Any X11 color name.

    colors.description
    -Specifies the default color for calendar event descriptions.
    -Values: Any X11 -color name.

    +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. @@ -167,9 +165,8 @@ be drawn in that colour. Over-rides the default title colour.
    Values: [a valid regular expression, any X11 color name.]

    colors.past
    -Specifies the color for calendar events that have passed.
    -Values: Any X11 -color name.

    +The color for calendar events that have passed.
    +Values: Any X11 color name.

    conflictIcon
    The icon displayed beside calendar events that have conflicting times @@ -181,7 +178,7 @@ The icon displayed beside the current calendar event.
    Values: Any displayable unicode character.

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

    eventCount
    @@ -189,7 +186,7 @@ The number of calendar events to display.
    Values: A positive integer, 0..n.

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

    +Where in the grid this module’s widget will be displayed.

    refreshInterval
    How often, in seconds, this module will update its data.
    diff --git a/docs/posts/modules/git/index.html b/docs/posts/modules/git/index.html index 942c3f4f..d746168d 100644 --- a/docs/posts/modules/git/index.html +++ b/docs/posts/modules/git/index.html @@ -70,7 +70,7 @@

  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/posts/modules/github/index.html b/docs/posts/modules/github/index.html index 06f1e614..b32f5913 100644 --- a/docs/posts/modules/github/index.html +++ b/docs/posts/modules/github/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/posts/modules/index.html b/docs/posts/modules/index.html index 67bba0eb..42f7c2b0 100644 --- a/docs/posts/modules/index.html +++ b/docs/posts/modules/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • @@ -130,7 +130,7 @@ display in the “Clocks” widget.

  • OpsGenie
  • Security
  • Text File -
  • Todo +
  • Todo
  • Weather diff --git a/docs/posts/modules/jira/index.html b/docs/posts/modules/jira/index.html index 552d9b2f..b6879072 100644 --- a/docs/posts/modules/jira/index.html +++ b/docs/posts/modules/jira/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/posts/modules/newrelic/index.html b/docs/posts/modules/newrelic/index.html index fc175b3b..0af91899 100644 --- a/docs/posts/modules/newrelic/index.html +++ b/docs/posts/modules/newrelic/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/posts/modules/opsgenie/index.html b/docs/posts/modules/opsgenie/index.html index f7c01b50..b161656f 100644 --- a/docs/posts/modules/opsgenie/index.html +++ b/docs/posts/modules/opsgenie/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/posts/modules/security/index.html b/docs/posts/modules/security/index.html index e863e569..0d9b6490 100644 --- a/docs/posts/modules/security/index.html +++ b/docs/posts/modules/security/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/posts/modules/textfile/index.html b/docs/posts/modules/textfile/index.html index ad1f7a7d..e141be99 100644 --- a/docs/posts/modules/textfile/index.html +++ b/docs/posts/modules/textfile/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/posts/modules/todo/index.html b/docs/posts/modules/todo/index.html new file mode 100644 index 00000000..30994c3d --- /dev/null +++ b/docs/posts/modules/todo/index.html @@ -0,0 +1,181 @@ + + + + + + + + + + + + +Todo | WTF + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    + + WFT Logo +

    + +

    +
    + +
    +

    Content

    + + + + +
    + +

    + © 2018 Chris Cummer. +
    + Some Rights Reserved. +

    +

    + Built with Hugo & hyde-hyde. +

    +
    +
    + +
    +
    +

    Todo

    + +
    + + + + May 10, 2018 + + + + +
    + 1 min read +     +
    + + + +

    Description

    + +

    todo screenshot

    + +

    Source Code

    +
    wtf/todo/
    +

    Required ENV Variables

    + +

    None.

    + +

    Keyboard Commands

    + +

    A basic, interactive todo list.

    + +

    Configuration

    +
    todo:
+  checkedIcon: "X"
+  colors:
+    checked: gray
+    highlight:
+      fore: "black"
+      back: "orange"
+  enabled: true
+  filename: "todo.yml"
+  position:
+    top: 2
+    left: 2
+    height: 2
+    width: 1
+  refreshInterval: 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.
    +Note: Currently this file must reside in the ~/.wtf/ directory. +This is a known bug.
    +Values: Any valid filename, ideally ending in yml.

    + +

    position
    +Where in the grid this module’s widget will be displayed.

    + +

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

    + +
    +
    + + + +
    +
    + + + + diff --git a/docs/posts/modules/weather/index.html b/docs/posts/modules/weather/index.html index 3edca608..0ea857e3 100644 --- a/docs/posts/modules/weather/index.html +++ b/docs/posts/modules/weather/index.html @@ -70,7 +70,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather
    • diff --git a/docs/sitemap.xml b/docs/sitemap.xml index da408df2..0d018635 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -2,6 +2,11 @@ + + http://wtfutil.com/posts/modules/todo/ + 2018-05-10T12:41:50-07:00 + + http://wtfutil.com/posts/modules/jira/ 2018-05-10T10:44:35-07:00 @@ -79,7 +84,7 @@ http://wtfutil.com/posts/ - 2018-05-10T10:44:35-07:00 + 2018-05-10T12:41:50-07:00 0 @@ -90,7 +95,7 @@ http://wtfutil.com/ - 2018-05-10T10:44:35-07:00 + 2018-05-10T12:41:50-07:00 0 diff --git a/docs/tags/index.html b/docs/tags/index.html index 5516febf..7e35a9d3 100644 --- a/docs/tags/index.html +++ b/docs/tags/index.html @@ -72,7 +72,7 @@
  • OpsGenie
  • Security
  • Text File
    • -
  • Todo
    • +
  • Todo
  • Weather