模板:Documentation/doc

出自希顶维基
於 2021年7月27日 (二) 22:40 由 QWERTY 52 38留言 | 貢獻 所做的修訂 (建立内容为“这个模板用来显示和格式化模板的说明文档(一般写在模板的<code>/doc</code>子页面),包括你正在阅读的本文。 {{tl|Documenta…”的新页面)
(差異) ←上個修訂 | 最新修訂 (差異) | 下個修訂→ (差異)

這個模板用來顯示和格式化模板的說明文檔(一般寫在模板的/doc子頁面),包括你正在閱讀的本文。

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

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

用法

這個模板用法非常簡單:

  1. 在主模板頁面底部添加<noinclude>{{doc}}</noinclude>
  2. 點擊「創建」鏈接,打開/doc子頁面,並在子頁面中填寫文檔。
  3. /doc子頁面的底部添加<noinclude>[[分类:模板文档]]</noinclude>

至於效果,如你所見,這個顯示在模板:Documentation頁面的文檔就是。

注意
  1. 模板主要內容的<includeonly></includeonly>與作為模板說明內容的<noinclude></noinclude>之間不要換行,否則模板使用時會出現莫名其妙的空格或空行。
  2. 推薦使用{{doc}}而不是{{Documentation}},因為前者更加簡潔明了且不易出現拼寫錯誤。

其他模板的文檔

你可以選擇顯示其他模板的文檔,免去搬運或重定向重複文檔的麻煩。

<noinclude>{{doc|模板:其他模板/doc}}</noinclude>

內聯文檔

內聯文檔是不顯示/doc子頁面內容,直接編寫的文檔。

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

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