模板:Documentation

出自Bejeweled Wiki
跳至導覽 跳至搜尋

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

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

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

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

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

內聯文檔

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

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


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

模板數據

向頁面嵌入說明文檔,並以一定樣式加以標記。

模板參數

參數描述類型狀態
待嵌入頁面名1

待嵌入的文檔頁面名。嵌入Template命名空間的頁面時需要加上Template:前綴。

預設
<當前頁面名>/doc
頁面名稱非必填
內聯文檔內容content

內聯文檔的內容。會使參數1失效(即覆蓋嵌入的內容)。

內容非必填
文檔類型type

文檔類型。會使文檔框標題的內容變成「<type>文檔」。

預設
在Template名字空間中:「模板」

在Module名字空間中:「模塊」

在其餘名字空間中:「頁面」
非必填

模板別名