diff --git a/buildUML/README.md b/buildUML/README.md index 61c51023f..71e301d85 100644 --- a/buildUML/README.md +++ b/buildUML/README.md @@ -6,7 +6,7 @@ These are temporary instructions, pending a move of more [diagrams and utilities * Get and install the [PlantUML Integration plugin](https://plugins.jetbrains.com/plugin/7017-plantuml-integration) for IntelliJ IDEA: * Set the `GRAPHVIZ_DOT` system or environment property to point to the directory containing the Graphviz executable on your machine. For example, `export GRAPHVIZ_DOT="/usr/local/Cellar/graphviz/2.42.3/bin/dot"` - * In the PlantUML plugin Settings (**Preferences/Settings \| Other Settings \| PlantUML**) set: + * In the PlantUML plugin Settings (**Settings/Preferences \| Other Settings \| PlantUML**) set: * The "Additional 'plantuml.include.path'" to be the absolute path to the directory containing the `jb-plantuml-theme.puml` file on your machine. For example, `//buildUML` or, if you have the IntelliJ-Community source code, `//platform/docs/`. * The "PlantUML config" to `!include jb-plantuml-theme.puml` diff --git a/topics/appendix/api_notable/api_notable_list_2019.md b/topics/appendix/api_notable/api_notable_list_2019.md index 0b52c2949..738ab6f70 100644 --- a/topics/appendix/api_notable/api_notable_list_2019.md +++ b/topics/appendix/api_notable/api_notable_list_2019.md @@ -22,7 +22,7 @@ Symbol completion in plain text editor (VCS Commit Message) : Contribute symbol names (classes, methods, ..) via `com.intellij.completion.plainTextSymbol` extension point (`com.intellij.codeInsight.completion.PlainTextSymbolCompletionContributor`). User-customizable date/time formatting -: Use `com.intellij.util.text.JBDateFormat#getFormatter()` to use configured format from `Settings | Appearance & Behavior | System Settings | Date Formats`. +: Use `com.intellij.util.text.JBDateFormat#getFormatter()` to use configured format from Settings/Preferences | Appearance & Behavior | System Settings | Date Formats. ### Notable Changes in IntelliJ IDEA 2019.3 diff --git a/topics/basics/plugin_signing.md b/topics/basics/plugin_signing.md index 4ca217be0..b98af4f94 100644 --- a/topics/basics/plugin_signing.md +++ b/topics/basics/plugin_signing.md @@ -211,7 +211,7 @@ Signing plugins hosted on a custom repository can be accomplished for added trus ### Verification Before looking at how we can sign a plugin, let's first review how verification works when a non-JetBrains certificate is used. -As of 2021.2, during verification, IntelliJ-based IDEs check if the plugin was signed by the JetBrains CA certificate or any public key provided by the user via `Preferences > Plugins > Manage Plugin Certificates`. In 2021.2.1, a system property has been added: `intellij.plugins.truststore`, pointing to a trusted JKS TrustStore. During verification, the plugin's public key is extracted from the signature. The last certificate entry in the chain matched against the certificates stored in one of the storages from above. +As of 2021.2, during verification, IntelliJ-based IDEs check if the plugin was signed by the JetBrains CA certificate or any public key provided by the user via Settings/Preferences | Plugins | Manage Plugin Certificates. In 2021.2.1, a system property has been added: `intellij.plugins.truststore`, pointing to a trusted JKS TrustStore. During verification, the plugin's public key is extracted from the signature. The last certificate entry in the chain matched against the certificates stored in one of the storages from above. ### Using a Trusted Internal CA @@ -219,7 +219,7 @@ If an internal CA is available, you can use this to generate certificates for si With this approach, existing internal TrustStores may exist and could be used. Be sure when choosing a TrustStore that the CAs are limited to the internal CAs you trust. Using a TrustStore with public CAs can expose the users to an attack vector. -If adding a TrustStore to a users environment is not possible, the user may also add the root CAs public key to `Preferences > Plugins > Manage Plugin Certificates` +If adding a TrustStore to a users environment is not possible, the user may also add the root CAs public key to Settings/Preferences | Plugins | Manage Plugin Certificates. ### Using Self-Signed Certificates @@ -232,4 +232,4 @@ keytool -import -alias IdeaPlugin -file chain.crt -keystore pluginKeystore.jks - ``` (note: the TrustStore password must remain `changeit`) -Otherwise, users may add the public key manually to `Preferences > Plugins > Manage Plugin Certificates`. +Otherwise, users may add the public key manually to Settings/Preferences | Plugins | Manage Plugin Certificates. diff --git a/topics/basics/virtual_file_system.md b/topics/basics/virtual_file_system.md index d877e9ebd..6d627e475 100644 --- a/topics/basics/virtual_file_system.md +++ b/topics/basics/virtual_file_system.md @@ -36,7 +36,7 @@ The VFS will be updated during the next refresh operation, which includes the fi IntelliJ Platform refreshes the entire project contents asynchronously on startup. By default, it performs a refresh operation when the user switches to it from another app. -Still, users can turn this off via **Settings \| Appearance & Behavior \| System Settings \| Synchronize external changes \[...]**. +Still, users can turn this off via Settings/Preferences | Appearance & Behavior | System Settings | Synchronize external changes\[...]. On Windows, Mac, and Linux, a native file watcher process is started that receives file change notifications from the file system and reports them to the IntelliJ Platform. If a file watcher is available, a refresh operation looks only at the files that have been reported as changed by the file watcher. @@ -48,7 +48,7 @@ If a file's contents were changed, but its timestamp remained the same, the Inte There is currently no facility for removing files from the snapshot. If a file was loaded there once, it remains there forever unless it was deleted from the disk, and a refresh operation was called on one of its parent directories. -The VFS itself does not honor ignored files listed in **Settings \| Editor \| File Types** and folders to ignore and excluded folders listed in **Project Structure \| Modules \| Sources \| Excluded**. +The VFS itself does not honor ignored files listed in Settings/Preferences | Editor | File Types and folders to ignore and excluded folders listed in Project Structure | Modules | Sources | Excluded. If the application code accesses them, the VFS will load and return their contents. In most cases, the ignored files and excluded folders must be skipped from processing by higher-level code. diff --git a/topics/reference_guide/settings_guide.md b/topics/reference_guide/settings_guide.md index e526546a0..de89cee00 100644 --- a/topics/reference_guide/settings_guide.md +++ b/topics/reference_guide/settings_guide.md @@ -140,7 +140,7 @@ The following nested interfaces are markers, which convey information about the #### Additional Interfaces Based on Configurable There are classes in the IntelliJ Platform specialized for particular types of Settings. These subtypes are based on `com.intellij.openapi.options.ConfigurableEP`. -For example, **Settings/Preferences \| Editor \| General \|Appearance** allows adding Settings via [`EditorSmartKeysConfigurableEP`](upsource:///platform/lang-impl/src/com/intellij/application/options/editor/EditorSmartKeysConfigurableEP.java) and `com.intellij.editorSmartKeysConfigurable` EP. +For example, Settings/Preferences | Editor | General | Appearance allows adding Settings via [`EditorSmartKeysConfigurableEP`](upsource:///platform/lang-impl/src/com/intellij/application/options/editor/EditorSmartKeysConfigurableEP.java) and `com.intellij.editorSmartKeysConfigurable` EP. ### The ConfigurableProvider Class The [`ConfigurableProvider`](upsource:///platform/platform-api/src/com/intellij/openapi/options/ConfigurableProvider.java) class only provides a `Configurable` implementation if its runtime conditions are met. diff --git a/topics/reference_guide/ui_themes/themes_extras.md b/topics/reference_guide/ui_themes/themes_extras.md index 2e0744732..06b69169b 100644 --- a/topics/reference_guide/ui_themes/themes_extras.md +++ b/topics/reference_guide/ui_themes/themes_extras.md @@ -55,7 +55,7 @@ For example, the snippet below sets the color of the line numbers displayed in t For additional examples of `name` and `value` attributes, review the editor color scheme XML file for the [High Contrast editor scheme](upsource:///platform/platform-resources/src/themes/highContrastScheme.xml). ### Customizing Version Control File Status Colors -As [described above](#creating-a-custom-editor-scheme-using-settingspreferences), colors corresponding to the VCS status of files can be customized and exported via the [Preferences/Settings](https://www.jetbrains.com/help/idea/file-status-highlights.html). +As [described above](#creating-a-custom-editor-scheme-using-settingspreferences), colors corresponding to the VCS status of files can be customized and exported via the [Settings/Preferences](https://www.jetbrains.com/help/idea/file-status-highlights.html). No other procedure is necessary to customize these colors. In the exported color scheme file the `name` is the VCS file status, and the `value` is the new color corresponding to that status. For example, customized VCS colors for a subset of file statuses will appear in the editor scheme file as: diff --git a/topics/tutorials/action_system/working_with_custom_actions.md b/topics/tutorials/action_system/working_with_custom_actions.md index e82a9b8e4..d2892753b 100644 --- a/topics/tutorials/action_system/working_with_custom_actions.md +++ b/topics/tutorials/action_system/working_with_custom_actions.md @@ -52,7 +52,7 @@ A more comprehensive explanation of action registration is available in the [Act ### Registering an Action with the New Action Form IntelliJ IDEA has an embedded inspection that spots unregistered actions. -Verify the inspection is enabled at **Settings/Preferences \| Editor \| Inspections \| Plugin DevKit \| Code \| Component/Action not registered**. +Verify the inspection is enabled at Settings/Preferences | Editor | Inspections | Plugin DevKit | Code | Component/Action not registered. Here is an example for this stage of the `PopupDialogAction` class: !["Action never used" inspection](action_never_used.png){width="600"} diff --git a/topics/tutorials/custom_language_support/code_style_settings.md b/topics/tutorials/custom_language_support/code_style_settings.md index 6d9c7106b..eed691e79 100644 --- a/topics/tutorials/custom_language_support/code_style_settings.md +++ b/topics/tutorials/custom_language_support/code_style_settings.md @@ -52,6 +52,6 @@ The `SimpleLanguageCodeStyleSettingsProvider` implementation is registered with ## Run the Project Run the plugin by using the Gradle [runIde task](gradle_prerequisites.md#running-a-simple-gradle-based-intellij-platform-plugin). -In the IDE Development Instance, open the Simple Language code formatting page: **Preferences/Settings \| Editor \| Code Style \| Simple**. +In the IDE Development Instance, open the Simple Language code formatting page: Settings/Preferences | Editor | Code Style | Simple. ![Code Style Settings](code_style_settings.png) \ No newline at end of file diff --git a/topics/tutorials/custom_language_support/syntax_highlighter_and_color_settings_page.md b/topics/tutorials/custom_language_support/syntax_highlighter_and_color_settings_page.md index 7c1a68468..eed518a60 100644 --- a/topics/tutorials/custom_language_support/syntax_highlighter_and_color_settings_page.md +++ b/topics/tutorials/custom_language_support/syntax_highlighter_and_color_settings_page.md @@ -61,7 +61,7 @@ Register the Simple Language color settings page with the IntelliJ Platform in t ### Run the Project Run the project by using the Gradle [runIde task](gradle_prerequisites.md#running-a-simple-gradle-based-intellij-platform-plugin). -In the IDE Development Instance, open the Simple Language highlight settings page: **Preferences/Settings \| Editor \| Color Scheme \| Simple**. -Each color initially inherits from a _Language Defaults_ value. +In the IDE Development Instance, open the Simple Language highlight settings page: Settings/Preferences | Editor | Color Scheme | Simple. +Each color initially inherits from a Language Defaults value. ![Color Settings Page](color_settings_page.png) \ No newline at end of file diff --git a/topics/tutorials/editor_basics/coordinates_system.md b/topics/tutorials/editor_basics/coordinates_system.md index edc674bcf..dbb064f23 100644 --- a/topics/tutorials/editor_basics/coordinates_system.md +++ b/topics/tutorials/editor_basics/coordinates_system.md @@ -173,7 +173,7 @@ The caret Offset includes: * The first (0th) character in a document. * Whitespace characters, including newline and tabs. * Any characters after end-of-line if the IDE settings permit them. - (**Preferences \| Editor \| General \| Virtual Space**) + (Settings/Preferences | Editor | General | Virtual Space) * The character selected by the caret. The example below demonstrates the Offset of a caret placed at the first character of Logical line one. diff --git a/topics/tutorials/settings_tutorial.md b/topics/tutorials/settings_tutorial.md index e3e9ac3e8..54288158d 100644 --- a/topics/tutorials/settings_tutorial.md +++ b/topics/tutorials/settings_tutorial.md @@ -104,7 +104,7 @@ Also review notes about [IntelliJ Platform Interactions](settings_guide.md#intel ## Testing the Custom Settings Plugin After performing the steps described above, compile and run the plugin in a Development Instance to see the custom Settings available in the Settings Dialog. -Open the IDE Settings by selecting **Settings/Preferences \| Tools \| SDK: Application Settings Example**. +Open the IDE Settings by selecting Settings/Preferences | Tools | SDK: Application Settings Example. The settings are preloaded with the default values: !["Settings Defaults"](settings_defaults.png){width="600"} diff --git a/topics/user_interface_components/notifications.md b/topics/user_interface_components/notifications.md index 4bc3678a3..857f3d0a8 100644 --- a/topics/user_interface_components/notifications.md +++ b/topics/user_interface_components/notifications.md @@ -1,6 +1,6 @@ [//]: # (title: Notifications) - + One of the leading design principles is avoiding the use of modal message boxes for notifying the user about errors and other situations that may warrant the user's attention. As a replacement, the IntelliJ Platform provides multiple non-modal notification UI options. @@ -32,8 +32,8 @@ The most general way to display non-modal notifications is to use the [`Notifica It has two main advantages: -* The user can control the way each notification type is displayed under `Settings | Appearance & Behavior | Notifications` -* All displayed notifications are gathered in the Event Log tool window and can be reviewed later +* The user can control the way each notification type is displayed under Settings/Preferences | Appearance & Behavior | Notifications +* All displayed notifications are gathered in the Event Log tool window and can be reviewed later For UI reference, see [Balloon](https://jetbrains.design/intellij/controls/balloon/) in the IntelliJ Platform UI Guidelines. @@ -43,7 +43,7 @@ The text of the notification can include HTML tags. Use `Notification.addAction(AnAction)` to add links below the content, use [`NotificationAction`](upsource:///platform/platform-api/src/com/intellij/notification/NotificationAction.java) for convenience. -The `groupId` parameter of the [`Notification`](upsource:///platform/platform-api/src/com/intellij/notification/Notification.java) constructor specifies a notification type. The user can choose the display type corresponding to each notification type under `Settings | Appearance and Behavior | Notifications`. +The `groupId` parameter of the [`Notification`](upsource:///platform/platform-api/src/com/intellij/notification/Notification.java) constructor specifies a notification type. The user can choose the display type corresponding to each notification type under Settings/Preferences | Appearance & Behavior | Notifications. To specify the preferred display type, you need to use [`NotificationGroup`](upsource:///platform/platform-api/src/com/intellij/notification/NotificationGroup.kt) to create notifications.