心百科:模板文档页面模式

模板文档页模式是一种机制，用来将模板帮助文档从模板源代码中安全地分离成为帮助文档页面。这能够使得模板本身处于完全保护状态下，而说明部分保持未保护状态，让每个人仍然可以编辑模板帮助文档。

使用方法

假设有一个模板 Template:X ，在 template X 的模板源代码底下加入以下的标示：

[--模板的最后一行文字--]<noinclude>
{{Documentation}}
<!-- 请將模板的分类放在 /doc 子页面 --> </noinclude>


保存后，单击模板文档中的“创建”按钮，即可以对 Template:X/doc 进行编辑模板说明。如果该文档模板没有创建，以下的维基源代码会自动产生：（参见模板:Documentation/preload）

<!-- 在本行下编辑模板说明 -->
 == 概要 ==
 
 == 参数及使用方法 ==
 
 == 范例 ==
 
 == 注意事项 ==
 
 == 重定向 ==
 
 == 模板编辑说明 ==
 
 == 参见 ==

在上方指示的注释行下分别填写模板说明和分类。

注意：

请确保<noinclude>的开头，接在模板源代码或文字的最后一列后方，不要新起一列。否则，一个多余的新列会被插入到包含 X 模板的页面中，往往该页面不需要这个新列。

此外，子页面的标题请必定要使用"/doc"的型式。

你可以将 /doc 子页面的讨论页重定向到模板本身的讨论页，那么最后所有有关模板及其文档页的讨论就会在同一讨论页上，举个例，将 Template talk:X/doc 重定向到 Template talk:X。

现在这个模板可以被完全保护了。因为它的'X/doc'文档页面并没有被保护，所以任何人可以编辑该文档页面。然而，注意连锁保护模板会使得文档页面也被保护。

分类链接

• 要将模板本身置于一个分类中，请在 doc 子页面上的 <includeonly>...</includeonly> 段落中添加代码 [[Category:分类名]]。

• 要将 doc 子页面置于一个分类中，请在 doc 子页面上的 <noinclude>...</noinclude> 段落中添加代码 [[Category:分类名]]。

• 要让该模板将条目置于一个分类中（当该条目使用该模板时），请在模板页上的 <includeonly>...</includeonly> 段落中添加代码 [[Category:分类名]]。

优点

• 编辑的 X/doc 页面只会传递展示到该模板页面上，而不会被包含在 X 模板里。引用 X 模板的页面不需要仰赖文档页面，所以不会为了重度使用模板而扩大工作请求。
• 文档的编辑不会对模板本身和引用的页面造成任何危害。对于文档页面的破坏，不会扩及到引用 X 模板的页面上。
• 即使模板受到完全保护，每个人仍然能够编辑模板帮助文档。分类可以简单地增加在 X/doc 子页面。