add missing <control> and <menupath> markers

This commit is contained in:
Karol Lewandowski 2022-03-09 09:41:47 +01:00
parent 57e9fa3511
commit 9c1bba9c44
9 changed files with 30 additions and 30 deletions

View File

@ -40,7 +40,7 @@ Quickfixes for file-level notifications
Create HTML representation of code Create HTML representation of code
: Use `com.intellij.openapi.editor.richcopy.HtmlSyntaxInfoUtil` to create Lexer-based highlighted code samples, e.g. for usage in documentation. : Use `com.intellij.openapi.editor.richcopy.HtmlSyntaxInfoUtil` to create Lexer-based highlighted code samples, e.g. for usage in documentation.
View \| Appearance \| Description in Tree Views <menupath>View | Appearance | Details in Tree Views</menupath>
: Toggles showing additional details in UI (e.g. modification timestamp in Project View) see `UISettings.getShowInplaceComments()`. : Toggles showing additional details in UI (e.g. modification timestamp in Project View) see `UISettings.getShowInplaceComments()`.
New API for Editor Inlay Hints New API for Editor Inlay Hints

View File

@ -127,8 +127,8 @@ Override text presentation for actions depending on menu context
: Set the [`<override-text>`](basic_action_system.md#setting-the-override-text-element) element within the `<action>` declaration in <path>plugin.xml</path>. : Set the [`<override-text>`](basic_action_system.md#setting-the-override-text-element) element within the `<action>` declaration in <path>plugin.xml</path>.
Changes in Project Open/Import Changes in Project Open/Import
: **Import from Existing Sources** has been removed from the Welcome Screen, leaving only **Open or Import**, which calls a different extension than the one previously used to contribute a wizard step to **Import from Existing Sources** (which is still available in the **File** menu). To support **Open or Import**, a plugin must provide [`ProjectOpenProcessor`](upsource:///platform/ide-core/src/com/intellij/projectImport/ProjectOpenProcessor.java). : **Import from Existing Sources** has been removed from the Welcome Screen, leaving only **Open or Import**, which calls a different extension than the one previously used to contribute a wizard step to **Import from Existing Sources** (which is still available in the <control>File</control> menu). To support **Open or Import**, a plugin must provide [`ProjectOpenProcessor`](upsource:///platform/ide-core/src/com/intellij/projectImport/ProjectOpenProcessor.java).
`ProjectOpenProcessor.canOpenProject()` should return `true` for the folder selected by the user only if it guarantees `doOpenProject()` can handle it. If there are several matching processors, a simple choice dialog is shown. If additional manual configuration is necessary, a modal dialog can be shown in `doOpenProject()` - however, it is highly recommended performing all setup automatically (like Maven and Gradle plugins do). `ProjectOpenProcessor.canOpenProject()` should return `true` for the folder selected by the user only if it guarantees `doOpenProject()` can handle it. If there are several matching processors, a simple chooser dialog is shown. If additional manual configuration is necessary, a modal dialog can be shown in `doOpenProject()` - however, it is highly recommended performing all setup automatically (like Maven and Gradle plugins do).
### IntelliJ IDEA 2020.1 ### IntelliJ IDEA 2020.1

View File

@ -140,7 +140,7 @@ A group's "compact" attribute specifies whether an action within that group is v
See [Registering Actions in plugin.xml](#registering-actions-in-pluginxml) for an explanation of how the `compact` attribute is set for a group. See [Registering Actions in plugin.xml](#registering-actions-in-pluginxml) for an explanation of how the `compact` attribute is set for a group.
If the `compact` attribute is `true` for a menu group, an action in the menu only appears if its state is both enabled and visible. If the `compact` attribute is `true` for a menu group, an action in the menu only appears if its state is both enabled and visible.
In contrast, if the `compact` attribute is `false`, an action in the menu appears if its state is disabled but visible. In contrast, if the `compact` attribute is `false`, an action in the menu appears if its state is disabled but visible.
Some menus like **Tools** have the `compact` attribute set, so there isn't a way to show an action on the tools menu if it is not enabled. Some menus like <menupath>Tools</menupath> have the `compact` attribute set, so there isn't a way to show an action on the <menupath>Tools</menupath> menu if it is not enabled.
| Host Menu<br/>`compact` Setting | Action Enabled | Visibility Enabled | Menu Item Visible? | Menu Item Appears Gray? | | Host Menu<br/>`compact` Setting | Action Enabled | Visibility Enabled | Menu Item Visible? | Menu Item Appears Gray? |
|:-------------------------------:|:--------------:|:------------------:|:------------------:|:-----------------------:| |:-------------------------------:|:--------------:|:------------------:|:------------------:|:-----------------------:|
@ -171,7 +171,7 @@ In the `action` element reference example (below) with `id` attribute `VssIntegr
The `add-to-group` element declares the action is added to the Tools Menu. The `add-to-group` element declares the action is added to the Tools Menu.
However, the `override-text` element declares that text for `VssIntegration.GarbageCollection` displayed anywhere in the main menu system should be the alternate text "Collect _Garbage." However, the `override-text` element declares that text for `VssIntegration.GarbageCollection` displayed anywhere in the main menu system should be the alternate text "Collect _Garbage."
The Tools menu is part of the main menu, so the displayed menu text is "Collect _Garbage." The <menupath>Tools</menupath> menu is part of the main menu, so the displayed menu text is "Collect _Garbage."
A different context, such as searching for the action using <menupath>Help | Find Action</menupath>, displays the default text "Garbage Collector: Collect _Garbage" to give the user additional information about the action. A different context, such as searching for the action using <menupath>Help | Find Action</menupath>, displays the default text "Garbage Collector: Collect _Garbage" to give the user additional information about the action.
A second `override-text` element uses `place` and `use-text-of-place` attributes to declare the same version of the text used in the main menu is also used in the editor popup menu. A second `override-text` element uses `place` and `use-text-of-place` attributes to declare the same version of the text used in the main menu is also used in the editor popup menu.

View File

@ -6,7 +6,7 @@
> >
{type="note"} {type="note"}
This section explains how you can create a new plugin project from scratch using the New Project wizard. This section explains how you can create a new plugin project from scratch using the <menupath>New Project</menupath> wizard.
Optionally, you can import an existing project or import a project from external models. Optionally, you can import an existing project or import a project from external models.
You can also add a new plugin module to the current IntelliJ Platform project. You can also add a new plugin module to the current IntelliJ Platform project.
For more information, refer to the [IntelliJ IDEA Web Help](https://www.jetbrains.com/idea/help/new-project-wizard.html). For more information, refer to the [IntelliJ IDEA Web Help](https://www.jetbrains.com/idea/help/new-project-wizard.html).
@ -17,23 +17,23 @@ For more information, refer to the [IntelliJ IDEA Web Help](https://www.jetbrain
> >
{type="note"} {type="note"}
* On the main menu, choose **File \| New \| Project**. * On the main menu, choose <menupath>File | New | Project</menupath>.
The *New Project* wizard starts. The <control>New Project</control> wizard starts.
![New Project Wizard](new_project_wizard.png) ![New Project Wizard](new_project_wizard.png)
* Set *IntelliJ Platform Plugin* project type. * Select <control>IntelliJ Platform Plugin</control> project type.
* Click **Next**. * Click <control>Next</control> button.
* Set the desired project name. * Set the desired project name.
* Click **Finish** to generate project structure files. * Click <control>Finish</control> to generate project structure files.
* Go to **File \| Project Structure** to customize project settings if required. * Go to <menupath>File | Project Structure</menupath> to customize project settings if required.
### To Create an IntelliJ Platform Plugin Module ### To Create an IntelliJ Platform Plugin Module
* Select **File \| New \| Module** and choose the *IntelliJ Platform Plugin* module type * Select <menupath>File | New | Module</menupath> and choose the <control>IntelliJ Platform Plugin</control> module type.
![IntelliJ Platform Plugin Module](intellij_platform_plugin_module.png) ![IntelliJ Platform Plugin Module](intellij_platform_plugin_module.png)
<br/> <br/>
<br/> <br/>
* Enter your desired plugin name. * Enter your desired plugin name.
* Go to **File \| Project Structure** and select the newly created *IntelliJ Platform SDK* as the default SDK for the plugin module: * Go to <menupath>File | Project Structure</menupath> and select the newly created *IntelliJ Platform SDK* as the default SDK for the plugin module:
![Set Plugin Module SDK](set_plugin_module_sdk.png) ![Set Plugin Module SDK](set_plugin_module_sdk.png)
### Adding Code to the Project ### Adding Code to the Project

View File

@ -6,9 +6,9 @@ Before your custom plugin can be used, it must be deployed: built, installed, an
To deploy a plugin: To deploy a plugin:
* Make your project by invoking **Build \| Build Project** or **Build \| Build Module \<module name\>**. * Make your project by invoking <menupath>Build | Build Project</menupath> or <menupath>Build | Build Module $MODULE_NAME$</menupath>.
* Prepare your plugin for deployment. * Prepare your plugin for deployment.
In the main menu, select **Build \| Prepare Plugin Module \<module name\> for Deployment**. In the main menu, select <menupath>Build | Prepare Plugin Module $MODULE_NAME$ for Deployment</menupath>.
![Prepare Plugin for Deployment](prepare_plugin_for_deployment.png) ![Prepare Plugin for Deployment](prepare_plugin_for_deployment.png)

View File

@ -6,7 +6,7 @@ It's possible to run and debug a plugin directly from the IntelliJ IDEA.
You need a configured special profile (a *Plugin* Run/Debug configuration) that specifies the plugin module, VM parameters, and other specific options. You need a configured special profile (a *Plugin* Run/Debug configuration) that specifies the plugin module, VM parameters, and other specific options.
When you run such a profile, it launches the IDE with your plugin installed. When you run such a profile, it launches the IDE with your plugin installed.
See [IDE Development Instances](ide_development_instance.md) for more information about configuration and advanced settings. See [](ide_development_instance.md) for more information about configuration and advanced settings.
For information on how to change the Run/Debug configuration profile, refer to [Run/Debug Configuration](https://www.jetbrains.com/help/idea/run-debug-configuration.html) and [Run/Debug Configuration: Plugin](https://www.jetbrains.com/idea/help/run-debug-configuration-plugin.html) in IntelliJ IDEA Web Help. For information on how to change the Run/Debug configuration profile, refer to [Run/Debug Configuration](https://www.jetbrains.com/help/idea/run-debug-configuration.html) and [Run/Debug Configuration: Plugin](https://www.jetbrains.com/idea/help/run-debug-configuration-plugin.html) in IntelliJ IDEA Web Help.
@ -14,8 +14,8 @@ Using IntelliJ IDEA's debugger, you can find out the origin of the run-time erro
**To debug a plugin** **To debug a plugin**
* Select **Run \| Debug** in the main menu, or press <shortcut>Shift+F9</shortcut>. * Select <menupath>Run | Debug...</menupath> in the main menu, or press <shortcut>Shift+F9</shortcut>.
**To run a plugin** **To run a plugin**
* Select **Run \| Run** in the main menu, or press <shortcut>Shift+F10</shortcut>. * Select <menupath>Run | Run...</menupath> in the main menu, or press <shortcut>Shift+F10</shortcut>.

View File

@ -30,11 +30,11 @@ To set up your plugin development environment:
> >
{type="warning"} {type="warning"}
* Create a new *IntelliJ Platform SDK* under **File \| Project Structure**: * Create a new <control>IntelliJ Platform Plugin SDK</control> under <menupath>File | Project Structure</menupath>:
![Create IntelliJ Platform SDK](create_intellij_idea_sdk.png) ![Create IntelliJ Platform SDK](create_intellij_idea_sdk.png)
<br/> <br/>
<br/> <br/>
* Specify the installation folder of the *IntelliJ IDEA Community Edition* as the home directory (on Mac, select application icon in _/Applications/_). * Specify the installation folder of the *IntelliJ IDEA Community Edition* as the home directory (on Mac, select application icon in <path>/Applications/</path>).
You can use the installation package built from sources or download it from the [Download IntelliJ IDEA page](https://www.jetbrains.com/idea/download/). You can use the installation package built from sources or download it from the [Download IntelliJ IDEA page](https://www.jetbrains.com/idea/download/).
> You may use IntelliJ IDEA Ultimate as an alternative, but debugging the core code will only work with the *Community Edition*. > You may use IntelliJ IDEA Ultimate as an alternative, but debugging the core code will only work with the *Community Edition*.
![Set Home Directory](set_home_directory.png) ![Set Home Directory](set_home_directory.png)
@ -44,7 +44,7 @@ To set up your plugin development environment:
![Set IDEA JDK](set_java_sdk.png) ![Set IDEA JDK](set_java_sdk.png)
<br/> <br/>
<br/> <br/>
* In the Sourcepath tab of the SDK settings, click the *Add* button (_this step can be skipped if your plugin doesn't require debugging_): * In the <control>Sourcepath</control> tab of the SDK settings, click the <control>Add</control> button (_this step can be skipped if your plugin doesn't require debugging_):
![Add Sourcepath](add_sourcepath.png) ![Add Sourcepath](add_sourcepath.png)
<br/> <br/>
<br/> <br/>
@ -52,12 +52,12 @@ To set up your plugin development environment:
![Specify Source Paths](community_sources_directory.png) ![Specify Source Paths](community_sources_directory.png)
<br/> <br/>
<br/> <br/>
* Specify the **Sandbox Home** directory. * Specify the <control>Sandbox Home</control> directory.
The *Sandbox Home* directory stores the settings of the IDE development instance launched from a Plugin Project's **Run** configuration. The <control>Sandbox Home</control> directory stores the settings of the IDE development instance launched from a Plugin Project's run configuration.
Shown below is the default *Sandbox Home* directory for a user on macOS. Shown below is the default <control>Sandbox Home</control> directory for a user on macOS.
Any directory can be chosen as the *Sandbox Home* location. Any directory can be chosen as the <control>Sandbox Home</control> location.
Use the ellipsis button (shown below) to define a custom location. Use the ellipsis button (shown below) to define a custom location.
See the [IDE Development Instances](ide_development_instance.md) page for more information about the default *Sandbox Home* directory locations and contents. See the [IDE Development Instances](ide_development_instance.md) page for more information about the default <control>Sandbox Home</control> directory locations and contents.
![Specify Sandbox Path](plugins-sandbox.png) ![Specify Sandbox Path](plugins-sandbox.png)

View File

@ -137,7 +137,7 @@ For more information, see [](basic_action_system.md#setting-the-override-text-el
## Testing the Minimal Custom Action Implementation ## Testing the Minimal Custom Action Implementation
After performing the steps described above, compile and run the plugin to see the newly created action available as a <control>Tools</control> menu item, which is within the context of the main menu: After performing the steps described above, compile and run the plugin to see the newly created action available as a <menupath>Tools</menupath> menu item, which is within the context of the main menu:
![Register action](tools_menu_item_action.png){width="350"} ![Register action](tools_menu_item_action.png){width="350"}
@ -151,7 +151,7 @@ However, it confirms the new entry appears at <menupath>Tools | Pop Dialog Actio
## Developing the `AnAction` Methods ## Developing the `AnAction` Methods
At this point, the new action `PopupDialogAction` is registered with the IntelliJ Platform and functions in the sense that `update()` and `actionPerformed()` are called in response to user interaction with the IDE <control>Tools</control> menu. At this point, the new action `PopupDialogAction` is registered with the IntelliJ Platform and functions in the sense that `update()` and `actionPerformed()` are called in response to user interaction with the IDE <menupath>Tools</menupath> menu.
However, neither method implements any code to perform useful work. However, neither method implements any code to perform useful work.
This section describes adding useful code to these methods. This section describes adding useful code to these methods.

View File

@ -57,7 +57,7 @@ Create a generic `DemoModuleWizardStep` based on [`ModuleWizardStep`](upsource:/
## Creating a Module of New Type ## Creating a Module of New Type
After compiling and running the plugin in a development instance, create a new project. After compiling and running the plugin in a development instance, create a new project.
Select **File \| New \| Module...** Select <menupath>File | New | Module...</menupath>.
A new module type and its settings panel are available in the Project Wizard. A new module type and its settings panel are available in the Project Wizard.
![New Module Type](new_module_type.png){width="800"} ![New Module Type](new_module_type.png){width="800"}