From c307eb5642810e1f41105da9660e855f6f7fce4f Mon Sep 17 00:00:00 2001 From: Matt Ellis Date: Fri, 9 Jun 2017 17:13:28 +0100 Subject: [PATCH] Minor formatting fixes --- basics/getting_started/deploying_plugin.md | 2 +- basics/plugin_structure/plugin_dependencies.md | 2 +- reference_guide/localization_guide.md | 7 +------ reference_guide/vcs_integration_for_plugins.md | 7 +------ user_interface_components/popups.md | 4 +--- 5 files changed, 5 insertions(+), 17 deletions(-) diff --git a/basics/getting_started/deploying_plugin.md b/basics/getting_started/deploying_plugin.md index 0fae56a1001..184a071a194 100644 --- a/basics/getting_started/deploying_plugin.md +++ b/basics/getting_started/deploying_plugin.md @@ -7,7 +7,7 @@ Before your custom plugin can be used, it must be deployed: built, installed, an To deploy a plugin: * Make your project by invoking **Build \| Make Project**. -* Prepare your plugin for deployment. In the main menu, select **Build \| Prepare Plugin Module '' for Deployment**. +* Prepare your plugin for deployment. In the main menu, select **Build \| Prepare Plugin Module '\' for Deployment**. ![Prepare Plugin for Deployment](deploying_plugin/img/prepare_plugin_for_deployment.png) diff --git a/basics/plugin_structure/plugin_dependencies.md b/basics/plugin_structure/plugin_dependencies.md index 69525bf70c3..b996aab602d 100644 --- a/basics/plugin_structure/plugin_dependencies.md +++ b/basics/plugin_structure/plugin_dependencies.md @@ -6,7 +6,7 @@ In your plugin, you may depend on classes from other plugins, either bundled, th * Add the jars of the plugin you're depending on to the classpath of your *IntelliJ Platform SDK*. -> **warning** Do not add the plugin jars as a library: this will fail at runtime because IntelliJ Platform will load two separate copies of the dependency plugin classes. + > **warning** Do not add the plugin jars as a library: this will fail at runtime because IntelliJ Platform will load two separate copies of the dependency plugin classes. * Add a `` tag to your plugin.xml, adding the ID of the plugin you're depending on as the contents of the tag. For example: diff --git a/reference_guide/localization_guide.md b/reference_guide/localization_guide.md index cd087f4e1ad..234d8721baa 100644 --- a/reference_guide/localization_guide.md +++ b/reference_guide/localization_guide.md @@ -30,12 +30,7 @@ tool for more details. Property values mostly follow MessageFormat rules. -**Note**: - - Due to historic reasons main menu, toolbar, popup menus and other actions have their mnemonic char prefixed with - '\_' (underscore) char while all other mnemonics like those for checkboxes, buttons etc use '&' (ampersand) sign for the same purpose. - Moreover one can encounter && (double ampersand) in some places, which denote alternative mnemonic to be used under MacOS X (mnemonics mapped to U, I, O N chars won't work there). - Generally, use the same mnemonic denotation used in original property value and everything will be OK. +> **Note** Due to historic reasons main menu, toolbar, popup menus and other actions have their mnemonic char prefixed with `\_` (underscore) char while all other mnemonics like those for checkboxes, buttons etc. use `&` (ampersand) sign for the same purpose. Moreover one can encounter `&&` (double ampersand) in some places, which denote alternative mnemonic to be used under MacOS X (mnemonics mapped to `U`, `I`, `O`, `N` chars won't work there). Generally, use the same mnemonic denotation used in original property value and everything will be OK. ## Components Location diff --git a/reference_guide/vcs_integration_for_plugins.md b/reference_guide/vcs_integration_for_plugins.md index 3067a6dcd81..0facbfc3f6d 100644 --- a/reference_guide/vcs_integration_for_plugins.md +++ b/reference_guide/vcs_integration_for_plugins.md @@ -116,12 +116,7 @@ There are two main kinds of changelists: For VCSes which use per-file commit (like CVS), the plugin can use heuristics to group a sequence of individual file commits into a [CommittedChangeList](upsource:///platform/vcs-api/src/com/intellij/openapi/vcs/versionBrowser/CommittedChangeList.java) -**Note**: - -``` -The *Unversioned Files*, *Locally Deleted Files* etc. nodes in the *Changes* view are not actually changelists, -and files under those nodes are not represented by Change objects. -``` +> **Note** The *Unversioned Files*, *Locally Deleted Files* etc. nodes in the *Changes* view are not actually changelists, and files under those nodes are not represented by Change objects. ## Plugin Components diff --git a/user_interface_components/popups.md b/user_interface_components/popups.md index 2139a9ad54e..bc10afb59fe 100644 --- a/user_interface_components/popups.md +++ b/user_interface_components/popups.md @@ -50,9 +50,7 @@ Once you've created the popup, you need to display it by calling one of the `sho You can let the IntelliJ Platform automatically choose the position based on the context, by calling `showInBestPositionFor()`, or specify the position explicitly through methods like `showUnderneathOf()` and `showInCenterOf()`. -**Note:** - -> The `show()` methods return immediately and do not wait for the popup to be closed. +> **Note:** The `show()` methods return immediately and do not wait for the popup to be closed. If you need to perform some action when the popup is closed, you can either attach a listener to it using the `addListener()` method, override a method of the popup contents such as [PopupStep.onChosen()](upsource:///platform/platform-api/src/com/intellij/openapi/ui/popup/PopupStep.java),