模板:Documentation/doc

出自 Arch Linux 中文维基
此模板使用了模塊:Documentation,這些腳本均使用Lua編寫。
更多詳情,請參閱維基百科:LuaMediaWiki:擴展:Scribunto

對於模板,在末尾插入{{subst:doc}},然後保存頁面,這將放置{{documentation}}和一條建議編輯者在何處放置類別和interwiki連結的評論。對於其他類型的頁面,文檔模板應該存在。

單擊頁面頂部的「創建」將打開文檔頁面,並帶有某些預格式化。也可以使用文檔頁面上的{{subst:doc}}創建這種格式。

文檔頁面將自動添加到Category:文檔頁面。 使用不帶subst:{{doc}}會將頁面添加到Category:需要替換模板的頁面

可選參數[編輯原始碼]

創建頁面時,可以將此參數添加到 {{subst:doc}}模板中,也可以添加到{{documentation}}模板。

type[編輯原始碼]

設置文檔的「type」,例如模板、模塊、消息等。這將用作模板可能顯示的某些消息以及分類的一部分。

type是基於命名空間的自動類型,因此通常無需設置。

page[編輯原始碼]

文檔所在的頁面。默認為當前頁面的子頁面,稱為「doc」。

content[編輯原始碼]

允許直接指定文檔內容,而不是在單獨的子頁面上。 對於特定於小型頁面的子頁面模板很有用,例如中文Minecraft Wiki的爆炸/table

nodoc[編輯原始碼]

如果模板沒有文檔,並且你不知道如何使用它,請在文檔頁面上的文檔模板中添加nodoc=1。文檔的背景將變為紅色以使其引人注意,並且將頁面添加到類別中。

如果文檔頁面不存在或為空,則會自動設置,因此通常不需要設置。

baddoc[編輯原始碼]

與nodoc相似,它用於標記文檔的模板,但不是很好。這可能意味著它沒有足夠的示例,未正確解釋所有功能或未正確解釋模板的要點。文檔的背景將變為黃色以使其更引人注目,並且頁面將添加到類別中。由於沒有安裝DPL3,需要在模板和模板文檔同時指定該參數。