Improve URLs for live template topics (it may improve SEO)

This commit is contained in:
Karol Lewandowski 2024-12-06 11:19:51 +01:00
parent d15e687ba6
commit 06445844a0
4 changed files with 9 additions and 9 deletions

View File

@ -195,8 +195,8 @@
<toc-element topic="advanced_postfix_templates.md"/> <toc-element topic="advanced_postfix_templates.md"/>
</toc-element> </toc-element>
<toc-element topic="live_templates.md"> <toc-element topic="live_templates.md">
<toc-element topic="template_support.md"/> <toc-element topic="providing_live_templates.md" accepts-web-file-names="template-support.html"/>
<toc-element topic="new_macros.md"/> <toc-element topic="creating_live_template_functions.md" accepts-web-file-names="new-macros.html"/>
</toc-element> </toc-element>
<toc-element topic="file_and_code_templates.md" accepts-web-file-names="templates.html"> <toc-element topic="file_and_code_templates.md" accepts-web-file-names="templates.html">
<toc-element topic="providing_file_templates.md"/> <toc-element topic="providing_file_templates.md"/>

View File

@ -1,6 +1,6 @@
# Live Templates <!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<!-- Copyright 2000-2023 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
<link-summary>Live templates support overview.</link-summary> <link-summary>Live templates support overview.</link-summary>
@ -54,5 +54,5 @@ public void testMethod() {
For more information about creating Custom Live Templates, refer to the [corresponding documentation](https://www.jetbrains.com/idea/help/creating-and-editing-live-templates.html). For more information about creating Custom Live Templates, refer to the [corresponding documentation](https://www.jetbrains.com/idea/help/creating-and-editing-live-templates.html).
These sections describe how to add Live Templates, and their associated building blocks, to plugins. These sections describe how to add Live Templates, and their associated building blocks, to plugins.
* [Providing Live Templates](template_support.md) * [Providing Live Templates](providing_live_templates.md)
* [Creating New Functions for Live Templates](new_macros.md) * [Creating New Functions for Live Templates](creating_live_template_functions.md)

View File

@ -1,4 +1,4 @@
<!-- Copyright 2000-2024 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. --> <!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Creating New Functions for Live Templates # Creating New Functions for Live Templates
@ -18,7 +18,7 @@ A new custom function for Live Templates is implemented in `TitleCaseMacro`, whi
Three `TitleCaseMacro` methods are of particular interest: Three `TitleCaseMacro` methods are of particular interest:
* The `TitleCaseMacro()` constructor passes the name and description of the macro to the parent constructor. * The `TitleCaseMacro()` constructor passes the name and description of the macro to the parent constructor.
* The `isAcceptableInContext()` method tests whether the macro is available in the current context. * The `isAcceptableInContext()` method tests whether the macro is available in the current context.
The test relies on the [`MarkdownContext`](template_support.md#implement-templatecontexttype) object previously defined in the `live_templates` plugin. The test relies on the [`MarkdownContext`](providing_live_templates.md#implement-templatecontexttype) object previously defined in the `live_templates` plugin.
* The `calculateResult()` method gets invoked when the titleCase function is used in a Live Template. * The `calculateResult()` method gets invoked when the titleCase function is used in a Live Template.
The text to be capitalized is retrieved from the Live Template and converted to Title Case. The text to be capitalized is retrieved from the Live Template and converted to Title Case.
@ -28,7 +28,7 @@ Three `TitleCaseMacro` methods are of particular interest:
## Adding a Live Template ## 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](%gh-sdk-samples-master%/live_templates/src/main/resources/liveTemplates) file for the plugin. Using the procedures previously discussed for [Template Creation](providing_live_templates.md#template-creation) and [Export the Live Template](providing_live_templates#export-the-live-template), add a Live Template to the [Markdown.xml](%gh-sdk-samples-master%/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. The XML representation of an example Live Template using the new `titleCase` function is listed below.
There is only one variable, `TITLE`. There is only one variable, `TITLE`.