From bf29b21124ceb1e08ca8f62b1871efe45b2442c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yann=20C=C3=A9bron?= Date: Mon, 8 Apr 2024 17:04:40 +0200 Subject: [PATCH] TOC: remove "Part"/"Appendix" prefix/numbering --- ijs.tree | 26 ++++++++-------- topics/appendix/resources/explore_api.md | 2 +- .../resources/extension_point_list.md | 2 +- .../tools_gradle_intellij_plugin.md | 2 +- .../getting_started/plugin_compatibility.md | 2 +- .../plugin_structure/plugin_extensions.md | 2 +- topics/basics/plugins_quick_start.md | 4 +-- topics/intro/about.md | 30 +++++++++---------- topics/intro/content_updates.md | 14 ++++----- topics/products/dev_alternate_products.md | 10 +++---- 10 files changed, 47 insertions(+), 47 deletions(-) diff --git a/ijs.tree b/ijs.tree index 93eb160a4..58095181f 100644 --- a/ijs.tree +++ b/ijs.tree @@ -21,7 +21,7 @@ - + @@ -59,7 +59,7 @@ - + @@ -139,7 +139,7 @@ - + @@ -156,7 +156,7 @@ - + @@ -174,7 +174,7 @@ - + @@ -216,7 +216,7 @@ - + @@ -225,7 +225,7 @@ - + @@ -301,7 +301,7 @@ - + @@ -353,11 +353,11 @@ - + - + @@ -371,7 +371,7 @@ - + @@ -385,7 +385,7 @@ - + @@ -407,7 +407,7 @@ - + diff --git a/topics/appendix/resources/explore_api.md b/topics/appendix/resources/explore_api.md index 08b6a0f84..cb2131758 100644 --- a/topics/appendix/resources/explore_api.md +++ b/topics/appendix/resources/explore_api.md @@ -29,7 +29,7 @@ The most important resource for discovering new EPs is the extensive list provid On this page, you will find all the EPs, and each entry includes a link to the online source code and a link to the [IntelliJ Platform Explorer](https://jb.gg/ipe), which helps you find examples of this EP in other plugins. -Additionally, dedicated Extension Point Lists specific to IDEs are available under _Part VIII — Product Specific_. +Additionally, dedicated Extension Point Lists specific to IDEs are available under _Product Specific_. ### 1.2 Use Autocompletion Information diff --git a/topics/appendix/resources/extension_point_list.md b/topics/appendix/resources/extension_point_list.md index 7efae84fc..86525e47c 100644 --- a/topics/appendix/resources/extension_point_list.md +++ b/topics/appendix/resources/extension_point_list.md @@ -12,7 +12,7 @@ - [](#intellij-community-plugins) - [](#android-plugin) -> Dedicated Extension Point/Listener Lists specific to IDEs (e.g., [WebStorm](webstorm.md)) are available under _Part VIII — Product Specific_. +> Dedicated Extension Point/Listener Lists specific to IDEs (e.g., [WebStorm](webstorm.md)) are available under _Product Specific_. > {title="Product Specific Information"} diff --git a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md index 89ad34929..cd6aafac2 100644 --- a/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md +++ b/topics/appendix/tools/gradle_intellij_plugin/tools_gradle_intellij_plugin.md @@ -332,7 +332,7 @@ Acceptable values - `JPS` - JPS-only - `GW` - Gateway -To build against IDEs not supported directly by `type`, please see their corresponding page in _Part VIII — Product Specific_. +To build against IDEs not supported directly by `type`, please see their corresponding page in _Product Specific_. #### pluginName {#intellij-extension-pluginname} diff --git a/topics/basics/getting_started/plugin_compatibility.md b/topics/basics/getting_started/plugin_compatibility.md index 7a6031106..7aecd4ff4 100644 --- a/topics/basics/getting_started/plugin_compatibility.md +++ b/topics/basics/getting_started/plugin_compatibility.md @@ -221,7 +221,7 @@ Drill down into the JAR files to expose the packages and (decompiled) classes. If a project is dependent on a plugin or module, in some cases, the project can also [extend](plugin_extensions.md) the functionality available from the plugin or module. > See [Explore the IntelliJ Platform API](explore_api.md) for more information and strategies. -> Dedicated Extension Point Lists specific to IDEs are available under _Part VIII — Product Specific_. +> Dedicated Extension Point Lists specific to IDEs are available under _Product Specific_. > To browse the opportunities for an extension, start by placing the cursor on the contents of the [``](plugin_configuration_file.md#idea-plugin__depends) elements in the project's plugin.xml file. diff --git a/topics/basics/plugin_structure/plugin_extensions.md b/topics/basics/plugin_structure/plugin_extensions.md index ea6c18f04..f90cd2cf6 100644 --- a/topics/basics/plugin_structure/plugin_extensions.md +++ b/topics/basics/plugin_structure/plugin_extensions.md @@ -17,7 +17,7 @@ There are more than 1500 extension points available in the platform and the bund ## Exploring Available Extensions [](extension_point_list.md) lists all available extension points in IntelliJ Platform and from bundled plugins in IntelliJ IDEA. -Additionally, dedicated Extension Point and Listener Lists specific to IDEs are available under _Part VIII — Product Specific_. +Additionally, dedicated Extension Point and Listener Lists specific to IDEs are available under _Product Specific_. Browse usages inside existing implementations of open-source IntelliJ Platform plugins via [IntelliJ Platform Explorer](https://jb.gg/ipe). Alternatively (or when using 3rd party extension points), all available extension points for the specified namespace (`defaultExtensionNs`) can be listed using auto-completion inside the [``](plugin_configuration_file.md#idea-plugin__extensions) block in [plugin.xml](plugin_configuration_file.md). diff --git a/topics/basics/plugins_quick_start.md b/topics/basics/plugins_quick_start.md index b889af4e4..303eecf38 100644 --- a/topics/basics/plugins_quick_start.md +++ b/topics/basics/plugins_quick_start.md @@ -1,4 +1,4 @@ - + # Quick Start Guide @@ -17,6 +17,6 @@ It will familiarize you with the working environment, project structure, and fre * [](ide_development_instance.md) * [](faq.md) -> If you are interested in the UI theme development, please see [Part X - Themes](themes_getting_started.md). +> If you are interested in the UI theme development, please see [Themes](themes_getting_started.md). > {style="note"} diff --git a/topics/intro/about.md b/topics/intro/about.md index 12a2baed0..e0f2ab366 100644 --- a/topics/intro/about.md +++ b/topics/intro/about.md @@ -1,6 +1,6 @@ -# About This Guide + - +# About This Guide Introduction and summary overview of contents. @@ -22,63 +22,63 @@ All source links and reference lists target IntelliJ Platform %ijPlatform%. > See also [](glossary.md) for a handy reference of common terms. > -#### Part I — Plugins +#### Plugins Describes how to create a plugin that can extend the IntelliJ Platform. Includes details on how to set up the project, register extension points, target specific versions of the IntelliJ Platform, and how to package, deploy, and test your plugins. -#### Part II — Base Platform +#### Base Platform Describes the foundational layer of the architecture, which provides many features and utilities, such as the component model, the user interface, documents and editors, the virtual file system, settings, threading, and background tasks. The Base Platform layer mainly comprises the functionality of the IntelliJ Platform that does not target language features or parsing. -#### Part III — Project Model +#### Project Model Documents the Project Model, which represents the files and configuration of the currently loaded project, as well as the build system used to build the project. -#### Part IV — PSI +#### PSI The Program Structure Interface (PSI) builds the syntactic and semantic models for lots of different file types. This section describes how to work with the PSI, navigating and manipulating the syntax trees, and also looks at the powerful references system, which allows a syntax tree node to reference an item in the semantic model. It also details how PSI creates and uses indexes. -#### Part V — Features +#### Features Describes how to extend and interact with various features that use the PSI layer, such as code completion, navigation, Alt+Enter items, intentions, refactorings, and more. See also the section on Custom Languages below for language-specific features that are only applicable when adding support for a new language. -#### Part VI — Testing +#### Testing Describes the available infrastructure for writing automated tests covering the functionality of plugins. -#### Part VII — Custom Languages +#### Custom Languages Plugins frequently extend support for existing languages, such as adding inspections to Java files. This section describes how to add support to the IntelliJ Platform for a new language that isn't supported by default, creating parsers, syntactic and semantic models, and all the features that build on top. -#### Part VIII — Product Specific +#### Product Specific A lot of the functionalities in the IntelliJ Platform are language and product agnostic. For example, code inspections work the same in Java as they do in Ruby; it is just the syntax trees and semantic information that is different. This section describes product-specific features, such as specific project model differences and how to target them in a plugin. -#### Part IX — Custom IDEs +#### Custom IDEs Documents how to use the IntelliJ Platform to create a new, custom IDE, rather than plugins to an existing product, e.g., WebStorm, or Android Studio. -#### Part X — Themes +#### Themes Describes how to create a theme for IntelliJ Platform-based IDEs. Includes details on how to set up the theme project, customize, build, and publish it on JetBrains Marketplace. -#### Appendix I — Resources +#### Resources Links to [useful resources](useful_links.md), a [](glossary.md), [](extension_point_list.md), tips on how to [](explore_api.md) and [](learning_resources.md). -#### Appendix II — API and Compatibility +#### API and Compatibility Information on [](verifying_plugin_compatibility.md) and list of [backwards-incompatible](api_changes_list.md) API changes as well as [notable changes and new features](api_notable.md) in each major release of the IntelliJ Platform. -#### Appendix III — Tooling +#### Tooling Reference and usage guides for commonly used tools like the [](tools_gradle_intellij_plugin.md). diff --git a/topics/intro/content_updates.md b/topics/intro/content_updates.md index 4030b80fc..fc2f79390 100644 --- a/topics/intro/content_updates.md +++ b/topics/intro/content_updates.md @@ -165,7 +165,7 @@ Minor Changes and Additions ### September {#september-22} -Extract Part X — Themes +Extract "Themes" part : All the content related to [themes customization](theme_structure.md) and creating a project using the [DevKit approach](developing_themes.md) has been moved to a new [_Themes_](themes_getting_started.md) part. Content has been refreshed to match the current state of the project and SDK wizards. @@ -209,7 +209,7 @@ Postfix Completion : Add [](postfix_completion.md) section explaining how to implement generating or wrapping the existing code into additional constructs without navigating the caret back. Gradle IntelliJ Plugin -: Add [](tools_gradle_intellij_plugin.md) documentation to _Appendix III — Tooling_. +: Add [](tools_gradle_intellij_plugin.md) documentation to _Tooling_. Bundling Plugin API Sources : Add the [](bundling_plugin_openapi_sources.md) section explaining how to expose plugin API sources to dependent plugin developers. @@ -219,7 +219,7 @@ Minor Changes and Additions - Add a small section to [](php_open_api.md#utility-classes) describing `PhpFilePathUtils` utility class. - Add mention of the way to programmatically open an autocomplete popup to [](code_completion.md). - Add a small section to [](icons.md#animated-icons) describing animated icons. -- Moved [](tools_gradle_grammar_kit_plugin.md) documentation to _Appendix III — Tooling_ +- Moved [](tools_gradle_grammar_kit_plugin.md) documentation to _Tooling_. ### May {#may-22} @@ -303,7 +303,7 @@ IDE Infrastructure : [](ide_infrastructure.md) handles Logging, Error Reporting, Runtime Information, and how to provide Context Help. Extension Point Lists: Listeners, Deprecation status -: [](extension_point_list.md) now contains sections listing all provided [Listener](plugin_listeners.md) Topics. See also corresponding Extension Point Lists under _Part VIII — Product Specific_. Also, all deprecated API now has a dedicated tag. +: [](extension_point_list.md) now contains sections listing all provided [Listener](plugin_listeners.md) Topics. See also corresponding Extension Point Lists under _Product Specific_. Also, all deprecated API now has a dedicated tag. ### July {#july-21} @@ -324,7 +324,7 @@ Documentation Provider {#may-21} IDE specific Extension Point Lists -: See _Part VIII — Product Specific_. +: See _Product Specific_. New Guide - Explore the IntelliJ Platform API : Add a new section [](explore_api.md) that describes how plugin authors work with the IntelliJ Platform API and what tools they use. @@ -404,7 +404,7 @@ Custom Language Support Tutorial converted to Gradle : The [corresponding tutorial](custom_language_support_tutorial.md) and [Testing a Custom Language Plugin](writing_tests_for_plugins.md) have been updated and enhanced as well. Targeting specific IDEs -: [Part VIII — Product Specific](plugin_compatibility.md) has been expanded massively, now also covering each IDE with its dedicated page. +: [Product Specific](plugin_compatibility.md) has been expanded massively, now also covering each IDE with its dedicated page. ## 2019 @@ -420,7 +420,7 @@ Plugin Components migration ### October {#october-19} -Part X — Plugin Repository moved +Plugin Repository moved : All contents have been moved to [JetBrains Marketplace Documentation](https://plugins.jetbrains.com/docs/marketplace/). ### July diff --git a/topics/products/dev_alternate_products.md b/topics/products/dev_alternate_products.md index 57b1ee16d..c0fa1eae3 100644 --- a/topics/products/dev_alternate_products.md +++ b/topics/products/dev_alternate_products.md @@ -8,7 +8,7 @@ Plugin projects can target any (custom) IDEs, as long as the products are based Such plugins are developed much like plugin projects that target IntelliJ IDEA. Project configuration attributes common to projects targeting products other than IntelliJ IDEA are described on this page. -Details particular to an IntelliJ Platform-based product are described on the individual product pages in _Part VIII — Product Specific_. +Details particular to an IntelliJ Platform-based product are described on the individual product pages in _Product Specific_. All the Gradle configuration attributes described here are discussed in-depth on the [](configuring_plugin_project.md) and the [](tools_gradle_intellij_plugin.md). @@ -19,7 +19,7 @@ All the Gradle configuration attributes described here are discussed in-depth on To create a new Gradle plugin project, follow the tutorial on the [](creating_plugin_project.md) page. The tutorial produces a skeleton Gradle project suitable to use as a starting point. -Modifications are needed to the skeleton project's Gradle build script and [plugin.xml](plugin_configuration_file.md) files, as described below, and on the individual product pages in _Part VIII — Product Specific_. +Modifications are needed to the skeleton project's Gradle build script and [plugin.xml](plugin_configuration_file.md) files, as described below, and on the individual product pages in _Product Specific_. The Gradle build script is modified to specify the target product, determining the APIs available during development. The plugin.xml file is modified to declare the plugin's dependencies on modules or libraries. @@ -91,7 +91,7 @@ For API compatibility, the IntelliJ Platform version used in the _targetIDE_ dic #### Matching Versions of the IntelliJ Platform with the Target IDE Version The _baseIntelliJPlatformVersion_ used in the _targetIDE_ may not be readily apparent, depending on the product. -See the individual product pages in _Part VIII — Product Specific_ for exceptions. +See the individual product pages in _Product Specific_ for exceptions. To find the version of the IntelliJ Platform used to build the _targetIDE_, use the About dialog screen for the _targetIDE_. Next to Build # is the *BRANCH.BUILD.FIX* version of the _targetIDE_. @@ -100,7 +100,7 @@ The version of the IntelliJ Platform used to build this product version is *BRAN ![Example PhpStorm Splash Screen](phpstorm_build.png){width="500"} -If the product version isn't clear on the About screen, consult the individual product pages in _Part VIII — Product Specific_. +If the product version isn't clear on the About screen, consult the individual product pages in _Product Specific_. The [Other IntelliJ IDEA Versions](https://www.jetbrains.com/idea/download/other.html) page is a way to find build numbers for every product version. Additional ways include hovering over the version number for a product in [Toolbox App](https://www.jetbrains.com/toolbox-app/) or examining the About screen for IntelliJ IDEA Community. @@ -123,7 +123,7 @@ The [`intellij.version`](tools_gradle_intellij_plugin.md#intellij-extension-vers Any [dependencies](configuring_plugin_project.md#plugin-dependencies) on _targetIDE_-specific plugins or modules must be declared in the [`intellij`](tools_gradle_intellij_plugin.md#configuration-intellij-extension) extension. Use the Gradle plugin attribute [`intellij.plugins`](tools_gradle_intellij_plugin.md#intellij-extension-plugins) to declare a dependency. -See the specific product pages in _Part VIII — Product Specific_ for the _targetIDE_ plugin or module name. +See the specific product pages in _Product Specific_ for the _targetIDE_ plugin or module name. The best practice is to modify the [`runIde`](tools_gradle_intellij_plugin.md#tasks-runide) task to use a local installation of _targetIDE_ as the [](ide_development_instance.md). Set the [`runIde.ideDir`](tools_gradle_intellij_plugin.md#tasks-runide-idedir) attribute to the (user-specific) absolute path of the _targetIDE_ application.