跳至內容

模板:Documentation

今本(此為底本,未經審校)
文出維基大典
Documentation icon 模案[] [] [] []

模板:NoteTA模板:Uses Lua

概要

[]

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

參數及使用方法

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

正常的/doc子页面

[]
<noinclude>{{Documentation}}</noinclude>

任意/doc子页面

[]
<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

内联内容

[]
-{zh-hans:
<noinclude>{{Documentation|content=这是一个文档。}}</noinclude>
; zh-hant:
<noinclude>{{Documentation|content=這是一個文件。}}</noinclude>
;}-

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

[]
<noinclude>{{Documentation
|1 = Template:模板名/doc
|content = {{Template:模板名/doc|参数}}
}}</noinclude>

最佳用法

[]

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

請勿在/doc子頁面裡再掛上{{Documentation}},以避免出錯。

此事於可視化編輯器暨其他工具之模板數據文檔。

Documentation模板數據

顯示一個模板的使用說明

模板參數[編輯模板資料]

參數描述類型狀態
模板的使用說明所在頁面1

標示該模板的使用說明所在頁面名稱

預設
{{PAGENAME}}/doc
範例
Template:Documentation/doc
頁面名稱非必填
模板的使用說明內容content

以所寫的使用說明內容取代該模板的/doc子頁面

範例
這是這個模板的使用說明
內容非必填

重定向

[]