Updated fs (markdown)

[etc/awesome.git] / Widgets.md

diff --git a/Widgets.md b/Widgets.md
index c0a7dd61265c7d96f0035c78683cb681b1ffe7d5..e812db21a39db4c60cea9f6906ac50be4e6be059 100644 (file)
--- a/Widgets.md
+++ b/Widgets.md
@@ -1,14 +1,18 @@
 Every widget is output by a `function`.
 
 Every widget is output by a `function`.
 

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

 
 Every widget may take either a table or a list of variables as argument.
 
 
 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.
+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.

 
 

-Here follows a simple example, see the sections for all the details: 
+`widget` is a textbox, so you can threat it like any other `wibox.widget.textbox`.
+
+Here follows an example: 

 
     mycpu = lain.widgets.cpu({
         timeout = 4,
 
     mycpu = lain.widgets.cpu({
         timeout = 4,


@@ -17,6 +21,8 @@ Here follows a simple example, see the sections for all the details:
         end
     })
 
         end
     })
 

+---
+

 - [alsa](https://github.com/copycat-killer/lain/wiki/alsa)
 - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)
 - [bat](https://github.com/copycat-killer/lain/wiki/bat)
 - [alsa](https://github.com/copycat-killer/lain/wiki/alsa)
 - [alsabar](https://github.com/copycat-killer/lain/wiki/alsabar)
 - [bat](https://github.com/copycat-killer/lain/wiki/bat)