From ec9fdde4511dfeb7e849f3a63c4d1496363d23a7 Mon Sep 17 00:00:00 2001
From: Ryan Wang <i@ryanc.cc>
Date: Mon, 9 Dec 2024 19:21:34 +0800
Subject: [PATCH] fix: correct getByNames method examples for category and tag
 api (#483)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

修复 categoryFinder 和 tagFinder 关于 getByNames 的错误示例。

Fixes https://github.com/halo-dev/docs/issues/475

```release-note
None
```
---
 docs/developer-guide/theme/finder-apis/category.md     | 10 +++++++++-
 docs/developer-guide/theme/finder-apis/contributor.md  |  2 +-
 docs/developer-guide/theme/finder-apis/tag.md          | 10 +++++++++-
 .../developer-guide/theme/finder-apis/category.md      |  2 +-
 .../developer-guide/theme/finder-apis/contributor.md   |  2 +-
 .../developer-guide/theme/finder-apis/tag.md           |  2 +-
 .../developer-guide/theme/finder-apis/category.md      |  2 +-
 .../developer-guide/theme/finder-apis/contributor.md   |  2 +-
 .../developer-guide/theme/finder-apis/tag.md           |  2 +-
 .../developer-guide/theme/finder-apis/category.md      |  2 +-
 .../developer-guide/theme/finder-apis/contributor.md   |  2 +-
 .../developer-guide/theme/finder-apis/tag.md           |  2 +-
 .../developer-guide/theme/finder-apis/category.md      |  2 +-
 .../developer-guide/theme/finder-apis/contributor.md   |  2 +-
 .../developer-guide/theme/finder-apis/tag.md           |  2 +-
 .../developer-guide/theme/finder-apis/category.md      | 10 +++++++++-
 .../developer-guide/theme/finder-apis/contributor.md   |  2 +-
 .../developer-guide/theme/finder-apis/tag.md           | 10 +++++++++-
 18 files changed, 50 insertions(+), 18 deletions(-)

diff --git a/docs/developer-guide/theme/finder-apis/category.md b/docs/developer-guide/theme/finder-apis/category.md
index 8b83cdbc..ab6abe16 100644
--- a/docs/developer-guide/theme/finder-apis/category.md
+++ b/docs/developer-guide/theme/finder-apis/category.md
@@ -12,6 +12,10 @@ import CategoryTreeVo from "../vo/_CategoryTreeVo.md"
 categoryFinder.getByName(name)
 ```
 
+:::info 提示
+通常建议配合 [主题设置](../settings.md) 和 [分类选择器](../../form-schema.md#categoryselect) 使用，让用户自行选择所需的分类。
+:::
+
 ### 描述
 
 根据 `metadata.name` 获取文章分类。
@@ -38,6 +42,10 @@ categoryFinder.getByName(name)
 categoryFinder.getByNames(names)
 ```
 
+:::info 提示
+通常建议配合 [主题设置](../settings.md) 和 [分类选择器](../../form-schema.md#categoryselect) 使用，让用户自行选择所需的分类。
+:::
+
 ### 描述
 
 根据一组 `metadata.name` 获取文章分类。
@@ -53,7 +61,7 @@ List\<[#CategoryVo](#categoryvo)\>
 ### 示例
 
 ```html
-<div th:with="categories = ${categoryFinder.getByNames(['category-foo', 'category-bar'])}">
+<div th:with="categories = ${categoryFinder.getByNames({'category-foo', 'category-bar'})}">
   <a th:each="category : ${categories}" th:href="@{${category.status.permalink}}" th:text="${category.spec.displayName}"></a>
 </div>
 ```
diff --git a/docs/developer-guide/theme/finder-apis/contributor.md b/docs/developer-guide/theme/finder-apis/contributor.md
index c39db576..675aec86 100644
--- a/docs/developer-guide/theme/finder-apis/contributor.md
+++ b/docs/developer-guide/theme/finder-apis/contributor.md
@@ -52,7 +52,7 @@ List\<[#ContributorVo](#contributorvo)\>
 ### 示例
 
 ```html
-<div th:with="contributors = ${contributorFinder.getContributors(['contributor-foo, 'contributor-bar'])}">
+<div th:with="contributors = ${contributorFinder.getContributors({'contributor-foo, 'contributor-bar'})}">
   <span th:each="contributor : ${contributors}" th:text="${contributor.displayName}"></span>
 </div>
 ```
diff --git a/docs/developer-guide/theme/finder-apis/tag.md b/docs/developer-guide/theme/finder-apis/tag.md
index c8bee355..05a605a6 100644
--- a/docs/developer-guide/theme/finder-apis/tag.md
+++ b/docs/developer-guide/theme/finder-apis/tag.md
@@ -11,6 +11,10 @@ import TagVo from "../vo/_TagVo.md"
 tagFinder.getByName(name)
 ```
 
+:::info 提示
+通常建议配合 [主题设置](../settings.md) 和 [标签选择器](../../form-schema.md#tagselect) 使用，让用户自行选择所需的标签。
+:::
+
 ### 描述
 
 根据 `metadata.name` 获取标签。
@@ -37,6 +41,10 @@ tagFinder.getByName(name)
 tagFinder.getByNames(names)
 ```
 
+:::info 提示
+通常建议配合 [主题设置](../settings.md) 和 [标签选择器](../../form-schema.md#tagselect) 使用，让用户自行选择所需的标签。
+:::
+
 ### 描述
 
 根据一组 `metadata.name` 获取标签。
@@ -52,7 +60,7 @@ List\<[#TagVo](#tagvo)\>
 ### 示例
 
 ```html
-<div th:with="tags = ${tagFinder.getByNames(['tag-foo', 'tag-bar'])}">
+<div th:with="tags = ${tagFinder.getByNames({'tag-foo', 'tag-bar'})}">
   <a th:each="tag : ${tags}" th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
 </div>
 ```
diff --git a/versioned_docs/version-2.16/developer-guide/theme/finder-apis/category.md b/versioned_docs/version-2.16/developer-guide/theme/finder-apis/category.md
index 2c3bea56..2bdeb1fa 100644
--- a/versioned_docs/version-2.16/developer-guide/theme/finder-apis/category.md
+++ b/versioned_docs/version-2.16/developer-guide/theme/finder-apis/category.md
@@ -53,7 +53,7 @@ List\<[#CategoryVo](#categoryvo)\>
 ### 示例
 
 ```html
-<div th:with="categories = ${categoryFinder.getByNames(['category-foo', 'category-bar'])}">
+<div th:with="categories = ${categoryFinder.getByNames({'category-foo', 'category-bar'})}">
   <a th:each="category : ${categories}" th:href="@{${category.status.permalink}}" th:text="${category.spec.displayName}"></a>
 </div>
 ```
diff --git a/versioned_docs/version-2.16/developer-guide/theme/finder-apis/contributor.md b/versioned_docs/version-2.16/developer-guide/theme/finder-apis/contributor.md
index c39db576..675aec86 100644
--- a/versioned_docs/version-2.16/developer-guide/theme/finder-apis/contributor.md
+++ b/versioned_docs/version-2.16/developer-guide/theme/finder-apis/contributor.md
@@ -52,7 +52,7 @@ List\<[#ContributorVo](#contributorvo)\>
 ### 示例
 
 ```html
-<div th:with="contributors = ${contributorFinder.getContributors(['contributor-foo, 'contributor-bar'])}">
+<div th:with="contributors = ${contributorFinder.getContributors({'contributor-foo, 'contributor-bar'})}">
   <span th:each="contributor : ${contributors}" th:text="${contributor.displayName}"></span>
 </div>
 ```
diff --git a/versioned_docs/version-2.16/developer-guide/theme/finder-apis/tag.md b/versioned_docs/version-2.16/developer-guide/theme/finder-apis/tag.md
index c8bee355..43bfddc3 100644
--- a/versioned_docs/version-2.16/developer-guide/theme/finder-apis/tag.md
+++ b/versioned_docs/version-2.16/developer-guide/theme/finder-apis/tag.md
@@ -52,7 +52,7 @@ List\<[#TagVo](#tagvo)\>
 ### 示例
 
 ```html
-<div th:with="tags = ${tagFinder.getByNames(['tag-foo', 'tag-bar'])}">
+<div th:with="tags = ${tagFinder.getByNames({'tag-foo', 'tag-bar'})}">
   <a th:each="tag : ${tags}" th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
 </div>
 ```
diff --git a/versioned_docs/version-2.17/developer-guide/theme/finder-apis/category.md b/versioned_docs/version-2.17/developer-guide/theme/finder-apis/category.md
index 8b83cdbc..d331a05e 100644
--- a/versioned_docs/version-2.17/developer-guide/theme/finder-apis/category.md
+++ b/versioned_docs/version-2.17/developer-guide/theme/finder-apis/category.md
@@ -53,7 +53,7 @@ List\<[#CategoryVo](#categoryvo)\>
 ### 示例
 
 ```html
-<div th:with="categories = ${categoryFinder.getByNames(['category-foo', 'category-bar'])}">
+<div th:with="categories = ${categoryFinder.getByNames({'category-foo', 'category-bar'})}">
   <a th:each="category : ${categories}" th:href="@{${category.status.permalink}}" th:text="${category.spec.displayName}"></a>
 </div>
 ```
diff --git a/versioned_docs/version-2.17/developer-guide/theme/finder-apis/contributor.md b/versioned_docs/version-2.17/developer-guide/theme/finder-apis/contributor.md
index c39db576..675aec86 100644
--- a/versioned_docs/version-2.17/developer-guide/theme/finder-apis/contributor.md
+++ b/versioned_docs/version-2.17/developer-guide/theme/finder-apis/contributor.md
@@ -52,7 +52,7 @@ List\<[#ContributorVo](#contributorvo)\>
 ### 示例
 
 ```html
-<div th:with="contributors = ${contributorFinder.getContributors(['contributor-foo, 'contributor-bar'])}">
+<div th:with="contributors = ${contributorFinder.getContributors({'contributor-foo, 'contributor-bar'})}">
   <span th:each="contributor : ${contributors}" th:text="${contributor.displayName}"></span>
 </div>
 ```
diff --git a/versioned_docs/version-2.17/developer-guide/theme/finder-apis/tag.md b/versioned_docs/version-2.17/developer-guide/theme/finder-apis/tag.md
index c8bee355..43bfddc3 100644
--- a/versioned_docs/version-2.17/developer-guide/theme/finder-apis/tag.md
+++ b/versioned_docs/version-2.17/developer-guide/theme/finder-apis/tag.md
@@ -52,7 +52,7 @@ List\<[#TagVo](#tagvo)\>
 ### 示例
 
 ```html
-<div th:with="tags = ${tagFinder.getByNames(['tag-foo', 'tag-bar'])}">
+<div th:with="tags = ${tagFinder.getByNames({'tag-foo', 'tag-bar'})}">
   <a th:each="tag : ${tags}" th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
 </div>
 ```
diff --git a/versioned_docs/version-2.18/developer-guide/theme/finder-apis/category.md b/versioned_docs/version-2.18/developer-guide/theme/finder-apis/category.md
index 8b83cdbc..d331a05e 100644
--- a/versioned_docs/version-2.18/developer-guide/theme/finder-apis/category.md
+++ b/versioned_docs/version-2.18/developer-guide/theme/finder-apis/category.md
@@ -53,7 +53,7 @@ List\<[#CategoryVo](#categoryvo)\>
 ### 示例
 
 ```html
-<div th:with="categories = ${categoryFinder.getByNames(['category-foo', 'category-bar'])}">
+<div th:with="categories = ${categoryFinder.getByNames({'category-foo', 'category-bar'})}">
   <a th:each="category : ${categories}" th:href="@{${category.status.permalink}}" th:text="${category.spec.displayName}"></a>
 </div>
 ```
diff --git a/versioned_docs/version-2.18/developer-guide/theme/finder-apis/contributor.md b/versioned_docs/version-2.18/developer-guide/theme/finder-apis/contributor.md
index c39db576..675aec86 100644
--- a/versioned_docs/version-2.18/developer-guide/theme/finder-apis/contributor.md
+++ b/versioned_docs/version-2.18/developer-guide/theme/finder-apis/contributor.md
@@ -52,7 +52,7 @@ List\<[#ContributorVo](#contributorvo)\>
 ### 示例
 
 ```html
-<div th:with="contributors = ${contributorFinder.getContributors(['contributor-foo, 'contributor-bar'])}">
+<div th:with="contributors = ${contributorFinder.getContributors({'contributor-foo, 'contributor-bar'})}">
   <span th:each="contributor : ${contributors}" th:text="${contributor.displayName}"></span>
 </div>
 ```
diff --git a/versioned_docs/version-2.18/developer-guide/theme/finder-apis/tag.md b/versioned_docs/version-2.18/developer-guide/theme/finder-apis/tag.md
index c8bee355..43bfddc3 100644
--- a/versioned_docs/version-2.18/developer-guide/theme/finder-apis/tag.md
+++ b/versioned_docs/version-2.18/developer-guide/theme/finder-apis/tag.md
@@ -52,7 +52,7 @@ List\<[#TagVo](#tagvo)\>
 ### 示例
 
 ```html
-<div th:with="tags = ${tagFinder.getByNames(['tag-foo', 'tag-bar'])}">
+<div th:with="tags = ${tagFinder.getByNames({'tag-foo', 'tag-bar'})}">
   <a th:each="tag : ${tags}" th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
 </div>
 ```
diff --git a/versioned_docs/version-2.19/developer-guide/theme/finder-apis/category.md b/versioned_docs/version-2.19/developer-guide/theme/finder-apis/category.md
index 8b83cdbc..d331a05e 100644
--- a/versioned_docs/version-2.19/developer-guide/theme/finder-apis/category.md
+++ b/versioned_docs/version-2.19/developer-guide/theme/finder-apis/category.md
@@ -53,7 +53,7 @@ List\<[#CategoryVo](#categoryvo)\>
 ### 示例
 
 ```html
-<div th:with="categories = ${categoryFinder.getByNames(['category-foo', 'category-bar'])}">
+<div th:with="categories = ${categoryFinder.getByNames({'category-foo', 'category-bar'})}">
   <a th:each="category : ${categories}" th:href="@{${category.status.permalink}}" th:text="${category.spec.displayName}"></a>
 </div>
 ```
diff --git a/versioned_docs/version-2.19/developer-guide/theme/finder-apis/contributor.md b/versioned_docs/version-2.19/developer-guide/theme/finder-apis/contributor.md
index c39db576..675aec86 100644
--- a/versioned_docs/version-2.19/developer-guide/theme/finder-apis/contributor.md
+++ b/versioned_docs/version-2.19/developer-guide/theme/finder-apis/contributor.md
@@ -52,7 +52,7 @@ List\<[#ContributorVo](#contributorvo)\>
 ### 示例
 
 ```html
-<div th:with="contributors = ${contributorFinder.getContributors(['contributor-foo, 'contributor-bar'])}">
+<div th:with="contributors = ${contributorFinder.getContributors({'contributor-foo, 'contributor-bar'})}">
   <span th:each="contributor : ${contributors}" th:text="${contributor.displayName}"></span>
 </div>
 ```
diff --git a/versioned_docs/version-2.19/developer-guide/theme/finder-apis/tag.md b/versioned_docs/version-2.19/developer-guide/theme/finder-apis/tag.md
index c8bee355..43bfddc3 100644
--- a/versioned_docs/version-2.19/developer-guide/theme/finder-apis/tag.md
+++ b/versioned_docs/version-2.19/developer-guide/theme/finder-apis/tag.md
@@ -52,7 +52,7 @@ List\<[#TagVo](#tagvo)\>
 ### 示例
 
 ```html
-<div th:with="tags = ${tagFinder.getByNames(['tag-foo', 'tag-bar'])}">
+<div th:with="tags = ${tagFinder.getByNames({'tag-foo', 'tag-bar'})}">
   <a th:each="tag : ${tags}" th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
 </div>
 ```
diff --git a/versioned_docs/version-2.20/developer-guide/theme/finder-apis/category.md b/versioned_docs/version-2.20/developer-guide/theme/finder-apis/category.md
index 8b83cdbc..ab6abe16 100644
--- a/versioned_docs/version-2.20/developer-guide/theme/finder-apis/category.md
+++ b/versioned_docs/version-2.20/developer-guide/theme/finder-apis/category.md
@@ -12,6 +12,10 @@ import CategoryTreeVo from "../vo/_CategoryTreeVo.md"
 categoryFinder.getByName(name)
 ```
 
+:::info 提示
+通常建议配合 [主题设置](../settings.md) 和 [分类选择器](../../form-schema.md#categoryselect) 使用，让用户自行选择所需的分类。
+:::
+
 ### 描述
 
 根据 `metadata.name` 获取文章分类。
@@ -38,6 +42,10 @@ categoryFinder.getByName(name)
 categoryFinder.getByNames(names)
 ```
 
+:::info 提示
+通常建议配合 [主题设置](../settings.md) 和 [分类选择器](../../form-schema.md#categoryselect) 使用，让用户自行选择所需的分类。
+:::
+
 ### 描述
 
 根据一组 `metadata.name` 获取文章分类。
@@ -53,7 +61,7 @@ List\<[#CategoryVo](#categoryvo)\>
 ### 示例
 
 ```html
-<div th:with="categories = ${categoryFinder.getByNames(['category-foo', 'category-bar'])}">
+<div th:with="categories = ${categoryFinder.getByNames({'category-foo', 'category-bar'})}">
   <a th:each="category : ${categories}" th:href="@{${category.status.permalink}}" th:text="${category.spec.displayName}"></a>
 </div>
 ```
diff --git a/versioned_docs/version-2.20/developer-guide/theme/finder-apis/contributor.md b/versioned_docs/version-2.20/developer-guide/theme/finder-apis/contributor.md
index c39db576..675aec86 100644
--- a/versioned_docs/version-2.20/developer-guide/theme/finder-apis/contributor.md
+++ b/versioned_docs/version-2.20/developer-guide/theme/finder-apis/contributor.md
@@ -52,7 +52,7 @@ List\<[#ContributorVo](#contributorvo)\>
 ### 示例
 
 ```html
-<div th:with="contributors = ${contributorFinder.getContributors(['contributor-foo, 'contributor-bar'])}">
+<div th:with="contributors = ${contributorFinder.getContributors({'contributor-foo, 'contributor-bar'})}">
   <span th:each="contributor : ${contributors}" th:text="${contributor.displayName}"></span>
 </div>
 ```
diff --git a/versioned_docs/version-2.20/developer-guide/theme/finder-apis/tag.md b/versioned_docs/version-2.20/developer-guide/theme/finder-apis/tag.md
index c8bee355..05a605a6 100644
--- a/versioned_docs/version-2.20/developer-guide/theme/finder-apis/tag.md
+++ b/versioned_docs/version-2.20/developer-guide/theme/finder-apis/tag.md
@@ -11,6 +11,10 @@ import TagVo from "../vo/_TagVo.md"
 tagFinder.getByName(name)
 ```
 
+:::info 提示
+通常建议配合 [主题设置](../settings.md) 和 [标签选择器](../../form-schema.md#tagselect) 使用，让用户自行选择所需的标签。
+:::
+
 ### 描述
 
 根据 `metadata.name` 获取标签。
@@ -37,6 +41,10 @@ tagFinder.getByName(name)
 tagFinder.getByNames(names)
 ```
 
+:::info 提示
+通常建议配合 [主题设置](../settings.md) 和 [标签选择器](../../form-schema.md#tagselect) 使用，让用户自行选择所需的标签。
+:::
+
 ### 描述
 
 根据一组 `metadata.name` 获取标签。
@@ -52,7 +60,7 @@ List\<[#TagVo](#tagvo)\>
 ### 示例
 
 ```html
-<div th:with="tags = ${tagFinder.getByNames(['tag-foo', 'tag-bar'])}">
+<div th:with="tags = ${tagFinder.getByNames({'tag-foo', 'tag-bar'})}">
   <a th:each="tag : ${tags}" th:href="@{${tag.status.permalink}}" th:text="${tag.spec.displayName}"></a>
 </div>
 ```