模板: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}}
+<!-- 文档页面 -->
+{{Lua}}
-== 语法 ==
+当前模板用于输出模板或者模块的文档页面。
-=== 使用 /doc 页面 ===
-<pre>
-&lt;noinclude>
-<br style="clear: both;" />
-{{Documentation}}
-[[Category:模板]]
+如果页面不存在文档，可以通过点击提示栏的'''创建'''会打开创建文档的编辑页面。打开页面后，会自动附带[[Template:Documentation/preload|默认文档页面的模板]]。
-&lt;/noinclude>
-</nowiki></pre>
-=== 通过参数插入 ===
+文档页面会被自动添加到[[:分类:文档页面]]下。
-<pre>
-{{Documentation
-| content =
-文档内容
+== 可选参数 ==
+引入 <code><nowiki>{{Documentation}}</nowiki></code> 模板时，可以传入以下参数。
-}}
+=== type ===
-</pre>
+设置文档的'''类型'''，例如模板、模块等。
-<includeonly>[[Category:模板]]
-[[Category:模板文档|*]]</includeonly><noinclude>
+默认情况下，type 会根据命名空间的自动设置，因此通常无需手动指定。
-[[Category:模板文档]]</noinclude>
+=== page ===
+文档所在的页面。默认为当前页面的 '''doc''' 子页面。
+=== content ===
+直接指定文档的内容，将文档的内容嵌入到本体页面，不单独创建新的子页面。一般在比较小的模板上使用。
+=== nodoc ===
+如果模板文档缺失，并且编辑者不清楚如何使用，则可添加 nodoc=1。文档的背景会被设置为红色，并且页面会被添加到下面的分类之中。
+* [[:分类:文档缺失的模板]]
+* [[:分类:文档缺失的模块]]
+如果文档页面不存在或着为空时会自动判断，一般情况下不需要手动设置。
+=== baddoc ===
+和 nodoc 类似，baddoc 用于标记'''有'''文档但文档质量一般的模板（没有示例等）。文档的背景会被设置为黄色，并且页面会被添加到下面的分类之中。
+* [[:分类:文档质量较低的模板]]
+* [[:分类:文档质量较低的模块]]
+<includeonly>
+<!-- 模板分类/跨语言链接 -->
+[[Category:文档模板|*]]
+</includeonly>