From e060b9799f2a29b129ec056f2dac5a44677496a5 Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Wed, 16 May 2018 21:46:22 -0700 Subject: [PATCH] Adds top-level configuration documentation. --- .../content/posts/configuration/attributes.md | 63 +++++++ .../hyde-hyde/layouts/partials/sidebar.html | 2 + docs/404.html | 2 + docs/categories/index.html | 2 + docs/index.html | 2 + docs/index.xml | 12 +- .../posts/configuration/attributes/index.html | 175 ++++++++++++++++++ docs/posts/configuration/index.html | 2 + docs/posts/glossary/index.html | 2 + docs/posts/index.html | 9 + docs/posts/index.xml | 12 +- docs/posts/modules/bamboohr/index.html | 2 + docs/posts/modules/clocks/index.html | 2 + docs/posts/modules/gcal/index.html | 2 + docs/posts/modules/git/index.html | 2 + docs/posts/modules/github/index.html | 2 + docs/posts/modules/index.html | 2 + docs/posts/modules/jira/index.html | 2 + docs/posts/modules/newrelic/index.html | 2 + docs/posts/modules/opsgenie/index.html | 2 + docs/posts/modules/security/index.html | 2 + docs/posts/modules/textfile/index.html | 2 + docs/posts/modules/todo/index.html | 2 + docs/posts/modules/weather/index.html | 2 + docs/sitemap.xml | 9 +- docs/tags/index.html | 2 + 26 files changed, 316 insertions(+), 4 deletions(-) create mode 100644 _site/content/posts/configuration/attributes.md create mode 100644 docs/posts/configuration/attributes/index.html diff --git a/_site/content/posts/configuration/attributes.md b/_site/content/posts/configuration/attributes.md new file mode 100644 index 00000000..4e5dc9a5 --- /dev/null +++ b/_site/content/posts/configuration/attributes.md @@ -0,0 +1,63 @@ +--- +title: "Attributes" +date: 2018-05-16T21:51:23-07:00 +draft: false +--- + +This page describes the top-level attributes that can be added to +`config.yml`. + +```yaml +wtf: + colors: + border: + Focusable: "darkslateblue" + focused: "orange" + normal: "gray" + grid: + # How _wide_ the columns are, in terminal characters. In this case we have + # six columns, each of which are 35 characters wide + columns: [35, 35, 35, 35, 35, 35] + + # How _high_ the rows are, in terminal lines. In this case we have five rows + # that support ten line of text, one of three lines, and one of four + rows: [10, 10, 10, 10, 10, 3, 4] + # The app redraws itself once a second + refreshInterval: 1 +``` + +### Attributes + +`colors.border.focusable`
+The color in which to draw the border of widgets that can accept +keyboard focus.
+Values: Any X11 +color name. + +`colors.border.focused`
+The color in which to draw the border of the widget that currently has +keyboard focus.
+Values: Any X11 +color name. + +`colors.border.normal`
+The color in which to draw the borders of the widgets that cannot accept +focus.
+Values: Any X11 +color name. + +`grid.columns`
+An array that defines the widths of all the columns.
+Values: See tview's +Grid for details. + +`grid.rows`
+An array that defines the heights of all the rows.
+Values: See tview's +Grid for details. + +`refreshInterval`
+How often, in seconds, the UI refreshes itself.
+**Note:** This implementation is probably wrong and buggy and likely to +change.
+Values: A positive integer, `0..n`. diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index 777e421a..94f26920 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -14,6 +14,8 @@ diff --git a/docs/404.html b/docs/404.html index 0efa1daa..1e861e61 100644 --- a/docs/404.html +++ b/docs/404.html @@ -55,6 +55,8 @@ diff --git a/docs/categories/index.html b/docs/categories/index.html index 520ec572..e4c0d211 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -57,6 +57,8 @@ diff --git a/docs/index.html b/docs/index.html index 89f71ac1..00adc709 100644 --- a/docs/index.html +++ b/docs/index.html @@ -56,6 +56,8 @@ diff --git a/docs/index.xml b/docs/index.xml index 77b38673..432776d5 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,21 @@ Recent content on WTF Hugo -- gohugo.io en-us - Thu, 10 May 2018 12:41:50 -0700 + Wed, 16 May 2018 21:51:23 -0700 + + Attributes + http://wtfutil.com/posts/configuration/attributes/ + Wed, 16 May 2018 21:51:23 -0700 + + http://wtfutil.com/posts/configuration/attributes/ + This page describes the top-level attributes that can be added to config.yml. +wtf:colors:border:Focusable:"darkslateblue"focused:"orange"normal:"gray"grid:# How _wide_ the columns are, in terminal characters. In this case we have# six columns, each of which are 35 characters widecolumns:[35,35,35,35,35,35]# How _high_ the rows are, in terminal lines. In this case we have five rows# that support ten line of text, one of three lines, and one of fourrows:[10,10,10,10,10,3,4]# The app redraws itself once a secondrefreshInterval:1 Attributes colors. + + Todo http://wtfutil.com/posts/modules/todo/ diff --git a/docs/posts/configuration/attributes/index.html b/docs/posts/configuration/attributes/index.html new file mode 100644 index 00000000..81329003 --- /dev/null +++ b/docs/posts/configuration/attributes/index.html @@ -0,0 +1,175 @@ + + + + + + + + + + + + +Attributes | WTF + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + WFT Logo +

+ +

+
+ + + +

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

+

+ Built with Hugo & hyde-hyde. +

+
+
+ +
+
+

Attributes

+ +
+ + + + May 16, 2018 + + + + +
+ 1 min read + +
+ + + +

This page describes the top-level attributes that can be added to +config.yml.

+
wtf:
+  colors:
+    border:
+      Focusable: "darkslateblue"
+      focused: "orange"
+      normal: "gray"
+  grid:
+    # How _wide_ the columns are, in terminal characters. In this case we have
+    # six columns, each of which are 35 characters wide
+    columns: [35, 35, 35, 35, 35, 35]
+
+    # How _high_ the rows are, in terminal lines. In this case we have five rows
+    # that support ten line of text, one of three lines, and one of four
+    rows: [10, 10, 10, 10, 10, 3, 4]
+  # The app redraws itself once a second
+  refreshInterval: 1
+

Attributes

+ +

colors.border.focusable
+The color in which to draw the border of widgets that can accept +keyboard focus.
+Values: Any X11 +color name.

+ +

colors.border.focused
+The color in which to draw the border of the widget that currently has +keyboard focus.
+Values: Any X11 +color name.

+ +

colors.border.normal
+The color in which to draw the borders of the widgets that cannot accept +focus.
+Values: Any X11 +color name.

+ +

grid.columns
+An array that defines the widths of all the columns.
+Values: See tview’s +Grid for details.

+ +

grid.rows
+An array that defines the heights of all the rows.
+Values: See tview’s +Grid for details.

+ +

refreshInterval
+How often, in seconds, the UI refreshes itself.
+Note: This implementation is probably wrong and buggy and likely to +change.
+Values: A positive integer, 0..n.

+ +
+
+ + + +
+
+ + + + diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index 06bc8b42..f9b12d27 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index de5c6a8a..ce83de88 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/index.html b/docs/posts/index.html index 9898e02f..39b6a570 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -57,6 +57,8 @@ @@ -92,6 +94,13 @@

Posts

  • + + Attributes + + + + +
  • Todo diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 3c967df0..87d2fbbb 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -6,11 +6,21 @@ Recent content in Posts on WTF Hugo -- gohugo.io en-us - Thu, 10 May 2018 12:41:50 -0700 + Wed, 16 May 2018 21:51:23 -0700 + + Attributes + http://wtfutil.com/posts/configuration/attributes/ + Wed, 16 May 2018 21:51:23 -0700 + + http://wtfutil.com/posts/configuration/attributes/ + This page describes the top-level attributes that can be added to config.yml. +wtf:colors:border:Focusable:"darkslateblue"focused:"orange"normal:"gray"grid:# How _wide_ the columns are, in terminal characters. In this case we have# six columns, each of which are 35 characters widecolumns:[35,35,35,35,35,35]# How _high_ the rows are, in terminal lines. In this case we have five rows# that support ten line of text, one of three lines, and one of fourrows:[10,10,10,10,10,3,4]# The app redraws itself once a secondrefreshInterval:1 Attributes colors. + + Todo http://wtfutil.com/posts/modules/todo/ diff --git a/docs/posts/modules/bamboohr/index.html b/docs/posts/modules/bamboohr/index.html index d6bf6f65..172401db 100644 --- a/docs/posts/modules/bamboohr/index.html +++ b/docs/posts/modules/bamboohr/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/clocks/index.html b/docs/posts/modules/clocks/index.html index eccdfd48..0095f306 100644 --- a/docs/posts/modules/clocks/index.html +++ b/docs/posts/modules/clocks/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/gcal/index.html b/docs/posts/modules/gcal/index.html index f102f13e..da68e857 100644 --- a/docs/posts/modules/gcal/index.html +++ b/docs/posts/modules/gcal/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/git/index.html b/docs/posts/modules/git/index.html index d746168d..ae009bd1 100644 --- a/docs/posts/modules/git/index.html +++ b/docs/posts/modules/git/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/github/index.html b/docs/posts/modules/github/index.html index b32f5913..df90552b 100644 --- a/docs/posts/modules/github/index.html +++ b/docs/posts/modules/github/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/index.html b/docs/posts/modules/index.html index 42f7c2b0..f2a4351e 100644 --- a/docs/posts/modules/index.html +++ b/docs/posts/modules/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/jira/index.html b/docs/posts/modules/jira/index.html index f749d1b4..adc6cca7 100644 --- a/docs/posts/modules/jira/index.html +++ b/docs/posts/modules/jira/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/newrelic/index.html b/docs/posts/modules/newrelic/index.html index 0af91899..40116ec6 100644 --- a/docs/posts/modules/newrelic/index.html +++ b/docs/posts/modules/newrelic/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/opsgenie/index.html b/docs/posts/modules/opsgenie/index.html index cf593a30..36bbd3a0 100644 --- a/docs/posts/modules/opsgenie/index.html +++ b/docs/posts/modules/opsgenie/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/security/index.html b/docs/posts/modules/security/index.html index 0d9b6490..10913623 100644 --- a/docs/posts/modules/security/index.html +++ b/docs/posts/modules/security/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/textfile/index.html b/docs/posts/modules/textfile/index.html index cf6664cb..d135753b 100644 --- a/docs/posts/modules/textfile/index.html +++ b/docs/posts/modules/textfile/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/todo/index.html b/docs/posts/modules/todo/index.html index 01fbe33c..d0d56d82 100644 --- a/docs/posts/modules/todo/index.html +++ b/docs/posts/modules/todo/index.html @@ -55,6 +55,8 @@ diff --git a/docs/posts/modules/weather/index.html b/docs/posts/modules/weather/index.html index 0ea857e3..7302501a 100644 --- a/docs/posts/modules/weather/index.html +++ b/docs/posts/modules/weather/index.html @@ -55,6 +55,8 @@ diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 0d018635..2470591f 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -2,6 +2,11 @@ + + http://wtfutil.com/posts/configuration/attributes/ + 2018-05-16T21:51:23-07:00 + + http://wtfutil.com/posts/modules/todo/ 2018-05-10T12:41:50-07:00 @@ -84,7 +89,7 @@ http://wtfutil.com/posts/ - 2018-05-10T12:41:50-07:00 + 2018-05-16T21:51:23-07:00 0 @@ -95,7 +100,7 @@ http://wtfutil.com/ - 2018-05-10T12:41:50-07:00 + 2018-05-16T21:51:23-07:00 0 diff --git a/docs/tags/index.html b/docs/tags/index.html index 7e35a9d3..a3fd91ea 100644 --- a/docs/tags/index.html +++ b/docs/tags/index.html @@ -57,6 +57,8 @@