diff --git a/topics/basics/basic_action_system.md b/topics/basics/basic_action_system.md index 153cb86c3..40e8c9a75 100644 --- a/topics/basics/basic_action_system.md +++ b/topics/basics/basic_action_system.md @@ -201,7 +201,7 @@ To exclude a group from appearing in Help | Find Action res #### Localizing Actions and Groups Action and group localization use resource bundles containing property files named $NAME$Bundle.properties, each file consisting of `key=value` pairs. -The [`action_basics`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/action_basics) plugin demonstrates using a resource bundle to localize the group and action entries added to the Editor Popup Menu. +The [`action_basics`](%gh-sdk-samples%/action_basics) plugin demonstrates using a resource bundle to localize the group and action entries added to the Editor Popup Menu. When localizing actions and groups, the `text` and `description` attributes are not declared in plugin.xml. Instead, those attribute values vary depending on the locale and get declared in a resource bundle. diff --git a/topics/basics/plugin_structure/plugin_services.md b/topics/basics/plugin_structure/plugin_services.md index 1fdcc4aae..e0b597d46 100644 --- a/topics/basics/plugin_structure/plugin_services.md +++ b/topics/basics/plugin_structure/plugin_services.md @@ -149,7 +149,7 @@ public final class ProjectService { ## Sample Plugin -To clarify how to use services, consider the **maxOpenProjects** sample plugin available in the [code samples](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/max_opened_projects). +To clarify how to use services, consider the **maxOpenProjects** sample plugin available in the [code samples](%gh-sdk-samples%/max_opened_projects). This plugin has an application service counting the number of currently opened projects in the IDE. If this number exceeds the maximum number of simultaneously opened projects allowed by the plugin (3), it displays a warning message. diff --git a/topics/products/pycharm/pycharm.md b/topics/products/pycharm/pycharm.md index 304ab3840..6bd7bb994 100644 --- a/topics/products/pycharm/pycharm.md +++ b/topics/products/pycharm/pycharm.md @@ -25,7 +25,7 @@ Click on an entry in the table's *Attribute* column to go to the documentation a The dependency on the PyCharm APIs must be declared in the plugin.xml file. As described in [Configuring the plugin.xml File](dev_alternate_products.md#configuring-pluginxml), the `` tags must declare `com.intellij.modules.python`. -See the SDK code sample [`pycharm_basics`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/product_specific/pycharm_basics/) for an example configuration. +See the SDK code sample [`pycharm_basics`](%gh-sdk-samples%/product_specific/pycharm_basics/) for an example configuration. Please note that this code sample must be imported into Gradle explicitly, as it is not included in the `_gradleCompositeBuild`. ## Available PyCharm APIs diff --git a/topics/reference_guide/project_model/facet.md b/topics/reference_guide/project_model/facet.md index 03e3ef6c9..ae2545472 100644 --- a/topics/reference_guide/project_model/facet.md +++ b/topics/reference_guide/project_model/facet.md @@ -9,7 +9,7 @@ E.g. Spring Framework specific configuration is stored in a Spring facet. For more information about facets see [Adding Support for Frameworks and Technologies](https://www.jetbrains.com/help/idea/adding-support-for-frameworks-and-technologies.html) and the help page for the [Facets dialog](https://www.jetbrains.com/help/idea/facet-page.html) in the IntelliJ IDEA Web Help. ## Facet Basics Sample -Please see [Facet Basics](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/facet_basics) sample plugin project. +Please see [Facet Basics](%gh-sdk-samples%/facet_basics) sample plugin project. ## Working with Facets diff --git a/topics/reference_guide/project_model/sdk.md b/topics/reference_guide/project_model/sdk.md index 5183aa3f0..2d2e2cc3d 100644 --- a/topics/reference_guide/project_model/sdk.md +++ b/topics/reference_guide/project_model/sdk.md @@ -42,7 +42,7 @@ Sdk projectSdk = ProjectRootManager.getInstance(project).getProjectSdk(); ProjectRootManager.getInstance(project).setProjectSdkName(name); ``` -See the [project_model](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/project_model/src/main/java/org/intellij/sdk/project/model/ProjectSdkAction.java) code sample to get more familiar with SDK manipulation toolset. +See the [project_model](%gh-sdk-samples%/project_model/src/main/java/org/intellij/sdk/project/model/ProjectSdkAction.java) code sample to get more familiar with SDK manipulation toolset. ## Available SDKs diff --git a/topics/reference_guide/work_with_icons_and_images.md b/topics/reference_guide/work_with_icons_and_images.md index 44d00c5b3..6a40433e9 100644 --- a/topics/reference_guide/work_with_icons_and_images.md +++ b/topics/reference_guide/work_with_icons_and_images.md @@ -21,7 +21,7 @@ If custom icons are required, please refer to detailed [design guide](https://je ## How to organize and how to use icons? -> See [Action Basics](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/action_basics) sample plugin as reference. +> See [Action Basics](%gh-sdk-samples%/action_basics) sample plugin as reference. > {type="tip"} diff --git a/topics/tutorials/action_system.md b/topics/tutorials/action_system.md index 2036a396d..663f76666 100644 --- a/topics/tutorials/action_system.md +++ b/topics/tutorials/action_system.md @@ -7,4 +7,4 @@ By registering actions, you can add your own menu items, toolbar buttons and key * [Creating Actions](working_with_custom_actions.md) * [Grouping Actions](grouping_action.md) -The source code for the [`action_basics`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/action_basics) code sample is used throughout this tutorial. +The source code for the [`action_basics`](%gh-sdk-samples%/action_basics) code sample is used throughout this tutorial. diff --git a/topics/tutorials/action_system/grouping_action.md b/topics/tutorials/action_system/grouping_action.md index 4fbe4619e..860600895 100644 --- a/topics/tutorials/action_system/grouping_action.md +++ b/topics/tutorials/action_system/grouping_action.md @@ -4,7 +4,7 @@ If an implementation requires several actions, or there are simply too many actions that overload the menu, the actions can be placed into groups. This tutorial demonstrates adding an action to an existing group, creating a new action group, and action groups with a variable number of actions. -The sample code discussed in this tutorial is from the code sample [`action_basics`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/action_basics). +The sample code discussed in this tutorial is from the code sample [`action_basics`](%gh-sdk-samples%/action_basics). Some content in this tutorial assumes the reader is familiar with the tutorial for [Creating Actions](working_with_custom_actions.md). diff --git a/topics/tutorials/action_system/working_with_custom_actions.md b/topics/tutorials/action_system/working_with_custom_actions.md index cd39f42b6..fa92418a9 100644 --- a/topics/tutorials/action_system/working_with_custom_actions.md +++ b/topics/tutorials/action_system/working_with_custom_actions.md @@ -8,7 +8,7 @@ Plugins can add actions to existing IDE menus and toolbars, as well as add new m The IntelliJ Platform calls the actions of plugins in response to user interactions with the IDE. However, the actions of a plugin must first be defined and registered with the IntelliJ Platform. -Using the SDK code sample [`action_basics`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/action_basics), this tutorial illustrates the steps to create an action for a plugin. +Using the SDK code sample [`action_basics`](%gh-sdk-samples%/action_basics), this tutorial illustrates the steps to create an action for a plugin. ## Creating a Custom Action diff --git a/topics/tutorials/code_inspections.md b/topics/tutorials/code_inspections.md index 48df62978..29c1aad98 100644 --- a/topics/tutorials/code_inspections.md +++ b/topics/tutorials/code_inspections.md @@ -4,7 +4,7 @@ The IntelliJ Platform provides tools designed for static code analysis called _code inspections_, which help the user maintain and clean up code without actually executing it. Custom code inspections can be implemented as IntelliJ Platform plugins. -Examples of the plugin approach are the IntelliJ Platform SDK code samples [inspection_basics](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/inspection_basics) and [comparing_references_inspection](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/comparing_references_inspection). +Examples of the plugin approach are the IntelliJ Platform SDK code samples [inspection_basics](%gh-sdk-samples%/inspection_basics) and [comparing_references_inspection](%gh-sdk-samples%/comparing_references_inspection). In addition, the comparing_references_inspection code sample demonstrates implementing a unit test. You can also create custom inspections through the IntelliJ IDEA user interface. @@ -14,7 +14,7 @@ See [Inspections](https://jetbrains.design/intellij/text/inspections/) topic in ## Creating an Inspection Plugin -The [comparing_references_inspection](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/comparing_references_inspection) code sample adds a new inspection to the Java | Probable Bugs group in the [Inspections list](https://www.jetbrains.com/help/idea/inspections-settings.html). +The [comparing_references_inspection](%gh-sdk-samples%/comparing_references_inspection) code sample adds a new inspection to the Java | Probable Bugs group in the [Inspections list](https://www.jetbrains.com/help/idea/inspections-settings.html). The inspection reports when the `==` or `!=` operator is used between Java expressions of reference types. It illustrates the components for a custom inspection plugin: @@ -46,7 +46,7 @@ See also [](explore_api.md) for more information and strategies. ## Creating an Inspection -The [comparing_references_inspection](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/comparing_references_inspection) code sample reports when the `==` or `!=` operators are used between Java expressions of reference types. +The [comparing_references_inspection](%gh-sdk-samples%/comparing_references_inspection) code sample reports when the `==` or `!=` operators are used between Java expressions of reference types. The user can apply a quick fix to change `a==b` to `a.equals(b)`, or `a!=b` to `!a.equals(b)`. The details of the `comparing_references_inspection` implementation illustrate the components of an inspection plugin. @@ -164,7 +164,7 @@ The `comparing_references_inspection` tests run the inspection on the ∗. ## Running the Comparing References Inspection Code Sample -The [comparing_references_inspection](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/comparing_references_inspection) code sample adds a new inspection to the Java | Probable Bugs group in the [Inspections List](https://www.jetbrains.com/help/idea/inspections-settings.html). +The [comparing_references_inspection](%gh-sdk-samples%/comparing_references_inspection) code sample adds a new inspection to the Java | Probable Bugs group in the [Inspections List](https://www.jetbrains.com/help/idea/inspections-settings.html). See [](code_samples.md) on how to set up and run the plugin. diff --git a/topics/tutorials/code_intentions.md b/topics/tutorials/code_intentions.md index 467a47f9b..07ec3321b 100644 --- a/topics/tutorials/code_intentions.md +++ b/topics/tutorials/code_intentions.md @@ -2,7 +2,7 @@ -This topic describes the [conditional_operator_intention](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/conditional_operator_intention), a sample plugin that adds a new [intention action](https://www.jetbrains.com/help/idea/intention-actions.html) to the IDE Intentions list. +This topic describes the [conditional_operator_intention](%gh-sdk-samples%/conditional_operator_intention), a sample plugin that adds a new [intention action](https://www.jetbrains.com/help/idea/intention-actions.html) to the IDE Intentions list. In addition, the sample plugin contains a JUnit-based test. ## About Intention Actions @@ -17,7 +17,7 @@ You can view a list of all available intention actions as well as enable/disable ## Techniques Used -The [conditional_operator_intention](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/conditional_operator_intention) sample plugin illustrates the use of the following techniques: +The [conditional_operator_intention](%gh-sdk-samples%/conditional_operator_intention) sample plugin illustrates the use of the following techniques: - How to analyze a [PSI tree](psi_files.md). - How to find a Java token of interest in the PSI tree. diff --git a/topics/tutorials/custom_language_support/custom_language_support_tutorial.md b/topics/tutorials/custom_language_support/custom_language_support_tutorial.md index 3347f0617..76bf9b60e 100644 --- a/topics/tutorials/custom_language_support/custom_language_support_tutorial.md +++ b/topics/tutorials/custom_language_support/custom_language_support_tutorial.md @@ -12,7 +12,7 @@ In this tutorial we will add support for a [.properties](https://en.wikipedia.or {type="tip"} -> The complete and fully working example plugin used in this tutorial is the [`simple_language_plugin`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/simple_language_plugin) code sample. +> The complete and fully working example plugin used in this tutorial is the [`simple_language_plugin`](%gh-sdk-samples%/simple_language_plugin) code sample. > See [](code_samples.md) on how to build and run it. > {type="note"} diff --git a/topics/tutorials/custom_language_support/quick_fix.md b/topics/tutorials/custom_language_support/quick_fix.md index 6438a76b5..585afb7d2 100644 --- a/topics/tutorials/custom_language_support/quick_fix.md +++ b/topics/tutorials/custom_language_support/quick_fix.md @@ -21,7 +21,7 @@ A new overload of `createProperty()` creates a new `key`-`value` pair for Simple ## Define an Intention Action The `SimpleCreatePropertyQuickFix` creates a property in the file chosen by the user - in this case, a Java file containing a `prefix:key` - and navigate to this property after creation. Under the hood, `SimpleCreatePropertyQuickFix` is an Intention Action. -For a more in-depth example of an Intention Action, see [`conditional_operator_intention`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/conditional_operator_intention). +For a more in-depth example of an Intention Action, see [`conditional_operator_intention`](%gh-sdk-samples%/conditional_operator_intention). ```java ``` diff --git a/topics/tutorials/editor_basics.md b/topics/tutorials/editor_basics.md index a370b72d1..2867071b4 100644 --- a/topics/tutorials/editor_basics.md +++ b/topics/tutorials/editor_basics.md @@ -12,7 +12,7 @@ For operations that require access to the PSI please see the [PSI Cookbook](psi_ **See also:** The following are referenced in the tutorial: -* The [editor_basics](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/editor_basics/) plugin code sample, +* The [editor_basics](%gh-sdk-samples%/editor_basics/) plugin code sample, * [editor-ui-api package](%gh-ic%/platform/editor-ui-api), * Those not found in editor-ui-api package: * [`EditorActionManager`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/EditorActionManager.java), diff --git a/topics/tutorials/editor_basics/coordinates_system.md b/topics/tutorials/editor_basics/coordinates_system.md index da239a23e..17336c117 100644 --- a/topics/tutorials/editor_basics/coordinates_system.md +++ b/topics/tutorials/editor_basics/coordinates_system.md @@ -10,7 +10,7 @@ This tutorial describes how to access information about the caret(s) in an edito ## Introduction -In this tutorial, the [editor_basics](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/editor_basics) code sample is used to explore caret positions. +In this tutorial, the [editor_basics](%gh-sdk-samples%/editor_basics) code sample is used to explore caret positions. In particular, the **Caret Position** action added by `editor_basics` to the editor context menu is used to retrieve information about the current caret position. A keyboard shortcut can also initiate the action. diff --git a/topics/tutorials/editor_basics/editor_events.md b/topics/tutorials/editor_basics/editor_events.md index 0386c157b..d81f3fa3c 100644 --- a/topics/tutorials/editor_basics/editor_events.md +++ b/topics/tutorials/editor_basics/editor_events.md @@ -5,13 +5,13 @@ The previous tutorial [Editor Coordinate Systems](coordinates_system.md) described working with caret coordinate systems in an editor window. Caret position was discussed in terms of Logical Position, Visual Position, and Offset. This tutorial introduces the Editor Action system, which handles actions activated by keystroke events in the editor. -Two classes from the [editor_basics](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/editor_basics) code sample are used to illustrate: +Two classes from the [editor_basics](%gh-sdk-samples%/editor_basics) code sample are used to illustrate: * Using an IntelliJ Platform [`EditorActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/EditorActionHandler.java) to manipulate a caret. * Creating and registering a custom [`TypedActionHandler`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/editor/actionSystem/TypedActionHandler.java) to intercept keystrokes and change the document. ## Using an IntelliJ Platform EditorActionHandler -In this portion of the tutorial, the [editor_basics](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/editor_basics) code sample is used to demonstrate cloning an existing caret. +In this portion of the tutorial, the [editor_basics](%gh-sdk-samples%/editor_basics) code sample is used to demonstrate cloning an existing caret. A custom action class will use `EditorActionManager` to access a specific `EditorActionHandler` for caret cloning. The `editor_basics` code sample adds an **Editor Add Caret** menu item to the editor context menu: diff --git a/topics/tutorials/editor_basics/working_with_text.md b/topics/tutorials/editor_basics/working_with_text.md index 913e2a467..120145e96 100644 --- a/topics/tutorials/editor_basics/working_with_text.md +++ b/topics/tutorials/editor_basics/working_with_text.md @@ -10,7 +10,7 @@ Using information about the caret, replace selected text in a document with a st The approach in this tutorial relies heavily on creating and registering actions. To review the fundamentals of creating and registering actions, refer to the [Actions Tutorial](action_system.md). -Multiple examples are used from the [editor_basics](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/editor_basics) plugin code sample from the IntelliJ Platform SDK. +Multiple examples are used from the [editor_basics](%gh-sdk-samples%/editor_basics) plugin code sample from the IntelliJ Platform SDK. It may be helpful to open that project in an IntelliJ Platform-based IDE, build the project, run it, select some text in the editor, and invoke the **Editor Replace Text** menu item on the editor context menu. ![Editor Basics Menu](basics.png){width="600"} diff --git a/topics/tutorials/framework.md b/topics/tutorials/framework.md index e86b35c67..1b5c9b69c 100644 --- a/topics/tutorials/framework.md +++ b/topics/tutorials/framework.md @@ -3,7 +3,7 @@ The following tutorial shows how to support a custom framework type for a project and make this framework type embedded in a project wizard as a UI component. -The examples in this tutorial rely heavily on the [framework_basics](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/framework_basics) code sample. +The examples in this tutorial rely heavily on the [framework_basics](%gh-sdk-samples%/framework_basics) code sample. ## Creating a New Framework diff --git a/topics/tutorials/kotlin.md b/topics/tutorials/kotlin.md index c75d82284..436e81419 100644 --- a/topics/tutorials/kotlin.md +++ b/topics/tutorials/kotlin.md @@ -37,7 +37,7 @@ To learn more about building IntelliJ Platform plugins with Kotlin, this tutoria > The [IntelliJ Platform Plugin Template](github_template.md) provides a preconfigured project using Kotlin. > -> See also [kotlin_demo](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/kotlin_demo) for a minimal sample plugin. +> See also [kotlin_demo](%gh-sdk-samples%/kotlin_demo) for a minimal sample plugin. > {type="tip"} @@ -85,7 +85,7 @@ Please see [Third-Party Software and Licenses](https://www.jetbrains.com/legal/t Plugins using the [Gradle Build System](gradle_build_system.md) use the [Kotlin JVM Gradle plugin](https://kotlinlang.org/docs/gradle.html#targeting-the-jvm). -See the build.gradle.kts from [kotlin_demo](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/kotlin_demo) sample plugin: +See the build.gradle.kts from [kotlin_demo](%gh-sdk-samples%/kotlin_demo) sample plugin: ```kotlin ``` diff --git a/topics/tutorials/live_templates/new_macros.md b/topics/tutorials/live_templates/new_macros.md index 5878708be..ae6e15eae 100644 --- a/topics/tutorials/live_templates/new_macros.md +++ b/topics/tutorials/live_templates/new_macros.md @@ -7,7 +7,7 @@ However, sometimes the Predefined Functions are not enough. This tutorial illustrates how to add custom functions to an IntelliJ Platform plugin and make them available for use by Live Templates. As an example, a function is created to convert a selection to Title Case. -Refer to the SDK code sample [`live_templates`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/live_templates). +Refer to the SDK code sample [`live_templates`](%gh-sdk-samples%/live_templates). ## Implementing a New Function @@ -26,7 +26,7 @@ Three `TitleCaseMacro` methods are of particular interest: ## Adding a Live Template -Using the procedures previously discussed for [Template Creation](template_support.md#template-creation) and [Export the Live Template](template_support.md#export-the-live-template), add a Live Template to the [Markdown.xml](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/live_templates/src/main/resources/liveTemplates) file for the plugin. +Using the procedures previously discussed for [Template Creation](template_support.md#template-creation) and [Export the Live Template](template_support.md#export-the-live-template), add a Live Template to the [Markdown.xml](%gh-sdk-samples%/live_templates/src/main/resources/liveTemplates) file for the plugin. The XML representation of an example Live Template using the new `titleCase` function is listed below. There is only one variable, `TITLE`. diff --git a/topics/tutorials/live_templates/template_support.md b/topics/tutorials/live_templates/template_support.md index 9799d4893..df43ae01b 100644 --- a/topics/tutorials/live_templates/template_support.md +++ b/topics/tutorials/live_templates/template_support.md @@ -6,7 +6,7 @@ This tutorial illustrates how to add default Custom Live Templates to an Intelli In addition, the tutorial discusses how to export existing Live Templates, and bundle them within a plugin. Any Live Template that can be created and exported can be added to a plugin by following the Template Creation, Export, and Extension Point Registration processes. -This tutorial uses the SDK code sample [`live_templates`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/live_templates). +This tutorial uses the SDK code sample [`live_templates`](%gh-sdk-samples%/live_templates). ## Template Creation @@ -58,7 +58,7 @@ The export produces a file called Markdown.xml with the following c The display `name` can also provide localized variants by specifying `key` and `resource-bundle` attributes additionally (2020.3 and later). -Copy this file into the [plugin's resources folder](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/live_templates/src/main/resources/liveTemplates). +Copy this file into the [plugin's resources folder](%gh-sdk-samples%/live_templates/src/main/resources/liveTemplates). ## Implement TemplateContextType diff --git a/topics/tutorials/project_wizard/module_types.md b/topics/tutorials/project_wizard/module_types.md index 82bb289f6..67ea15e7b 100644 --- a/topics/tutorials/project_wizard/module_types.md +++ b/topics/tutorials/project_wizard/module_types.md @@ -6,7 +6,7 @@ IntelliJ Platform provides a set of standard module types. However, an application might need a module of a type that isn't supported yet. This tutorial shows how to register a new module type and link it to the project creation procedure and the UI. -The source code for the [`module`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/module) and [`project_wizard`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/project_wizard) code samples is used throughout this tutorial. +The source code for the [`module`](%gh-sdk-samples%/module) and [`project_wizard`](%gh-sdk-samples%/project_wizard) code samples is used throughout this tutorial. ## Pre-Requirements diff --git a/topics/tutorials/run_configurations.md b/topics/tutorials/run_configurations.md index 790b0e8f0..fb8902d04 100644 --- a/topics/tutorials/run_configurations.md +++ b/topics/tutorials/run_configurations.md @@ -6,7 +6,7 @@ These series of steps show how to register and implement a simple Run Configurat Run Configurations are used to run internal and external processes from within IntelliJ Platform based products. To get familiar with the concept of a Run Configuration refer [Run/Debug Configuration](https://www.jetbrains.com/idea/help/run-debug-configuration.html) section of [IntelliJ IDEA Web Help](https://www.jetbrains.com/idea/help/intellij-idea.html) -Consider the **runConfiguration** sample plugin available in the [code samples](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/run_configuration). +Consider the **runConfiguration** sample plugin available in the [code samples](%gh-sdk-samples%/run_configuration). See [Code Samples](code_samples.md) on how to set up and run the plugin. ## Pre-Requirements diff --git a/topics/tutorials/settings_tutorial.md b/topics/tutorials/settings_tutorial.md index 6540a5e8a..4b5dc452f 100644 --- a/topics/tutorials/settings_tutorial.md +++ b/topics/tutorials/settings_tutorial.md @@ -10,7 +10,7 @@ Custom Settings are displayed and function just like those native to the IDE. ## Overview of Custom Settings Implementation -Using the SDK code sample [`settings`](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/settings), this tutorial illustrates the steps to create custom Application-level Settings. +Using the SDK code sample [`settings`](%gh-sdk-samples%/settings), this tutorial illustrates the steps to create custom Application-level Settings. Many IntelliJ Platform Settings implementations use fewer classes, but the `settings` code sample factors the functionality into three classes for clarity: * The [`AppSettingsConfigurable`](%gh-sdk-samples%/settings/src/main/java/org/intellij/sdk/settings/AppSettingsConfigurable.java) is analogous to a Controller in the MVC model - it interacts with the other two Settings classes and the IntelliJ Platform, * The [`AppSettingsState`](%gh-sdk-samples%/settings/src/main/java/org/intellij/sdk/settings/AppSettingsState.java) is like a Model because it stores the Settings persistently, diff --git a/topics/tutorials/tree_structure_view.md b/topics/tutorials/tree_structure_view.md index d111a2a29..53b6d9b6b 100644 --- a/topics/tutorials/tree_structure_view.md +++ b/topics/tutorials/tree_structure_view.md @@ -4,7 +4,7 @@ This tutorial is meant to illustrate how the project tree structure view appearance can be modified programmatically. -This topic describes the [treeStructureProvider](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/tree_structure_provider) sample plugin. +This topic describes the [treeStructureProvider](%gh-sdk-samples%/tree_structure_provider) sample plugin. The steps below show how to filter out and keep visible only text files and directories in the Project View Panel. diff --git a/topics/tutorials/writing_tests_for_plugins/writing_tests_for_plugins.md b/topics/tutorials/writing_tests_for_plugins/writing_tests_for_plugins.md index fd195a181..9069e0f8e 100644 --- a/topics/tutorials/writing_tests_for_plugins/writing_tests_for_plugins.md +++ b/topics/tutorials/writing_tests_for_plugins/writing_tests_for_plugins.md @@ -10,7 +10,7 @@ This tutorial demonstrates how to write and run automated tests for a custom lan As an example, the plugin implemented in the [Custom Language Support Tutorial](custom_language_support_tutorial.md) is used to demonstrate functional test development. -The plugin and test code can be found in the [simple_language_plugin](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/simple_language_plugin) code sample. +The plugin and test code can be found in the [simple_language_plugin](%gh-sdk-samples%/simple_language_plugin) code sample. * [](tests_prerequisites.md) * [](parsing_test.md) diff --git a/topics/user_interface_components/tool_windows.md b/topics/user_interface_components/tool_windows.md index d2a488251..78217afe2 100644 --- a/topics/user_interface_components/tool_windows.md +++ b/topics/user_interface_components/tool_windows.md @@ -82,7 +82,7 @@ If closing tabs is enabled in general, a plugin can disable closing of specific ## Sample Plugin -To clarify how to develop plugins that create tool windows, consider the **toolWindow** sample plugin available in the [code samples](https://github.com/JetBrains/intellij-sdk-code-samples/tree/main/tool_window). +To clarify how to develop plugins that create tool windows, consider the **toolWindow** sample plugin available in the [code samples](%gh-sdk-samples%/tool_window). See [Code Samples](code_samples.md) on how to set up and run the plugin. diff --git a/v.list b/v.list index fa314df8c..77e48249d 100644 --- a/v.list +++ b/v.list @@ -6,7 +6,7 @@ - +