Merge pull request #603 from sumnerevans/hint-documentation

Adding notes about typing hint characters in lowercase (fix #588).

readme.md

@@ -45,7 +45,7 @@ This is a (non-exhaustive) list of the most common normal-mode bindings. Type
 - `^`/`$` — scroll to left/right margin
 - `gg`/`G` — scroll to start/end of page
 - `f`/`F` — enter "hint mode" to select a link to follow. `F` to open in a
-  background tab
+  background tab (note: hint characters should be typed in lowercase)
 - `gi` — scroll to and focus the last-used input on the page
 - `r`/`R` — reload page or hard reload page
 - `yy` — copy the current page URL to the clipboard

src/excmds.ts

@@ -42,7 +42,8 @@
       type the tab ID or part of the title or URL to choose a tab
     - Press `Shift` + `Insert` to enter "ignore mode". Press `Shift` + `Insert`
       again to return to "normal mode".
-    - Press `f` to start "hint mode", `F` to open in background
+    - Press `f` to start "hint mode", `F` to open in background (note: hint
+      characters should be typed in lowercase)
     - Press `o` to `:open` a different page
     - Press `s` if you want to search for something that looks like a domain
       name or URL

src/static/clippy/hint_mode.md

@@ -1,6 +1,6 @@
 # Hint mode
 
-There are many different hint submodes. They all follow a similar pattern: hinting modes display characters above various elements on the screen, which you can type to perform actions using those elements.
+There are many different hint submodes. They all follow a similar pattern: hinting modes display characters above various elements on the screen, which you can type to perform actions using those elements. (Note: hint characters should be typed in lowercase.)
 
 Here are some of the most useful hint modes:
 

src/static/clippy/tutor.md

@@ -19,6 +19,7 @@ The idea behind Tridactyl is to allow you to navigate the web more efficiently w
     - This mode highlights elements on the web page and performs actions on those elements.
     - This is most often used for following links, but it has many other submodes.
     - You can enter this mode with `f` and exit it with `Escape` or `Enter`.
+    - Hint characters are displayed as uppercase letters, but you should type the lowercase letter.
 - Command mode ("ex-mode")
     - This mode allows you to execute more complicated commands by typing them out manually.
     - It is commonly used for binding keys and accessing help.

src/static/newtab.md

@@ -20,7 +20,7 @@ REPLACE_ME_WITH_THE_CHANGE_LOG_USING_SED
 
 ## Highlighted features:
 
-- `f`/`F` — enter the "hint mode" to select a link to follow. `F` to open it in a background tab.
+- `f`/`F` — enter the "hint mode" to select a link to follow. `F` to open it in a background tab. (Note: hint characters should be typed in lowercase.)
 - `Shift` + `Insert` — enter "ignore mode" to send all key presses to the web page you are on. Press `Shift` + `Insert` again to return to the highly productive "normal mode".
 - `H`/`L` — go back/forward in the history.
 - `o`/`O` — open a URL in this tab (`O` to pre-load current URL).