Updated Home (markdown)

[etc/awesome.git] / Utilities.md

diff --git a/Utilities.md b/Utilities.md
index d9790dadc5aa024b9a58a80538a99717eea32a9a..cbf8c0ff4eba042778f4839bbd945c447418865c 100644 (file)
--- a/Utilities.md
+++ b/Utilities.md
@@ -1,4 +1,47 @@
-[<- home](https://github.com/copycat-killer/lain/wiki)
+markup
+------
+
+This is a submodule which helps you markupping your text.
+
+First, require it like this:
+
+    local markup = require("lain.util.markup")
+
+then you can call its functions:
+
+     +-- markup
+     |
+     |`-- bold()        Set bold.
+     |`-- italic()      Set italicized text.
+     |`-- strike()      Set strikethrough text.
+     |`-- underline()   Set underlined text.
+     |`-- monospace()   Set monospaced text.
+     |`-- big()         Set bigger text.
+     |`-- small()       Set smaller text.
+     |`-- font()        Set the font of the text.
+     |
+     |`--+ bg
+     |   |
+     |   |`-- color()   Set background color.
+     |   |`-- focus()   Set focus  background color.
+     |   |`-- normal()  Set normal background color.
+     |    `-- urgent()  Set urgent background color.
+     |
+     |`--+ fg
+     |   |
+     |   |`-- color()   Set foreground color.
+     |   |`-- focus()   Set focus  foreground color.
+     |   |`-- normal()  Set normal foreground color.
+     |    `-- urgent()  Set urgent foreground color.
+     |
+     |`-- focus()       Set both foreground and background focus  colors.
+     |`-- normal()      Set both foreground and background normal colors.
+      `-- urgent()      Set both foreground and background urgent colors.
+
+they all take one argument, which is the text to markup, except `fg.color` and `bg.color`:
+
+    markup.fg.color(text, color)
+    markup.bg.color(text, color)
 
 menu\_clients\_current\_tags
 ----------------------------
@@ -6,7 +49,8 @@ menu\_clients\_current\_tags
 Similar to `awful.menu.clients()`, but this menu only shows the clients
 of currently visible tags. Use it with a key binding like this:
 
-    awful.key({ "Mod1" }, "Tab", function()
+    awful.key({ "Mod1" }, "Tab",
+    function()
         awful.menu.menu_keys.down = { "Down", "Alt_L", "Tab", "j" }
         awful.menu.menu_keys.up = { "Up", "k" }
         lain.util.menu_clients_current_tags({ width = 350 }, { keygrabber = true })