查看“︁Template:Documentation/doc”︁的源代码


這個模板用來显示并格式化一些模板的-{zh-hans:说明文档;zh-hant:說明文件;zh:说明文档（Documentation）}-，包括你正在阅读的本文。

Template:Documentation既可以用来嵌入'''/doc'''子页面，也可以用来进行内联嵌入；同时，将有一定的样式来标记文档部分。

使用Template:Documentation能够将模板及其页面分离，从而避免'''内联文档'''的缺点（如页面被保护/数据库被锁定后无法编辑说明、只选一个目录编辑可能会被系统误判为无限递归使用等问题）。

使用方法极其简单，仅需在目标模板的最后加入<code><nowiki><noinclude>{{Documentation}}</noinclude></nowiki></code>即可，然后在模板下方就会出现文档内容。
*在其他页面嵌入目标模板后，{{tl|Documentation}}呈现的内容不会出现。
*如果你在目标模板使用的是'''&lt;onlyinclude&gt;'''标签，你可以直接在该HTML标签以外输入<code class="prettyprint"><nowiki>{{Documentation}}</nowiki></code>, 亦可实现嵌入模板时不显示说明文档的效果。<br>因为<code class="prettyprint lang=HTML">'''&lt;onlyinclude&gt;'''</code>同样用于控制嵌入显示内容，仅允许被标签包含其中的内容可被嵌入显示。

<b>注意：</b>請確保HTML标签'''&lt;noinclude&gt;'''直接接在模板原始碼或文字的最後一行後方，'''不要新起一行'''。
*否則，一個多餘的新行會插入到包含该模板的頁面中，一般情况下，模板本身的页面不需要這個新行。
{{Hide|标题=另起一行时的呈现效果|内容=
<pre class="prettyprint linenums lang-wiki">初音未来。

<noinclude>{{Documentation|content=内联文档
}}</noinclude></pre>
初音未来。


{{Documentation|content=
内联文档
}}}}
点击模板中的“创建”按钮就能在模板的'''/doc'''子页面中创建所需的文档。创建完以后模板页就会自动包含这个文档，效果即如本文档般。

===内联文档===
虽然不推荐内联文档，但对于一些内容精简的文档，内联呈现方式的确更加方便。这时候可以使用该模板的<code class="prettyprint lang-wiki">content</code>属性：
<pre class="prettyprint linenums lang-wiki"><noinclude>{{Documentation|content=
内联文档
}}</noinclude></pre>
{{Documentation|content=
内联文档
}}


*參數1的默認值是<code>{{tl|Documentation/docname}}</code>；解析后的结果为“（页面名字）/doc”。例如，在本页面（{{FULLPAGENAME}}）下，参数1的默认值是{{Documentation/docname}}。
*以下特定场合亦可使用此模板：
**多个模板使用一个说明文档时，参数1指向统一的说明文档页面。
**用在页面空间为“模块（Module）”、“小部件（Widget）”的页面时，此模板将分别显示“[[File:Template-info.svg|24px|link=]]模块文档”或“[[File:Template-info.svg|24px|link=]]小部件文档”。
**在其他页面空间以文档形式呈现内容时，此模板将显示为“文档”而不是“[[File:Template-info.svg|24px|link=]]模板文档”。<br>可以在[[帮助:沙盒]]中自行使用{{tl|Documentation}}并显示预览以查看呈现效果。
*參數<code>content</code>的默認值為空。
*<span class="plainlinks">[{{fullurl:T:Doc|redirect=no}} 模板:Doc] 作为快捷方式重定向至此模板，输入<code><nowiki>{{</nowiki>[[模板:Doc|Doc]]<nowiki>}}</nowiki></code>等效于<code><nowiki>{{</nowiki>[[模板:Documentation|Documentation]]<nowiki>}}</nowiki></code>。</span>
<includeonly>[[Category:模板页模板]]</includeonly><noinclude>[[Category:模板文档]]</noinclude>