hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

"Part n": use dash symbol

Browse Source
This commit is contained in:
Yann Cébron 2022-02-08 14:39:39 +01:00
parent 6b1cdfee8d
commit 925cafad36
9 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
ijs.tree
View File

@ -20,7 +20,7 @@
<toc-element id="getting_help.md"/>
<toc-element id="content_updates.md" accepts-web-file-names="recently_updated.html"/>
</toc-element>
<toc-element toc-title="Part I - Plugins">
<toc-element toc-title="Part I — Plugins">
<toc-element id="basics.md">
<toc-element id="types_of_plugins.md"/>
</toc-element>
@ -71,7 +71,7 @@
<toc-element id="performance.md"/>
<toc-element id="faq.md"/>
</toc-element>
<toc-element toc-title="Part II - Base Platform">
<toc-element toc-title="Part II — Base Platform">
<toc-element id="fundamentals.md" accepts-web-file-names="reference_guide.html,architectural_overview.html">
<toc-element toc-title="Component Model"/>
<toc-element id="disposers.md"/>
@ -146,7 +146,7 @@
<toc-element id="localization_guide.md"/>
<toc-element toc-title="Diagrams"/>
</toc-element>
<toc-element toc-title="Part III - Project Model">
<toc-element toc-title="Part III — Project Model">
<toc-element id="project_structure.md" toc-title="Introduction"/>
<toc-element id="project.md">
<toc-element id="trusted_projects.md"/>
@ -163,7 +163,7 @@
<toc-element id="facet.md"/>
<toc-element id="external_system_integration.md"/>
</toc-element>
<toc-element toc-title="Part IV - PSI">
<toc-element toc-title="Part IV — PSI">
<toc-element id="psi.md" toc-title="What Is the PSI?"/>
<toc-element id="psi_files.md"/>
<toc-element id="file_view_providers.md"/>
@ -180,7 +180,7 @@
<toc-element id="uast.md" toc-title="Unified AST"/>
<toc-element id="xml_dom_api.md"/>
</toc-element>
<toc-element toc-title="Part V - Features">
<toc-element toc-title="Part V — Features">
<toc-element toc-title="Navigation"/>
<toc-element id="editing.md">
<toc-element toc-title="Code Completion"/>
@ -215,7 +215,7 @@
<toc-element id="external_builder_api.md"/>
</toc-element>
</toc-element>
<toc-element toc-title="Part VI - Testing">
<toc-element toc-title="Part VI — Testing">
<toc-element id="testing_plugins.md" accepts-web-file-names="testing_plugins.html"/>
<toc-element id="tests_and_fixtures.md"/>
<toc-element id="light_and_heavy_tests.md"/>
@ -224,7 +224,7 @@
<toc-element id="testing_highlighting.md"/>
<toc-element id="testing_faq.md"/>
</toc-element>
<toc-element toc-title="Part VII - Custom Languages">
<toc-element toc-title="Part VII — Custom Languages">
<toc-element id="custom_language_support.md">
<toc-element id="registering_file_type.md"/>
<toc-element id="implementing_lexer.md"/>
@ -287,7 +287,7 @@
<toc-element toc-title="Compiler"/>
<toc-element toc-title="Debugger"/>
</toc-element>
<toc-element toc-title="Part VIII - Product Specific">
<toc-element toc-title="Part VIII — Product Specific">
<toc-element id="build_number_ranges.md"/>
<toc-element id="dev_alternate_products.md" toc-title="Developing for Multiple Products"/>
<toc-element id="plugin_compatibility.md" toc-title="Compatibility with Multiple Products"/>
@ -334,16 +334,16 @@
<toc-element id="webstorm_extension_point_list.md"/>
</toc-element>
</toc-element>
<toc-element toc-title="Part IX - Custom IDEs">
<toc-element toc-title="Part IX — Custom IDEs">
<toc-element toc-title="Build Your Own IDE"/>
<toc-element toc-title="Licensing"/>
</toc-element>
<toc-element toc-title="Part X - Plugin Repository [moved]">
<toc-element toc-title="Part X — Plugin Repository [moved]">
<toc-element id="plugin_repository_obsolete.md"
accepts-web-file-names="api_reference.html,feature_extractor.html,plugin_details.html,custom_channels.html,plugins_list.html,maven_interface.html,plugin_upload.html,plugin_developers.html"
toc-title="Overview"/>
</toc-element>
<toc-element toc-title="Appendix I - Resources">
<toc-element toc-title="Appendix I — Resources">
<toc-element id="glossary.md"/>
<toc-element id="explore_api.md" toc-title="Explore the API"/>
<toc-element id="extension_point_list.md"/>
@ -351,7 +351,7 @@
<toc-element id="marketing.md"/>
<toc-element id="consulting.md"/>
</toc-element>
<toc-element toc-title="Appendix II - API Changes">
<toc-element toc-title="Appendix II — API Changes">
<toc-element id="api_changes_list.md" toc-title="Incompatible API Changes">
<toc-element id="api_changes_list_2022.md" toc-title="2022.*"/>
<toc-element id="api_changes_list_2021.md" toc-title="2021.*"/>

2
topics/appendix/plugin_repository_obsolete.md
View File

@ -4,7 +4,7 @@
JetBrains provides an official plugins repository [JetBrains Marketplace](https://plugins.jetbrains.com) for all IntelliJ Platform-based IDEs, as well as other products.
> **Part X - Plugin Repository** pages have moved to [JetBrains Marketplace](https://plugins.jetbrains.com/docs/marketplace/about-marketplace.html) documentation, please update your bookmarks.
> **Part X — Plugin Repository** pages have moved to [JetBrains Marketplace](https://plugins.jetbrains.com/docs/marketplace/about-marketplace.html) documentation, please update your bookmarks.
>
{type="warning"}

2
topics/appendix/resources/explore_api.md
View File

@ -23,7 +23,7 @@ The most important resource for discovering new EPs is the extensive list provid
On this page, you will find all of 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 _Part VIII — Product Specific_.
### 1.2 Use Autocompletion Information

2
topics/appendix/resources/extension_point_list.md
View File

@ -8,7 +8,7 @@
- [IntelliJ Community Plugins](#intellij-community-plugins)
- [Android Plugin](#android-plugin)
> Dedicated Extension Point Lists specific to IDEs are available under _Part VIII - Product Specific_.
> Dedicated Extension Point/Listener Lists specific to IDEs are available under _Part VIII — Product Specific_.
>
> See also [Explore the IntelliJ Platform API](explore_api.md) for more information and strategies.
>

2
topics/basics/getting_started/plugin_compatibility.md
View File

@ -143,7 +143,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 _Part VIII — Product Specific_.
>
{type="tip"}

2
topics/basics/plugin_structure/plugin_extensions.md
View File

@ -18,7 +18,7 @@ There are more than 1000 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 Lists specific to IDEs are available under _Part VIII - Product Specific_.
Additionally, dedicated Extension Point Lists specific to IDEs are available under _Part VIII — 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 `<extensions>` block in <path>plugin.xml</path>.

24
topics/intro/about.md
View File

@ -19,58 +19,58 @@ The [Key Topics](key_topics.md) page aims to link to the pages that are necessar
>
{type="tip"}
#### Part I - Plugins
#### Part I — 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
#### Part II — 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
#### Part III — 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
#### Part IV — PSI
The Program Structure Interface 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
#### Part V — Features
Describes how to extend and interact with various features that use the PSI layer, such as code completion, navigation, <shortcut>Alt+Enter</shortcut> 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
#### Part VI — Testing
Describes the available infrastructure for writing automated tests covering the functionality of plugins.
#### Part VII - Custom Languages
#### Part VII — 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
#### Part VIII — Product Specific
A lot of the functionality in the IntelliJ Platform is 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
#### Part IX — 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 - Plugin Repository
#### Part X — Plugin Repository
This part has been moved to [JetBrains Marketplace documentation](https://plugins.jetbrains.com/docs/marketplace/about-marketplace.html).
#### Appendix I - Resources
#### Appendix I — Resources
Links to [useful resources](useful_links.md), [Glossary](glossary.md), [](extension_point_list.md), and tips on how to [Explore the IntelliJ Platform API](explore_api.md).
#### Appendix II - API Changes
#### Appendix II — API Changes
Provides a list of [backward-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.

8
topics/intro/content_updates.md
View File

@ -36,7 +36,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 _Part VIII — Product Specific_. Also, all deprecated API now has a dedicated tag.
### July-21
@ -54,7 +54,7 @@ Documentation Provider
### May-21
IDE specific Extension Point Lists
: See _Part VIII - Product Specific_.
: See _Part VIII — 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.
@ -125,7 +125,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.
: [Part VIII — Product Specific](plugin_compatibility.md) has been expanded massively, now also covering each IDE with its dedicated page.
## 2019
@ -139,7 +139,7 @@ Plugin Components migration
### October-19
Part X - Plugin Repository moved
Part X — Plugin Repository moved
: All contents have been moved to [JetBrains Marketplace](https://plugins.jetbrains.com/docs/marketplace/about-marketplace.html) documentation.
### July-19

2
topics/intro/intellij_platform.md
View File

@ -89,4 +89,4 @@ This means that creating a plugin for Rider involves two parts - a plugin that l
Fortunately, many plugins can simply work with the ReSharper backend.
The Rider takes care of displaying the results of inspections and code completion, and many plugins can be written that don't require an IntelliJ UI component.
More details can be found in the *Part VIII - Product Specific* section.
More details can be found in the *Part VIII — Product Specific* section.