Skip to content

Commit

Permalink
Replace "IntelliJ IDEA" with "IntelliJ Platform" where appropriate an…
Browse files Browse the repository at this point in the history
…d other minor changes
  • Loading branch information
breandan committed Nov 30, 2015
1 parent 4600783 commit da6f83a
Show file tree
Hide file tree
Showing 43 changed files with 102 additions and 102 deletions.
2 changes: 1 addition & 1 deletion basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Quick Start Guide
This section covers the basics of working with *IntelliJ Platform*.
It will familiarize you with the working environment, project structure, and frequently used API components.

* [Main Types of IntelliJ IDEA Plugins](basics/types_of_plugins.md)
* [Main Types of IntelliJ Platform Plugins](basics/types_of_plugins.md)
* [Getting Started](basics/getting_started.md)
* [Architectural Overview](basics/architectural_overview.md)
* [Project Structure](basics/project_structure.md)
Expand Down
2 changes: 1 addition & 1 deletion basics/architectural_overview/psi_elements.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: PSI Elements

A PSI (Program Structure Interface) file represents a hierarchy of PSI elements (so-called _PSI trees_). A single PSI file may include several PSI trees in a particular programming language. A PSI element, in its turn, can have child PSI elements.

PSI elements and operations on the level of individual PSI elements are used to explore the internal structure of source code as it is interpreted by **IntelliJ IDEA**. For example, you can use PSI elements to perform code analysis, such as [code inspections](http://www.jetbrains.com/idea/help/code-inspection.html) or [intention actions](http://www.jetbrains.com/idea/help/intention-actions.html).
PSI elements and operations on the level of individual PSI elements are used to explore the internal structure of source code as it is interpreted by the **IntelliJ Platform**. For example, you can use PSI elements to perform code analysis, such as [code inspections](http://www.jetbrains.com/idea/help/code-inspection.html) or [intention actions](http://www.jetbrains.com/idea/help/intention-actions.html).

The [PsiElement](upsource:///platform/core-api/src/com/intellij/psi/PsiElement.java) class is the common base class for PSI elements.

Expand Down
4 changes: 2 additions & 2 deletions basics/architectural_overview/virtual_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Virtual Files
---

A virtual file [com.intellij.openapi.vfs.VirtualFile](upsource:///platform/core-api/src/com/intellij/openapi/vfs/VirtualFile.java) is *IntelliJ IDEA's* representation of a file in a file system (VFS). Most commonly, a virtual file is a file in your local file system. However, *IntelliJ IDEA* supports multiple pluggable file system implementations, so virtual files can also represent classes in a JAR file, old revisions of files loaded from a version control repository, and so on.
A virtual file [com.intellij.openapi.vfs.VirtualFile](upsource:///platform/core-api/src/com/intellij/openapi/vfs/VirtualFile.java) is the *IntelliJ Platform's* representation of a file in a file system (VFS). Most commonly, a virtual file is a file in your local file system. However, the *IntelliJ Platform* supports multiple pluggable file system implementations, so virtual files can also represent classes in a JAR file, old revisions of files loaded from a version control repository, and so on.

The VFS level deals only with binary content. You can get or set the contents of a `VirtualFile` as a stream of bytes, but concepts like encodings and line separators are handled on higher system levels.

Expand All @@ -21,7 +21,7 @@ Typical file operations are available, such as traverse the file system, get fil

The VFS is built incrementally, by scanning the file system up and down starting from the project root. New files appearing in the file system are detected by VFS _refreshes_. A refresh operation can be initiated programmatically using (`VirtualFileManager.getInstance().refresh()` or `VirtualFile.refresh()`). VFS refreshes are also triggered whenever file system watchers receive file system change notifications (available on the Windows and Mac operating systems).

As a plugin developer, you may want to invoke a VFS refresh if you need to access a file that has just been created by an external tool through IntelliJ IDEA APIs.
As a plugin developer, you may want to invoke a VFS refresh if you need to access a file that has just been created by an external tool through the IntelliJ Platform APIs.

## How long does a virtual file persist?

Expand Down
6 changes: 3 additions & 3 deletions basics/checkout_and_build_community.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ You can also browse the source code through the Web interface.

## Forking on GitHub

As an alternative to checking out the official repository, you can fork the GitHub mirror of the IntelliJ IDEA source code, make changes in your own fork, and send us a pull request.
As an alternative to checking out the official repository, you can fork the GitHub mirror of the IntelliJ Platform source code, make changes in your own fork, and send us a pull request.

The GitHub mirror can be found at [https://github.com/JetBrains/intellij-community](https://github.com/JetBrains/intellij-community).

## Building and Running from the IDE

To develop IntelliJ IDEA, you can use either [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/) or [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/download/).
To develop plugins and applications on the IntelliJ Platform, you can use either [IntelliJ IDEA Community Edition](https://www.jetbrains.com/idea/download/) or [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/download/).

**Building and running the code**

Expand All @@ -61,7 +61,7 @@ To develop IntelliJ IDEA, you can use either [IntelliJ IDEA Community Edition](h

Parts of IntelliJ IDEA are written in Groovy, and you will get compilation errors if you don't have the plugin enabled.

* Make sure you have the UI Designer plugin enabled. Most of IntelliJ IDEA's UI is built using the UI Designer, and the version you build will not run correctly if you don't have the plugin enabled.
* Make sure you have the UI Designer plugin enabled. Most of the IntelliJ IDEA platform UI is built using the UI Designer, and the version you build will not run correctly if you don't have the plugin enabled.

![UI Designer plugin](img/ui_designer_plugin_enabled.png)

Expand Down
16 changes: 8 additions & 8 deletions basics/getting_started/creating_an_action.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
title: Creating an action
---

Your plugins can customize the Intellij IDEA UI by adding new items to the menus and toolbars. Intellij IDEA provides the [AnAction.java](upsource:///platform/editor-ui-api/src/com/intellij/openapi/actionSystem/AnAction.java) class whose `actionPerformed` method is called each time you select a menu item or click a toolbar button.
Your plugins can customize the IntelliJ Platform UI by adding new items to the menus and toolbars. The IntelliJ Platform provides the class [AnAction.java](upsource:///platform/editor-ui-api/src/com/intellij/openapi/actionSystem/AnAction.java) whose `actionPerformed` method is called each time you select a menu item or click a toolbar button.

To customize *IntelliJ IDEA*, you should perform two basic steps:
To create custom actions in the *IntelliJ Platform*, you should perform two basic steps:

1. In your plugin, define an action or a system of actions that add their own items to menus and toolbars.
2. Register your actions.

This topic outlines the above steps. For detailed information and samples, refer to [IntelliJ IDEA Action System](/basics/action_system.md).
This topic outlines the above steps. For detailed information and samples, refer to [IntelliJ Platform Action System](/basics/action_system.md).

### Defining actions

Expand Down Expand Up @@ -46,7 +46,7 @@ Once you have defined an action or a system of actions, you must register them t
* Register actions in the `<actions>` section of the `plugin.xml` file.
* Register actions from Java code.

This section provides some examples that illustrate how to register actions. For more information, refer to [IntelliJ IDEA Action System](/basics/action_system.md).
This section provides some examples that illustrate how to register actions. For more information, refer to [IntelliJ Platform Action System](/basics/action_system.md).

#### Registering actions in the plugin.xml file

Expand All @@ -64,15 +64,15 @@ To register your actions, make appropriate changes to the `<actions>` section of
</actions>
```

This fragment of the plugin.xml file demonstrates only some elements you can use in the `<actions>` section to register your actions. For information about all elements designed to register your actions, refer to [IntelliJ IDEA Action System](/basics/action_system.md).
This fragment of the plugin.xml file demonstrates only some elements you can use in the `<actions>` section to register your actions. For information about all elements designed to register your actions, refer to [IntelliJ Platform Action System](/basics/action_system.md).

#### Registering actions from Java code

Alternatively, you can register your actions from Java code. For more information and samples that illustrate how to register actions from Java code, see [IntelliJ IDEA Action System](/basics/action_system.md).
Alternatively, you can register your actions from Java code. For more information and samples that illustrate how to register actions from Java code, see [IntelliJ Platform Action System](/basics/action_system.md).

### Quick creation of actions

IntelliJ IDEA provides the New Action wizard that suggests a simplified way of creating actions, with all the required infrastructure. The wizard helps you declare the action class and automatically makes appropriate changes to the `<actions>` section of the plugin.xml file.
The IntelliJ Platform provides the **New Action** wizard that suggests a simplified way of creating actions, with all the required infrastructure. The wizard helps you declare the action class and automatically makes appropriate changes to the `<actions>` section of the plugin.xml file.

Note that you can use this wizard only to add a new action to an existing action group on the main menu or toolbar. If you want to create a new action group, and then add an action to this group, follow instructions earlier in this document.

Expand All @@ -94,4 +94,4 @@ Note that you can use this wizard only to add a new action to an existing action

![New Action Page](img/new_action_page.png)

IntelliJ IDEA generates a `.java` file with the specified class name, registers the newly created action in the plugin.xml file, adds a node to the module tree view, and opens the created action class file in the editor.
The IntelliJ Platform generates a `.java` file with the specified class name, registers the newly created action in the plugin.xml file, adds a node to the module tree view, and opens the created action class file in the editor.
4 changes: 2 additions & 2 deletions basics/getting_started/creating_plugin_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: Creating a Plugin Project
---

This section explains how you can create a new plugin project from scratch using the New Project wizard. Optionally, you can import an existing project or import a project from external models. You can also add a new plugin module to an existing *Intellij IDEA* project.
For more information, refer to the [Intellij IDEA Web Help](https://www.jetbrains.com/idea/help/new-project-wizard.html).
This section explains how you can create a new plugin project from scratch using the New Project wizard. Optionally, you can import an existing project or import a project from external models. You can also add a new plugin module to an existing *IntelliJ Platform* project.
For more information, refer to the [IntelliJ IDEA Web Help](https://www.jetbrains.com/idea/help/new-project-wizard.html).

## To create a plugin project:

Expand Down
4 changes: 2 additions & 2 deletions basics/getting_started/deploying_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ To deploy a plugin:

![Jar Saved Notification](deploying_plugin/img/jar_saved_notification.png)

* Copy the newly created archive file to the `.IntelliJIDEAx0\config\plugins` folder, and then restart IntelliJ IDEA so the changes take effect. To know how to locate your *plugins* directory, refer to [IDE Settings, Caches, Logs, and Plugins](/basics/settings_caches_logs.md).
* Copy the newly created archive file to the `.IntelliJIDEAx0\config\plugins` folder, and then restart your IDE so the changes may take effect. To know how to locate your *plugins* directory, refer to [IDE Settings, Caches, Logs, and Plugins](/basics/settings_caches_logs.md).

![Jar File Location](deploying_plugin/img/jar_location.png)

* In the main menu, select **File \| Settings** to open the Settings dialog box.
* In the Settings dialog box, under **IDE Settings**, click **Plugins**.
* In the Plugins area, open the **Installed** tab, and then select the check-box next to your plugin name.
* When finished, click OK to close the Settings dialog box.
* Restart *IntelliJ IDEA* so that your changes take effect.
* Restart the IDE so that your changes take effect.
2 changes: 1 addition & 1 deletion basics/getting_started/running_and_debugging_a_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Running and Debugging a Plugin

The *IntelliJ Platform* allows you to run and debug a plugin without leaving the IDE. To run or debug the plugin from within *IntelliJ IDEA*, you need a configured special profile (a Run/Debug configuration) that specifies the class to run, VM parameters and other specific options. In most cases, you can use the default *Run/Debug* configuration profiles for your plugin projects.

For information on how to change the Run/Debug configuration profile, refer to [Run/Debug Configuration](http://www.jetbrains.com/idea/help/run-debug-configuration.html) and [Run/Debug Configuration: Plugin](http://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](http://www.jetbrains.com/idea/help/run-debug-configuration.html) and [Run/Debug Configuration: Plugin](http://www.jetbrains.com/idea/help/run-debug-configuration-plugin.html) in *IntelliJ IDEA* Web Help.

Using *IntelliJ IDEA*'s debugger, you can find out the origin of the run-time errors and exceptions.

Expand Down
4 changes: 2 additions & 2 deletions basics/plugin_structure/plugin_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
title: Plugin Actions
---

*Intellij IDEA* provides the concept of _actions_. An action is a class, derived from the [`AnAction`](upsource:///platform/editor-ui-api/src/com/intellij/openapi/actionSystem/AnAction.java) class, whose `actionPerformed` method is called when the menu item or toolbar button is selected.
The *Intellij Platform* provides the concept of _actions_. An action is a class, derived from the [`AnAction`](upsource:///platform/editor-ui-api/src/com/intellij/openapi/actionSystem/AnAction.java) class, whose `actionPerformed` method is called when the menu item or toolbar button is selected.

The system of actions allows plugins to add their own items to IDEA menus and toolbars. Actions are organized into groups, which, in turn, can contain other groups. A group of actions can form a toolbar or a menu. Subgroups of the group can form submenus of a menu. You can find detailed information on how to create and register your actions in [IntelliJ IDEA Action System](/basics/action_system.md).
The system of actions allows plugins to add their own items to IDEA menus and toolbars. Actions are organized into groups, which, in turn, can contain other groups. A group of actions can form a toolbar or a menu. Subgroups of the group can form submenus of a menu. You can find detailed information on how to create and register your actions in the [IntelliJ Platform Action System](/basics/action_system.md).
Loading

0 comments on commit da6f83a

Please sign in to comment.