From 4f9e76a52cdfa04328eee841abac52361f1775d2 Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Tue, 2 Oct 2018 17:04:31 -0700 Subject: [PATCH] Generate documentation for Clocks module --- docs/index.json | 2 +- docs/index.xml | 2 +- docs/modules/clocks/index.html | 8 ++ docs/modules/gerrit/index.html | 12 --- docs/modules/google/index.html | 96 ++++++++++++++++++++++++ docs/modules/index.xml | 2 +- docs/modules/ipaddress/ipinfo/index.html | 15 ++++ docs/modules/jira/index.html | 12 --- docs/modules/todoist/index.html | 95 +++++++++++++++++++++++ docs/modules/travisci/index.html | 95 +++++++++++++++++++++++ docs/modules/twitter/index.html | 12 +++ docs/modules/zendesk/index.html | 12 +++ 12 files changed, 336 insertions(+), 27 deletions(-) diff --git a/docs/index.json b/docs/index.json index e106805b..e0b71f71 100644 --- a/docs/index.json +++ b/docs/index.json @@ -109,7 +109,7 @@ "title": "Clocks", "tags": [], "description": "", - "content": " Displays a configurable list of world clocks, the local time, and date.\nSource Code wtf/clocks/ Configuration clocks:colors:rows:even:\u0026#34;lightblue\u0026#34;odd:\u0026#34;white\u0026#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:\u0026#34;Europe/Paris\u0026#34;Barcelona:\u0026#34;Europe/Madrid\u0026#34;Dubai:\u0026#34;Asia/Dubai\u0026#34;NewYork:\u0026#34;America/New York\u0026#34;Toronto:\u0026#34;America/Toronto\u0026#34;UTC:\u0026#34;Etc/UTC\u0026#34;Vancouver:\u0026#34;America/Vancouver\u0026#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:\u0026#34;alphabetical\u0026#34; Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name.\ncolors.rows.odd The foreground color for the odd-numbered rows. Values: Any X11 color name.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nlocations Defines the timezones for the world clocks that you want to display. key is a unique label that will be displayed in the UI. value is a timezone name. Values: Any TZ database timezone.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed.\nrefreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nsort Defines the display order of the clocks in the widget. Values: alphabetical or chronological. alphabetical will sort in acending order by key, chronological will sort in ascending order by date/time.\n" + "content": " Displays a configurable list of world clocks, the local time, and date.\nSource Code wtf/clocks/ Configuration clocks:colors:rows:even:\u0026#34;lightblue\u0026#34;odd:\u0026#34;white\u0026#34;enabled:truelocations:# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zonesAvignon:\u0026#34;Europe/Paris\u0026#34;Barcelona:\u0026#34;Europe/Madrid\u0026#34;Dubai:\u0026#34;Asia/Dubai\u0026#34;NewYork:\u0026#34;America/New York\u0026#34;Toronto:\u0026#34;America/Toronto\u0026#34;UTC:\u0026#34;Etc/UTC\u0026#34;Vancouver:\u0026#34;America/Vancouver\u0026#34;position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:\u0026#34;alphabetical\u0026#34; Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name.\ncolors.rows.odd The foreground color for the odd-numbered rows. Values: Any X11 color name.\ndateFormat The format of the date string for all clocks. Values: Any valid Go date layout which is handled by Time.Format. Defaults to Jan 2.\nenabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.\nlocations Defines the timezones for the world clocks that you want to display. key is a unique label that will be displayed in the UI. value is a timezone name. Values: Any TZ database timezone.\nposition Defines where in the grid this module\u0026rsquo;s widget will be displayed.\nrefreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.\nsort Defines the display order of the clocks in the widget. Values: alphabetical or chronological. alphabetical will sort in acending order by key, chronological will sort in ascending order by date/time.\ntimeFormat The format of the time string for all clocks. Values: Any valid Go time layout which is handled by Time.Format. Defaults to 15:04 MST.\n" }, { "uri": "https://wtfutil.com/modules/cmdrunner/", diff --git a/docs/index.xml b/docs/index.xml index 9373bd9d..1807cc55 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -182,7 +182,7 @@ Configuration weather:apiKey:"2dfb3e3650a1950adddb6badf5ba1aaa"# Displays a configurable list of world clocks, the local time, and date. Source Code wtf/clocks/ 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"NewYork:"America/New York"Toronto:"America/Toronto"UTC:"Etc/UTC"Vancouver:"America/Vancouver"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name. colors.rows.odd 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. Values: true, false. +dateFormat The format of the date string for all clocks. Values: Any valid Go date layout which is handled by Time. diff --git a/docs/modules/clocks/index.html b/docs/modules/clocks/index.html index a124ebc4..4f839f74 100644 --- a/docs/modules/clocks/index.html +++ b/docs/modules/clocks/index.html @@ -514,6 +514,10 @@ The foreground color for the odd-numbered rows.
Values: Any X11 color name.

+

dateFormat
+The format of the date string for all clocks.
+Values: Any valid Go date layout which is handled by Time.Format. Defaults to Jan 2.

+

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

@@ -537,6 +541,10 @@ Values: alphabetical or chronological. alphabeti acending order by key, chronological will sort in ascending order by date/time.

+

timeFormat
+The format of the time string for all clocks.
+Values: Any valid Go time layout which is handled by Time.Format. Defaults to 15:04 MST.

+ diff --git a/docs/modules/gerrit/index.html b/docs/modules/gerrit/index.html index cd1ff3c8..6587ef0a 100644 --- a/docs/modules/gerrit/index.html +++ b/docs/modules/gerrit/index.html @@ -410,22 +410,13 @@ - - - @@ -439,9 +430,6 @@ - diff --git a/docs/modules/google/index.html b/docs/modules/google/index.html index 3eaade88..bc3a2ba5 100644 --- a/docs/modules/google/index.html +++ b/docs/modules/google/index.html @@ -141,6 +141,35 @@ CmdRunner + +
  • +
    + Crypo Currencies +
    +
  • @@ -183,6 +212,29 @@ Gitter
    +
    • +
  • +
    + Google Apps + +
    +
  • @@ -190,6 +242,28 @@ Hacker News
    +
    • +
  • +
    + IP Addresses +
    +
  • @@ -281,6 +355,28 @@ Twitter
    +
    • +
  • +
    + Weather Services +
    +
  • diff --git a/docs/modules/index.xml b/docs/modules/index.xml index 31e6db50..f6bb080d 100644 --- a/docs/modules/index.xml +++ b/docs/modules/index.xml @@ -45,7 +45,7 @@ position Defines where in the grid this module’s widget will be displa Displays a configurable list of world clocks, the local time, and date. Source Code wtf/clocks/ 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"NewYork:"America/New York"Toronto:"America/Toronto"UTC:"Etc/UTC"Vancouver:"America/Vancouver"position:top:4left:0height:1width:1refreshInterval:15# Valid options are: alphabetical, chronologicalsort:"alphabetical" Attributes colors.rows.even The foreground color for even-numbered rows. Values: Any X11 color name. colors.rows.odd 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. Values: true, false. +dateFormat The format of the date string for all clocks. Values: Any valid Go date layout which is handled by Time. diff --git a/docs/modules/ipaddress/ipinfo/index.html b/docs/modules/ipaddress/ipinfo/index.html index 61ed6ad9..01f1eba1 100644 --- a/docs/modules/ipaddress/ipinfo/index.html +++ b/docs/modules/ipaddress/ipinfo/index.html @@ -411,13 +411,25 @@ + + + + + + @@ -431,6 +443,9 @@ + diff --git a/docs/modules/jira/index.html b/docs/modules/jira/index.html index edaf5113..66a49919 100644 --- a/docs/modules/jira/index.html +++ b/docs/modules/jira/index.html @@ -410,22 +410,13 @@ - - - @@ -439,9 +430,6 @@ - diff --git a/docs/modules/todoist/index.html b/docs/modules/todoist/index.html index f6c6ee0c..13aaefed 100644 --- a/docs/modules/todoist/index.html +++ b/docs/modules/todoist/index.html @@ -141,6 +141,35 @@ CmdRunner
    +
    • +
  • +
    + Crypo Currencies +
    +
  • @@ -183,6 +212,28 @@ Gitter
    +
    • +
  • +
    + Google Apps +
    +
  • @@ -190,6 +241,28 @@ Hacker News
    +
    • +
  • +
    + IP Addresses +
    +
  • @@ -281,6 +354,28 @@ Twitter
    +
    • +
  • +
    + Weather Services +
    +
  • diff --git a/docs/modules/travisci/index.html b/docs/modules/travisci/index.html index fbb527ca..238ab72b 100644 --- a/docs/modules/travisci/index.html +++ b/docs/modules/travisci/index.html @@ -141,6 +141,35 @@ CmdRunner
    +
    • +
  • +
    + Crypo Currencies +
    +
  • @@ -183,6 +212,28 @@ Gitter
    +
    • +
  • +
    + Google Apps +
    +
  • @@ -190,6 +241,28 @@ Hacker News
    +
    • +
  • +
    + IP Addresses +
    +
  • @@ -281,6 +354,28 @@ Twitter
    +
    • +
  • +
    + Weather Services +
    +
  • diff --git a/docs/modules/twitter/index.html b/docs/modules/twitter/index.html index 16e58683..813e0033 100644 --- a/docs/modules/twitter/index.html +++ b/docs/modules/twitter/index.html @@ -410,13 +410,22 @@ + + + @@ -430,6 +439,9 @@ + diff --git a/docs/modules/zendesk/index.html b/docs/modules/zendesk/index.html index 7736959c..aafc2b98 100644 --- a/docs/modules/zendesk/index.html +++ b/docs/modules/zendesk/index.html @@ -410,13 +410,22 @@ + + + @@ -430,6 +439,9 @@ +