]> git.madduck.net Git - etc/awesome.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Updated Widgets (markdown)
authorLuke Bonham <dadasignificanulla@gmail.com>
Tue, 10 Sep 2013 19:56:10 +0000 (12:56 -0700)
committerLuke Bonham <dadasignificanulla@gmail.com>
Tue, 10 Sep 2013 19:56:10 +0000 (12:56 -0700)
Widgets.md

index 07723605b64fa0f94c561a5481bdd02aa2e4cb8f..2138b270ddaf7e4f4e2cfc4b51bbf2f4d80253c5 100644 (file)
@@ -2,9 +2,22 @@ Every widget is output by a `function`.
 
 Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`.
 
 
 Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`.
 
-We say this because, for some widget, `function` returns a table to be used for notification and update purposes.
+This is said because, for some widgets, `function` returns a table to be used for notification and update purposes.
 
 
-Almost all widgets can be set by an input function called `settings`: you can markup textboxes and do whatever customization within it. 
+Every widget may take either a table or a list of variables as argument.
+
+If it takes a table, you have to define a function variable called `settings` in it: with this you can markup textboxes using predefined variables and do whatever customization you want.
+
+I'll give an example: 
+
+    mycpu = lain.widgets.cpu({
+        timeout = 4,
+        settings = function()
+            widgets:set_markup("Cpu " .. usage)
+        end
+    })
+
+check the sections for all the details.
 
 - [alsa](https://github.com/copycat-killer/lain/wiki/alsa)
 - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)
 
 - [alsa](https://github.com/copycat-killer/lain/wiki/alsa)
 - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)