Help:模板數據
外观
模板數據擴展引進了<templatedata>
標籤及相應的API資源,可供其他擴展及系統(如可視化編輯器)可以取用其元數據,並製作一個表格,可於頁面上向終端用戶顯示。
目前模板數據不支援中文版繁簡轉換。
用途
目前用途是在模板說明頁上顯示有關該模板的信息,以及在可視化編輯器的模板編輯模組中,顯示有關模板的描述,並提供可供選用的參數清單。
加入說明
請在模板的/doc頁面中任何一個位置(如沒有/doc頁面,可改為在模板本身頁面的noinclude區域加入)加入下列內容:
<templatedata>
{
模板數據內容
}
</templatedata>
之後,再加入有關模板的描述,如此例子:
<templatedata>
{
"description": "此模板用於……",
}
</templatedata>
注意description一字需保持為英語。然後,再加入有關模板參數的說明:
"params": {
... <-- 參數資料
}
模板參數的說明需要填寫的資料包括:
資料名稱(請保持英語) | 說明 | 內容是否在引號("")內 |
---|---|---|
label | 人類可以明白的信息 | 是 |
description | 該參數的描述 | 是 |
type | 參數應輸入的內容,可供填入的內容包括:
|
是 |
required | 該參數是否為必要,如為必需,請填入true,否則請填入false | 否 |