Webhelp migration (#347)

* [webhelp] Fixes for TXP00152, TXP00002, test build 27 Jul 22:26

* [webhelp] Fixes for Part #4 TXP00010, EXCEPT decimal numbers in section titles

* [webhelp] Fixes for Part #5 TXP00017

* [webhelp] Fixes for Part #4 TXP00010 - removed numbers from page section titles in "Custom Language Support Tutorial" and "Testing a Custom Language Plugin".

* [webhelp] Removed numbers from page section titles in rest of project *.md files.

* [new webhelp] Build #44 changes

* [new webhelp] Maintenance merge from master

* [new webhelp] Add placeholder file for webhelp import.

* [webhelp] Correct redirects for file name changes

* [webhelp] TOC not needed in webhelp

* [format] {:toc} not needed for webhelp

* add {:disable-links} to ensure demo links are not interpreted as real links.

* Put all badges on the same line to simplify composition.

* formatter.md: fix upsource link

* fix some links

* api_changes_list.md: remove note

* migrate to webhelp - initial

* fix GH edit URL

* remove sdkdocs-template setup in VCS config

* remove recently_updated.md

* restore COC/CONTRIBUTING.md

* api_changes_list.md: remove note

* useful_links.md: IPE

Co-authored-by: JohnHake <john.hake@jetbrains.com>
Co-authored-by: Yann Cébron <yann.cebron@jetbrains.com>
This commit is contained in:
Jakub Chrzanowski 2021-01-14 16:07:39 +01:00 committed by GitHub
parent 0a01036e1b
commit 4e802980f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
401 changed files with 3122 additions and 3146 deletions

View File

@ -2,34 +2,7 @@ name: Build
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
docs:
name: Docs
runs-on: ubuntu-latest
container:
image: ruby:2.6
steps:
- name: Fetch Sources
uses: actions/checkout@v2
- name: Setup Cache
uses: actions/cache@v2
with:
path: vendor/bundle
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
restore-keys: |
${{ runner.os }}-gems-
- name: Install Dependencies
run: |
git submodule update --init --remote
gem install bundler:2.0.1
bundle install
- name: Build
run: |
dpkg-reconfigure --frontend=noninteractive locales && update-locale LANG=C.UTF-8
export LC_ALL=C.UTF-8
export LANG=en_US.UTF-8
export LANGUAGE=en_US.UTF-8
rake build
documentedProblemsPageVerification: documentedProblemsPageVerification:
name: Documented Problems Page Verification name: Documented Problems Page Verification
runs-on: ubuntu-latest runs-on: ubuntu-latest

3
.gitmodules vendored
View File

@ -1,3 +0,0 @@
[submodule "sdkdocs-template"]
path = sdkdocs-template
url = https://github.com/JetBrains/sdkdocs-template.git

3
.idea/vcs.xml generated
View File

@ -12,6 +12,5 @@
</component> </component>
<component name="VcsDirectoryMappings"> <component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" /> <mapping directory="$PROJECT_DIR$" vcs="Git" />
<mapping directory="$PROJECT_DIR$/sdkdocs-template" vcs="Git" />
</component> </component>
</project> </project>

View File

@ -8,10 +8,7 @@ Before you begin contributing content to the SDK, please read this page thorough
For information about contributing to the IntelliJ Platform itself, please visit [Contributing to the IntelliJ Platform](/basics/platform_contributions.md). For information about contributing to the IntelliJ Platform itself, please visit [Contributing to the IntelliJ Platform](/basics/platform_contributions.md).
Here are some useful things to know before authoring SDK content and submitting your Pull Request. Here are some useful things to know before authoring SDK content and submitting your Pull Request.
* Dummy list item
{:toc}
## Setting Up the Documentation Build Environment ## Setting Up the Documentation Build Environment
This site runs via [Jekyll](https://jekyllrb.com), which is a popular static site generator, written in Ruby. This site runs via [Jekyll](https://jekyllrb.com), which is a popular static site generator, written in Ruby.
@ -20,7 +17,7 @@ Once set up, running the site is as easy as calling `rake preview`.
Alternatively, the site can also be hosted in a [Docker container](https://www.docker.com). Alternatively, the site can also be hosted in a [Docker container](https://www.docker.com).
On Mac and Windows, this means the site is hosted in a virtual machine. On Mac and Windows, this means the site is hosted in a virtual machine.
Docker maintains this container, building it based on the instructions in the [`Dockerfile`](Dockerfile). Docker maintains this container, building it based on the instructions in the [`Dockerfile`](https://github.com/JetBrains/intellij-sdk-docs/blob/master/Dockerfile).
All dependencies (Ruby, etc.) are automatically installed when building the image, which reduces the manual configuration steps. All dependencies (Ruby, etc.) are automatically installed when building the image, which reduces the manual configuration steps.
The Docker image is also used to build the [published site](https://www.jetbrains.org/intellij/sdk/docs/index.html), so it is a known working environment. The Docker image is also used to build the [published site](https://www.jetbrains.org/intellij/sdk/docs/index.html), so it is a known working environment.

View File

@ -1,35 +0,0 @@
FROM ruby:2.2
RUN apt-get update
RUN apt-get --yes install locales
RUN dpkg-reconfigure -f noninteractive locales && \
locale-gen C.UTF-8 && \
/usr/sbin/update-locale LANG=C.UTF-8
RUN echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && \
locale-gen
ENV LANG en_US.UTF-8
ENV LANGUAGE en_US:en
ENV LC_ALL en_US.UTF-8
# Tell anyone who's interested that we're running in docker
ENV DOCKER true
RUN apt-get --yes install nodejs
# Add bundle install to Docker image
ADD Gemfile* /tmp/
ADD Rakefile /tmp/
ADD _SUMMARY.md /tmp/
ADD .git /tmp/.git
ADD sdkdocs-template /tmp/sdkdocs-template
WORKDIR /tmp
RUN rake bootstrap --trace
WORKDIR /usr/src/app
EXPOSE 4000
CMD \
rake bootstrap --trace && \
rake preview

View File

@ -1 +0,0 @@
eval File.read('sdkdocs-template/bundler/Gemfile.defaults')

View File

@ -1,106 +0,0 @@
GIT
remote: https://github.com/JetBrains/link-checker.git
revision: 3c945617a239d3f96da888c55f6813d39916a41b
branch: multiple_fixes
specs:
link-checker (0.7.2)
anemone (~> 0.7.2)
certified (~> 1.0.0)
colorize (~> 0.7.3)
nokogiri (~> 1.6)
trollop (~> 2.0)
GIT
remote: https://github.com/citizenmatt/jekyll-git_metadata.git
revision: 03c85b599fe6c52e3f0253450b9790503a3dd742
branch: caching
specs:
jekyll-git_metadata (0.1.2)
jekyll (~> 3.0)
GEM
remote: https://rubygems.org/
specs:
addressable (2.6.0)
public_suffix (>= 2.0.2, < 4.0)
anemone (0.7.2)
nokogiri (>= 1.3.0)
robotex (>= 1.0.0)
certified (1.0.0)
colorator (1.1.0)
colorize (0.7.7)
concurrent-ruby (1.1.4)
em-websocket (0.5.1)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
eventmachine (1.2.7)
eventmachine (1.2.7-x64-mingw32)
ffi (1.10.0)
ffi (1.10.0-x64-mingw32)
forwardable-extended (2.6.0)
http_parser.rb (0.6.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.8.5)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
kramdown (~> 1.14)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-redirect-from (0.14.0)
jekyll (~> 3.3)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-watch (2.1.2)
listen (~> 3.0)
kramdown (1.17.0)
liquid (4.0.1)
listen (3.1.5)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
ruby_dep (~> 1.2)
mercenary (0.3.6)
mini_portile2 (2.4.0)
nokogiri (1.10.8)
mini_portile2 (~> 2.4.0)
nokogiri (1.10.8-x64-mingw32)
mini_portile2 (~> 2.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (3.0.3)
rake (12.3.3)
rb-fsevent (0.10.3)
rb-inotify (0.10.0)
ffi (~> 1.0)
robotex (1.0.0)
rouge (3.3.0)
ruby_dep (1.5.0)
safe_yaml (1.0.4)
sass (3.7.3)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
trollop (2.9.9)
PLATFORMS
ruby
x64-mingw32
DEPENDENCIES
jekyll (~> 3.8.5)
jekyll-git_metadata!
jekyll-redirect-from
link-checker!
rake
rouge
BUNDLED WITH
2.0.1

View File

@ -1,24 +0,0 @@
Rake.add_rakelib 'sdkdocs-template/rakelib'
begin
FileUtils.mkdir_p %w( _includes/code_samples )
Dir.glob('code_samples/**/*').reject { |e| e.match(/\/(build|gradlew?)(\/|$)/) }.each do |path|
if File.directory? path
FileUtils.mkdir_p "_includes/#{path}"
else
FileUtils.mkdir_p "_includes/#{File.dirname path}"
FileUtils.cp path, "_includes/#{path}"
end
end
rescue
`yes | cp -rf code_samples _includes`
end
CONFIG = {
:source_dir => __dir__,
:tmp_dir => "#{__dir__}/_tmp",
:build_destination => "_site",
:preview_host => "0.0.0.0",
:preview_port => 4000,
:default_env => 'dev'
}

View File

@ -1,292 +0,0 @@
## Summary
* [Introduction](intro/welcome.md)
* [The IntelliJ Platform](intro/intellij_platform.md)
* [Contributing to the IntelliJ Platform](basics/platform_contributions.md)
* [IntelliJ Platform Coding Guidelines](basics/intellij_coding_guidelines.md)
* [The IntelliJ Platform SDK](intro/about.md)
* [Key Topics](intro/key_topics.md)
* [Contributing to the SDK](CONTRIBUTING.md)
* [SDK Docs Style Guide](intro/sdk_style.md)
* [SDK Code Sample Guidelines](intro/sdk_code_guidelines.md)
* [Code of Conduct](CODE_OF_CONDUCT.md)
* [Getting Help](intro/getting_help.md)
* [Content Updates](intro/content_updates.md)
* [Recently Updated](recently_updated.md)
## Part I - Plugins
* [Quick Start Guide](basics/basics.md)
* [Main Types of Plugins](basics/types_of_plugins.md)
* [Code Samples](https://github.com/JetBrains/intellij-sdk-code-samples)
* [Creating Your First Plugin](basics/getting_started.md)
* [Using GitHub Template](tutorials/github_template.md)
* [Using Gradle](tutorials/build_system.md)
* [Getting Started with Gradle](tutorials/build_system/prerequisites.md)
* [Configuring Gradle Projects](tutorials/build_system/gradle_guide.md)
* [Publishing Plugins with Gradle](tutorials/build_system/deployment.md)
* [Using DevKit](basics/getting_started/using_dev_kit.md)
* [Setting Up a Development Environment](basics/getting_started/setting_up_environment.md)
* [Creating a Plugin Project](basics/getting_started/creating_plugin_project.md)
* [Running and Debugging a Plugin](basics/getting_started/running_and_debugging_a_plugin.md)
* [Deploying a Plugin](basics/getting_started/deploying_plugin.md)
* [Publishing a Plugin](basics/getting_started/publishing_plugin.md)
* [IDE Development Instances](basics/ide_development_instance.md)
* [Custom Plugin Repositories](basics/getting_started/update_plugins_format.md)
* [Plugin Structure](basics/plugin_structure.md)
* [Plugin Content](basics/plugin_structure/plugin_content.md)
* [Plugin Class Loaders](basics/plugin_structure/plugin_class_loaders.md)
* [Plugin Actions](basics/plugin_structure/plugin_actions.md)
* [Plugin Extensions](basics/plugin_structure/plugin_extensions.md)
* [Plugin Services](basics/plugin_structure/plugin_services.md)
* [Plugin Listeners](basics/plugin_structure/plugin_listeners.md)
* [Plugin Extension Points](basics/plugin_structure/plugin_extension_points.md)
* [Plugin Components](basics/plugin_structure/plugin_components.md)
* [Plugin Configuration File](basics/plugin_structure/plugin_configuration_file.md)
* [Plugin Logo (Icon)](basics/plugin_structure/plugin_icon_file.md)
* [Plugin Dependencies](basics/plugin_structure/plugin_dependencies.md)
* [Dynamic Plugins](basics/plugin_structure/dynamic_plugins.md)
* [IntelliJ Platform Artifacts Repositories](reference_guide/intellij_artifacts.md)
* [Kotlin for Plugin Developers](tutorials/kotlin.md)
* [Internal Actions Menu](reference_guide/internal_actions/internal_actions_intro.md)
* [Enabling Internal Mode](reference_guide/internal_actions/enabling_internal.md)
* [UI Tools](reference_guide/internal_actions/internal_ui_sub.md)
* [UI Inspector](reference_guide/internal_actions/internal_ui_inspector.md)
* [LaF Defaults](reference_guide/internal_actions/internal_ui_laf_defaults.md)
* [Optimizing Performance](reference_guide/performance/performance.md)
* [Plugin Development FAQ](basics/faq.md)
## Part II - Base Platform
* [Fundamentals](platform/fundamentals.md)
* Component Model
* [Disposer and Disposable](basics/disposers.md)
* [Threading](basics/architectural_overview/general_threading_rules.md)
* Background Tasks
* [Messaging Infrastructure](reference_guide/messaging_infrastructure.md)
* Queries and Query Executors
* [User Interface Components](user_interface_components/user_interface_components.md)
* [Tool Windows](user_interface_components/tool_windows.md)
* [Dialogs](user_interface_components/dialog_wrapper.md)
* [Popups](user_interface_components/popups.md)
* [Notifications](user_interface_components/notifications.md)
* [File and Class Choosers](user_interface_components/file_and_class_choosers.md)
* [Editor Components](user_interface_components/editor_components.md)
* [List and Tree Controls](user_interface_components/lists_and_trees.md)
* [Miscellaneous Swing Components](user_interface_components/misc_swing_components.md)
* [Icons and Images](reference_guide/work_with_icons_and_images.md)
* [Color Scheme Management](reference_guide/color_scheme_management.md)
* [Kotlin UI DSL](user_interface_components/kotlin_ui_dsl.md)
* [JCEF](reference_guide/jcef.md)
* [UI Themes](reference_guide/ui_themes/themes_intro.md)
* [Creating UI Themes](reference_guide/ui_themes/themes.md)
* [Customizing a UI Theme](reference_guide/ui_themes/themes_customize.md)
* [Adding Schemes and Images](reference_guide/ui_themes/themes_extras.md)
* [Exposing Theme Metadata](reference_guide/ui_themes/themes_metadata.md)
* [Actions](basics/action_system.md)
* [Actions Tutorial](tutorials/action_system.md)
* [Creating Actions](tutorials/action_system/working_with_custom_actions.md)
* [Grouping Actions](tutorials/action_system/grouping_action.md)
* [Persistence](basics/persistence.md)
* [Persisting State of Components](basics/persisting_state_of_components.md)
* [Persisting Sensitive Data](basics/persisting_sensitive_data.md)
* [Settings](basics/settings.md)
* [Settings Guide](reference_guide/settings_guide.md)
* [Custom Groups](reference_guide/settings_groups.md)
* [Settings Tutorial](tutorials/settings_tutorial.md)
* [Files](basics/architectural_overview/files.md)
* [Virtual File System](basics/virtual_file_system.md)
* [Virtual Files](basics/architectural_overview/virtual_file.md)
* [Documents](basics/architectural_overview/documents.md)
* [Editors](reference_guide/editors.md)
* [Editor Basics](tutorials/editor_basics.md)
* [1. Working with Text](tutorials/editor_basics/working_with_text.md)
* [2. Editor Coordinates System. Positions and Offsets](tutorials/editor_basics/coordinates_system.md)
* [3. Handling Editor Events](tutorials/editor_basics/editor_events.md)
* [Multiple Carets](reference_guide/multiple_carets.md)
* [Run Configurations](basics/run_configurations.md)
* [Run Configuration Management](basics/run_configurations/run_configuration_management.md)
* [Execution](basics/run_configurations/run_configuration_execution.md)
* [Run Configurations Tutorial](tutorials/run_configurations.md)
* [Version Control Systems](reference_guide/vcs_integration_for_plugins.md)
* Diff
* Local History
* Tasks and Contexts
* [Localization Guide](reference_guide/localization_guide.md)
* Diagrams
## Part III - Project Model
* [Introduction](basics/project_structure.md)
* [Project](reference_guide/project_model/project.md)
* [Project Wizard](reference_guide/project_wizard.md)
* [Project Wizard Tutorial](tutorials/project_wizard.md)
* [Adding New Steps to Project Wizard](tutorials/project_wizard/adding_new_steps.md)
* [Supporting Module Types](tutorials/project_wizard/module_types.md)
* [Frameworks](tutorials/framework.md)
* [Module](reference_guide/project_model/module.md)
* [SDK](reference_guide/project_model/sdk.md)
* [Library](reference_guide/project_model/library.md)
* [Facet](reference_guide/project_model/facet.md)
* [External System Integration](reference_guide/frameworks_and_external_apis/external_system_integration.md)
## Part IV - PSI
* [What Is the PSI?](basics/architectural_overview/psi.md)
* [PSI Files](basics/architectural_overview/psi_files.md)
* [File View Providers](basics/architectural_overview/file_view_providers.md)
* [PSI Elements](basics/architectural_overview/psi_elements.md)
* [Navigating the PSI](basics/architectural_overview/navigating_psi.md)
* [References](basics/architectural_overview/psi_references.md)
* [Modifying the PSI](basics/architectural_overview/modifying_psi.md)
* [PSI Cookbook](basics/psi_cookbook.md)
* [Indexing and PSI Stubs](basics/indexing_and_psi_stubs.md)
* [File-Based Indexes](basics/indexing_and_psi_stubs/file_based_indexes.md)
* [Stub Indexes](basics/indexing_and_psi_stubs/stub_indexes.md)
* Element Patterns
* Unified AST
* [XML DOM API](reference_guide/frameworks_and_external_apis/xml_dom_api.md)
## Part V - Features
* Navigation
* Go To Symbol
* [Editing](basics/editing.md)
* Code Completion
* [Templates](basics/templates.md)
* [Live Templates](tutorials/live_templates.md)
* [Adding Live Templates to a Plugin](tutorials/live_templates/template_support.md)
* [Creating New Functions for Live Templates](tutorials/live_templates/new_macros.md)
* Surround Templates
* File Templates
* QuickDoc
* [Intentions](tutorials/code_intentions.md)
* [Analysing](basics/analyzing.md)
* Annotator
* [Inspections](tutorials/code_inspections.md)
* Profiles
* Scopes
* Suppressing Highlights
* Structural Search
* Refactoring
* [Project View](basics/project_view.md)
* [Modifying Project View Structure](tutorials/tree_structure_view.md)
* Unit Testing
* [Build System](reference_guide/project_model/build_system.md)
* [External Builder API and Plugins](reference_guide/frameworks_and_external_apis/external_builder_api.md)
## Part VI - Testing
* [Testing Plugins](basics/testing_plugins/testing_plugins.md)
* [Tests and Fixtures](basics/testing_plugins/tests_and_fixtures.md)
* [Light and Heavy Tests](basics/testing_plugins/light_and_heavy_tests.md)
* [Test Project and Testdata Directories](basics/testing_plugins/test_project_and_testdata_directories.md)
* [Writing Tests](basics/testing_plugins/writing_tests.md)
* [Testing Highlighting](basics/testing_plugins/testing_highlighting.md)
## Part VII - Custom Languages
* [Custom Language Support](reference_guide/custom_language_support.md)
* [Registering File Type](reference_guide/custom_language_support/registering_file_type.md)
* [Implementing Lexer](reference_guide/custom_language_support/implementing_lexer.md)
* [Implementing Parser and PSI](reference_guide/custom_language_support/implementing_parser_and_psi.md)
* [Syntax Highlighting and Error Highlighting](reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md)
* [References and Resolve](reference_guide/custom_language_support/references_and_resolve.md)
* [Symbols](reference_guide/custom_language_support/symbols.md)
* [Declarations and References](reference_guide/custom_language_support/declarations_and_references.md)
* [Navigation](reference_guide/custom_language_support/navigation.md)
* [Code Completion](reference_guide/custom_language_support/code_completion.md)
* [Find Usages](reference_guide/custom_language_support/find_usages.md)
* [Rename Refactoring](reference_guide/custom_language_support/rename_refactoring.md)
* [Safe Delete Refactoring](reference_guide/custom_language_support/safe_delete_refactoring.md)
* [Code Formatter](reference_guide/custom_language_support/code_formatting.md)
* [Code Inspections and Intentions](reference_guide/custom_language_support/code_inspections_and_intentions.md)
* [Structure View](reference_guide/custom_language_support/structure_view.md)
* [Surround With](reference_guide/custom_language_support/surround_with.md)
* [Go to Class and Go to Symbol](reference_guide/custom_language_support/go_to_class_and_go_to_symbol.md)
* [Documentation](reference_guide/custom_language_support/documentation.md)
* [Additional Minor Features](reference_guide/custom_language_support/additional_minor_features.md)
* Parameter Info
* Parameter Hints
* [Custom Language Support Tutorial](tutorials/custom_language_support_tutorial.md)
* [1. Prerequisites](tutorials/custom_language_support/prerequisites.md)
* [2. Language and File Type](tutorials/custom_language_support/language_and_filetype.md)
* [3. Grammar and Parser](tutorials/custom_language_support/grammar_and_parser.md)
* [4. Lexer and Parser Definition](tutorials/custom_language_support/lexer_and_parser_definition.md)
* [5. Syntax Highlighter and Color Settings Page](tutorials/custom_language_support/syntax_highlighter_and_color_settings_page.md)
* [6. PSI Helpers and Utilities](tutorials/custom_language_support/psi_helper_and_utilities.md)
* [7. Annotator](tutorials/custom_language_support/annotator.md)
* [8. Line Marker Provider](tutorials/custom_language_support/line_marker_provider.md)
* [9. Completion Contributor](tutorials/custom_language_support/completion_contributor.md)
* [10. Reference Contributor](tutorials/custom_language_support/reference_contributor.md)
* [11. Find Usages Provider](tutorials/custom_language_support/find_usages_provider.md)
* [12. Folding Builder](tutorials/custom_language_support/folding_builder.md)
* [13. Go To Symbol Contributor](tutorials/custom_language_support/go_to_symbol_contributor.md)
* [14. Structure View Factory](tutorials/custom_language_support/structure_view_factory.md)
* [15. Formatter](tutorials/custom_language_support/formatter.md)
* [16. Code Style Settings](tutorials/custom_language_support/code_style_settings.md)
* [17. Commenter](tutorials/custom_language_support/commenter.md)
* [18. Quick Fix](tutorials/custom_language_support/quick_fix.md)
* [Testing a Custom Language Plugin](tutorials/writing_tests_for_plugins.md)
* [1. Tests Prerequisites](tutorials/writing_tests_for_plugins/tests_prerequisites.md)
* [2. Parsing Test](tutorials/writing_tests_for_plugins/parsing_test.md)
* [3. Completion Test](tutorials/writing_tests_for_plugins/completion_test.md)
* [4. Annotator Test](tutorials/writing_tests_for_plugins/annotator_test.md)
* [5. Formatter Test](tutorials/writing_tests_for_plugins/formatter_test.md)
* [6. Rename Test](tutorials/writing_tests_for_plugins/rename_test.md)
* [7. Folding Test](tutorials/writing_tests_for_plugins/folding_test.md)
* [8. Find Usages Test](tutorials/writing_tests_for_plugins/find_usages_test.md)
* [9. Commenter Test](tutorials/writing_tests_for_plugins/commenter_test.md)
* [10. Reference Test](tutorials/writing_tests_for_plugins/reference_test.md)
* Injected Languages
* Build System
* Compiler
* Debugger
## Part VIII - Product Specific
* [Build Number Ranges](basics/getting_started/build_number_ranges.md)
* [Developing for Multiple Products](products/dev_alternate_products.md)
* [Compatibility with Multiple Products](basics/getting_started/plugin_compatibility.md)
* [Android Studio](products/android_studio.md)
* [AppCode](products/app_code.md)
* [CLion](products/clion.md)
* [DataGrip](products/data_grip.md)
* [GoLand](products/goland.md)
* [IntelliJ IDEA](products/idea.md)
* [Tomcat Integration](reference_guide/tomcat_integration.md)
* [Spring API](reference_guide/frameworks_and_external_apis/spring_api.md)
* [PhpStorm](products/phpstorm/phpstorm.md)
* [Working with the PHP Open API](products/phpstorm/php_open_api.md)
* [Breaking Changes](products/phpstorm/php_open_api_breaking_changes.md)
* [2020.3](products/phpstorm/php_open_api_breaking_changes_203.md)
* [2020.2](products/phpstorm/php_open_api_breaking_changes_202.md)
* [Existing Third Party Plugins](products/phpstorm/existing_plugins.md)
* [PyCharm](products/pycharm.md)
* [Rider](products/rider.md)
* [RubyMine](products/rubymine.md)
* [WebStorm](products/webstorm.md)
## Part IX - Custom IDEs
* Build Your Own IDE
* Licensing
## Part X - Plugin Repository \[moved]
* [Overview](appendix/plugin_repository_obsolete.md)
## Appendix I - Resources
* [Glossary](appendix/glossary.md)
* [Extension Point List](appendix/resources/extension_point_list.md)
* [Useful Links](appendix/resources/useful_links.md)
* [Marketing](appendix/resources/marketing.md)
* [Consulting](appendix/resources/consulting.md)
## Appendix II - API Changes
* [Incompatible API Changes](reference_guide/api_changes_list.md)
* [2021.*](reference_guide/api_changes/api_changes_list_2021.md)
* [2020.*](reference_guide/api_changes/api_changes_list_2020.md)
* [2019.*](reference_guide/api_changes/api_changes_list_2019.md)
* [2018.*](reference_guide/api_changes/api_changes_list_2018.md)
* [2017.*](reference_guide/api_changes/api_changes_list_2017.md)
* [2016.*](reference_guide/api_changes/api_changes_list_2016.md)
* [Notable API Changes](reference_guide/api_notable/api_notable.md)
* [2021.*](reference_guide/api_notable/api_notable_list_2021.md)
* [2020.*](reference_guide/api_notable/api_notable_list_2020.md)
* [2019.*](reference_guide/api_notable/api_notable_list_2019.md)
* [2018.*](reference_guide/api_notable/api_notable_list_2018.md)

View File

@ -1,22 +0,0 @@
---
product_name: IntelliJ Platform SDK
product_version:
product_type: DevGuide
url: https://www.jetbrains.org
baseurl: /intellij/sdk/docs/
description: Documentation for working with and extending the IntelliJ Platform SDK
# 2020.3
upsource:
server: upsource.jetbrains.com
repo: idea-ce
commit: 4b94ba01122752d7576eb9d69638b6e89d1671b7
tag: 203.5981.155
github_repo: JetBrains/intellij-sdk-docs
youtrack_project: IJSDK
exclude:
- code_samples

View File

@ -1,93 +0,0 @@
---
title: Glossary
---
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2 -->
## A
Abstract Syntax Tree _(AST)_
: The [Abstract Syntax Tree](/reference_guide/custom_language_support/implementing_parser_and_psi.md) represents the structure of source input files.
&rarr; _Program Structure Interface_
Annotator
: Provides [semantic highlighting](/reference_guide/custom_language_support/syntax_highlighting_and_error_highlighting.md) based on underlying &rarr; _Program Structure Interface_ elements.
&rarr; _Inspection_
## D
Document Object Model _(DOM)_
: [DOM API](/reference_guide/frameworks_and_external_apis/xml_dom_api.md) abstracts working with XML files based on a custom semantic model.
## E
Event Dispatch Thread _(EDT)_
: The [Event Dispatch Thread](https://docs.oracle.com/javase/tutorial/uiswing/concurrency/dispatch.html) handles all Swing events. See also [General Threading Rules](/basics/architectural_overview/general_threading_rules.md).
Extension Point _(EP)_
: Most functionality is provided by [Using Extension Points](/basics/plugin_structure/plugin_extensions.md) provided by the platform or plugins. Plugins can also [define their own](/basics/plugin_structure/plugin_extension_points.md) to allow extensibility.
External System _(ES)_
: [External System](/reference_guide/frameworks_and_external_apis/external_system_integration.md) allows integrating external project management systems.
## F
File Based Index _(FBI)_
: [File Based Index](/basics/indexing_and_psi_stubs/file_based_indexes.md) allows storing key-value information based on the project's files.
## I
Inspection
: Supports configurable [semantic highlighting](/reference_guide/custom_language_support/code_inspections_and_intentions.md).
&rarr; _Annotator_
Intention
: Provides an [automated fix](/reference_guide/custom_language_support/code_inspections_and_intentions.md) for commonly encountered code problems.
## L
Local History _(LVCS)_
: A builtin &rarr; _Version Control System_ tracking all changes in the project [locally](https://www.jetbrains.com/help/idea/local-history.html).
## J
JetBrains Project System _(JPS)_
: Represents the project model in [External Build](/reference_guide/frameworks_and_external_apis/external_builder_api.md#accessing-project-model-and-configuration-from-external-build) process.
JetBrains Runtime _(JBR)_
: The [JetBrains Runtime](/basics/ide_development_instance.md#using-a-jetbrains-runtime-for-the-development-instance) is the default bundled runtime for all IntelliJ Platform-based IDEs by JetBrains.
## P
Program Structure Interface _(PSI)_
: The [Program Structure Interface](/basics/architectural_overview/psi.md) represents a syntactic and semantic code model of the source input files. &rarr; _Abstract Syntax Tree_ &rarr; _Stubs_
## R
Read Action
: Allows accessing code-related data structures for reading purposes. See also [General Threading Rules](/basics/architectural_overview/general_threading_rules.md).
&rarr; _Write Action_
Run Configuration _(RC)_
: A [Run Configuration](/basics/run_configurations.md) allows running external processes from within the IDE.
## S
Stubs
: A subset of a &rarr; _Program Structure Interface_ tree in a binary serialized compact format, see [Stub Indexes](/basics/indexing_and_psi_stubs/stub_indexes.md).
## V
Version Control System _(VCS)_
: The API for [Version Control System](/reference_guide/vcs_integration_for_plugins.md) allows accessing builtin as well as adding custom implementations.
Virtual File _(VF)_
: A [Virtual File](/basics/architectural_overview/virtual_file.md) represents a file in a &rarr; _Virtual File System_.
Virtual File System _(VFS)_
: A [Virtual File System](/basics/virtual_file_system.md) provides a unified API for working with files represented as &rarr; _Virtual File_.
## W
Write Action
: Allows accessing code-related data structures for writing purposes. See also [General Threading Rules](/basics/architectural_overview/general_threading_rules.md).
&rarr; _Read Action_

View File

@ -1,18 +0,0 @@
---
title: Plugin Structure
---
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
Click the following topics to learn more about the plugin system structure and plugin lifecycles:
* [Plugin Content](plugin_structure/plugin_content.md)
* [Plugin Class Loaders](plugin_structure/plugin_class_loaders.md)
* [Plugin Actions](plugin_structure/plugin_actions.md)
* [Plugin Extensions](plugin_structure/plugin_extensions.md)
* [Plugin Services](plugin_structure/plugin_services.md)
* [Plugin Listeners](plugin_structure/plugin_listeners.md)
* [Plugin Extension Points](plugin_structure/plugin_extension_points.md)
* [Plugin Components](plugin_structure/plugin_components.md)
* [Plugin Configuration File](plugin_structure/plugin_configuration_file.md)
* [Plugin Logo (Icon)](plugin_structure/plugin_icon_file.md)
* [Plugin Dependencies](plugin_structure/plugin_dependencies.md)

View File

@ -1,11 +0,0 @@
---
title: Settings
---
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
## Introduction to Settings
[Settings](https://www.jetbrains.com/help/idea/configuring-project-and-ide-settings.html) are but one application of the IntelliJ Platform [Persistence Model](/basics/persistence.md).
For more information, see:
* [Settings Guide](/reference_guide/settings_guide.md) for information about Settings Extension Points and implementations.
* [Custom Settings Groups](/reference_guide/settings_groups.md) for information about creating custom Settings groups and parent-child relationships.
* [Settings Tutorial](/tutorials/settings_tutorial.md) for step-by-step instructions for creating a simple set of custom Settings.

View File

@ -1,10 +0,0 @@
---
title: Templates
---
<!-- Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
* [Live Templates](/tutorials/live_templates.md)
* [Adding Live Templates to a Plugin](/tutorials/live_templates/template_support.md)
* [Creating New Functions for Live Templates](/tutorials/live_templates/new_macros.md)
* Surround Templates
* File Templates

11
cfg/build-script.xml Normal file
View File

@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE root
SYSTEM "https://helpserver.labs.jb.gg/help/build-script.dtd">
<root>
<builds>
<product id="ijs" master="project.ihp" family="idea">
<artifact type="web2" platform="primary" local-update="true" local-update-path="idea-sdk"
image-bundle="true"/>
</product>
</builds>
</root>

34
cfg/buildprofiles.xml Normal file
View File

@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<buildprofiles>
<variables>
<web-root>https://plugins.jetbrains.com/docs</web-root>
<web-community-path>Developer Community:http://www.jetbrains.net/devnet/community/idea/kb</web-community-path>
<download-page/>
<search-scope/>
<fallback-url/>
<generate-sitemap-url-prefix>https://plugins.jetbrains.com/docs/intellij/</generate-sitemap-url-prefix>
<config-feedbackRequireEmail>false</config-feedbackRequireEmail>
<config-showDownloadButton>true</config-showDownloadButton>
<config-disqus-show>false</config-disqus-show>
<config-feedback-url>https://data.services.jetbrains.com/feedback</config-feedback-url>
<config-feedback-enabled>true</config-feedback-enabled>
<config-feedback-widget>true</config-feedback-widget>
<config-webmaster>https://plugins.jetbrains.com/docs/intellij/getting-help.html</config-webmaster>
<config-feedback-support>https://www.jetbrains.com/support/</config-feedback-support>
<config-sideblocks>true</config-sideblocks>
<config-search-scopes-provider>https://data.services.jetbrains.com/search/</config-search-scopes-provider>
<og-twitter>@JBPlatform</og-twitter>
<og-image>https://resources.jetbrains.com/storage/products/jetbrains/img/meta/preview.png</og-image>
<enable-browser-edits>true</enable-browser-edits>
<browser-edits-url>https://github.com/JetBrains/intellij-sdk-docs/edit/master/</browser-edits-url>
<images-prefix-override>images/</images-prefix-override>
<upsource-commit-hash>4b94ba01122752d7576eb9d69638b6e89d1671b7</upsource-commit-hash>
<upsource-repo-name>idea-ce</upsource-repo-name>
<upsource-server-address>upsource.jetbrains.com</upsource-server-address>
</variables>
<build-profile product="ijs"/>
</buildprofiles>

14
cfg/platforms.xml Normal file
View File

@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<platforms>
<platform id="primary">
<delimiter>+</delimiter>
<src>keymap-%currentId%.xml</src>
<mappings>ctrl:Ctrl;control:Ctrl;alt:Alt;shift:Shift;command:⌘;meta:⌘</mappings>
<directory-separator>\</directory-separator>
</platform>
<platform id="secondary">
<src>keymap-%currentId%.xml</src>
<mappings>ctrl:^;control:Control;alt:⌥;shift:⇧;command:⌘;meta:⌘</mappings>
<directory-separator>/</directory-separator>
</platform>
</platforms>

View File

@ -1,8 +0,0 @@
{
"productName": "IntelliJ Platform SDK",
"searchScope": "intellij-sdk-docs",
"searchService": "https://data.services.jetbrains.com/search/",
"disqusID": "",
"showDisqus": false,
"useSideblocks": false
}

View File

@ -1,8 +0,0 @@
{
"_comment": "FOR DETAILED FORMAT LOOK AT https://docs.docker.com/reference/api/docker_remote_api_v1.16/#create-a-container",
"AttachStdin": true,
"OpenStdin": true,
"HostConfig": {
"PortBindings":{ "8080/tcp": [{ "HostIp": "0.0.0.0", "HostPort": "18080" }] }
}
}

354
ijs.tree Normal file
View File

@ -0,0 +1,354 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE product-profile
SYSTEM "https://helpserver.labs.jb.gg/help/product-profile.dtd">
<product-profile id="ijs" name="IntelliJ Platform Plugin SDK" start-page="welcome.md" status="release">
<toc-element toc-title="Summary">
<toc-element id="welcome.md" accepts-web-file-names="welcome.html" toc-title="Introduction"/>
<toc-element id="intellij_platform.md" toc-title="The IntelliJ Platform">
<toc-element id="platform_contributions.md" toc-title="Contributing to the IntelliJ Platform"/>
<toc-element id="intellij_coding_guidelines.md" toc-title="IntelliJ Platform Coding Guidelines"/>
</toc-element>
<toc-element id="about.md" toc-title="The IntelliJ Platform SDK">
<toc-element id="key_topics.md" toc-title="Key Topics"/>
<toc-element id="intellij-sdk-docs-original_CONTRIBUTING.md" toc-title="Contributing to the SDK">
<toc-element id="sdk_style.md" toc-title="SDK Docs Style Guide"/>
<toc-element id="sdk_code_guidelines.md" toc-title="SDK Code Sample Guidelines"/>
</toc-element>
<toc-element id="intellij-sdk-docs-original_CODE_OF_CONDUCT.md" toc-title="Code of Conduct"/>
</toc-element>
<toc-element id="getting_help.md" toc-title="Getting Help"/>
<toc-element id="content_updates.md" toc-title="Content Updates">
<toc-element id="recently_updated.md" toc-title="Recently Updated"/>
</toc-element>
</toc-element>
<toc-element toc-title="Part I - Plugins">
<toc-element id="basics.md" accepts-web-file-names="basics.html" toc-title="Quick Start Guide">
<toc-element id="types_of_plugins.md" toc-title="Main Types of Plugins"/>
</toc-element>
<toc-element toc-title="Code Samples" href="https://github.com/JetBrains/intellij-sdk-code-samples"/>
<toc-element id="getting_started.md" toc-title="Creating Your First Plugin">
<toc-element id="github_template.md" toc-title="Using GitHub Template"/>
<toc-element id="gradle_build_system.md" accepts-web-file-names="build_system.html"
toc-title="Using Gradle">
<toc-element id="gradle_prerequisites.md" accepts-web-file-names="prerequisites.html"
toc-title="Getting Started with Gradle"/>
<toc-element id="gradle_guide.md" toc-title="Configuring Gradle Projects"/>
<toc-element id="deployment.md" toc-title="Publishing Plugins with Gradle"/>
</toc-element>
<toc-element id="using_dev_kit.md" toc-title="Using DevKit">
<toc-element id="setting_up_environment.md" toc-title="Setting Up a Development Environment"/>
<toc-element id="creating_plugin_project.md" accepts-web-file-names="creating_an_action.html"
toc-title="Creating a Plugin Project"/>
<toc-element id="running_and_debugging_a_plugin.md" toc-title="Running and Debugging a Plugin"/>
<toc-element id="deploying_plugin.md" toc-title="Deploying a Plugin"/>
<toc-element id="publishing_plugin.md" toc-title="Publishing a Plugin"/>
</toc-element>
</toc-element>
<toc-element id="ide_development_instance.md" accepts-web-file-names="settings_caches_logs.html"
toc-title="IDE Development Instances"/>
<toc-element id="update_plugins_format.md" toc-title="Custom Plugin Repositories"/>
<toc-element id="plugin_structure.md" toc-title="Plugin Structure">
<toc-element id="plugin_content.md" toc-title="Plugin Content"/>
<toc-element id="plugin_class_loaders.md" toc-title="Plugin Class Loaders"/>
<toc-element id="plugin_actions.md" toc-title="Plugin Actions"/>
<toc-element id="plugin_extensions.md" accepts-web-file-names="plugin_extensions_and_extension_points.html"
toc-title="Plugin Extensions"/>
<toc-element id="plugin_services.md" toc-title="Plugin Services"/>
<toc-element id="plugin_listeners.md" toc-title="Plugin Listeners"/>
<toc-element id="plugin_extension_points.md" toc-title="Plugin Extension Points"/>
<toc-element id="plugin_components.md" toc-title="Plugin Components"/>
<toc-element id="plugin_configuration_file.md" toc-title="Plugin Configuration File"/>
<toc-element id="plugin_icon_file.md" toc-title="Plugin Logo (Icon)"/>
<toc-element id="plugin_dependencies.md" toc-title="Plugin Dependencies"/>
</toc-element>
<toc-element id="dynamic_plugins.md" toc-title="Dynamic Plugins"/>
<toc-element id="intellij_artifacts.md" toc-title="IntelliJ Platform Artifacts Repositories"/>
<toc-element id="kotlin.md" toc-title="Kotlin for Plugin Developers"/>
<toc-element id="internal_actions_intro.md" accepts-web-file-names="interal_actions_menu.html"
toc-title="Internal Actions Menu">
<toc-element id="enabling_internal.md" toc-title="Enabling Internal Mode"/>
<toc-element id="internal_ui_sub.md" toc-title="UI Tools">
<toc-element id="internal_ui_inspector.md" accepts-web-file-names="internal_uii.html"
toc-title="UI Inspector"/>
<toc-element id="internal_ui_laf_defaults.md" accepts-web-file-names="internal_ui_lafd.html"
toc-title="LaF Defaults"/>
</toc-element>
</toc-element>
<toc-element id="performance.md" toc-title="Optimizing Performance"/>
<toc-element id="faq.md" accepts-web-file-names="faq.html" toc-title="Plugin Development FAQ"/>
</toc-element>
<toc-element toc-title="Part II - Base Platform">
<toc-element id="fundamentals.md" accepts-web-file-names="reference_guide.html,architectural_overview.html"
toc-title="Fundamentals">
<toc-element toc-title="Component Model"/>
<toc-element id="disposers.md" toc-title="Disposer and Disposable"/>
<toc-element id="general_threading_rules.md" toc-title="Threading">
<toc-element toc-title="Background Tasks"/>
</toc-element>
<toc-element id="messaging_infrastructure.md" toc-title="Messaging Infrastructure"/>
<toc-element toc-title="Queries and Query Executors"/>
</toc-element>
<toc-element id="user_interface_components.md" toc-title="User Interface Components">
<toc-element id="tool_windows.md" toc-title="Tool Windows"/>
<toc-element id="dialog_wrapper.md" toc-title="Dialogs"/>
<toc-element id="popups.md" toc-title="Popups"/>
<toc-element id="notifications.md" toc-title="Notifications"/>
<toc-element id="file_and_class_choosers.md" toc-title="File and Class Choosers"/>
<toc-element id="editor_components.md" toc-title="Editor Components"/>
<toc-element id="lists_and_trees.md" toc-title="List and Tree Controls"/>
<toc-element id="misc_swing_components.md" toc-title="Miscellaneous Swing Components"/>
<toc-element id="work_with_icons_and_images.md" toc-title="Icons and Images"/>
<toc-element id="color_scheme_management.md" toc-title="Color Scheme Management"/>
<toc-element id="kotlin_ui_dsl.md" toc-title="Kotlin UI DSL"/>
</toc-element>
<toc-element id="jcef.md" toc-title="JCEF"/>
<toc-element id="themes_intro.md" toc-title="UI Themes">
<toc-element id="themes.md" toc-title="Creating UI Themes"/>
<toc-element id="themes_customize.md" toc-title="Customizing a UI Theme"/>
<toc-element id="themes_extras.md" toc-title="Adding Schemes and Images"/>
<toc-element id="themes_metadata.md" toc-title="Exposing Theme Metadata"/>
</toc-element>
<toc-element id="basic_action_system.md" accepts-web-file-names="action_system.html" toc-title="Actions">
<toc-element id="action_system.md" toc-title="Actions Tutorial">
<toc-element id="working_with_custom_actions.md" toc-title="Creating Actions"/>
<toc-element id="grouping_action.md" toc-title="Grouping Actions"/>
</toc-element>
</toc-element>
<toc-element id="persistence.md" toc-title="Persistence">
<toc-element id="persisting_state_of_components.md" toc-title="Persisting State of Components"/>
<toc-element id="persisting_sensitive_data.md" toc-title="Persisting Sensitive Data"/>
</toc-element>
<toc-element id="settings.md" toc-title="Settings">
<toc-element id="settings_guide.md" toc-title="Settings Guide"/>
<toc-element id="settings_groups.md" toc-title="Custom Groups"/>
<toc-element id="settings_tutorial.md" toc-title="Settings Tutorial"/>
</toc-element>
<toc-element id="files.md" toc-title="Files">
<toc-element id="virtual_file_system.md" toc-title="Virtual File System"/>
<toc-element id="virtual_file.md" toc-title="Virtual Files"/>
</toc-element>
<toc-element id="documents.md" toc-title="Documents"/>
<toc-element id="editors.md" toc-title="Editors">
<toc-element id="editor_basics.md" toc-title="Editor Basics">
<toc-element id="working_with_text.md" toc-title="1. Working with Text"/>
<toc-element id="coordinates_system.md"
toc-title="2. Editor Coordinates System. Positions and Offsets"/>
<toc-element id="editor_events.md" toc-title="3. Handling Editor Events"/>
</toc-element>
<toc-element id="multiple_carets.md" toc-title="Multiple Carets"/>
</toc-element>
<toc-element id="basic_run_configurations.md" accepts-web-file-names="run_configurations.html"
toc-title="Run Configurations">
<toc-element id="run_configuration_management.md" toc-title="Run Configuration Management"/>
<toc-element id="run_configuration_execution.md" toc-title="Execution"/>
<toc-element id="run_configurations.md" toc-title="Run Configurations Tutorial"/>
</toc-element>
<toc-element id="vcs_integration_for_plugins.md" toc-title="Version Control Systems">
<toc-element toc-title="Diff"/>
<toc-element toc-title="Local History"/>
</toc-element>
<toc-element toc-title="Tasks and Contexts"/>
<toc-element id="localization_guide.md" toc-title="Localization Guide"/>
<toc-element toc-title="Diagrams"/>
</toc-element>
<toc-element toc-title="Part III - Project Model">
<toc-element id="project_structure.md" toc-title="Introduction"/>
<toc-element id="project.md" toc-title="Project">
<toc-element id="project_wizard.md" toc-title="Project Wizard"/>
<toc-element id="intro_project_wizard.md" accepts-web-file-names="project_wizard.html"
toc-title="Project Wizard Tutorial">
<toc-element id="adding_new_steps.md" toc-title="Adding New Steps to Project Wizard"/>
<toc-element id="module_types.md" toc-title="Supporting Module Types"/>
</toc-element>
<toc-element id="framework.md" toc-title="Frameworks"/>
</toc-element>
<toc-element id="module.md" toc-title="Module"/>
<toc-element id="sdk.md" toc-title="SDK"/>
<toc-element id="library.md" toc-title="Library"/>
<toc-element id="facet.md" toc-title="Facet"/>
<toc-element id="external_system_integration.md" toc-title="External System Integration"/>
</toc-element>
<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-title="PSI Files"/>
<toc-element id="file_view_providers.md" toc-title="File View Providers"/>
<toc-element id="psi_elements.md" toc-title="PSI Elements"/>
<toc-element id="navigating_psi.md" toc-title="Navigating the PSI"/>
<toc-element id="psi_references.md" toc-title="References"/>
<toc-element id="modifying_psi.md" toc-title="Modifying the PSI"/>
<toc-element id="psi_cookbook.md" toc-title="PSI Cookbook"/>
<toc-element id="indexing_and_psi_stubs.md" toc-title="Indexing and PSI Stubs">
<toc-element id="file_based_indexes.md" toc-title="File-Based Indexes"/>
<toc-element id="stub_indexes.md" toc-title="Stub Indexes"/>
</toc-element>
<toc-element toc-title="Element Patterns"/>
<toc-element toc-title="Unified AST"/>
<toc-element id="xml_dom_api.md" toc-title="XML DOM API"/>
</toc-element>
<toc-element toc-title="Part V - Features">
<toc-element toc-title="Navigation"/>
<toc-element id="editing.md" toc-title="Editing">
<toc-element toc-title="Code Completion"/>
<toc-element id="templates.md" toc-title="Templates">
<toc-element id="live_templates.md" toc-title="Live Templates">
<toc-element id="template_support.md" toc-title="Adding Live Templates to a Plugin"/>
<toc-element id="new_macros.md" toc-title="Creating New Functions for Live Templates"/>
<toc-element toc-title="Surround Templates"/>
</toc-element>
<toc-element toc-title="File Templates"/>
</toc-element>
<toc-element toc-title="QuickDoc"/>
<toc-element id="code_intentions.md" toc-title="Intentions"/>
</toc-element>
<toc-element id="analyzing.md" toc-title="Analysing">
<toc-element toc-title="Annotator"/>
<toc-element id="code_inspections.md" toc-title="Inspections">
<toc-element toc-title="Profiles"/>
<toc-element toc-title="Scopes"/>
<toc-element toc-title="Suppressing Highlights"/>
<toc-element toc-title="Structural Search"/>
</toc-element>
</toc-element>
<toc-element toc-title="Refactoring"/>
<toc-element id="project_view.md" toc-title="Project View">
<toc-element id="tree_structure_view.md" toc-title="Modifying Project View Structure"/>
</toc-element>
<toc-element toc-title="Unit Testing"/>
<toc-element id="build_system.md" toc-title="Build System">
<toc-element id="external_builder_api.md" toc-title="External Builder API and Plugins"/>
</toc-element>
</toc-element>
<toc-element toc-title="Part VI - Testing">
<toc-element id="testing_plugins.md" accepts-web-file-names="testing_plugins.html" toc-title="Testing Plugins"/>
<toc-element id="tests_and_fixtures.md" toc-title="Tests and Fixtures"/>
<toc-element id="light_and_heavy_tests.md" toc-title="Light and Heavy Tests"/>
<toc-element id="test_project_and_testdata_directories.md" toc-title="Test Project and Testdata Directories"/>
<toc-element id="writing_tests.md" toc-title="Writing Tests"/>
<toc-element id="testing_highlighting.md" toc-title="Testing Highlighting"/>
</toc-element>
<toc-element toc-title="Part VII - Custom Languages">
<toc-element id="custom_language_support.md" toc-title="Custom Language Support">
<toc-element id="registering_file_type.md" toc-title="Registering File Type"/>
<toc-element id="implementing_lexer.md" toc-title="Implementing Lexer"/>
<toc-element id="implementing_parser_and_psi.md" toc-title="Implementing Parser and PSI"/>
<toc-element id="syntax_highlighting_and_error_highlighting.md"
toc-title="Syntax Highlighting and Error Highlighting"/>
<toc-element id="references_and_resolve.md" toc-title="References and Resolve"/>
<toc-element id="symbols.md" toc-title="Symbols"/>
<toc-element id="declarations_and_references.md" toc-title="Declarations and References"/>
<toc-element id="navigation.md" toc-title="Navigation"/>
<toc-element id="code_completion.md" toc-title="Code Completion"/>
<toc-element id="find_usages.md" toc-title="Find Usages"/>
<toc-element id="rename_refactoring.md" toc-title="Rename Refactoring"/>
<toc-element id="safe_delete_refactoring.md" toc-title="Safe Delete Refactoring"/>
<toc-element id="code_formatting.md" toc-title="Code Formatter"/>
<toc-element id="code_inspections_and_intentions.md" toc-title="Code Inspections and Intentions"/>
<toc-element id="structure_view.md" toc-title="Structure View"/>
<toc-element id="surround_with.md" toc-title="Surround With"/>
<toc-element id="go_to_class_and_go_to_symbol.md" toc-title="Go to Class and Go to Symbol"/>
<toc-element id="documentation.md" toc-title="Documentation"/>
<toc-element id="additional_minor_features.md" toc-title="Additional Minor Features"/>
<toc-element toc-title="Parameter Info"/>
<toc-element toc-title="Parameter Hints"/>
</toc-element>
<toc-element id="custom_language_support_tutorial.md" toc-title="Custom Language Support Tutorial">
<toc-element id="prerequisites.md" toc-title="1. Prerequisites"/>
<toc-element id="language_and_filetype.md" toc-title="2. Language and File Type"/>
<toc-element id="grammar_and_parser.md" toc-title="3. Grammar and Parser"/>
<toc-element id="lexer_and_parser_definition.md" toc-title="4. Lexer and Parser Definition"/>
<toc-element id="syntax_highlighter_and_color_settings_page.md"
toc-title="5. Syntax Highlighter and Color Settings Page"/>
<toc-element id="psi_helper_and_utilities.md" toc-title="6. PSI Helpers and Utilities"/>
<toc-element id="annotator.md" toc-title="7. Annotator"/>
<toc-element id="line_marker_provider.md" toc-title="8. Line Marker Provider"/>
<toc-element id="completion_contributor.md" toc-title="9. Completion Contributor"/>
<toc-element id="reference_contributor.md" toc-title="10. Reference Contributor"/>
<toc-element id="find_usages_provider.md" toc-title="11. Find Usages Provider"/>
<toc-element id="folding_builder.md" toc-title="12. Folding Builder"/>
<toc-element id="go_to_symbol_contributor.md" toc-title="13. Go To Symbol Contributor"/>
<toc-element id="structure_view_factory.md" toc-title="14. Structure View Factory"/>
<toc-element id="formatter.md" toc-title="15. Formatter"/>
<toc-element id="code_style_settings.md" toc-title="16. Code Style Settings"/>
<toc-element id="commenter.md" toc-title="17. Commenter"/>
<toc-element id="quick_fix.md" toc-title="18. Quick Fix"/>
</toc-element>
<toc-element id="writing_tests_for_plugins.md" toc-title="Testing a Custom Language Plugin">
<toc-element id="tests_prerequisites.md" toc-title="1. Tests Prerequisites"/>
<toc-element id="parsing_test.md" toc-title="2. Parsing Test"/>
<toc-element id="completion_test.md" toc-title="3. Completion Test"/>
<toc-element id="annotator_test.md" toc-title="4. Annotator Test"/>
<toc-element id="formatter_test.md" toc-title="5. Formatter Test"/>
<toc-element id="rename_test.md" toc-title="6. Rename Test"/>
<toc-element id="folding_test.md" toc-title="7. Folding Test"/>
<toc-element id="find_usages_test.md" toc-title="8. Find Usages Test"/>
<toc-element id="commenter_test.md" toc-title="9. Commenter Test"/>
<toc-element id="reference_test.md" toc-title="10. Reference Test"/>
</toc-element>
<toc-element toc-title="Injected Languages"/>
<toc-element toc-title="Build System"/>
<toc-element toc-title="Compiler"/>
<toc-element toc-title="Debugger"/>
</toc-element>
<toc-element toc-title="Part VIII - Product Specific">
<toc-element id="build_number_ranges.md" toc-title="Build Number Ranges"/>
<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"/>
<toc-element id="android_studio.md" toc-title="Android Studio"/>
<toc-element id="app_code.md" toc-title="AppCode"/>
<toc-element id="clion.md" toc-title="CLion"/>
<toc-element id="data_grip.md" toc-title="DataGrip"/>
<toc-element id="goland.md" toc-title="GoLand"/>
<toc-element id="idea.md" toc-title="IntelliJ IDEA">
<toc-element id="tomcat_integration.md" toc-title="Tomcat Integration"/>
<toc-element id="spring_api.md" toc-title="Spring API"/>
</toc-element>
<toc-element id="phpstorm.md" accepts-web-file-names="phpstorm.html,setting_up_environment.html"
toc-title="PhpStorm">
<toc-element id="php_open_api.md" accepts-web-file-names="php_open_api.html"
toc-title="Working with the PHP Open API">
<toc-element id="php_open_api_breaking_changes.md" toc-title="Breaking Changes">
<toc-element id="php_open_api_breaking_changes_203.md" toc-title="2020.3"/>
<toc-element id="php_open_api_breaking_changes_202.md" toc-title="2020.2"/>
</toc-element>
</toc-element>
<toc-element id="existing_plugins.md" accepts-web-file-names="existing_plugins.html"
toc-title="Existing Third Party Plugins"/>
</toc-element>
<toc-element id="pycharm.md" toc-title="PyCharm"/>
<toc-element id="rider.md" toc-title="Rider"/>
<toc-element id="rubymine.md" toc-title="RubyMine"/>
<toc-element id="webstorm.md" toc-title="WebStorm"/>
</toc-element>
<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 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 id="glossary.md" toc-title="Glossary"/>
<toc-element id="extension_point_list.md" toc-title="Extension Point List"/>
<toc-element id="useful_links.md" accepts-web-file-names="resources.html" toc-title="Useful Links"/>
<toc-element id="marketing.md" toc-title="Marketing"/>
<toc-element id="consulting.md" toc-title="Consulting"/>
</toc-element>
<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_2021.md" toc-title="2021.*"/>
<toc-element id="api_changes_list_2020.md" toc-title="2020.*"/>
<toc-element id="api_changes_list_2019.md" toc-title="2019.*"/>
<toc-element id="api_changes_list_2018.md" toc-title="2018.*"/>
<toc-element id="api_changes_list_2017.md" toc-title="2017.*"/>
<toc-element id="api_changes_list_2016.md" toc-title="2016.*"/>
</toc-element>
<toc-element id="api_notable.md" toc-title="Notable API Changes">
<toc-element id="api_notable_list_2021.md" toc-title="2021.*"/>
<toc-element id="api_notable_list_2020.md" toc-title="2020.*"/>
<toc-element id="api_notable_list_2019.md" toc-title="2019.*"/>
<toc-element id="api_notable_list_2018.md" toc-title="2018.*"/>
</toc-element>
</toc-element>
</product-profile>

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

Before

Width:  |  Height:  |  Size: 110 KiB

After

Width:  |  Height:  |  Size: 110 KiB

View File

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 47 KiB

View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

View File

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 47 KiB

View File

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 70 KiB

View File

Before

Width:  |  Height:  |  Size: 134 KiB

After

Width:  |  Height:  |  Size: 134 KiB

View File

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

View File

Before

Width:  |  Height:  |  Size: 4.2 KiB

After

Width:  |  Height:  |  Size: 4.2 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

Before

Width:  |  Height:  |  Size: 28 KiB

After

Width:  |  Height:  |  Size: 28 KiB

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

Before

Width:  |  Height:  |  Size: 112 KiB

After

Width:  |  Height:  |  Size: 112 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB

View File

Before

Width:  |  Height:  |  Size: 95 KiB

After

Width:  |  Height:  |  Size: 95 KiB

View File

Before

Width:  |  Height:  |  Size: 252 KiB

After

Width:  |  Height:  |  Size: 252 KiB

View File

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 76 KiB

View File

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 63 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 7.3 KiB

After

Width:  |  Height:  |  Size: 7.3 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

Before

Width:  |  Height:  |  Size: 322 KiB

After

Width:  |  Height:  |  Size: 322 KiB

View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

View File

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

View File

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 72 KiB

View File

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View File

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View File

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

1
images/info Normal file
View File

@ -0,0 +1 @@
Store your code snippets here

View File

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 53 KiB

View File

Before

Width:  |  Height:  |  Size: 452 KiB

After

Width:  |  Height:  |  Size: 452 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

View File

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

View File

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 45 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

View File

Before

Width:  |  Height:  |  Size: 6.9 KiB

After

Width:  |  Height:  |  Size: 6.9 KiB

View File

Before

Width:  |  Height:  |  Size: 6.5 KiB

After

Width:  |  Height:  |  Size: 6.5 KiB

View File

Before

Width:  |  Height:  |  Size: 3.4 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

View File

Before

Width:  |  Height:  |  Size: 5.8 KiB

After

Width:  |  Height:  |  Size: 5.8 KiB

View File

Before

Width:  |  Height:  |  Size: 432 B

After

Width:  |  Height:  |  Size: 432 B

View File

Before

Width:  |  Height:  |  Size: 837 B

After

Width:  |  Height:  |  Size: 837 B

View File

Before

Width:  |  Height:  |  Size: 836 B

After

Width:  |  Height:  |  Size: 836 B

View File

Before

Width:  |  Height:  |  Size: 432 B

After

Width:  |  Height:  |  Size: 432 B

View File

Before

Width:  |  Height:  |  Size: 8.2 KiB

After

Width:  |  Height:  |  Size: 8.2 KiB

View File

Before

Width:  |  Height:  |  Size: 5.9 KiB

After

Width:  |  Height:  |  Size: 5.9 KiB

View File

Before

Width:  |  Height:  |  Size: 182 KiB

After

Width:  |  Height:  |  Size: 182 KiB

View File

Before

Width:  |  Height:  |  Size: 162 KiB

After

Width:  |  Height:  |  Size: 162 KiB

View File

Before

Width:  |  Height:  |  Size: 132 KiB

After

Width:  |  Height:  |  Size: 132 KiB

View File

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View File

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 36 KiB

View File

Before

Width:  |  Height:  |  Size: 135 KiB

After

Width:  |  Height:  |  Size: 135 KiB

View File

Before

Width:  |  Height:  |  Size: 146 KiB

After

Width:  |  Height:  |  Size: 146 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

Some files were not shown because too many files have changed in this diff Show More