From 41c4eef320cb3c5ba88ce3587f07fa50937347bd Mon Sep 17 00:00:00 2001 From: Drauthius Date: Sat, 10 Nov 2018 14:04:20 +0100 Subject: [PATCH] Fixed formatting --- README.md | 157 ++++++++++++++++++++++++++---------------------------- 1 file changed, 76 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index 00963d9..b1633ff 100644 --- a/README.md +++ b/README.md @@ -25,98 +25,93 @@ Installation configuration is included in the repository for easy comparison, but keep reading for a textual description. 1. Require the `sharedtags` library somewhere at the top of the file. - - ```lua - local sharedtags = require("sharedtags") - ``` + ```lua + local sharedtags = require("sharedtags") + ``` 2. Create the tags using the `sharedtags()` method, instead of the original ones created with `awful.tag()`. They should be created at the file level, i.e. outside of any function. - - ```lua - local tags = sharedtags({ - { name = "main", layout = awful.layout.layouts[2] }, - { name = "www", layout = awful.layout.layouts[10] }, - { name = "game", layout = awful.layout.layouts[1] }, - { name = "misc", layout = awful.layout.layouts[2] }, - { name = "chat", screen = 2, layout = awful.layout.layouts[2] }, - { layout = awful.layout.layouts[2] }, - { screen = 2, layout = awful.layout.layouts[2] } - }) - ``` + ```lua + local tags = sharedtags({ + { name = "main", layout = awful.layout.layouts[2] }, + { name = "www", layout = awful.layout.layouts[10] }, + { name = "game", layout = awful.layout.layouts[1] }, + { name = "misc", layout = awful.layout.layouts[2] }, + { name = "chat", screen = 2, layout = awful.layout.layouts[2] }, + { layout = awful.layout.layouts[2] }, + { screen = 2, layout = awful.layout.layouts[2] } + }) + ``` 3. Remove or uncomment the code which creates the tags when a screen is connected, in the `connect_for_each_screen` callback. + ```lua + awful.screen.connect_for_each_screen(function(s) + -- Each screen has its own tag table. + --awful.tag({ "1", "2", "3", "4", "5", "6", "7", "8", "9" }, s, awful.layout.layouts[1]) - ```lua - awful.screen.connect_for_each_screen(function(s) - -- Each screen has its own tag table. - --awful.tag({ "1", "2", "3", "4", "5", "6", "7", "8", "9" }, s, awful.layout.layouts[1]) - - -- Here is a good place to add tags to a newly connected screen, if desired: - --sharedtags.viewonly(tags[4], s) - end) - ``` + -- Here is a good place to add tags to a newly connected screen, if desired: + --sharedtags.viewonly(tags[4], s) + end) + ``` 4. The code for handling tags and clients needs to be changed to use the library and pick the correct tag. - - ```lua - for i = 1, 9 do - globalkeys = gears.table.join(globalkeys, - -- View tag only. - awful.key({ modkey }, "#" .. i + 9, - function () - local screen = awful.screen.focused() - local tag = tags[i] - if tag then - sharedtags.viewonly(tag, screen) - end - end, - {description = "view tag #"..i, group = "tag"}), - -- Toggle tag display. - awful.key({ modkey, "Control" }, "#" .. i + 9, - function () - local screen = awful.screen.focused() - local tag = tags[i] - if tag then - sharedtags.viewtoggle(tag, screen) + ```lua + for i = 1, 9 do + globalkeys = gears.table.join(globalkeys, + -- View tag only. + awful.key({ modkey }, "#" .. i + 9, + function () + local screen = awful.screen.focused() + local tag = tags[i] + if tag then + sharedtags.viewonly(tag, screen) + end + end, + {description = "view tag #"..i, group = "tag"}), + -- Toggle tag display. + awful.key({ modkey, "Control" }, "#" .. i + 9, + function () + local screen = awful.screen.focused() + local tag = tags[i] + if tag then + sharedtags.viewtoggle(tag, screen) + end + end, + {description = "toggle tag #" .. i, group = "tag"}), + -- Move client to tag. + awful.key({ modkey, "Shift" }, "#" .. i + 9, + function () + if client.focus then + local tag = tags[i] + if tag then + client.focus:move_to_tag(tag) + end end - end, - {description = "toggle tag #" .. i, group = "tag"}), - -- Move client to tag. - awful.key({ modkey, "Shift" }, "#" .. i + 9, - function () - if client.focus then - local tag = tags[i] - if tag then - client.focus:move_to_tag(tag) - end - end - end, - {description = "move focused client to tag #"..i, group = "tag"}), - -- Toggle tag on focused client. - awful.key({ modkey, "Control", "Shift" }, "#" .. i + 9, - function () - if client.focus then - local tag = tags[i] - if tag then - client.focus:toggle_tag(tag) - end - end - end, - {description = "toggle focused client on tag #" .. i, group = "tag"}) - ) - end - ``` + end, + {description = "move focused client to tag #"..i, group = "tag"}), + -- Toggle tag on focused client. + awful.key({ modkey, "Control", "Shift" }, "#" .. i + 9, + function () + if client.focus then + local tag = tags[i] + if tag then + client.focus:toggle_tag(tag) + end + end + end, + {description = "toggle focused client on tag #" .. i, group = "tag"}) + ) + end + ``` 5. Lastly, any rules referencing the screen and tag should use the newly created `tags` array instead. - - ```lua - awful.rules.rules = { - -- Set Firefox to always map on tag number 2. - { rule = { class = "Firefox" }, - properties = { tag = tags[2] } }, -- or tags["www"] to map it to the name instead - } - ``` + ```lua + awful.rules.rules = { + -- Set Firefox to always map on tag number 2. + { rule = { class = "Firefox" }, + properties = { tag = tags[2] } }, -- or tags["www"] to map it to the name instead + } + ``` 3. Restart or reload *awesome*. Notes