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

以互动方式浏览历史

←上一编辑

可视化wikitext

2025年10月7日 (二) 02:06的最新版本

[ 刷新 ]

当前页面是文档页面，会被模板:Documentation引入。查看模板:Documentation获取更多信息。

Lua

此模板使用了模块:Documentation，此脚本使用 Lua 编写。

当前模板用于输出模板或者模块的文档页面。

如果页面不存在文档，可以通过点击提示栏的创建会打开创建文档的编辑页面。打开页面后，会自动附带默认文档页面的模板。

文档页面会被自动添加到分类:文档页面下。

可选参数

引入 {{Documentation}} 模板时，可以传入以下参数。

type

设置文档的类型，例如模板、模块等。

默认情况下，type 会根据命名空间的自动设置，因此通常无需手动指定。

page

文档所在的页面。默认为当前页面的 doc 子页面。

content

直接指定文档的内容，将文档的内容嵌入到本体页面，不单独创建新的子页面。一般在比较小的模板上使用。

nodoc

如果模板文档缺失，并且编辑者不清楚如何使用，则可添加 nodoc=1。文档的背景会被设置为红色，并且页面会被添加到下面的分类之中。

如果文档页面不存在或着为空时会自动判断，一般情况下不需要手动设置。

baddoc

和 nodoc 类似，baddoc 用于标记有文档但文档质量一般的模板（没有示例等）。文档的背景会被设置为黄色，并且页面会被添加到下面的分类之中。

@@ 第1行： / 第1行： @@
-{{documentation header}}
+{{Documentation header}}
 <!-- 文档页面 -->
 {{Lua}}
-对于模板，在末尾插入<code><nowiki>{{subst:doc}}</nowiki></code>，然后保存页面，这将放置<code><nowiki>{{documentation}}</nowiki></code>和一条建议编辑者在何处放置类别和interwiki链接的注释。对于其他类型的页面，文档模板应该存在。
+当前模板用于输出模板或者模块的文档页面。
-单击页面顶部的“创建”将打开文档页面，并带有某些[[Template:Documentation/preload|预格式化]]。也可以使用文档页面上的<code><nowiki>{{subst:doc}}</nowiki></code>创建这种格式。
+如果页面不存在文档，可以通过点击提示栏的'''创建'''会打开创建文档的编辑页面。打开页面后，会自动附带[[Template:Documentation/preload|默认文档页面的模板]]。
-文档页面将自动添加到[[:分类:文档页面]]。 使用不带<code>subst:</code>的{{t|doc}}会将页面添加到[[:分类:需要替换模板的页面]]。
+文档页面会被自动添加到[[:分类:文档页面]]下。
 == 可选参数 ==
-创建页面时，可以将此参数添加到<code> <nowiki>{{subst:doc}}</nowiki></code>模板中，也可以添加到<code><nowiki>{{documentation}}</nowiki></code>模板。
+引入 <code><nowiki>{{Documentation}}</nowiki></code> 模板时，可以传入以下参数。
 === type ===
-设置文档的“type”，例如模板、模块、消息等。这将用作模板可能显示的某些消息以及分类的一部分。
+设置文档的'''类型'''，例如模板、模块等。
-type是基于命名空间的自动类型，因此通常无需设置。
+默认情况下，type 会根据命名空间的自动设置，因此通常无需手动指定。
 === page ===
-文档所在的页面。默认为当前页面的子页面，称为“doc”。
+文档所在的页面。默认为当前页面的 '''doc''' 子页面。
 === content ===
-允许直接指定文档内容，而不是在单独的子页面上。 对于特定于小型页面的子页面模板很有用。
+直接指定文档的内容，将文档的内容嵌入到本体页面，不单独创建新的子页面。一般在比较小的模板上使用。
 === nodoc ===
-如果模板没有文档，并且你不知道如何使用它，请在文档页面上的文档模板中添加nodoc=1。文档的背景将变为红色以使其引人注意，并且将页面添加到类别中。
+如果模板文档缺失，并且编辑者不清楚如何使用，则可添加 nodoc=1。文档的背景会被设置为红色，并且页面会被添加到下面的分类之中。
-* [[:分类:没有文档的模板]]
+* [[:分类:文档缺失的模板]]
-* [[:分类:没有文档的模块]]
+* [[:分类:文档缺失的模块]]
-如果文档页面不存在或为空，则会自动设置，因此通常不需要设置。
+如果文档页面不存在或着为空时会自动判断，一般情况下不需要手动设置。
 === baddoc ===
-与nodoc相似，它用于标记'''有'''文档的模板，但不是很好。这可能意味着它没有足够的示例，未正确解释所有功能或未正确解释模板的要点。文档的背景将变为黄色以使其更引人注目，并且页面将添加到类别中。
+和 nodoc 类似，baddoc 用于标记'''有'''文档但文档质量一般的模板（没有示例等）。文档的背景会被设置为黄色，并且页面会被添加到下面的分类之中。
 * [[:分类:文档质量较低的模板]]