From 4b14c47af380ffa7d1e5ebe5e82f0bb6893a86a2 Mon Sep 17 00:00:00 2001 From: breandan Date: Wed, 29 Jul 2015 23:50:12 -0400 Subject: [PATCH] Escape unescaped angle brackets, fixes IJSDK-56 --- basics/action_system.md | 8 ++++---- basics/architectural_overview/file_view_providers.md | 2 +- basics/indexing_and_psi_stubs/file_based_indexes.md | 2 +- basics/plugin_structure/plugin_components.md | 6 +++--- basics/plugin_structure/plugin_dependencies.md | 4 ++-- .../plugin_extensions_and_extension_points.md | 2 +- basics/project_structure.md | 2 +- drafts/project_model.md | 2 +- .../frameworks_and_external_apis/external_builder_api.md | 4 ++-- reference_guide/project_model/library.md | 2 +- 10 files changed, 17 insertions(+), 17 deletions(-) diff --git a/basics/action_system.md b/basics/action_system.md index c93188411..cf890c95a 100644 --- a/basics/action_system.md +++ b/basics/action_system.md @@ -35,11 +35,11 @@ The ```AnActionEvent``` instance is also passed to the ```actionPerformed``` met ## Registering Actions -There are two main ways to register an action: either by listing it in the section of the plugin.xml file, or through Java code. +There are two main ways to register an action: either by listing it in the \ section of the plugin.xml file, or through Java code. ### Registering Actions in plugin.xml -Registering actions in plugin.xml is demonstrated in the following example. The example section of plugin.xml demonstrates all elements which can be used in the section, and describes the meaning of each element. +Registering actions in plugin.xml is demonstrated in the following example. The example section of plugin.xml demonstrates all elements which can be used in the \ section, and describes the meaning of each element. ```xml @@ -113,7 +113,7 @@ You can create a plugin that registers actions on IDEA startup using the followi *To register an action on IDEA startup* # Create a new class that implements the ```ApplicationComponent``` interface. # In this class, override the ```getComponentName```, ```initComponent```, and ```disposeComponent``` methods. -# Register this class in the section of the plugin.xml file. +# Register this class in the `` section of the plugin.xml file. To clarify the above procedure, consider the following sample Java class ```MyPluginRegistration``` that registers an action defined in a custom ```TextBoxes``` class and adds a new menu command to the *Window* menu group on the main menu: @@ -149,7 +149,7 @@ public class MyPluginRegistration implements ApplicationComponent { Note, that the sample ```TextBoxes``` class is described in [Getting Started with Plugin Development](/basics/getting_started.html). -To ensure that your plugin is initialized on IDEA start-up, make the following changes to the section of the plugin.xml file: +To ensure that your plugin is initialized on IDEA start-up, make the following changes to the \ section of the plugin.xml file: ```xml diff --git a/basics/architectural_overview/file_view_providers.md b/basics/architectural_overview/file_view_providers.md index b0f547418..c025f9731 100644 --- a/basics/architectural_overview/file_view_providers.md +++ b/basics/architectural_overview/file_view_providers.md @@ -35,7 +35,7 @@ bean class. To access this extension point, create a Java class that implements the [FileViewProviderFactory](https://github.com/JetBrains/intellij-community/blob/master/platform/core-api/src/com/intellij/psi/FileViewProviderFactory.java) interface, and in this class, override the ```createFileViewProvider``` method. -To declare the extension to the _fileType.fileViewProviderFactory_ extension point, to the section of the plugin.xml file, add the following syntax: +To declare the extension to the _fileType.fileViewProviderFactory_ extension point, to the \ section of the plugin.xml file, add the following syntax: ``` diff --git a/basics/indexing_and_psi_stubs/file_based_indexes.md b/basics/indexing_and_psi_stubs/file_based_indexes.md index 888a2612f..8d80bf0d2 100644 --- a/basics/indexing_and_psi_stubs/file_based_indexes.md +++ b/basics/indexing_and_psi_stubs/file_based_indexes.md @@ -26,7 +26,7 @@ Refer to it as an example to understand this topic better. Each specific index implementation is a class extending [FileBasedIndexExtension](https://github.com/JetBrains/intellij-community/blob/master/platform/indexing-api/src/com/intellij/util/indexing/FileBasedIndexExtension.java). -A file-base index should be registered in the extension point. +A file-base index should be registered in the \ extension point. The implementation of a file-based contains of the following main parts: diff --git a/basics/plugin_structure/plugin_components.md b/basics/plugin_structure/plugin_components.md index a8dbe9dd3..36d83b170 100644 --- a/basics/plugin_structure/plugin_components.md +++ b/basics/plugin_structure/plugin_components.md @@ -43,7 +43,7 @@ The name of a component is returned by its ```getComponentName()``` method. ### Components Naming Notation -It is recommended to name components in _._ form. +It is recommended to name components in \.\ form. ### Application Level Components @@ -115,7 +115,7 @@ Note that module-level components must be registered in the ``` section of the `plugin.xml` file. +The IDEA interface will help you declare the module component's implementation class, and will automatically make appropriate changes to the \ section of the `plugin.xml` file. *To create and register a module component* @@ -160,7 +160,7 @@ For more information and samples, refer to The defaults (components' predefined settings) should be placed in the *\.xml* file. Place this file in the plugin's classpath in the folder corresponding to the default package. -The ```readExternal()``` method will be called on the root tag. +The ```readExternal()``` method will be called on the \ root tag. If a component has defaults, the ```readExternal()``` method is called twice: diff --git a/basics/plugin_structure/plugin_dependencies.md b/basics/plugin_structure/plugin_dependencies.md index 7ab933418..a4e0dd7e8 100644 --- a/basics/plugin_structure/plugin_dependencies.md +++ b/basics/plugin_structure/plugin_dependencies.md @@ -8,11 +8,11 @@ In order to do so, you need to perform the following two steps: * Add the jars of the plugin you're depending on to the classpath of your *IntelliJ Platform SDK*. **Note**: Don't 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. +* 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: ```xml org.jetbrains.idea.maven ``` -To find out the ID of the plugin you're depending on, locate the META-INF/plugin.xml file inside its jar and check the contents of the tag. +To find out the ID of the plugin you're depending on, locate the META-INF/plugin.xml file inside its jar and check the contents of the \ tag. diff --git a/basics/plugin_structure/plugin_extensions_and_extension_points.md b/basics/plugin_structure/plugin_extensions_and_extension_points.md index 96190ba9e..5d84b7c9e 100644 --- a/basics/plugin_structure/plugin_extensions_and_extension_points.md +++ b/basics/plugin_structure/plugin_extensions_and_extension_points.md @@ -56,7 +56,7 @@ public class MyBeanClass1 extends AbstractExtensionPointBean { } ``` -Note that to declare an extension designed to access the MyExtensionPoint1 extension point, your plugin.xml file must contain the tag with the "key" and "implementationClass" attributes set to appropriate values (see the sample plugin.xml file below). +Note that to declare an extension designed to access the MyExtensionPoint1 extension point, your plugin.xml file must contain the \ tag with the "key" and "implementationClass" attributes set to appropriate values (see the sample plugin.xml file below). *To declare an extension* diff --git a/basics/project_structure.md b/basics/project_structure.md index dd79e8f1f..31e167902 100644 --- a/basics/project_structure.md +++ b/basics/project_structure.md @@ -35,7 +35,7 @@ A _library_ is an archive of compiled code (such as JAR files) that your modules * **Project Library**: the library classes are visible within the project and the library information is recorded in the project \*.ipr file or in _.idea/libraries_. -* **Global Library**: the library information is recorded in the _applicationLibraries.xml_ file into the _/.IntelliJIdea/config/options_ directory. Global libraries are similar to project libraries, but are visible for the different projects. +* **Global Library**: the library information is recorded in the _applicationLibraries.xml_ file into the \/.IntelliJIdea/config/options_ directory. Global libraries are similar to project libraries, but are visible for the different projects. For more information about libraries, refer to [Library](http://www.jetbrains.com/idea/webhelp/library.html). diff --git a/drafts/project_model.md b/drafts/project_model.md index 36b1f1985..1db202abf 100644 --- a/drafts/project_model.md +++ b/drafts/project_model.md @@ -32,7 +32,7 @@ IntelliJ IDEA supports three types of libraries: * **Module Library**: the library classes are visible only in this module and the library information is recorded in the module *.iml file. * **Project Library**: the library classes are visible within the project and the library information is recorded in the project *.ipr file or in .idea/libraries. -* **Global Library**: the library information is recorded in the applicationLibraries.xml file into the /.IntelliJIdea/config/options directory. Global libraries are similar to project libraries, but are visible for the different projects. +* **Global Library**: the library information is recorded in the applicationLibraries.xml file into the \/.IntelliJIdea/config/options directory. Global libraries are similar to project libraries, but are visible for the different projects. For more information about libraries, refer to [Library] (http://www.jetbrains.com/idea/webhelp/library.html). diff --git a/reference_guide/frameworks_and_external_apis/external_builder_api.md b/reference_guide/frameworks_and_external_apis/external_builder_api.md index 2a2f20d28..e5979eb32 100644 --- a/reference_guide/frameworks_and_external_apis/external_builder_api.md +++ b/reference_guide/frameworks_and_external_apis/external_builder_api.md @@ -50,7 +50,7 @@ mechanism to support plugins. There are several service interfaces (e.g. `Builde ### Registering a plugin for External Builder -Sources of a plugin for External Builder should be put in a separate module. By convention such module has name '...-jps-plugin' and its sources are placed under 'jps-plugin' directory in the main plugin directory. Use `` extension to add the plugin to classpath of external build process, the plugin jar should be named ".jar". 'Build' | 'Prepare Plugin Module for deployment' action will automatically pack 'jps-plugin' part to a separate jar accordingly. +Sources of a plugin for External Builder should be put in a separate module. By convention such module has name '...-jps-plugin' and its sources are placed under 'jps-plugin' directory in the main plugin directory. Use \ extension to add the plugin to classpath of external build process, the plugin jar should be named \.jar. 'Build' | 'Prepare Plugin Module for deployment' action will automatically pack 'jps-plugin' part to a separate jar accordingly. ### Debugging a plugin for External Builder @@ -73,7 +73,7 @@ The build process has built-in self-cpu-profiling capabilities. To enable them d 3. Make sure automatic make is turned off -After this every build process run should result in a CPU snapshot stored in /Snapshots directory. +After this every build process run should result in a CPU snapshot stored in \/Snapshots directory. Snapshots are named like "ExternalBuild\-\{date\}.snapshot". Specifying `-Dprofiling.mode=false` will turn profiling off. diff --git a/reference_guide/project_model/library.md b/reference_guide/project_model/library.md index d1e889d99..a221a3a7d 100644 --- a/reference_guide/project_model/library.md +++ b/reference_guide/project_model/library.md @@ -7,7 +7,7 @@ IntelliJ IDEA supports three types of libraries: * **Module Library**: the library classes are visible only in this module and the library information is recorded in the module *.iml file. * **Project Library**: the library classes are visible within the project and the library information is recorded in the project *.ipr file or in .idea/libraries. -* **Global Library**: the library information is recorded in the applicationLibraries.xml file into the /.IntelliJIdea/config/options directory. Global libraries are similar to project libraries, but are visible for the different projects. +* **Global Library**: the library information is recorded in the applicationLibraries.xml file into the \/.IntelliJIdea/config/options directory. Global libraries are similar to project libraries, but are visible for the different projects. For more information about libraries, refer to [Library](http://www.jetbrains.com/idea/webhelp/library.html).