]> 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:

Created tpbat (markdown)
[etc/awesome.git] / Widgets.md
index 7130cc396cb8692e74ec540075b4a928841b1d7b..ebe081026190ac8191e78fd8957ea5304928f9cf 100644 (file)
@@ -1,8 +1,9 @@
-Every widget is output by a `function`.
+General usage
+-------------
 
 
-Unless otherwise expressly noted, `function` returns a `wibox.widget.textbox`.
+Every widget is output by a `function`.
 
 
-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.
 
@@ -12,18 +13,21 @@ 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.
 
 
 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`.
+`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()
 
 Here follows an example: 
 
     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).
+
+Index
+-----
 
 - [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)
@@ -39,4 +43,9 @@ Here follows an example:
 - [net](https://github.com/copycat-killer/lain/wiki/net)
 - [sysload](https://github.com/copycat-killer/lain/wiki/sysload)
 - [temp](https://github.com/copycat-killer/lain/wiki/temp)
 - [net](https://github.com/copycat-killer/lain/wiki/net)
 - [sysload](https://github.com/copycat-killer/lain/wiki/sysload)
 - [temp](https://github.com/copycat-killer/lain/wiki/temp)
-- [yawn](https://github.com/copycat-killer/lain/wiki/yawn)
\ No newline at end of file
+- [yawn](https://github.com/copycat-killer/lain/wiki/yawn)
+
+Users contributed
+----------------
+
+- [task](https://github.com/copycat-killer/lain/wiki/task)
\ No newline at end of file