模板:Documentation

模板文檔  

這個文檔嵌入自Template:Documentation/doc。

本模板已應用於1000+頁面。
為避免大規模的破壞及不必要的伺服器負荷，任何改動均應先在模板的沙盒頁面或您自己的用戶頁測試，經過測試後即可一次性改動本模板。為尊重其他用戶，任何改動在生效前都應先在討論頁討論。

這個模板用來顯示和格式化一些重要模板的說明文件，包括你正在閱讀的本文。

Template:Documentation既可以用來嵌入/doc子頁面，也可以用來進行內聯嵌入；同時，將有一定的樣式來標記文檔部分。

使用Template:Documentation能夠將模板及其頁面分離，從而避免內聯文檔的缺點（如被鎖定後無法編輯說明、只選一個目錄編輯可能會被系統誤判為無限遞歸使用等）。

使用方法極其簡單，僅需在模板的最後加入<noinclude>{{Documentation}}</noinclude>即可，然後在模板下方就會出現文檔內容。

注意，請確保<noinclude>的開頭直接接在模板原始碼或文字的最後一行後方，不要新起一行。否則，一個多餘的新行會插入到包含該模板的頁面中，往往該頁面不需要這個新行。

點擊創建就能在模板的/doc子頁面中創建所需的文檔。創建完以後模板頁就會自動包含這個文檔，效果即如本文檔般。

內聯文檔

雖然不推薦內聯文檔，但是對於一些短小的文檔，內聯的確更加方便。這時候可以使用該模板的content屬性：

<noinclude>{{Documentation|content=
内联文档
}}</noinclude>

同樣地，請確保<noinclude>的開頭直接接在模板原始碼或文字的最後一行後方，不要新起一行。

• 參數1的默認值是{{Documentation/docname}}；其解析為「（頁面名字）/doc」。例如，在本頁面（Template:Documentation）下，參數1的默認值是Template:Documentation/doc。
• 參數content的默認值為空。en:Template:Documentationja:Template:Documentation