mirror of
https://github.com/halo-dev/docs.git
synced 2025-10-18 00:13:43 +00:00
dd6cc4848a
为 [Halo 2.18](https://github.com/halo-dev/halo/releases/tag/v2.18.0) 更新文档。 /kind documentation ```release-note None ```
90 lines
3.1 KiB
Markdown
90 lines
3.1 KiB
Markdown
---
|
||
title: 元数据表单定义
|
||
---
|
||
|
||
在 Halo 2.0，所有的模型都包含了 `metadata.annotations` 字段，用于存储元数据信息。元数据信息可以用于存储一些自定义的信息，可以等同于扩展字段。此文档主要介绍如何在 Halo 中为具体的模型定义元数据编辑表单，至于如何在插件或者主题模板中使用，请看插件或者主题的文档。
|
||
|
||
定义元数据编辑表单同样使用 `FormKit Schema`，但和主题或插件的定义方式稍有不同，其中输入组件类型可参考 [表单定义](./form-schema.md)。
|
||
|
||
:::info 提示
|
||
因为 `metadata.annotations` 是一个键值都为字符串类型的对象，所以表单项的值必须为字符串类型。这就意味着，FormKit 的 `number`、`group`、`repeater` 等类型的输入组件都不能使用。
|
||
:::
|
||
|
||
## AnnotationSetting 资源定义方式
|
||
|
||
```yaml title="annotation-setting.yaml"
|
||
apiVersion: v1alpha1
|
||
kind: AnnotationSetting
|
||
metadata:
|
||
name: my-annotation-setting
|
||
spec:
|
||
targetRef:
|
||
group: content.halo.run
|
||
kind: Post
|
||
formSchema:
|
||
- $formkit: "text"
|
||
name: "download"
|
||
label: "下载地址"
|
||
- $formkit: "text"
|
||
name: "version"
|
||
label: "版本"
|
||
```
|
||
|
||
以上定义为文章模型添加了两个元数据字段，分别为 `download` 和 `version`，分别对应了下载地址和版本号，最终效果：
|
||
|
||
|
||
|
||
字段说明：
|
||
|
||
1. `metadata.name`：唯一标识，命名规范可参考 [metadata name](./plugin/api-reference/server/extension.md#metadata-name)，为了尽可能避免冲突，建议自定义前缀以及追加随机字符串，如：`theme-earth-post-wanfs5`。
|
||
2. `spec.targetRef`：模型的关联，即为哪个模型添加元数据表单，目前支持的模型可查看下方的列表。
|
||
3. `spec.formSchema`：表单的定义，使用 FormKit Schema 来定义。虽然我们使用的 YAML，但与 FormKit Schema 完全一致。
|
||
|
||
targetRef 支持列表：
|
||
|
||
| 对应模型 | group | kind |
|
||
| ---------- | ---------------- | ---------- |
|
||
| 文章 | content.halo.run | Post |
|
||
| 自定义页面 | content.halo.run | SinglePage |
|
||
| 文章分类 | content.halo.run | Category |
|
||
| 文章标签 | content.halo.run | Tag |
|
||
| 菜单项 | `""` | MenuItem |
|
||
| 用户 | `""` | User |
|
||
|
||
## 为多个模型定义表单
|
||
|
||
考虑到某些情况可能会同时为多个模型添加元数据表单，推荐在一个 `yaml` 文件中使用 `---` 来分割多个资源定义，如下：
|
||
|
||
```yaml title="annotation-setting.yaml"
|
||
apiVersion: v1alpha1
|
||
kind: AnnotationSetting
|
||
metadata:
|
||
name: my-annotation-setting
|
||
spec:
|
||
targetRef:
|
||
group: content.halo.run
|
||
kind: Post
|
||
formSchema:
|
||
- $formkit: "text"
|
||
name: "download"
|
||
label: "下载地址"
|
||
- $formkit: "text"
|
||
name: "version"
|
||
label: "版本"
|
||
|
||
---
|
||
|
||
apiVersion: v1alpha1
|
||
kind: AnnotationSetting
|
||
metadata:
|
||
name: my-annotation-setting
|
||
spec:
|
||
targetRef:
|
||
group: ""
|
||
kind: MenuItem
|
||
formSchema:
|
||
- $formkit: "text"
|
||
name: "icon"
|
||
label: "图标"
|
||
```
|