模板:Documentation
外觀
此頁面是Template:Documentation的模板文件。 此頁面可能包含了模板的使用說明、分類和其他內容。 |
此模板文件被引用於約27,000個頁面。 為了避免造成大規模的影響,所有對此模板文件的編輯應先於沙盒、測試樣例或您的沙盒上測試。 測試後無誤的版本可以一次性地加入此模板文件中,但是修改前請務必於討論頁發起討論。 模板引用數量會自動更新。 |
此模板使用Lua語言: |
概要
這個模板自動顯示「模板文檔」框,就像你現在看到的這樣,文檔框中的內容由其它頁面生成。
參數及使用方法
- 在主模板中增加
<noinclude>{{Documentation}}</noinclude>
。 - 點擊「編輯」鏈接,它將打開/doc子頁面,並在那裡填寫文檔。
- 將分類增加在/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>
標籤來添加到文檔頁面。
更複雜的案例請參見 Wikipedia:模板文件頁模式#分類鏈接。
如果文檔頁包含 includeonly
或 noinclude
標籤並作為文檔的一部分,請用「<
」替代「<
」。
請勿在/doc子頁面裡再掛上{{Documentation}}
,以避免出錯。
顯示一個模板的使用說明
參數 | 描述 | 類型 | 狀態 | |
---|---|---|---|---|
模板的使用說明所在頁面 | 1 | 標示該模板的使用說明所在頁面名稱
| 頁面名稱 | 非必填 |
模板的使用說明內容 | content | 以所寫的使用說明內容取代該模板的/doc子頁面
| 內容 | 非必填 |
重定向
- {{Doc}}
- {{Documentation, template}}
- {{Documentations}}
- {{Template doc}}
- {{Template doc page}}
- {{Template doc page transcluded}}
- {{模板文件}}
- {{模板文档}}
- {{幫助文檔}}