什麼是模板資料?
模板資料(TemplateData)是視覺化編輯器的一部分,能夠改善使用者編輯模板時的體驗。視覺化編輯器中包含了一個編輯模板的輔助介面,但為了要讓這個介面更加有用,介面需要向使用者顯示關於每個模板的特定資訊,例如模板的簡要說明,以及其中各參數的意義等。這些資訊即是透過模板資料提供。
有模板資料時
有模板資料時,將會顯示模板支持的參數和其說明。 | |
每項參數之間的關係也將自動列明,可讓編輯模板變得更加簡單。 |
加入模板資料
任何人都能將模板資料加入至模板中(特別是經常被使用的資訊框模板),這將能讓模板在視覺化編輯器中更加容易使用和修改。以下是模板資料的簡單範例,可放置在模板的說明文件頁面中:
<templatedata>
{
"description": "在此輸入模板簡要的說明",
"params": {
"第一個參數": {
"label": "在此輸入參數標籤(例如:電影片名)",
"description": "在此輸入參數的詳細說明(例如:請輸入電影的中文片名,不需加上斜體記號或書名號)",
"type": "string",
"default": "default value",
"required": false
}
}
}
</templatedata>