From: Vladimir Panteleev <git@thecybershadow.net>
Date: Fri, 14 Dec 2018 13:16:11 +0000 (+0000)
Subject: userguide: Un-hide a TODO block completed in 2011
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=refs%2Fpull%2F3563%2Fhead;p=i3%2Fi3

userguide: Un-hide a TODO block completed in 2011

The userguide contained a commented-out section for marks, which
included the line:

> TODO: make i3-input replace %s

The line was added in a26a11c6099f82fc9fd8b87f8bda128408b4f7c9 (May
2011), at which point i3-input did not have a -F switch. The switch
was added only in 1737a78fcd8025e11398dbcf5acd65c6a07ae86d (September
2011), but the documentation was never updated to enable the
commented-out examples.
---

diff --git a/docs/userguide b/docs/userguide
index bf5a4d21..073ffdf1 100644
--- a/docs/userguide
+++ b/docs/userguide
@@ -2428,6 +2428,21 @@ mark [--add|--replace] [--toggle] <identifier>
 unmark <identifier>
 ----------------------------------------------
 
+You can use +i3-input+ to prompt for a mark name, then use the +mark+
+and +focus+ commands to create and jump to custom marks:
+
+*Examples*:
+---------------------------------------
+# read 1 character and mark the current window with this character
+bindsym $mod+m exec i3-input -F 'mark %s' -l 1 -P 'Mark: '
+
+# read 1 character and go to the window with the character
+bindsym $mod+g exec i3-input -F '[con_mark="%s"] focus' -l 1 -P 'Goto: '
+---------------------------------------
+
+Alternatively, if you do not want to mess with +i3-input+, you could create
+separate bindings for a specific set of labels and then only use those labels:
+
 *Example (in a terminal)*:
 ---------------------------------------------------------
 # marks the focused container
@@ -2443,21 +2458,6 @@ unmark irssi
 [class="(?i)firefox"] unmark
 ---------------------------------------------------------
 
-///////////////////////////////////////////////////////////////////
-TODO: make i3-input replace %s
-*Examples*:
----------------------------------------
-# Read 1 character and mark the current window with this character
-bindsym $mod+m exec i3-input -F 'mark %s' -l 1 -P 'Mark: '
-
-# Read 1 character and go to the window with the character
-bindsym $mod+g exec i3-input -F '[con_mark="%s"] focus' -l 1 -P 'Goto: '
----------------------------------------
-
-Alternatively, if you do not want to mess with +i3-input+, you could create
-separate bindings for a specific set of labels and then only use those labels.
-///////////////////////////////////////////////////////////////////
-
 [[pango_markup]]
 === Window title format