模板:Documentation

模板文檔[查看] [編輯] [查看歷史] [清除緩存]

概要

{{Documentation}} 模板自動顯示「模板文檔」框，就像你現在看到的這樣，文檔框中的內容由其它頁面生成。

參數及使用方法

1. 在主模板中增加<noinclude>{{Documentation}}</noinclude>。
2. 點擊「編輯」鏈接，它將打開/doc子頁面，並在那裡填寫文檔。
3. 將分類增加在/doc子頁面的<includeonly></includeonly>中。

正常的/doc子頁面

<noinclude>{{Documentation}}</noinclude>

任意/doc子頁面

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

內聯內容

<noinclude>{{Documentation|content=這是一個文件。}}</noinclude>

有[查看][編輯]鏈接的內聯內容

<noinclude>{{Documentation
|1 = Template:模板名/doc
|content = {{Template:模板名/doc|参数}}
}}</noinclude>

最佳用法

此代碼應該放置在模板代碼的底部「<noinclude>」之前且不加多餘的空格（否則會導致使用該模板的頁面上出現多餘空格）。參數可以像上面這樣來使用以包含任意文檔頁。 用於模板本身的分類鏈接應該用 <includeonly> </includeonly> 標籤來添加到文檔頁面。 如果文檔頁包含 includeonly 或 noinclude 標籤並作為文檔的一部分，請用「<」替代「<」。

請勿在/doc子頁面裡再掛上{{Documentation}}，以避免出錯。

本模板會檢查頁面的保護情況，並自動放置保護圖標（於頂部indicator位置）。因此使用本模板時不應再手動調用{{pp}}系列模板，否則將顯示重複的保護圖標。

模板數據

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

Documentation模板數據

顯示一個模板的使用說明

模板參數[編輯模板資料]

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

重定向

• {{Template:Documentation}}
• {{Documentations}}
• {{Template doc}}
• {{模板文档}}

上述文檔嵌入自Template:Documentation/doc。（編輯 | 查看歷史）
編者可以在本模板的沙盒（創建 | 鏡像）和測試樣例（創建）頁面進行實驗。
請將分類添加至/doc子頁面。本模板的子頁面。