模板:Documentation/doc：修订间差异

可视化wikitext

2021年5月3日 (一) 19:37的最新版本

这个模板用来显示和格式化模板的说明文档（一般写在模板的/doc子页面），包括你正在阅读的本文。

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

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

用法

这个模板用法非常简单：

在主模板页面底部添加<noinclude>{{doc}}</noinclude>。
点击“创建”链接，打开/doc子页面，并在子页面中填写文档。
在/doc子页面的底部添加<noinclude>[[分类:模板文档]]</noinclude>。

至于效果，如你所见，这个显示在模板:Documentation页面的文档就是。

注意

模板主要内容的<includeonly></includeonly>与作为模板说明内容的<noinclude></noinclude>之间不要换行，否则模板使用时会出现莫名其妙的空格或空行。
推荐使用{{doc}}而不是{{Documentation}}，因为前者更加简洁明了且不易出现拼写错误。

其他模板的文档

你可以选择显示其他模板的文档，免去搬运或重定向重复文档的麻烦。

<noinclude>{{doc|模板:其他模板/doc}}</noinclude>

内联文档

内联文档是不显示/doc子页面内容，直接编写的文档。

虽然不推荐内联文档，但是对于一些短小的文档，内联的确更加方便。这时候可以使用该模板的content参数：

<noinclude>{{doc|content=
内联文档
}}</noinclude>

@@ 第1行： / 第1行： @@
-這個模板用來显示和格式化一些重要模板的說明文件，包括你正在阅读的本文。
+这个模板用来显示和格式化模板的说明文档（一般写在模板的<code>/doc</code>子页面），包括你正在阅读的本文。
-Template:Documentation既可以用来嵌入'''/doc'''子页面，也可以用来进行内联嵌入；同时，将有一定的样式来标记文档部分。
+{{tl|Documentation}}既可以用来嵌入<code>/doc</code>子页面，也可以用来进行内联嵌入；同时，将有一定的样式来标记文档部分。
-使用Template:Documentation能够将模板及其页面分离，从而避免'''内联文档'''的缺点（如被锁定后无法编辑说明、只选一个目录编辑可能会被系统误判为无限递归使用等）。
+使用{{tl|Documentation}}能够将模板及其页面分离，从而避免'''内联文档'''的缺点（如被锁定后无法编辑说明、只选一个目录编辑可能会被系统误判为无限递归使用等）。
+== 用法 ==
-使用方法极其简单，仅需在模板的最后加入<code><nowiki><noinclude>{{Documentation}}</noinclude></nowiki></code>即可，然后在模板下方就会出现文档内容。
+这个模板用法非常简单：
-注意，請確保'''&lt;noinclude&gt;'''的開頭直接接在模板原始碼或文字的最後一行後方，'''不要新起一行'''。否則，一個多餘的新行會被插入到包含该模板的頁面中，往往該頁面不需要這個新行。
+# 在主模板页面底部添加<code><nowiki><noinclude>{{doc}}</noinclude></nowiki></code>。
-点击创建就能在模板的'''/doc'''子页面中创建所需的文档。创建完以后模板页就会自动包含这个文档，效果即如本文档般。
+# 点击“创建”链接，打开<code>/doc</code>子页面，并在子页面中填写文档。
+# 在<code>/doc</code>子页面的底部添加<code><nowiki><noinclude>[[分类:模板文档]]</noinclude></nowiki></code>。
+至于效果，如你所见，这个显示在模板:Documentation页面的文档就是。
-===内联文档===
-虽然不推荐内联文档，但是对于一些短小的文档，内联的确更加方便。这时候可以使用该模板的content属性：
+; 注意
-<pre><noinclude>{{Documentation|content=
+# 模板主要内容的<code><nowiki><includeonly></includeonly></nowiki></code>与作为模板说明内容的<code><nowiki><noinclude></noinclude></nowiki></code>之间'''不要换行'''，否则模板使用时会出现莫名其妙的空格或空行。
+# 推荐使用<code><nowiki>{{doc}}</nowiki></code>而不是<code><nowiki>{{Documentation}}</nowiki></code>，因为前者更加简洁明了且不易出现拼写错误。
+=== 其他模板的文档 ===
+你可以选择显示其他模板的文档，免去搬运或重定向重复文档的麻烦。
+<pre><noinclude>{{doc|模板:其他模板/doc}}</noinclude></pre>
+=== 内联文档 ===
+内联文档是不显示<code>/doc</code>子页面内容，直接编写的文档。
+虽然不推荐内联文档，但是对于一些短小的文档，内联的确更加方便。这时候可以使用该模板的content参数：
+<pre><noinclude>{{doc|content=
 内联文档
 }}</noinclude></pre>
-<noinclude>{{Documentation|content=
+<!--<noinclude>{{doc|content=
 内联文档
 }}</noinclude>
+* 因为使用了<code>noinclude</code>标签，请点击文档左上角的“查看”，进入这个文档来查看效果。-->
-同样地，請確保'''&lt;noinclude&gt;'''的開頭直接接在模板原始碼或文字的最後一行後方，'''不要新起一行'''。
+<noinclude>[[分类:模板文档]]</noinclude>
-*參數1的默認值是<code>{{tl|Documentation/docname}}</code>；其解析为“（页面名字）/doc”。例如，在本页面（{{FULLPAGENAME}}）下，参数1的默认值是{{Documentation/docname}}。
-*參數content的默認值為空。

模板:Documentation/doc：修订间差异

2021年5月3日 (一) 19:37的最新版本

用法

其他模板的文档

内联文档

导航菜单