模板:Documentation/doc

{{Documentation}} 模板用於顯示某個模板的幫助文檔，通常從 /doc 子頁面加載。它包含兩部分：上方的"文檔框"（顯示文檔內容 + [查看][編輯][歷史][清除緩存]工具欄）和下方的"鏈接框"（顯示嵌入來源、沙盒/測試樣例鏈接等元數據）。

使用本模板可以讓模板本身得到保護，同時允許任何人編輯文檔和分類。

用法

基本語法

將以下代碼放在模板代碼末尾的 <noinclude> 之前：

<!-- 模板最后一行 --><noinclude>
{{Documentation}}
</noinclude>

嵌入其他頁面

通過第一個參數指定不同的文檔頁：

<noinclude>
{{Documentation|Template:其他页面/doc}}
</noinclude>

使用 content 參數

直接嵌入文檔內容（此時不顯示 [查看][編輯] 工具欄）：

<noinclude>
{{Documentation|content=这是一个文档。}}
</noinclude>

當同時指定 |1= 和 |content= 時，|content= 優先顯示在文檔框中。

高級語法

自定義標題

默認標題根據命名空間自動顯示"模板文檔"或"模塊文檔"。可通過 |heading= 自定義。 設為 |heading=（空值）則不顯示標題欄。

自定義鏈接框

通過 |link box= 自定義鏈接框內容。設為 off 則隱藏鏈接框。

測試

通過 |page= 參數模擬在某頁面的顯示效果，例如 |page=Template:Infobox。

放置位置和分類

此代碼應放在模板代碼末尾，<noinclude> 之前不要有多餘空格（否則會出現在使用該模板的頁面上）。 用於模板本身的分類應寫在 /doc 子頁面的 <includeonly> </includeonly> 標籤中。

請勿在 /doc 子頁面中再次使用 {{Documentation}}，以避免出錯。

完整語法

{{Documentation
| 1 = 文档页面路径（可选）
| content = 直接嵌入的文档（可选）
| heading = 自定义标题（可选）
| heading-style = 标题的 CSS 样式（可选）
| link box = 自定义链接框（可选，设为 off 则隐藏）
| page = 模拟页面（可选，仅测试用）
}}

模板數據

以下是該模板的模板數據，適用於可視化編輯器等工具。

Documentation模板數據

顯示一個模板的使用說明

模板參數

參數		描述	類型	狀態
模板的使用說明所在頁面	1	標示該模板的使用說明所在頁面名稱 預設 {{PAGENAME}}/doc 範例 Template:Documentation/doc	頁面名稱	非必填
模板的使用說明內容	content	以所寫的使用說明內容取代該模板的/doc子頁面 範例 這是這個模板的使用說明	內容	非必填

重定向

• {{Template:Documentation}}
• {{Template:Documentation}}