模板:Documentation/doc:修订间差异

来自TFLS Wiki
无编辑摘要
无编辑摘要
 
(未显示同一用户的3个中间版本)
第1行: 第1行:
這個模板用來显示和格式化一些重要模板的說明文件,包括你正在阅读的本文。
本模板用來显示和格式化一些重要模板的说明文件,包括你正在阅读的本文。


Template:Documentation既可以用来嵌入'''/doc'''子页面,也可以用来进行内联嵌入;同时,将有一定的样式来标记文档部分。
Template:Documentation既可以用来嵌入'''/doc'''子页面,也可以用来进行内联嵌入;同时,将有一定的样式来标记文档部分。
第7行: 第7行:
使用方法极其简单,仅需在模板的最后加入<code><nowiki><noinclude>{{Documentation}}</noinclude></nowiki></code>即可,然后在模板下方就会出现文档内容。
使用方法极其简单,仅需在模板的最后加入<code><nowiki><noinclude>{{Documentation}}</noinclude></nowiki></code>即可,然后在模板下方就会出现文档内容。


注意,請確保'''&lt;noinclude&gt;'''的開頭直接接在模板原始碼或文字的最後一行後方,'''不要新起一行'''。否則,一個多餘的新行會被插入到包含该模板的頁面中,往往該頁面不需要這個新行。
注意,请确保'''&lt;noinclude&gt;'''的开头直接接在模板原始代码或文字的最后一行后方,'''不要新起一行'''


点击创建就能在模板的'''/doc'''子页面中创建所需的文档。创建完以后模板页就会自动包含这个文档,效果即如本文档般。
点击创建就能在模板的'''/doc'''子页面中创建所需的文档。创建完以后模板页就会自动包含这个文档,效果即如本文档般。
第19行: 第19行:
内联文档
内联文档
}}</noinclude>
}}</noinclude>
同样地,請確保'''&lt;noinclude&gt;'''的開頭直接接在模板原始碼或文字的最後一行後方,'''不要新起一行'''。
同样地,请确保'''&lt;noinclude&gt;'''的开头直接接在模板原始代码或文字的最后一行后方,'''不要新起一行'''。


<!-- 本行下加入模板的分類 -->
<includeonly>[[Category:样式模板]]</includeonly>
<includeonly>[[Category:模板工具]]</includeonly>
<noinclude>[[Category:模板文档]]</noinclude>
</noinclude>[[Category:模板文档]][[Category:文档]]</noinclude>

2022年5月21日 (六) 22:58的最新版本

本模板用來显示和格式化一些重要模板的说明文件,包括你正在阅读的本文。

Template:Documentation既可以用来嵌入/doc子页面,也可以用来进行内联嵌入;同时,将有一定的样式来标记文档部分。

使用Template:Documentation能够将模板及其页面分离,从而避免内联文档的缺点(如被锁定后无法编辑说明、只选一个目录编辑可能会被系统误判为无限递归使用等)。

使用方法极其简单,仅需在模板的最后加入<noinclude>{{Documentation}}</noinclude>即可,然后在模板下方就会出现文档内容。

注意,请确保<noinclude>的开头直接接在模板原始代码或文字的最后一行后方,不要新起一行

点击创建就能在模板的/doc子页面中创建所需的文档。创建完以后模板页就会自动包含这个文档,效果即如本文档般。

内联文档

虽然不推荐内联文档,但是对于一些短小的文档,内联的确更加方便。这时候可以使用该模板的content属性:

<noinclude>{{Documentation|content=
内联文档
}}</noinclude>
模板文档  [编辑]

内联文档

同样地,请确保<noinclude>的开头直接接在模板原始代码或文字的最后一行后方,不要新起一行