模板:Documentation/doc

出自H萌娘
< Template:Documentation
於 2017年3月26日 (日) 10:42 由 imported>梦蝶葬花 所做的修訂 (创建页面,内容为“<!-- 在本行下編輯模板說明 --> <noinclude>這個模板用來建立一些重要模板的說明文件。包括本模板。 {{Template:High-risk|250+}} </noinc...”)
(差異) ←上個修訂 | 最新修訂 (差異) | 下個修訂→ (差異)
跳至導覽 跳至搜尋

這個模板用來建立一些重要模板的說明文件。包括本模板。

本模板已應用於250+頁面。
為避免大規模的破壞0及不必要的伺服器負荷,任何改動均應先在模板的沙盒頁面或您自己的用戶頁測試,經過測試後即可一次性改動本模板。為尊重其他用戶,任何改動在生效前都應先在討論頁討論。

本模板已應用於250+頁面。
為避免大規模的破壞0及不必要的伺服器負荷,任何改動均應先在模板的沙盒頁面或您自己的用戶頁測試,經過測試後即可一次性改動本模板。為尊重其他用戶,任何改動在生效前都應先在討論頁討論。


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

使用Template:Documentation能夠將模板及其頁面分離,從而避免內聯文檔的缺點。

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

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

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

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

內聯文檔


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

  • 參數1默認值是Template:Documentation/doc/doc。
  • 參數content默認值為空。

分類

  • 要將模板本身置於一個分類中,如果該文檔具有/doc子頁面,請在/doc子頁面上的 <includeonly>...</includeonly> 段落中添加分類。若沒有/doc子頁面,請在模板頁上的 <noinclude>...</noinclude> 段落中添加分類。模板的分類參見Category:頁面模板
  • 要將 /doc 子頁面置於一個分類中,請在 /doc 子頁面上的 <noinclude>...</noinclude> 段落中添加分類。文檔子頁面的分類應該只有Category:模板說明文件