模板:Documentation/doc

這是說明文件頁面，它應該被放置到模板:Documentation。查看Template:Documentation以取得更多資訊。

Lua

此模板使用了模塊:Documentation，此腳本使用 Lua 編寫。

當前模板用於輸出模板或者模塊的文檔頁面。

如果頁面不存在文檔，可以通過點擊提示欄的創建會打開創建文檔的編輯頁面。打開頁面後，會自動附帶默認文檔頁面的模板。

文檔頁面會被自動添加到分類:文檔頁面下。

可選參數

引入 {{Documentation}} 模板時，可以傳入以下參數。

設置文檔的類型，例如模板、模塊等。

默認情況下，type 會根據命名空間的自動設置，因此通常無需手動指定。

文檔所在的頁面。默認為當前頁面的 doc 子頁面。

直接指定文檔的內容，將文檔的內容嵌入到本體頁面，不單獨創建新的子頁面。一般在比較小的模板上使用。

如果模板文檔缺失，並且編輯者不清楚如何使用，則可添加 nodoc=1。文檔的背景會被設置為紅色，並且頁面會被添加到下面的分類之中。

如果文檔頁面不存在或著為空時會自動判斷，一般情況下不需要手動設置。

和 nodoc 類似，baddoc 用於標記有文檔但文檔質量一般的模板（沒有示例等）。文檔的背景會被設置為黃色，並且頁面會被添加到下面的分類之中。