From f95a7feb75a00f583d0b6b3db438d99f84e25b35 Mon Sep 17 00:00:00 2001 From: JohnHake Date: Tue, 21 Jul 2020 12:34:10 -0700 Subject: [PATCH] [products] PR#306 Clarify attribute settings in tables --- products/app_code.md | 3 ++- products/clion.md | 3 ++- products/data_grip.md | 4 +++- products/goland.md | 4 +++- products/phpstorm/phpstorm.md | 4 ++++ products/pycharm.md | 3 ++- products/rubymine.md | 4 +++- products/webstorm.md | 6 ++++-- 8 files changed, 23 insertions(+), 8 deletions(-) diff --git a/products/app_code.md b/products/app_code.md index f8bea9dc0..5bf4609d7 100644 --- a/products/app_code.md +++ b/products/app_code.md @@ -12,7 +12,8 @@ Instead, configure AppCode plugin projects to use the `intellij.localPath` attri > **Note** AppCode plugin development requires installing AppCode locally. -The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file: +The table below summarizes the `gradle-intellij-plugin` attributes to set in the plugin project's `build.gradle` file. +Click on an entry in the table's *Attribute* column to go to the documentation about that attribute. | `gradle-intellij-plugin` Attribute | Attribute Value | |-----------|-------| diff --git a/products/clion.md b/products/clion.md index 2b21fd114..78fef7e29 100644 --- a/products/clion.md +++ b/products/clion.md @@ -10,7 +10,8 @@ Plugin projects for CLion can be developed using IntelliJ IDEA with the `gradle- ## Configuring Plugin Projects Targeting CLion The configuration of CLion plugin projects follows the methods described in [Configuring Plugin Projects using a Product-Specific Attribute](dev_alternate_products.md#configuring-plugin-projects-using-a-product-specific-attribute), and [Configuring the plugin.xml File](dev_alternate_products.md#configuring-pluginxml). -The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file for a CLion plugin project: +The table below summarizes the `gradle-intellij-plugin` attributes to set in the plugin project's `build.gradle` file. +Click on an entry in the table's *Attribute* column to go to the documentation about that attribute. | `gradle-intellij-plugin` Attribute | Attribute Value | |-----------|-------| diff --git a/products/data_grip.md b/products/data_grip.md index e7260f35d..661003873 100644 --- a/products/data_grip.md +++ b/products/data_grip.md @@ -12,7 +12,9 @@ The configuration of DataGrip plugin projects follows the methods described in [ > **Note** DataGrip plugin development may require setting an additional Gradle attribute: `runIde.jvmArgs`. See table below. -The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file: +The table below summarizes the `gradle-intellij-plugin` attributes to set in the plugin project's `build.gradle` file. +Click on an entry in the table's *Attribute* column to go to the documentation about that attribute. +To see how these attributes appear in a similar `build.gradle` file for PhpStorm, see [Configuring build.gradle using the IntelliJ IDEA Product Attribute](/products/dev_alternate_products.md#configuring-buildgradle-using-the-intellij-idea-product-attribute). | `gradle-intellij-plugin` Attribute | Attribute Value | |-----------|-------| diff --git a/products/goland.md b/products/goland.md index e32df711a..1005344cb 100644 --- a/products/goland.md +++ b/products/goland.md @@ -10,7 +10,9 @@ Plugin projects for GoLand can be developed using IntelliJ IDEA with the `gradle ## Configuring Plugin Projects Targeting GoLand The configuration of GoLand plugin projects follows the methods described in [Configuring Plugin Projects using the IntelliJ IDEA Product Attribute](dev_alternate_products.md#configuring-plugin-projects-using-the-intellij-idea-product-attribute), and [Configuring the plugin.xml File](dev_alternate_products.md#configuring-pluginxml). -The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file for a GoLand plugin project: +The table below summarizes the `gradle-intellij-plugin` attributes to set in the plugin project's `build.gradle` file. +Click on an entry in the table's *Attribute* column to go to the documentation about that attribute. +To see how these attributes appear in a similar `build.gradle` file for PhpStorm, see [Configuring build.gradle using the IntelliJ IDEA Product Attribute](/products/dev_alternate_products.md#configuring-buildgradle-using-the-intellij-idea-product-attribute). | `gradle-intellij-plugin` Attribute | Attribute Value | |-----------|-------| diff --git a/products/phpstorm/phpstorm.md b/products/phpstorm/phpstorm.md index f10600110..52988a2c1 100644 --- a/products/phpstorm/phpstorm.md +++ b/products/phpstorm/phpstorm.md @@ -28,6 +28,10 @@ Configuration of a Gradle-based PhpStorm plugin project is used as a tutorial in Many techniques are discussed, such as choosing a version of IntelliJ IDEA Ultimate given a targeted version of PhpStorm. The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file for a PhpStorm plugin project: +The table below summarizes the `gradle-intellij-plugin` attributes to set in the plugin project's `build.gradle` file. +Click on an entry in the table's *Attribute* column to go to the documentation about that attribute. +To see how these attributes appear in the `build.gradle` file for PhpStorm, see [Configuring build.gradle using the IntelliJ IDEA Product Attribute](/products/dev_alternate_products.md#configuring-buildgradle-using-the-intellij-idea-product-attribute). + | `gradle-intellij-plugin` Attribute |
Attribute Value | |-----------|-------| | [`intellij.type`](https://github.com/JetBrains/gradle-intellij-plugin/blob/master/README.md#intellij-platform-properties) | `IU` for IntelliJ IDEA Ultimate. (The required PHP plugin isn't compatible with IntelliJ IDEA Community Edition.) | diff --git a/products/pycharm.md b/products/pycharm.md index c3ddef148..0ac90dcbb 100644 --- a/products/pycharm.md +++ b/products/pycharm.md @@ -9,7 +9,8 @@ Plugin projects for PyCharm can be developed using IntelliJ IDEA with the `gradl ## Configuring Plugin Projects Targeting PyCharm The configuration of PyCharm plugin projects follows the methods described in [Configuring Plugin Projects using a Product-Specific Attribute](dev_alternate_products.md#configuring-plugin-projects-using-a-product-specific-attribute), and [Configuring the plugin.xml File](dev_alternate_products.md#configuring-pluginxml). -The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file: +The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file. +Click on an entry in the table's *Attribute* column to go to the documentation about that attribute. | `gradle-intellij-plugin` Attribute | Attribute Value | |-----------|-------| diff --git a/products/rubymine.md b/products/rubymine.md index b9c035f51..7022335b7 100644 --- a/products/rubymine.md +++ b/products/rubymine.md @@ -10,7 +10,9 @@ Plugin projects for RubyMine can be developed using IntelliJ IDEA with the `grad ## Configuring Plugin Projects Targeting RubyMine The configuration of RubyMine plugin projects follows the methods described in [Configuring Plugin Projects using the IntelliJ IDEA Product Attribute](dev_alternate_products.md#configuring-plugin-projects-using-the-intellij-idea-product-attribute), and [Configuring the plugin.xml File](dev_alternate_products.md#configuring-pluginxml). -The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file for a RubyMine plugin project: +The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file for a RubyMine plugin project. +Click on an entry in the table's *Attribute* column to go to the documentation about that attribute. +To see how these attributes appear in a similar `build.gradle` file for PhpStorm, see [Configuring build.gradle using the IntelliJ IDEA Product Attribute](/products/dev_alternate_products.md#configuring-buildgradle-using-the-intellij-idea-product-attribute). | `gradle-intellij-plugin` Attribute | Attribute Value | |-----------|-------| diff --git a/products/webstorm.md b/products/webstorm.md index c186d9e87..9b6483696 100644 --- a/products/webstorm.md +++ b/products/webstorm.md @@ -8,9 +8,11 @@ title: WebStorm Plugin Development Plugin projects for WebStorm can be developed using IntelliJ IDEA with the `gradle-intellij-plugin`. ## Configuring Plugin Projects Targeting WebStorm -The configuration of WebStorm plugin projects follows the methods described in [Configuring Plugin Projects using the IntelliJ IDEA Product Attribute](dev_alternate_products.md#configuring-plugin-projects-using-the-intellij-idea-product-attribute), and [Configuring the plugin.xml File](dev_alternate_products.md#configuring-pluginxml). +The configuration of WebStorm plugin projects follows the methods described in [Configuring Plugin Projects using the IntelliJ IDEA Product Attribute](dev_alternate_products.md#configuring-plugin-projects-using-the-intellij-idea-product-attribute) and [Configuring the plugin.xml File](dev_alternate_products.md#configuring-pluginxml) for PhpStorm. -The table below summarizes the `gradle-intellij-plugin` attributes to set in the `build.gradle` file: +The table below summarizes the `gradle-intellij-plugin` attributes to set in the plugin project's `build.gradle` file. +Click on an entry in the table's *Attribute* column to go to the documentation about that attribute. +To see how these attributes appear in a similar `build.gradle` file for PhpStorm, see [Configuring build.gradle using the IntelliJ IDEA Product Attribute](/products/dev_alternate_products.md#configuring-buildgradle-using-the-intellij-idea-product-attribute). | `gradle-intellij-plugin` Attribute | Attribute Value | |-----------|-------|