模板:Documentation/doc

出自魔学
W​(留言 | 貢獻)2023年3月31日 (五) 22:53的修訂 (创建页面,内容为“Template:Documentation既可以用来嵌入'''/doc'''子页面,也可以用来进行内联嵌入;同时,将有一定的样式来标记文档部分。 使用Template:Documentation能够将模板及其页面分离,从而避免'''内联文档'''的缺点(如被锁定后无法编辑说明、只选一个目录编辑可能会被系统误判为无限递归使用等)。 使用方法极其简单,仅需在模板的最后加入<code><nowiki><noinclude>{{Do…”)
(差異) ←上個修訂 | 最新修訂 (差異) | 下個修訂→ (差異)

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

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

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

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

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

內聯文檔

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

<noinclude>{{Documentation|content=
内联文档
}}</noinclude>
模板文檔  [編輯]

內聯文檔

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

  • 參數1的默認值是{{Documentation/docname}};其解析為「(頁面名字)/doc」。例如,在本頁面(Template:Documentation/doc)下,參數1的默認值是Template:Documentation/doc/doc。
  • 參數content的默認值為空。