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

帮助页面
以互动方式浏览历史
添加的内容 删除的内容
可视化wikitext
无编辑摘要
（修正代码）
 

（未显示1个用户的2个中间版本）

第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;"><font style="background-color: #FFFF66">[--模板的最後一行文字--]</font>&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>
<!-- 請將模板的分類放在 /doc 子頁面 --></nowiki><br/><nowiki>
</noinclude></nowiki><br><nowiki>
</noinclude></nowiki><br/><nowiki>
</nowiki></code>
</nowiki></code>


保存後，单击模板文档中的“创建”按钮，即可以对 Template:X/doc 进行编辑模板说明。如果该文档模板没有建立，以下的源代码会自动产生：（參見[[Template:Documentation/preload]]）
保存后，单击模板文档中的“创建”按钮，即可以对 Template:X/doc 进行编辑模板说明。如果该文档模板没有建立，以下的源代码会自动产生：（参见[[Template:Documentation/preload]]）
<pre>
<pre>
{{NoteTA
{{NoteTA
第34行： 第33行：
}}
}}
{{Documentation subpage}}
{{Documentation subpage}}
<!-- 在本行下編輯模板說明 -->
<!-- 在本行下编辑模板说明 -->
== 概要 ==
== 概要 ==


== 參數及使用方法 ==
== 参数及使用方法 ==


== 範例 ==
== 范例 ==


== 注意事项 ==
== 注意事项 ==
第47行： 第46行：
== 模板编辑说明 ==
== 模板编辑说明 ==


== 參見 ==
== 参见 ==


<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||
<!-- 本行下加入模板的分類 -->
<!-- 本行下加入模板的分类 -->


}}</includeonly>
}}</includeonly>
第61行： 第60行：
:此外，子頁面的標題請'''必定要'''使用"/doc"的型式。
:此外，子頁面的標題請'''必定要'''使用"/doc"的型式。
:''''X/doc''''文件頁面的分類應該只有[[:Category:模板說明文件]]，請調整原始碼讓屬於模板的分類只存在於模板主頁面。
:''''X/doc''''文件頁面的分類應該只有[[:Category:模板說明文件]]，請調整原始碼讓屬於模板的分類只存在於模板主頁面。
:你可以將 /doc 子頁面的討論頁重定向到模板本身的討論頁，那麼最後所有有關模板及其文件頁的討論就會在同一討論頁上，舉個例，將 Template talk:X/doc 重定向到 Template talk:X。<!-- You may wish to redirect the talk page of the /doc subpage to the talk page of the template itself. Then all talk relating to the template and its documentation will end up on the same talkpage. For example, redirect Template talk:X/doc to Template talk:X. -->
:你可以將 /doc 子頁面的討論頁重定向到模板本身的討論頁，那麼最後所有有關模板及其文件頁的討論就會在同一討論頁上，舉個例，將 Template talk:X/doc 重定向到 Template talk:X。


現在這個模板可以被完全保護了。因為它的''''X/doc''''文件頁面並沒有被保護，所以任何人可以編輯該文件頁面。然而，注意[[Qiuwen:保护方针|連鎖保護]]模板會使得文件頁面也被保護。
現在這個模板可以被完全保護了。因為它的''''X/doc''''文件頁面並沒有被保護，所以任何人可以編輯該文件頁面。然而，注意[[Qiuwen:保护方针|連鎖保護]]模板會使得文件頁面也被保護。
取自“https://www.qiuwenbaike.cn/wiki/Help:模板文档”