Template:Documentation/doc：修订间差异

以互动方式浏览历史

←上一版本

删除的内容添加的内容

可视化wikitext

行内

2023年11月18日 (六) 02:54的最新版本

此頁面是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}}
-<includeonly>{{pp-template}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
+== 概要 ==
-这个模板自动显示“模板-{A|zh-hans:文档;zh-hant:文件}-”框，就像你现在看到的这样。文档框中的内容由其它页面生成，
-{{seealso|Wikipedia:模板文件頁模式}}
+{{See also|Wikipedia:模板文件頁模式}}
+这个模板自动显示“模板文档”框，就像你现在看到的这样，文档框中的内容由其它页面生成。
-== 用法 ==
-# 在主模板中增加<code>&lt;noinclude&gt;&#123;{Documentation}&#125;&lt;/noinclude&gt;</code>。
+== 參數及使用方法 ==
-# 点击“编辑”链接，它将打开<tt>/doc</tt>子页面，并在那里填写文档。
+# 在主模板中增加<syntaxhighlight lang=wikitext inline><noinclude>{{Documentation}}</noinclude></syntaxhighlight>。
-# 將分類增加在<tt>/doc</tt>子頁面的<code>&lt;includeonly&gt;&lt;/includeonly&gt;</code>中。
+# 点击“编辑”链接，它将打开/doc子页面，并在那里填写文档。
+# 將分類增加在/doc子頁面的<syntaxhighlight lang=wikitext inline><includeonly></includeonly></syntaxhighlight>中。
 === 正常的/doc子页面 ===
+<syntaxhighlight lang="wikitext">
- &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}&#125;&#125;&lt;/noinclude&gt;
+<noinclude>{{Documentation}}</noinclude>
+</syntaxhighlight>
 === 任意/doc子页面 ===
+<syntaxhighlight lang="wikitext">
- &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|Template:any page/doc&#125;&#125;&lt;/noinclude&gt;
+<noinclude>{{Documentation|Template:any page/doc}}</noinclude>
+</syntaxhighlight>
 === 内联内容 ===
+-{zh-hans:<syntaxhighlight lang="wikitext">
- &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|content=这是一个文档。&#125;&#125;&lt;/noinclude&gt;
+<noinclude>{{Documentation|content=这是一个文档。}}</noinclude>
+</syntaxhighlight>; zh-hant:<syntaxhighlight lang="wikitext">
+<noinclude>{{Documentation|content=這是一個文件。}}</noinclude>
+</syntaxhighlight>;}-
 === 有[查看][编辑]链接的内联内容 ===
+<syntaxhighlight lang="wikitext">
- &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}
+<noinclude>{{Documentation
- |1 = Template:模板名/doc
- |content =&#123;&#123;Template:模板名/doc|参数}}
+|1 = Template:模板名/doc
+|content = {{Template:模板名/doc|参数}}
- }}&lt;/noinclude>
+}}</noinclude>
+</syntaxhighlight>
 === 最佳用法 ===
-此代码应该放置在模板代码的底部“<code>&lt;noinclude></code>”之前且不加多余的空格（否则会导致使用该模板的页面上出现多余空格）。参数可以像上面这样来使用以包含任意文档页。
+此代码应该放置在模板代码的底部“<syntaxhighlight lang=wikitext inline><noinclude></syntaxhighlight>”之前且不加多余的空格（否则会导致使用该模板的页面上出现多余空格）。参数可以像上面这样来使用以包含任意文档页。
-用于模板本身的分类链接应该用 <code>&lt;includeonly> &lt;/includeonly></code> 标签来添加到文档页面。
+用于模板本身的分类链接应该用 <syntaxhighlight lang=wikitext inline><includeonly> </includeonly></syntaxhighlight> 标签来添加到文档页面。
 更复杂的案例请参见 [[Wikipedia:模板文件頁模式#分类链接]]。
 如果文档页包含 <code>includeonly</code> 或 <code>noinclude</code> 标签并作为文档的一部分，请用“<code>&amp;lt;</code>”替代“<code><</code>”。
-請勿在/doc子頁面裡再掛上{{tl|Documentation}}，以避免出錯
+請勿在/doc子頁面裡再掛上{{tlx|Documentation}}，以避免出錯。
+{{Documentation/TemplateData}}
-=== 自定义显示 ===
+== 重定向 ==
+*{{Tl|Doc}}
-替换这些值可以实现特殊的输出效果：
+*{{Tl|Documentation, template}}
-* <code>{&#123;documentation| '''heading''' = ...}}</code> − 改变“文档”页的标题文字。如果此处留空，整个标题行（包括第一个[编辑]链接）也将隐藏。
+*{{Tl|Documentations}}
-{{tl|模板文档}}、{{tl|Template doc}}、{{tl|Documentation, template}}與{{tl|Doc}}均重定向至此處。
+*{{Tl|Template doc}}
-<includeonly>
+*{{Tl|Template doc page}}
-[[Category:模板頁的模板]]
+*{{Tl|Template doc page transcluded}}
-</includeonly>
+*&#123;&#123;[[Template:模板文件|-{模板文件}-]]&#125;&#125;
+*&#123;&#123;[[Template:模板文档|-{模板文档}-]]&#125;&#125;
+*{{Tl|帮助文档}}
+<includeonly>{{Sandbox other||
+[[Category:模板說明文件|D]]
+[[Category:模板頁的模板|D]]
+[[Category:Lua模板|D]]
+}}</includeonly>