帮助:模板数据

帮助页面

什么是模板数据?

模板数据(TemplateData)是可视化编辑器的一部分,能够改善用户编辑模板时的体验。可视化编辑器中包含了一个编辑模板的辅助界面,但为了要让这个界面更加有用,界面需要向用户显示关于每个模板的特定信息,例如模板的简要说明,以及其中各参数的意义等。这些信息即是通过模板数据提供。

有模板数据时

有模板数据时,将会显示模板支持的参数和其说明。
可视化编辑器中模板的编辑界面(在有模板数据时).png

每项参数之间的关系也将自动列明,可让编辑模板变得更加简单。
可视化编辑器中模板的编辑界面【已填写】(在有模板数据时).png

加入模板数据

任何人都能将模板数据加入至模板中(特别是经常被使用的信息框模板),这将能让模板在可视化编辑器中更加容易使用和修改。以下是模板数据的简单示例,可放置在模板的帮助文档页面中:

<templatedata>
{
  "description": "在此输入模板简要的说明",
  "params": {
    "第一个参数": {
      "label": "在此输入参数标籤(例如:电影片名)",
      "description": "在此输入参数的详细说明(例如:请输入电影的中文片名,不需加上斜体记号或书名号)",
      "type": "string",
      "default": "default value",
      "required": false
    }
  }
}
</templatedata>