From e1778d4c0409505379e62102682f3a660c0cce33 Mon Sep 17 00:00:00 2001 From: Alexander Schwartz Date: Wed, 23 Nov 2022 22:58:22 +0100 Subject: [PATCH] Use macOS styleguide (#1214) --- .../modules/ROOT/pages/coder/inspections.adoc | 2 +- .../docs/writing-user-documentation.adoc | 6 +- .../ROOT/pages/features/advanced/antora.adoc | 2 +- .../modules/ROOT/pages/features/keymap.adoc | 124 +++++++++--------- .../editor-the-file-asciidoc-file.adoc | 8 +- .../technical-writing/git-integration.adoc | 4 +- .../navigating-in-a-project.adoc | 20 +-- .../searching-in-a-project.adoc | 16 +-- 8 files changed, 92 insertions(+), 90 deletions(-) diff --git a/doc/contributors-guide/modules/ROOT/pages/coder/inspections.adoc b/doc/contributors-guide/modules/ROOT/pages/coder/inspections.adoc index 9ec8a8349..6d6634a03 100644 --- a/doc/contributors-guide/modules/ROOT/pages/coder/inspections.adoc +++ b/doc/contributors-guide/modules/ROOT/pages/coder/inspections.adoc @@ -3,7 +3,7 @@ Inspections allow highlighting of issues in the editor. -They also allow for quick fixes that the user can select using [.windows.linux]#kbd:[Ctrl+Enter]# [.macos]#kbd:[⌘+Enter]#. +They also allow for quick fixes that the user can select using [.windows.linux]#kbd:[Ctrl+Enter]# [.macos]#kbd:[⌘ ↩]#. == How Inspections work diff --git a/doc/contributors-guide/modules/ROOT/pages/docs/writing-user-documentation.adoc b/doc/contributors-guide/modules/ROOT/pages/docs/writing-user-documentation.adoc index 078f9645d..928102832 100644 --- a/doc/contributors-guide/modules/ROOT/pages/docs/writing-user-documentation.adoc +++ b/doc/contributors-guide/modules/ROOT/pages/docs/writing-user-documentation.adoc @@ -25,7 +25,7 @@ Example: -- * `++[.windows]#kbd:[Alt+F7]#++` * `++[.linux]#kbd:[Alt+Shift+7]#++` -* `++[.macos]#kbd:[⌥+F7]#++` +* `++[.macos]#kbd:[⌥ F7]#++` -- + displays as @@ -33,11 +33,13 @@ displays as -- * kbd:[Alt+F7] (Windows) * kbd:[Alt+Shift+7] (Linux) -* kbd:[⌥+F7] (macOS) +* kbd:[⌥ F7] (macOS) -- + The UI theme displays an operating switcher which tries to auto-detect the operating system of the visitor, which will then show only the shortcuts relevant to the selected operating system. Therefore, always put all three operating systems into the docs. ++ +As per the https://developer.apple.com/design/human-interface-guidelines/inputs/keyboards/[Apple guidelines], there is no `+` but a space between the keys. Use active voice:: Active voice: "`The preview displays the result`" + diff --git a/doc/users-guide/modules/ROOT/pages/features/advanced/antora.adoc b/doc/users-guide/modules/ROOT/pages/features/advanced/antora.adoc index 6fe13000c..9ae1dcc76 100644 --- a/doc/users-guide/modules/ROOT/pages/features/advanced/antora.adoc +++ b/doc/users-guide/modules/ROOT/pages/features/advanced/antora.adoc @@ -84,7 +84,7 @@ To learn more about how to bundle multiple Git repositories as one IntelliJ proj === Antora editor support -In the editor, the user can autocomplete filenames and references using [.windows.linux]#kbd:[Ctrl+Space]# [.macos]#kbd:[^+Space]# and can navigate to a folder or file using [.windows.linux]#kbd:[Ctrl+B]# [.macos]#kbd:[⌘+B]#. +In the editor, the user can autocomplete filenames and references using [.windows.linux]#kbd:[Ctrl+Space]# [.macos]#kbd:[^ Space]# and can navigate to a folder or file using [.windows.linux]#kbd:[Ctrl+B]# [.macos]#kbd:[⌘ B]#. To allow auto-completion for components that reside in different Git repositories, consider using a xref:features/advanced/multimodule.adoc[multi-module project]. diff --git a/doc/users-guide/modules/ROOT/pages/features/keymap.adoc b/doc/users-guide/modules/ROOT/pages/features/keymap.adoc index cf6eec172..58c06fbb2 100644 --- a/doc/users-guide/modules/ROOT/pages/features/keymap.adoc +++ b/doc/users-guide/modules/ROOT/pages/features/keymap.adoc @@ -26,31 +26,31 @@ https://resources.jetbrains.com/storage/products/intellij-idea/docs/IntelliJIDEA | Basic code completion | [.windows.linux]#kbd:[Ctrl+Space]# -[.macos]#kbd:[⌃+Space]# +[.macos]#kbd:[⌃ Space]# | Smart code completion | [.windows.linux]#kbd:[Ctrl+Shift+Space]# -[.macos]#kbd:[⌃+⇧+Space]# +[.macos]#kbd:[⌃ ⇧ Space]# -| Show intention actions and quick-fixes | [.windows.linux]#kbd:[Alt+Enter]# +| Show intention actions and quick-fixes | [.windows.linux]#kbd:[Alt ↩]# -[.macos]#kbd:[⌘+Enter]# +[.macos]#kbd:[⌘ ↩]# | Open corresponding tool window | [.windows.linux]#kbd:[Alt+0] ... kbd:[Alt+9]# -[.macos]#kbd:[⌘+0] ... kbd:[⌘+9]# +[.macos]#kbd:[⌘ 0] ... kbd:[⌘ 9]# | Save all | [.windows.linux]#kbd:[Ctrl+S]# -[.macos]#kbd:[⌘+S]# +[.macos]#kbd:[⌘ S]# | Open Settings dialog | [.windows.linux]#kbd:[Ctrl+Alt+S]# -[.macos]#kbd:[⌘+,]# +[.macos]#kbd:[⌘ ,]# | Find Action | [.windows.linux]#kbd:[Ctrl+Shift+A]# -[.macos]#kbd:[⌘+⇧+A]# +[.macos]#kbd:[⌘ ⇧ A]# |=== [caption=] @@ -62,13 +62,13 @@ https://resources.jetbrains.com/storage/products/intellij-idea/docs/IntelliJIDEA [.windows.linux]#kbd:[Ctrl+W]# -[.macos]#kbd:[⌥+Up]# +[.macos]#kbd:[⌥ ↑]# | Shrink selection | [.windows.linux]#kbd:[Ctrl+Shift+W]# -[.macos]#kbd:[⌥+Down]# +[.macos]#kbd:[⌥ ↓]# | Toggle bold for the selected text | kbd:[*] | Toggle emphasize for the selected text | kbd:[_] @@ -81,124 +81,124 @@ https://resources.jetbrains.com/storage/products/intellij-idea/docs/IntelliJIDEA | Show intention actions and quick-fixes | [.windows.linux]#kbd:[Alt+Enter]# -[.macos]#kbd:[⌥+Enter]# +[.macos]#kbd:[⌥ ↩]# | Reformat code | [.windows.linux]#kbd:[Ctrl+Alt+L]# -[.macos]#kbd:[⌘+⌥+L]# +[.macos]#kbd:[⌘ ⌥ L]# | Auto-indent line(s) | [.windows.linux]#kbd:[Ctrl+Alt+I]# -[.macos]#kbd:[⌃+⌥+I]# +[.macos]#kbd:[⌃ ⌥ I]# | Indent/unindent selected lines | [.windows.linux]#kbd:[Tab] / kbd:[Shift+Tab]# -[.macos]#kbd:[Right] / kbd:[⇧+Right]# +[.macos]#kbd:[⇥] / kbd:[⇧ ⇥]# | Cut current line to clipboard | [.windows.linux]#kbd:[Ctrl+X],kbd:[Shift+Delete]# -[.macos]#kbd:[⌘+X]# +[.macos]#kbd:[⌘ X]# | Copy current line to clipboard | [.windows.linux]#kbd:[Ctrl+C],kbd:[Ctrl+Insert]# -[.macos]#kbd:[⌘+C]# +[.macos]#kbd:[⌘ C]# | Paste from clipboard + (text or images) | [.windows.linux]#kbd:[Ctrl+V],kbd:[Shift+Insert]# -[.macos]#kbd:[⌘+V]# +[.macos]#kbd:[⌘ V]# -| Move current line up/down | [.windows.linux]#kbd:[Ctrl+Shift+Up]/kbd:[Down]# +| Move current line up/down | [.windows.linux]#kbd:[Ctrl+Shift+Up]/kbd:[Ctrl+Shift+Down]# -[.macos]#kbd:[⇧+⌘+Up]/kbd:[Down]# +[.macos]#kbd:[⇧ ⌘ ↑]/kbd:[⇧ ⌘ ↓]# | Duplicate current line | [.windows.linux]#kbd:[Ctrl+D]# -[.macos]#kbd:[⌘+D]# +[.macos]#kbd:[⌘ D]# | Delete line at caret | [.windows.linux]#kbd:[Ctrl+Y]# -[.macos]#kbd:[⌘+Backspace]# +[.macos]#kbd:[⌘ ⌫]# | Smart line join | [.windows.linux]#kbd:[Ctrl+Shift+J]# -[.macos]#kbd:[⌃+⇧+J]# +[.macos]#kbd:[⌃ ⇧ J]# | Smart line split | [.windows.linux]#kbd:[Ctrl+Enter]# -[.macos]#kbd:[⌘+Enter]# +[.macos]#kbd:[⌘ ↩]# | Start new line | [.windows.linux]#kbd:[Shift+Enter]# -[.macos]#kbd:[⇧+Enter]# +[.macos]#kbd:[⇧ ↩]# | Toggle case for word at caret or selected block | [.windows.linux]#kbd:[Ctrl+Shift+U]# -[.macos]#kbd:[⌘+⇧+U]# +[.macos]#kbd:[⌘ ⇧ U]# | Delete to word end | [.windows.linux]#kbd:[Ctrl+Delete]# -[.macos]#kbd:[⌥+Backspace]# +[.macos]#kbd:[⌥ ⌫]# | Delete to word start | [.windows.linux]#kbd:[Ctrl+Backspace]# -[.macos]#kbd:[⌥+Delete]# +[.macos]#kbd:[⌥ Delete]# | Close active editor tab | [.windows.linux]#kbd:[Ctrl+F4]# -[.macos]#kbd:[⌘+W]# +[.macos]#kbd:[⌘ W]# | Basic code completion + (for example file names) | [.windows.linux]#kbd:[Ctrl+Space]# -[.macos]#kbd:[^+Space]# +[.macos]#kbd:[^ Space]# | Smart code completion + (for example file names) | [.windows.linux]#kbd:[Ctrl+Shift+Space]# -[.macos]#kbd:[^+⇧+Space]# +[.macos]#kbd:[^ ⇧ Space]# | Complete the statement + (for example macros) | [.windows.linux]#kbd:[Ctrl+Shift+Enter]# -[.macos]#kbd:[⌘+⇧+Enter]# +[.macos]#kbd:[⌘ ⇧ Enter]# | Quick documentation lookup | [.windows.linux]#kbd:[Ctrl+Q]# -[.macos]#kbd:[^+J]# +[.macos]#kbd:[^ J]# | Brief Info | [.windows.linux]#kbd:[Ctrl+mouse]# -[.macos]#kbd:[⌘+mouse]# +[.macos]#kbd:[⌘] + mouse# | Expand/collapse block or attribute | [.windows.linux]#kbd:[Ctrl+NumPad+] / kbd:[NumPad-]# -[.macos]#kbd:[⌘ + ++ + ++] / kbd:[⌘+-]# +[.macos]#kbd:[⌘ ++ + ++] / kbd:[⌘ -]# | Expand/collapse all | [.windows.linux]#kbd:[Ctrl+Shift+NumPad+] / kbd:[NumPad-]# -[.macos]#kbd:[⌘ + ⇧ + ++ + ++] / kbd:[⌘ + ⇧+-]# +[.macos]#kbd:[⌘ ⇧ ++ + ++] / kbd:[⌘ ⇧ -]# | Comment/uncomment with line comment | [.windows.linux]#kbd:[Ctrl+/]# -[.macos]#kbd:[⌘+/]# +[.macos]#kbd:[⌘ /]# | Comment/uncomment with block comment | [.windows.linux]#kbd:[Ctrl+Shift+/]# -[.macos]#kbd:[⌘ + ++⌥++ + /]# +[.macos]#kbd:[⌘ ⌥ /]# | Select till the end of a code block | [.windows.linux]#kbd:[Ctrl+Shift++]+]# -[.macos]#kbd:[⌘ + ⇧ + +]+]# +[.macos]#kbd:[⌘ ⇧ +]+]# | Select till the start of a code block | [.windows.linux]#kbd:[Ctrl+Shift++[+]# -[.macos]#kbd:[⌘ + ⇧ + +[+]# +[.macos]#kbd:[⌘ ⇧ +[+]# | Surround with... + (Use it with `ad-tag-include` template in any language to add tags for includes.) | [.windows.linux]#kbd:[Ctrl+Alt+T]# -[.macos]#kbd:[⌘+⌥+T]# +[.macos]#kbd:[⌘ ⌥ T]# |=== @@ -210,80 +210,80 @@ https://resources.jetbrains.com/storage/products/intellij-idea/docs/IntelliJIDEA | Go to declaration + Works also for file and class names in italics or monospace | [.windows.linux]#kbd:[Ctrl+B], kbd:[Ctrl+Click]# -[.macos]#kbd:[⌘+B], kbd:[⌘+Click]# +[.macos]#kbd:[⌘ B], kbd:[⌘] + click# | Go to class | [.windows.linux]#kbd:[Ctrl+N]# -[.macos]#kbd:[⌘+O]# +[.macos]#kbd:[⌘ O]# | Go to file | [.windows.linux]#kbd:[Ctrl+Shift+N]# -[.macos]#kbd:[⌘+⇧+O]# +[.macos]#kbd:[⌘ ⇧ O]# | Go to symbol | [.windows.linux]#kbd:[Ctrl+Alt+Shift+N]# -[.macos]#kbd:[⌘+⌥+O]# +[.macos]#kbd:[⌘ ⌥ O]# -| Go to next/previous editor tab | [.windows.linux]#kbd:[Alt+Right/Left]# +| Go to next/previous editor tab | [.windows.linux]#kbd:[Alt+Right] / kbd:[Alt+Left]# -[.macos]#kbd:[^+Right/Left]# +[.macos]#kbd:[^ →] / kbd:[^ ←]# | Go back to the previous tool window | kbd:[F12] | Go to editor (from the tool window) | kbd:[Esc] | Hide active or last active window | [.windows.linux]#kbd:[Shift+Esc]# -[.macos]#kbd:[⇧+Esc]# +[.macos]#kbd:[⇧ Esc]# | Go to line | [.windows.linux]#kbd:[Ctrl+G]# -[.macos]#kbd:[⌘+L]# +[.macos]#kbd:[⌘ L]# | Find in current file | [.windows.linux]#kbd:[Ctrl+F]# -[.macos]#kbd:[⌘+F]# +[.macos]#kbd:[⌘ F]# | Find usages | [.windows]#kbd:[Alt+F7]# [.linux]#kbd:[Alt+Shift+7]# -[.macos]#kbd:[⌥+F7]# +[.macos]#kbd:[⌥ F7]# | Replace in current file | [.windows.linux]#kbd:[Ctrl+R]# -[.macos]#kbd:[⌘+R]# +[.macos]#kbd:[⌘ R]# | Rename + (for example ID or file name) | [.windows.linux]#kbd:[Shift+F6]# -[.macos]#kbd:[⇧+F6]# +[.macos]#kbd:[⇧ F6]# | Recent files popup | [.windows.linux]#kbd:[Ctrl+E]# -[.macos]#kbd:[⌘+E]# +[.macos]#kbd:[⌘ E]# | Navigate back/forward | [.windows.linux]#kbd:[Ctrl+Alt+Left/Right]# -[.macos]#kbd:[⌘+⌥+Left/Right]# +[.macos]#kbd:[⌘ ⌥ ←] / kbd:[⌘ ⌥ →]# | Navigate to last edit location | [.windows.linux]#kbd:[Ctrl+Shift+Backspace]# -[.macos]#kbd:[⌘+⇧+Backspace]# +[.macos]#kbd:[⌘ ⇧ ⌫]# | Select current file or symbol in any view | [.windows.linux]#kbd:[Alt+F1]# -[.macos]#kbd:[⌥+F1]# +[.macos]#kbd:[⌥ F1]# | Go to declaration | [.windows.linux]#kbd:[Ctrl+B],kbd:[Ctrl+Click]# -[.macos]#kbd:[⌘+B],kbd:[⌘+Click]# +[.macos]#kbd:[⌘ B], kbd:[⌘] + click# | File structure popup | [.windows.linux]#kbd:[Ctrl+F12]# -[.macos]#kbd:[⌘+F12]# +[.macos]#kbd:[⌘ F12]# | Show navigation bar | [.windows.linux]#kbd:[Alt+Home]# -[.macos]#kbd:[⌥+Home]# +[.macos]#kbd:[⌥ Home]# | Toggle bookmark | [.windows.linux]#kbd:[F11]# @@ -291,15 +291,15 @@ Works also for file and class names in italics or monospace | [.windows.linux]#k | Toggle bookmark with mnemonic | [.windows.linux]#kbd:[Ctrl+F11]# -[.macos]#kbd:[⌥+F3]# +[.macos]#kbd:[⌥ F3]# | Go to numbered bookmark | [.windows.linux]#kbd:[Ctrl+0] ... kbd:[Ctrl+9]# -[.macos]#kbd:[^0] ... kbd:[^9]# +[.macos]#kbd:[^ 0] ... kbd:[^ 9]# | Show bookmarks | [.windows.linux]#kbd:[Shift+F11]# -[.macos]#kbd:[⌘+F3]# +[.macos]#kbd:[⌘ F3]# |=== diff --git a/doc/users-guide/modules/ROOT/pages/technical-writing/editor-the-file-asciidoc-file.adoc b/doc/users-guide/modules/ROOT/pages/technical-writing/editor-the-file-asciidoc-file.adoc index 3321cafbd..e7f87cc35 100644 --- a/doc/users-guide/modules/ROOT/pages/technical-writing/editor-the-file-asciidoc-file.adoc +++ b/doc/users-guide/modules/ROOT/pages/technical-writing/editor-the-file-asciidoc-file.adoc @@ -74,17 +74,17 @@ The main things to know about the editor are: * When the user types the three letters kbd:[a]kbd:[d]kbd:[-], the editor suggests live templates for common AsciiDoc structures like lists, links and source code. Continue typing to narrow down the list, use the up and down arrows to highlight an entry, and use kbd:[Enter] to select an entry. -* When typing a file name as part of an image macro or a reference, [.windows.linux]#kbd:[Ctrl+Space]# [.macos]#kbd:[^+Space]# shows a list of suggestions. +* When typing a file name as part of an image macro or a reference, [.windows.linux]#kbd:[Ctrl+Space]# [.macos]#kbd:[^ Space]# shows a list of suggestions. Press kbd:[Tab] to replace the text in editor for the current reference or press kbd:[Enter] to insert the text in the editor. * Using kbd:[Alt+Enter], the user can trigger context-specific features of the IDE, especially when there is an underlined text that indicate warnings and errors. Those features range from creating a missing file to choose a correct word when there is a spelling or grammar mistake. -* After placing the cursor on an include-macro or a reference and pressing [.windows.linux]#kbd:[Ctrl+B]# [.macos]#kbd:[⌘+B]#, the IDE opens that file in a new editor tab. +* After placing the cursor on an include-macro or a reference and pressing [.windows.linux]#kbd:[Ctrl+B]# [.macos]#kbd:[⌘ B]#, the IDE opens that file in a new editor tab. -* To rename an attribute name, file name or reference, place the cursor on it and press [.windows.linux]#kbd:[Shift+F6]# [.macos]#kbd:[⇧+F6]#, and the IDE renames the reference in all places if the checkboxes are enabled in the dialog that pops up after the key was pressed. +* To rename an attribute name, file name or reference, place the cursor on it and press [.windows.linux]#kbd:[Shift+F6]# [.macos]#kbd:[⇧ F6]#, and the IDE renames the reference in all places if the checkboxes are enabled in the dialog that pops up after the key was pressed. -* To format the complete file or a selection of text, press [.windows.linux]#kbd:[Ctrl+Alt+L]# [.macos]#kbd:[⌘+⌥+L]#. +* To format the complete file or a selection of text, press [.windows.linux]#kbd:[Ctrl+Alt+L]# [.macos]#kbd:[⌘ ⌥ L]#. The default configuration removes unnecessary blanks and applies the one-sentence-per line rule. See xref:features/advanced/reformatting.adoc[] for details. To learn more about the editor's features, read the page xref:features/editor.adoc[]. diff --git a/doc/users-guide/modules/ROOT/pages/technical-writing/git-integration.adoc b/doc/users-guide/modules/ROOT/pages/technical-writing/git-integration.adoc index 6d0744357..67d60326c 100644 --- a/doc/users-guide/modules/ROOT/pages/technical-writing/git-integration.adoc +++ b/doc/users-guide/modules/ROOT/pages/technical-writing/git-integration.adoc @@ -36,10 +36,10 @@ image::technical-writing/intellij-git.png[] . In the menu:Branch[] dropdown, select _HEAD_ to show only the commits of the current branch. . The "`Commit`" tool window shows all local changes that can then be committed. -Open it by click on the tool window or use the shortcut [.windows.linux]#kbd:[Alt+0]# [.macos]#kbd:[⌘+0]#. +Open it by click on the tool window or use the shortcut [.windows.linux]#kbd:[Alt+0]# [.macos]#kbd:[⌘ 0]#. Explore the different actions in the toolbar by hovering with the mouse over the different icons. + -Double-click on a highlighted file or press [.windows.linux]#kbd:[Ctrl+D]# [.macos]#kbd:[⌘+D]# to show the differences side-by-side. See the IntelliJ documentation on how to https://www.jetbrains.com/help/idea/comparing-file-versions.html[Compare file and folder versions] and https://www.jetbrains.com/help/idea/resolving-conflicts.html[Resolve Conflicts]. +Double-click on a highlighted file or press [.windows.linux]#kbd:[Ctrl+D]# [.macos]#kbd:[⌘ D]# to show the differences side-by-side. See the IntelliJ documentation on how to https://www.jetbrains.com/help/idea/comparing-file-versions.html[Compare file and folder versions] and https://www.jetbrains.com/help/idea/resolving-conflicts.html[Resolve Conflicts]. === Learning more about Git functionality diff --git a/doc/users-guide/modules/ROOT/pages/technical-writing/navigating-in-a-project.adoc b/doc/users-guide/modules/ROOT/pages/technical-writing/navigating-in-a-project.adoc index 5e3837446..b513a8dc5 100644 --- a/doc/users-guide/modules/ROOT/pages/technical-writing/navigating-in-a-project.adoc +++ b/doc/users-guide/modules/ROOT/pages/technical-writing/navigating-in-a-project.adoc @@ -21,18 +21,18 @@ Use the menu item menu:Navigate[] for a full list of options, or use menu:Help[F While all other sections describe how to navigate forward, these are the most common ways to return to files opened previously: -* To return to a previous file, use [.windows.linux]#kbd:[Ctrl+E]# [.macos]#kbd:[⌘+E]# and select the file to return to. -* Use [.linux]#kbd:[Alt+Shift+Left]# [.windows]#kbd:[Alt+Ctrl+Left]# [.macos]#kbd:[⌘ + ⌥ + ←]# and [.linux]#kbd:[Alt+Shift+Right]# [.windows]#kbd:[Alt+Ctrl+Right]# [.macos]#kbd:[⌘ + ⌥ + →]# +* To return to a previous file, use [.windows.linux]#kbd:[Ctrl+E]# [.macos]#kbd:[⌘ E]# and select the file to return to. +* Use [.linux]#kbd:[Alt+Shift+Left]# [.windows]#kbd:[Alt+Ctrl+Left]# [.macos]#kbd:[⌘ ⌥ ←]# and [.linux]#kbd:[Alt+Shift+Right]# [.windows]#kbd:[Alt+Ctrl+Right]# [.macos]#kbd:[⌘ ⌥ →]# to move backwards and forwards in the latest cursor positions. -* To return to the previous editing position, use [.windows.linux]#kbd:[Ctrl+Shift+Backspace]# [.macos]#kbd:[⇧ + ⌘ + ⌫]#. +* To return to the previous editing position, use [.windows.linux]#kbd:[Ctrl+Shift+Backspace]# [.macos]#kbd:[⇧ ⌘ ⌫]#. === Navigation in the editor Moving the cursor within a file:: The editor shows the content. After placing the cursor in the editor pane, the user can use the cursor keys to move up, down left and right, use the mouse and the scroll bar to move up and down, and also place the cursor. -Use [.windows.linux]#kbd:[Alt+Up]# [.macos]#kbd:[⌃ + ⇧ + ↑]# and [.windows.linux]#kbd:[Alt+Down]# and [.macos]#kbd:[⌃ + ⇧ + ↓]# to move the keyboard cursor by paragraph. -Use [.windows.linux]#kbd:[Ctrl+Left]# [.macos]#kbd:[⌥ + ←]# and [.windows.linux]#kbd:[Ctrl+Right]# [.macos]#kbd:[⌥ + →]# to move the keyboard cursor by one word. +Use [.windows.linux]#kbd:[Alt+Up]# [.macos]#kbd:[⌃ ⇧ ↑]# and [.windows.linux]#kbd:[Alt+Down]# and [.macos]#kbd:[⌃ ⇧ ↓]# to move the keyboard cursor by paragraph. +Use [.windows.linux]#kbd:[Ctrl+Left]# [.macos]#kbd:[⌥ ←]# and [.windows.linux]#kbd:[Ctrl+Right]# [.macos]#kbd:[⌥ →]# to move the keyboard cursor by one word. Navigation to referenced resource:: @@ -40,18 +40,18 @@ After pressing the [.windows.linux]#kbd:[Ctrl]# [.macos]#kbd:[⌥]#, all element This works file names and references in macros like `++xref:[]++`, `++images:[]++` and `++include::[]++`. When the user clicks the element while the [.windows.linux]#kbd:[Ctrl]# [.macos]#kbd:[⌥]# key is still pressed, the IDE opens the referenced resource in an editor. If there are multiple possible targets, the IDE shows a list of targets for the user to choose the one to navigate to. + -The same functionality works when placing the editing cursor with the keyboard on such a reference, and pressing [.windows.linux]#kbd:[Ctrl+B]# [.macos]#kbd:[⌘+B]#. +The same functionality works when placing the editing cursor with the keyboard on such a reference, and pressing [.windows.linux]#kbd:[Ctrl+B]# [.macos]#kbd:[⌘ B]#. Finding other usages of an element:: For each named element like an included file or a reference, the user can find its usages. -With the mouse, this is available from the context menu which opens when right-clicking on the element. It is also available as a shortcut via [.windows]#kbd:[Alt+F7]# [.linux]#kbd:[Alt+Shift+7]# [.macos]#kbd:[⌥+F7]#. +With the mouse, this is available from the context menu which opens when right-clicking on the element. It is also available as a shortcut via [.windows]#kbd:[Alt+F7]# [.linux]#kbd:[Alt+Shift+7]# [.macos]#kbd:[⌥ F7]#. Jump to a line/column in a file:: -To jump within the current file, press [.windows.linux]#kbd:[Ctrl+G]# [.macos]#kbd:[⌘+L]# and enter the line, optionally followed by a colon and the column to where to jump to. +To jump within the current file, press [.windows.linux]#kbd:[Ctrl+G]# [.macos]#kbd:[⌘ L]# and enter the line, optionally followed by a colon and the column to where to jump to. + -To jump to a different file, press [.windows.linux]#kbd:[Ctrl+Shift+N]# [.macos]#kbd:[⌘+⇧+O]# and enter the file name, optionally followed by the line, optionally followed by a colon with the line and optionally followed with a colon with the column. +To jump to a different file, press [.windows.linux]#kbd:[Ctrl+Shift+N]# [.macos]#kbd:[⌘ ⇧ O]# and enter the file name, optionally followed by the line, optionally followed by a colon with the line and optionally followed with a colon with the column. === Navigation in the preview @@ -94,7 +94,7 @@ Clicking it selects the file that is opened in active editor in the tree view which allows locating a file in the project's hierarchy. For each file, the user and find its usages, for example, where an AsciiDoc file is used as in an `include::[]` preprocessor macro. -With the mouse, this is available from the context menu which opens when right-clicking on the element. It is also available as a shortcut via [.windows]#kbd:[Alt+F7]# [.linux]#kbd:[Alt+Shift+7]# [.macos]#kbd:[⌥+F7]#. +With the mouse, this is available from the context menu which opens when right-clicking on the element. It is also available as a shortcut via [.windows]#kbd:[Alt+F7]# [.linux]#kbd:[Alt+Shift+7]# [.macos]#kbd:[⌥ F7]#. Even when the project tool window is closed, the user can use the navigation bar to navigate the file tree using the current editor's file path. diff --git a/doc/users-guide/modules/ROOT/pages/technical-writing/searching-in-a-project.adoc b/doc/users-guide/modules/ROOT/pages/technical-writing/searching-in-a-project.adoc index 2f4b52d57..00ad44634 100644 --- a/doc/users-guide/modules/ROOT/pages/technical-writing/searching-in-a-project.adoc +++ b/doc/users-guide/modules/ROOT/pages/technical-writing/searching-in-a-project.adoc @@ -23,20 +23,20 @@ Use the menu item menu:Navigate[] for a full list of options, or use menu:Help[F To return to previously edited files, use the following options: -- -* To return to a previous file, use [.windows.linux]#kbd:[Ctrl+E]# [.macos]#kbd:[⌘+E]# and select the file to return to. -* Use [.linux]#kbd:[Alt+Shift+Left]# [.windows]#kbd:[Alt+Ctrl+Left]# [.macos]#kbd:[⌘ + ⌥ + ←]# and [.linux]#kbd:[Alt+Shift+Right]# [.windows]#kbd:[Alt+Ctrl+Right]# [.macos]#kbd:[⌘ + ⌥ + →]# to move backwards and forwards in the latest cursor positions. -* To return to the previous editing position, use [.windows.linux]#kbd:[Ctrl+Shift+Backspace]# [.macos]#kbd:[⇧ + ⌘ + ⌫]#. +* To return to a previous file, use [.windows.linux]#kbd:[Ctrl+E]# [.macos]#kbd:[⌘ E]# and select the file to return to. +* Use [.linux]#kbd:[Alt+Shift+Left]# [.windows]#kbd:[Alt+Ctrl+Left]# [.macos]#kbd:[⌘ ⌥ ←]# and [.linux]#kbd:[Alt+Shift+Right]# [.windows]#kbd:[Alt+Ctrl+Right]# [.macos]#kbd:[⌘ ⌥ →]# to move backwards and forwards in the latest cursor positions. +* To return to the previous editing position, use [.windows.linux]#kbd:[Ctrl+Shift+Backspace]# [.macos]#kbd:[⇧ ⌘ ⌫]#. -- Search for a text snippet in the current file:: -To search within the current file, use [.windows.linux]#kbd:[Ctrl+F]# [.macos]#kbd:[⌘+F]. +To search within the current file, use [.windows.linux]#kbd:[Ctrl+F]# [.macos]#kbd:[⌘ F]. This is by default case-insensitive and uses a plain text search. Using the icons at the end of the input field, the use can switch to a case-sensitive search and a search with regular expressions. Search for a text snippet in the current file:: -To search within all files of the project, use [.windows.linux]#kbd:[Ctrl+Shift+F]# [.macos]#kbd:[⌘ + ⇧ +F]#. +To search within all files of the project, use [.windows.linux]#kbd:[Ctrl+Shift+F]# [.macos]#kbd:[⌘ ⇧ F]#. + image::technical-writing/intellij-find-in-files.png[] + @@ -47,11 +47,11 @@ Use the menu items menu:In Project[], menu:Module[], menu:Directory[] and menu:S + Move the selection up and down, and use the small editor window to edit the code directly. + -Use btn:[Open in Find Window] to open the list of files in a tool window which allows opening each occurrence in an editor and then jump with [.windows.linux]#kbd:[Ctrl+Alt+Down]# [.macos]#kbd:[⌘+ ⌥ + ↓]# and [.windows.linux]#kbd:[Ctrl+Alt+Up]# [.macos]#kbd:[⌘+ ⌥ + ↑]# between them. +Use btn:[Open in Find Window] to open the list of files in a tool window which allows opening each occurrence in an editor and then jump with [.windows.linux]#kbd:[Ctrl+Alt+Down]# [.macos]#kbd:[⌘ ⌥ ↓]# and [.windows.linux]#kbd:[Ctrl+Alt+Up]# [.macos]#kbd:[⌘ ⌥ ↑]# between them. Search by File Name:: -To search a file by its name, use [.windows.linux]#kbd:[Ctrl+Shift+N]# [.macos]#kbd:[⌘ + ⇧ + O]#. +To search a file by its name, use [.windows.linux]#kbd:[Ctrl+Shift+N]# [.macos]#kbd:[⌘ ⇧ O]#. + image::technical-writing/intellij-find-file.png[] + @@ -61,7 +61,7 @@ Search Everywhere:: A user can search for all named elements in a project. This includes attributes, IDs and section heading. -Use [.windows.linux]#kbd:[Shift+Shift]# [.macos]#kbd:[⇧ + ⇧]# to open the dialog. +Use [.windows.linux]#2x kbd:[Shift]# [.macos]#2x kbd:[⇧]# to open the dialog. + image::technical-writing/intellij-search-everywhere.png[]