Help:模板文档:修订间差异

帮助页面
添加的内容 删除的内容
无编辑摘要
(修正代码)
 
第9行: 第9行:
== 能够解决什么问题? ==
== 能够解决什么问题? ==


求闻编者经常喜欢在模板页面里加上使用说明(例如:[[template:cite news]])。这些叙述文字可以用包含在维基源代码<noinclude>...</noinclude>的方式写在模板里。然而,这种作法会有一些缺点:
求闻编者经常喜欢在模板页面里加上使用说明(例如:[[template:cite news]])。这些叙述文字可以用包含在维基源代码<nowiki><noinclude>...</noinclude></nowiki>的方式写在模板里。然而,这种作法会有一些缺点:


* 在 <noinclude>...</noinclude> 中的文字会被加算到“展开前的大小 ''pre-expand include size''”,其大小有上限(参见[[Help:模板限制|模板限制]])。
* 在 <nowiki><noinclude>...</noinclude></nowiki> 中的文字会被加算到“展开前的大小 ''pre-expand include size''”,其大小有上限(参见[[Help:模板限制|模板限制]])。
* 有一些模板,因为被大量的页面所引用而受到完全的保护。这时候编辑说明内容变得极为不方便,非管理员必须提出修改的要求,而管理员得去代为修改。
* 有一些模板,因为被大量的页面所引用而受到完全的保护。这时候编辑说明内容变得极为不方便,非管理员必须提出修改的要求,而管理员得去代为修改。
* 一个页面的“预先包含 ''pre-included''”和“展开后 ''post-expanded''”的大小设有上限。更糟的情况是,模板里包含了另一个模板,其“预先展开 ''pre-expanded''”大小因此倍增而发生冲突。(参见[[Help:模板限制|模板限制]])。
* 一个页面的“预先包含 ''pre-included''”和“展开后 ''post-expanded''”的大小设有上限。更糟的情况是,模板里包含了另一个模板,其“预先展开 ''pre-expanded''”大小因此倍增而发生冲突。(参见[[Help:模板限制|模板限制]])。


总括来说,有个双重办法可以将解说和使用方法置于一个“解说模板”,以取代<noinclude>...</noinclude>区块所围住的工具模板(若妥善运用的话,可以涵盖数个相关的工具型模板),这个方法同时具有两个明显的附加效果:
总括来说,有个双重办法可以将解说和使用方法置于一个“解说模板”,以取代<nowiki><noinclude>...</noinclude></nowiki>区块所围住的工具模板(若妥善运用的话,可以涵盖数个相关的工具型模板),这个方法同时具有两个明显的附加效果:


# 当广受利用的模板更新时,能将服务器重新读取的资料量降到最小。
# 当广受利用的模板更新时,能将服务器重新读取的资料量降到最小。
第23行: 第23行:
假设有一个模板Template:X ,在Template:X的模板源代码底下加入以下的标示:
假设有一个模板Template:X ,在Template:X的模板源代码底下加入以下的标示:


:<code style="display:table; line-height:1.2em;"><span style="background-color: #FFFF66">[--模板的最后一行文字--]</span>&lt;noinclude&gt;<br/>'''&#123;&#123;Documentation&#125;&#125;'''<br/><nowiki>
:<code style="display:table; line-height:1.2em;"><span style="background-color: #FFFF66">[--模板的最后一行文字--]</span>&lt;noinclude&gt;<br>'''&#123;&#123;Documentation&#125;&#125;'''<br><nowiki>
</noinclude></nowiki><br/><nowiki>
</noinclude></nowiki><br><nowiki>
</nowiki></code>
</nowiki></code>