Template:Documentation

模板文档[查看][编辑][历史][清除缓存]

此頁面是Template:Documentation的Template文档。
此頁面可能包含了模板的使用說明、分類和其他内容。

此Template文档被引用於約47,000個頁面。
為了避免造成大規模的影響，所有對此Template文档的編輯應先於沙盒、測試樣例或您的沙盒上測試。实施修改前，建议先在討論頁發起討論。

模板引用數量會自動更新。

此模板已评为穩定版，其已臻成熟，可正常使用于各处而不会出现错误。已可在帮助页面和其他维基百科资源中提及，以帮助新用户学习。为降低服务器负载和错误输出，改善本模板前应进行沙盒测试，而不是重复的试错性编辑。

此Template文档已被全保護。僅限管理員編輯。

此Template文档已被移動保護。僅限管理員移動。

此模板使用Lua语言：

Module:Documentation

概要

这个模板自动显示“模板文档”框，就像你现在看到的这样，文档框中的内容由其它页面生成。

參數及使用方法

在主模板中增加<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}}，以避免出錯。

本模板会检查页面的保护情况，并自动放置保护图标（于顶部indicator位置）。因此使用本模板时不应再手动调用{{pp}}系列模板，否则将显示重复的保护图标。

参数	描述		默认值	状态
`1`	模板的使用說明所在頁面	標示該模板的使用說明所在頁面名稱	`{{PAGENAME}}/doc`	可选
`content`	模板的使用說明內容	以所寫的使用說明內容取代該模板的/doc子頁面	（無）	可选

TemplateData

模板数据

以下是该模板的模板数据，适用于可视化编辑器等工具。

Documentation模板数据

模板参数[编辑模板数据]
此模板首选参数不换行的行内格式。
参数		描述	类型	状态
模板的使用說明所在頁面	`1`	標示該模板的使用說明所在頁面名稱默认值 {{PAGENAME}}/doc 自动值 `{{FULLPAGENAME}}/doc`	页面名称	可选
模板的使用說明內容	`content`	以所寫的使用說明內容取代該模板的/doc子頁面	内容	可选

重定向

上述文档嵌入自Template:Documentation/doc。
编者可以在本模板的沙盒和测试样例页面进行实验。
请在/doc子页面中添加分类。本模板的子页面。