维基百科 :模 板文 档
此維 |
能 夠解決 什麼 問題 ?
維基
在 <noinclude>...</noinclude>中 的 文字 在 被 其他页面嵌入 前 显示會 被 加算 到 「展開 前 的 大小 pre-expand include size」,其大小 有 上限 (參 見 Wikipedia:模 板 限 制 )。有 一 些模板 ,因 為 被 大量 的 頁 面 所 引用 而受到完全 的 保護 。這時候 編輯 說明 內容變 得 極 為 不 方便 ,非 管理 員 必須 提出 修 改 的 要求 ,而管理 員 得 去 代 為 修 改 。一 個 頁 面 的 「預 先 包含 pre-included」和 「展開 後 post-expanded」的 大小 設 有 上限 。更 糟 的 情況 是 ,模 板 裡 包含 了 另一 個 模 板 ,其「預 先 展開 pre-expanded」大小 因 此倍增 而發生 衝突 。(參 見 Wikipedia:模 板 限 制 )。- 如果
在 编辑模 板 时,要 使用 维基百科 的 “查找和 替 换”批量替 换模板 内容 的 话,可能 会 使 说明内容 也受到波及 。
這個
當 廣 受利用 的 模 板 更新 時 ,能 將 伺服器 重 新 讀取 的 資料 量 降 到 最小 。- 受
保護 的 穩定模 板 ,可 以增添解說 、分類 等 內容,而不用 干 擾到主要 用途 。
使用 方法
[--
模 板 的 最後 一 行 文字 --]<noinclude>
{{Documentation}}
<!-- 請將模 板 的 分類 放 在 /doc子 頁 面 -->
</noinclude>
{{NoteTA
|G1 = MediaWiki
}}
{{Documentation subpage}}
<!-- 在 本 行 下 編輯 模 板 說明 -->
== 概要 ==
== 參 數 及使用 方法 ==
== 範 例 ==
== 注意 事 项 ==
== 重定 向 ==
== 模 板 编辑说明 ==
== 參 見 ==
<includeonly>{{Sandbox other||
<!-- 本 行 下 加入 模 板 的 分類 -->
}}</includeonly>
- 請
確保 <noinclude>的 開 頭 ,接 在 模 板 原始 碼或文字 的 最後 一 列 後方 ,不要 新 起 一 列 。否 則 ,一個多餘的新列會被插入到包含 X模 板 的 頁 面 中 ,往往 該頁面 不 需要 這個新 列 。 - 此外,
子 頁 面 的 標題 請必定 要 使用 "/doc"的 型式 。 - 'X/doc'
文 件 頁 面 的 分類 應 該只有 Category:模 板 說明 文 件 ,請調整 原始 碼讓屬 於模板 的 分類 只 存在 於模板 主 頁 面 。 - 你可以將 /doc
子 頁 面 的 討論 頁 重定 向 到 模 板 本身 的 討論 頁 ,那 麼最後 所有 有 關 模 板 及其文 件 頁 的 討論 就會在 同一 討論 頁 上 ,舉個例 ,將 Template talk:X/doc重定 向 到 Template talk:X。
分 类链接
要 将 模 板 本身 置 于一个分类中,请在 doc子 页面上 的 <includeonly>
...</includeonly>
段落 中 添加 代 码[[Category:
。分 类名]]
要 将 doc子 页面置 于一个分类中,请在 doc子 页面上 的 <noinclude>
...</noinclude>
段落 中 添加 代 码[[Category:
。分 类名]]
要 让该模 板 将 条目 置 于一个分类中(当 该条目 使用 该模板 时),请在模 板 页上的 <includeonly>
...</includeonly>
段落 中 添加 代 码[[Category:
。分 类名]]
優 點
編輯 的 X/doc頁 面 只 會 傳 遞展示 到 該模板 頁 面 上 ,而不會 被 包含 在 X模 板 裡 。引用 X模 板 的 頁 面 不 需要 仰 賴 文 件 頁 面 ,所以 不 會 為 了 重度 使用 模 板 而擴大 工作 請求 (m:Help:job queue)。文 件 的 編輯 不 會 對 模 板 本身 和 引用 的 頁 面 造成 任 何 危害 。對 於文件 頁 面 的 破壞 ,不 會 擴及到引用 X模 板 的 頁 面 上 。即 使 模 板 受到完全 保護 ,每 個人 仍然能 夠編輯 模 板 說明 文 件 。分類 可 以簡單 地 增加 在 X/doc子 頁 面 。
註釋
- 蒂姆·斯塔
林 (Tim Starling)寫 到 :「若 解說 文 件 過大 或 是 更新 頻繁 ,我 建議 你將它移動 到 子 頁 面 。如此一來你可以將它引用到 <noinclude>區 段 和 討論 頁 之 中 。」 [1]
範 例
- {{Tnavbar}}(
被 保護 ),{{Tnavbar/doc}}(未 保護 )