Template:Documentation/doc:修订间差异

本页使用了标题或全文手工转换,现处于中国大陆简体模式
模板页面
无编辑摘要
(繁简转换 by ZF-bot
 
第3行: 第3行:
本模板用于各个文档描述。
本模板用于各个文档描述。
== 概要 ==
== 概要 ==
{{See also|LIB:模板文件頁模式}}
{{See also|LIB:模板文档页模式}}
这个模板自动显示“模板文档”框,就像你现在看到的这样,文档框中的内容由其它页面生成。
这个模板自动显示“模板文档”框,就像你现在看到的这样,文档框中的内容由其它页面生成。
== 參數及使用方法 ==
== 参数及使用方法 ==
# 在主模板中增加<code><nowiki>&lt;noinclude&gt;{{Documentation}}&lt;/noinclude&gt;</nowiki></code>。
# 在主模板中增加<code><nowiki>&lt;noinclude&gt;{{Documentation}}&lt;/noinclude&gt;</nowiki></code>。
# 点击“编辑”链接,它将打开<tt>/doc</tt>子页面,并在那里填写文档。
# 点击“编辑”链接,它将打开<tt>/doc</tt>子页面,并在那里填写文档。
# 增加在<tt>/doc</tt>子面的<code>&lt;includeonly&gt;&lt;/includeonly&gt;</code>中。
# 增加在<tt>/doc</tt>子面的<code>&lt;includeonly&gt;&lt;/includeonly&gt;</code>中。
=== 正常的/doc子页面 ===
=== 正常的/doc子页面 ===
<nowiki>&lt;noinclude&gt;{{{{{template-name|Documentation}}}}}&lt;/noinclude&gt;</nowiki>
<nowiki>&lt;noinclude&gt;{{{{{template-name|Documentation}}}}}&lt;/noinclude&gt;</nowiki>
第23行: 第23行:
此代码应该放置在模板代码的底部“<code>&lt;noinclude></code>”之前且不加多余的空格(否则会导致使用该模板的页面上出现多余空格)。参数可以像上面这样来使用以包含任意文档页。
此代码应该放置在模板代码的底部“<code>&lt;noinclude></code>”之前且不加多余的空格(否则会导致使用该模板的页面上出现多余空格)。参数可以像上面这样来使用以包含任意文档页。
用于模板本身的分类链接应该用 <code>&lt;includeonly> &lt;/includeonly></code> 标签来添加到文档页面。
用于模板本身的分类链接应该用 <code>&lt;includeonly> &lt;/includeonly></code> 标签来添加到文档页面。
更复杂的案例请参见 [[LIB:模板文件頁模式#分类链接]]。
更复杂的案例请参见 [[LIB:模板文档页模式#分类链接]]。
如果文档页包含 <code>includeonly</code> 或 <code>noinclude</code> 标签并作为文档的一部分,请用“<code>&amp;lt;</code>”替代“<code><</code>”。
如果文档页包含 <code>includeonly</code> 或 <code>noinclude</code> 标签并作为文档的一部分,请用“<code>&amp;lt;</code>”替代“<code><</code>”。


勿在/doc子上{{tlx|Documentation}},以避免出
勿在/doc子上{{tlx|Documentation}},以避免出
== 重定向 ==
== 重定向 ==
*{{Tl|Doc}}
*{{Tl|Doc}}
*{{Tl|Template doc}}
*{{Tl|Template doc}}
*{{Tl|模板文}}
*{{Tl|模板文}}
*{{Tl|模板文档}}
*{{Tl|模板文档}}
<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||
[[Category:模板明文]]
[[Category:模板明文]]
[[Category:模板的模板]]
[[Category:模板的模板]]
[[Category:Lua模板]]
[[Category:Lua模板]]
}}</includeonly>
}}</includeonly>
第40行: 第40行:
{
{
"params": {},
"params": {},
"description": "显示模板文框",
"description": "显示模板文框",
"format": "inline"
"format": "inline"
}
}

2023年9月24日 (日) 22:40的最新版本

本模板用于各个文档描述。

概要

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

参数及使用方法

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

正常的/doc子页面

<noinclude>{{{{{template-name|Documentation}}}}}</noinclude>

任意/doc子页面

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

内联内容

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

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

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

最佳用法

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

请勿在/doc子页面里再挂上{{Documentation}},以避免出错

重定向

显示模板文档框

模板参数

此模板首选参数不换行的行内格式。

参数描述类型状态
未指定参数