]> git.madduck.net Git - etc/awesome.git/blobdiff - Widgets.md

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 borderbox (markdown)
[etc/awesome.git] / Widgets.md
index c0a7dd61265c7d96f0035c78683cb681b1ffe7d5..981e4e16966fd71596a6a4a1934f0c9fd2f4f0b1 100644 (file)
@@ -1,22 +1,30 @@
 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,
         settings = function()
 
     mycpu = lain.widgets.cpu({
         timeout = 4,
         settings = function()
-            widget:set_markup("Cpu " .. usage)
+            widget:set_markup("Cpu " .. cpu_now.usage)
         end
     })
 
         end
     })
 
+If you want to see more complex applications, check [awesome-copycats](https://github.com/copycat-killer/awesome-copycats).
+
+---
+
 - [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)