用戶:Ycc/沙盒/BGDWiki:模板指引

本指引介紹BGDWiki中模板頁面普遍遵循的格式規範。

組成部分

BGDWiki的模板頁面主要由模板說明和模板代碼兩部分組成。

模板說明包含該模板的模板文檔、模板分類兩部分。使用<noinclude>......</noinclude></code>與模板代碼部分分隔開。

模板文檔

模板文檔是對模板的詳細介紹，包含以下三個部分：

模板用途：對模板適用以及不適用的情況作以說明。
模板參數：對模板中所有可用參數及其參數格式、參數含義、可選情況等內容作以說明。
模板示例：展示該模板實際樣式。應儘量包含所有的可用參數。

模板文檔通常使用{{Documentation}}</code>或{{Doc}}</code>嵌入模板頁，詳見：模板:Documentation

模板分類

BGDWiki要求每個模板都應有至少一個模板分類，以便管理與查找所有模板。
（模板分類待補充）

結語

模板是BGDWiki的重要組成部分，對於模板的修改往往會導致大量頁面的變動。建議各位編者在編輯模板時先前往沙盒頁面進行測試，待修改無誤後再次添加。如有進一步的問題或困難，歡迎前往Help:互助客棧提問。