Updated Utilities (markdown)

[etc/awesome.git] / Widgets.md

diff --git a/Widgets.md b/Widgets.md
index 8accde980697cc81dbfc81243f2488d4137015d3..1a26b801b1546bf485dea1f9815fabbd75b023e8 100644 (file)
--- a/Widgets.md
+++ b/Widgets.md
@@ -1,10 +1,27 @@
 Every widget is output by a `function`.
 
 Every widget is output by a `function`.
 

-Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`.
+For some widgets, `function` returns a `wibox.widget.textbox`, for others a table to be used for notification and update purposes.

 
 

-We say this because, for some widget, `function` return a table to be used for notification and update purposes.
+Every widget may take either a table or a list of variables as argument.

 
 

-Almost all widgets can be set by an input function called `settings`: you can markup textboxes and do whatever customization within it. 
+If it takes a table, you have to define a function variable called `settings` in it, in order to make your customizations.
+
+To markup the textbox, call `widget:set_markup(...)` within `settings`.
+
+You can feed `set_markup` with predefined arguments, see the sections for all the details.
+
+`widget` is a textbox, so you can also threat it like any other `wibox.widget.textbox`.
+
+Here follows an example: 
+
+    mycpu = lain.widgets.cpu({
+        timeout = 4,
+        settings = function()
+            widget:set_markup("Cpu " .. usage)
+        end
+    })
+
+---

 
 - [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)