Skip to content

Commit 44d9f4e

Browse files
committed
Use / (or s) to open search box
We allow for using `s` to open the search box, but it's more common to use `/` (forward slash) for this. E.g., MDN's documentation uses `/` for search. Rustdoc and GitHub accept either. Let's allow either key to be used, and let's switch to "advertising" `/` rather than `s` in the hover text for the search button. In making that switch, let's also simplify that hover text a bit. Previously it had said "Search. (Shortkey: s)". This was the only top button on which we had included a period in the hover text. Let's remove that, and let's remove the "shortkey" bit of jargon. It's enough to just put `/` in a parenthetical, i.e. "Search (`/`)". People will gleam from that what we mean. We've also updated the guide accordingly.
1 parent a8aee21 commit 44d9f4e

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

guide/src/guide/reading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Tapping the menu bar will scroll the page to the top.
4242
## Search
4343

4444
Each book has a built-in search system.
45-
Pressing the search icon (<i class="fa fa-search"></i>) in the menu bar, or pressing the `S` key on the keyboard will open an input box for entering search terms.
45+
Pressing the search icon (<i class="fa fa-search"></i>) in the menu bar, or pressing the `/` or `S` key on the keyboard will open an input box for entering search terms.
4646
Typing some terms will show matching chapters and sections in real time.
4747

4848
Clicking any of the results will jump to that section.

src/front-end/searcher/searcher.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ window.search = window.search || {};
3535
URL_SEARCH_PARAM = 'search',
3636
URL_MARK_PARAM = 'highlight',
3737

38-
SEARCH_HOTKEY_KEYCODE = 83,
38+
SEARCH_HOTKEY_KEYCODES = [83, 191], // `s` or `/`.
3939
ESCAPE_KEYCODE = 27,
4040
DOWN_KEYCODE = 40,
4141
UP_KEYCODE = 38,
@@ -362,7 +362,7 @@ window.search = window.search || {};
362362
}
363363
showSearch(false);
364364
marker.unmark();
365-
} else if (!hasFocus() && e.keyCode === SEARCH_HOTKEY_KEYCODE) {
365+
} else if (!hasFocus() && SEARCH_HOTKEY_KEYCODES.includes(e.keyCode)) {
366366
e.preventDefault();
367367
showSearch(true);
368368
window.scrollTo(0, 0);

src/front-end/templates/index.hbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
143143
</ul>
144144
{{#if search_enabled}}
145-
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
145+
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
146146
<i class="fa fa-search"></i>
147147
</button>
148148
{{/if}}

0 commit comments

Comments
 (0)