mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-30 02:07:50 +08:00
284 lines
16 KiB
Markdown
284 lines
16 KiB
Markdown
# 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)
|
|
* [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)
|
|
* [Internal Actions](reference_guide/internal_actions/interal_actions_menu.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)
|
|
* [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)
|
|
* [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)
|
|
* [Useful Links](appendix/resources/useful_links.md)
|
|
* [Consulting](appendix/resources/consulting.md)
|
|
|
|
## Appendix II - API Changes
|
|
|
|
* [Incompatible API Changes](reference_guide/api_changes_list.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)
|
|
* [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)
|