模板:Gadget-desc/doc

此頁面是Template:Gadget-desc的模板文件。
此頁面可能包含了模板的使用說明、分類和其他內容。

本模板用於以結構化的方式展示小工具描述。

參數[編輯]

self: 小工具描述頁的名稱，不含命名空間以及語言子頁面，用於生成小工具錨點。例如小工具描述頁為MediaWiki:Gadget-Foo/zh，參數應填寫Gadget-Foo。必須填寫。
name: 小工具名稱（如「Twinkle」）。可留空。
1: 小工具功能介紹（如「執行常見管理操作」）。必須填寫。
default: 預設啟用填1，否則填0。; 維基共享資源曾試圖使用Lua自動檢測是否預設啟用，但由於性能問題遭禁用。因而本站也採用手動標示。T51501解決後不再需要本設置。
extwiki: 若小工具會加載其他維基媒體wiki的內容，填1，否則填0。如這些內容同時亦為用戶腳本或樣式，請同時設置user。
external: 若小工具會加載外部網站（非維基媒體站點）的內容，填1，否則填0。此類小工具不建議預設啟用。
user: 若小工具會加載用戶腳本或樣式，填1，否則填0。此類小工具不建議預設啟用。
doc: 文檔頁名稱。可留空。
example: 範例頁名稱。可留空。
talk: 討論頁名稱。可留空。
settings: 設置頁面名稱。可留空。

代碼	效果
`{{Gadget-desc\|self=Gadget-Foo\|小工具描述。}}`	小工具描述。
`{{Gadget-desc\|self=Gadget-FooDefault\|default=1\|小工具描述。}}`	^預小工具描述。
`{{Gadget-desc\|self=Gadget-Foo1\|name=小工具名\|小工具描述。}}`	小工具名：小工具描述。
`{{Gadget-desc\|self=Gadget-Foo1ExtwikiUser\|name=小工具名\|extwiki=1\|user=1\|小工具描述。}}`	小工具名：^跨^用小工具描述。
`{{Gadget-desc\|self=Gadget-Foo2\|name=小工具名\|小工具描述。\|doc=Wikipedia:Sandbox}}`	小工具名：小工具描述。 [檔案]
`{{Gadget-desc\|self=Gadget-Foo3\|name=小工具名\|小工具描述。\|doc=Wikipedia:Sandbox\|talk=Talk:Sandbox\|example=Wikipedia:Sandbox\|settings=Wikipedia:Sandbox}}`	小工具名：小工具描述。 [檔案 / 範例 / 討論 / 設定]

隱藏的小工具不應使用本模板，而應使用{{Gadget-desc-utility}}作為佔位符。