Help:模板數據

模板數據擴展引進了<templatedata>標籤及相應的API資源，可供其他擴展及系統（如可視化編輯器）可以取用其元數據，並製作一個表格，可於頁面上向終端用戶顯示。

目前模板數據不支援中文版繁簡轉換。

用途

目前用途是在模板說明頁上顯示有關該模板的信息，以及在可視化編輯器的模板編輯模組中，顯示有關模板的描述，並提供可供選用的參數清單。

加入說明

請在模板的/doc頁面中任何一個位置（如沒有/doc頁面，可改為在模板本身頁面的noinclude區域加入）加入下列內容：

<templatedata>
{
模板數據內容
}
</templatedata>

之後，再加入有關模板的描述，如此例子：

<templatedata>
{
"description": "此模板用於……",
}
</templatedata>

注意description一字需保持為英語。然後，再加入有關模板參數的說明：

"params": {
                ...            <-- 參數資料
        }

模板參數的說明需要填寫的資料包括：

資料名稱（請保持英語）	說明	內容是否在引號（""）內
label	人類可以明白的信息	是
description	該參數的描述	是
type	參數應輸入的內容，可供填入的內容包括： string: 任何內容 number: 任何數字 string/wiki-user-name: 任何維基用戶名 string/wiki-page-name: 任何頁面名	是
required	該參數是否為必要，如為必需，請填入true，否則請填入false	否
default	該參數不填入時預設會顯示的內容	是
aliases	該參數的其他輸入方法	是
inherits	參照另一個參數	是

以下為一個例子：

<templatedata>
{
        "description": "這個模板是香港發佈熱帶氣旋警告信號模板，適用於各熱帶氣旋條目中。",
        "params": {
                "1": {
                        "label": "警告信號",
                        "type": "string",
                        "required": true,
                        "description": "警告信號級別"
                }
        }
}
</templatedata>

注意事項

• 最後一個填入的項目之後，不能加入逗號（即,），否則會報錯。
• 如果填入的內容有任何錯誤，您將不能夠保存編輯。
• MediaWiki.org提供更詳細的說明。
• 加入「模板數據」後，你可能需要在模板主頁面中（即不帶/doc的頁面）進行一次空編輯以強制系統更新JSON信息（清除缓存無效）；否則，內容可能需要幾個小時甚至幾天才能在可視化編輯器中呈現。

編輯工具

TemplateDataEditor

User:NicoV開發了一個名為TemplateDataEditor的編輯工具，允許用戶在模板加入「模板數據」資料，唯有關工具目前不提供中文版。有關安裝該工具的指引，請參閱英文版的說明。