From c4cade7bfd8ba57242ec54347f9f3ee750255701 Mon Sep 17 00:00:00 2001 From: slotThe Date: Mon, 14 Dec 2020 14:56:45 +0100 Subject: Further improvements --- contributing.org | 4 ++-- doc/plugins.org | 15 ++++++++++++++- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/contributing.org b/contributing.org index 4a59145..41c2af1 100644 --- a/contributing.org +++ b/contributing.org @@ -5,7 +5,7 @@ document will help guide you in this endeavour. In case you want to make any non-trivial change to xmobar, it's always best to talk with the community first. Currently the best way to do that -is to create an issue on GitHub. There, you can talk through the +is to [[https://github.com/jaor/xmobar/issues/new][create an issue]] on GitHub. There, you can talk through the problems you are having, as well as the proposed solution. ** Making the Change @@ -56,7 +56,7 @@ Writing a plugin for xmobar is very simple! First, you need to create a data type with at least one constructor. Next you must declare this data type an instance of the =Exec= class, by -defining the 1 needed method (alternatively =start= or =run=) and 3 +defining the one needed method (alternatively =start= or =run=) and 3 optional ones (=alias=, =rate=, and =trigger=): #+begin_src haskell diff --git a/doc/plugins.org b/doc/plugins.org index 59be7fd..8b529c5 100644 --- a/doc/plugins.org +++ b/doc/plugins.org @@ -18,7 +18,20 @@ All Monitors accept a common set of arguments, described below in [[Default Monitor Arguments]]. Some monitors also accept additional options that are specific to them. When specifying the list of arguments in your configuration, the common options come first, followed by =--=, followed -by any monitor-specific options. +by any monitor-specific options. For example, the following [[=Battery Args RefreshRate=][Battery]] +configuration first sets the global =template= and =Low= arguments and +then specifies the battery-specific =off= option. + +#+begin_src haskell + Run Battery + [ "--template", "" + , "--Low" , "15" + -- battery specific options start here. + , "--" + , "--off" , " ()" + ] + 100 +#+end_src ** Icon patterns -- cgit v1.2.3