Template:Documentation/doc：修订间差异

以互动方式浏览历史

←上一版本下一版本→

删除的内容添加的内容

可视化wikitext

行内

2023年11月18日 (六) 02:43的版本

此頁面是Template:Documentation的Template文档。
此頁面可能包含了模板的使用說明、分類和其他内容。

此Template文档被引用於約26,000個頁面。
為了避免造成大規模的影響，所有對此Template文档的編輯應先於沙盒、測試樣例或您的沙盒上測試。
測試後無誤的版本可以一次性地加入此Template文档中，但是修改前請務必於討論頁發起討論。

模板引用數量會自動更新。

此模板使用Lua语言：

Module:Documentation（沙盒）

概要

这个模板自动显示“模板文档”框，就像你现在看到的这样，文档框中的内容由其它页面生成。

參數及使用方法

在主模板中增加<noinclude>{{Documentation}}</noinclude>。
点击“编辑”链接，它将打开/doc子页面，并在那里填写文档。
將分類增加在/doc子頁面的<includeonly></includeonly>中。

正常的/doc子页面

<noinclude>{{Documentation}}</noinclude>

任意/doc子页面

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

内联内容

<noinclude>{{Documentation|content=这是一个文档。}}</noinclude>

有[查看][编辑]链接的内联内容

<noinclude>{{Documentation
|1 = Template:模板名/doc
|content = {{Template:模板名/doc|参数}}
}}</noinclude>

最佳用法

此代码应该放置在模板代码的底部“<noinclude>”之前且不加多余的空格（否则会导致使用该模板的页面上出现多余空格）。参数可以像上面这样来使用以包含任意文档页。用于模板本身的分类链接应该用 <includeonly> </includeonly> 标签来添加到文档页面。更复杂的案例请参见 Wikipedia:模板文件頁模式#分类链接。如果文档页包含 includeonly 或 noinclude 标签并作为文档的一部分，请用“<”替代“<”。

請勿在/doc子頁面裡再掛上{{Documentation}}，以避免出錯。

以下是该模板的模板数据，适用于可视化编辑器等工具。

Documentation模板数据

顯示一個模板的使用說明

模板参数
参数		描述	类型	状态
模板的使用說明所在頁面	`1`	標示該模板的使用說明所在頁面名稱默认值 {{PAGENAME}}/doc 示例值 Template:Documentation/doc	页面名称	可选
模板的使用說明內容	`content`	以所寫的使用說明內容取代該模板的/doc子頁面示例值這是這個模板的使用說明	内容	可选

重定向

@@ 第1行： / 第1行： @@
 {{NoteTA|G1=MediaWiki|G2=IT}}{{Documentation subpage}}{{High-use|1=20550}}{{Uses Lua|Module:Documentation}}
-==概要==
+== 概要 ==
 {{See also|Wikipedia:模板文件頁模式}}
 这个模板自动显示“模板文档”框，就像你现在看到的这样，文档框中的内容由其它页面生成。
-==參數及使用方法==
+== 參數及使用方法 ==
-# 在主模板中增加<code>&lt;noinclude&gt;&#123;{Documentation}&#125;&lt;/noinclude&gt;</code>。
+# 在主模板中增加<code>&lt;noinclude&gt;{{((}}Documentation{{))}}&lt;/noinclude&gt;</code>。
-# 点击“编辑”链接，它将打开<tt>/doc</tt>子页面，并在那里填写文档。
+# 点击“编辑”链接，它将打开/doc子页面，并在那里填写文档。
-# 將分類增加在<tt>/doc</tt>子頁面的<code>&lt;includeonly&gt;&lt;/includeonly&gt;</code>中。
+# 將分類增加在/doc子頁面的<code>&lt;includeonly&gt;&lt;/includeonly&gt;</code>中。
-===正常的/doc子页面===
- &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}&#125;&#125;&lt;/noinclude&gt;
-===任意/doc子页面===
+=== 正常的/doc子页面 ===
+<syntaxhighlight lang="wikitext">
- &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|Template:any page/doc&#125;&#125;&lt;/noinclude&gt;
+<noinclude>{{Documentation}}</noinclude>
-===内联内容===
+</syntaxhighlight>
- &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|content=这是一个文档。&#125;&#125;&lt;/noinclude&gt;
-===有[查看][编辑]链接的内联内容===
+=== 任意/doc子页面 ===
- &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}
+<syntaxhighlight lang="wikitext">
- |1 = Template:模板名/doc
+<noinclude>{{Documentation|Template:any page/doc}}</noinclude>
- |content =&#123;&#123;Template:模板名/doc|参数}}
+</syntaxhighlight>
- }}&lt;/noinclude>
-===最佳用法===
+=== 内联内容 ===
+-{zh-hans:<syntaxhighlight lang="wikitext">
+<noinclude>{{Documentation|content=这是一个文档。}}</noinclude>
+</syntaxhighlight>; zh-hant:<syntaxhighlight lang="wikitext">
+<noinclude>{{Documentation|content=這是一個文件。}}</noinclude>
+</syntaxhighlight>;}-
+=== 有[查看][编辑]链接的内联内容 ===
+<syntaxhighlight lang="wikitext">
+<noinclude>{{Documentation
+|1 = Template:模板名/doc
+|content = {{Template:模板名/doc|参数}}
+}}</noinclude>
+</syntaxhighlight>
+=== 最佳用法 ===
 此代码应该放置在模板代码的底部“<code>&lt;noinclude></code>”之前且不加多余的空格（否则会导致使用该模板的页面上出现多余空格）。参数可以像上面这样来使用以包含任意文档页。
 用于模板本身的分类链接应该用 <code>&lt;includeonly> &lt;/includeonly></code> 标签来添加到文档页面。
@@ 第24行： / 第40行： @@
 如果文档页包含 <code>includeonly</code> 或 <code>noinclude</code> 标签并作为文档的一部分，请用“<code>&amp;lt;</code>”替代“<code><</code>”。
-請勿在/doc子頁面裡再掛上{{tlx|Documentation}}，以避免出錯
+請勿在/doc子頁面裡再掛上{{tlx|Documentation}}，以避免出錯。
+{{Documentation/TemplateData}}
-==模板參數==
-<templatedata>
-{
-	"description": "顯示一個模板的使用說明，見Wikipedia:模板文件頁模式",
-	"params": {
-		"1": {
-			"aliases": [
-			],
-			"label": "模板的使用說明所在頁面",
-			"description": "標示該模板的使用說明所在頁面名稱",
-			"example": "Template:Documentation/doc",
-            "default": "{{PAGENAME}}/doc",
-			"type": "wiki-page-name",
-            "required": false
-		},
-		"content": {
-			"aliases": [
-			],
-			"label": "模板的使用說明內容",
-			"description": "以所寫的使用說明內容取代該模板的/doc子頁面",
-			"example": "這是這個模板的使用說明",
-            "default": null,
-			"type": "content",
-            "required": false
-		}
-	}
-}
-</templatedata>
-==重定向==
+== 重定向 ==
 *{{Tl|Doc}}
 *{{Tl|Documentation, template}}