2023年政策修订增补工作正在进行中,欢迎参与!
  • Moegirl.ICU:萌娘百科流亡社群 581077156(QQ),欢迎对萌娘百科运营感到失望的编辑者加入
  • Moegirl.ICU:账号认领正在试运行,有意者请参照账号认领流程

模板:Documentation

萌娘百科,萬物皆可萌的百科全書!轉載請標註來源頁面的網頁連結,並聲明引自萌娘百科。內容不可商用。
跳至導覽 跳至搜尋
Template-info.svg 模板文檔  [查看] [編輯] [歷史] [刷新]

這個模板用來顯示並格式化一些模板的說明文件,包括你正在閱讀的本文。

Template:Documentation既可以用來嵌入/doc子頁面,也可以用來進行內聯嵌入;同時,將有一定的樣式來標記文檔部分。

使用Template:Documentation能夠將模板及其頁面分離,從而避免內聯文檔的缺點(如頁面被保護/數據庫被鎖定後無法編輯說明、只選一個目錄編輯可能會被系統誤判為無限遞歸使用等問題)。

使用方法極其簡單,僅需在目標模板的最後加入<noinclude>{{Documentation}}</noinclude>即可,然後在模板下方就會出現文檔內容。

  • 在其他頁面嵌入目標模板後,{{Documentation}}呈現的內容不會出現。
  • 如果你在目標模板使用的是<onlyinclude>標籤,你可以直接在該HTML標籤以外輸入{{Documentation}}, 亦可實現嵌入模板時不顯示說明文檔的效果。
    因為<onlyinclude>同樣用於控制嵌入顯示內容,僅允許被標籤包含其中的內容可被嵌入顯示。

注意:請確保HTML標籤<noinclude>直接接在模板原始碼或文字的最後一行後方,不要新起一行

  • 否則,一個多餘的新行會插入到包含該模板的頁面中,一般情況下,模板本身的頁面不需要這個新行。
另起一行時的呈現效果
萌娘百科,万物皆可萌的百科全书。

<noinclude>{{Documentation|content=内联文档
}}</noinclude>

萌娘百科,萬物皆可萌的百科全書。


Template-info.svg 模板文檔  [編輯]

內聯文檔

點擊模板中的「創建」按鈕就能在模板的/doc子頁面中創建所需的文檔。創建完以後模板頁就會自動包含這個文檔,效果即如本文檔般。

內聯文檔

雖然不推薦內聯文檔,但對於一些內容精簡的文檔,內聯呈現方式的確更加方便。這時候可以使用該模板的content屬性:

<noinclude>{{Documentation|content=
内联文档
}}</noinclude>
Template-info.svg 模板文檔  [編輯]

內聯文檔


  • 參數1的默認值是{{Documentation/docname}};解析後的結果為「(頁面名字)/doc」。例如,在本頁面(Template:Documentation)下,參數1的默認值是Template:Documentation/doc。
  • 以下特定場合亦可使用此模板:
    • 多個模板使用一個說明文檔時,參數1指向統一的說明文檔頁面。
    • 用在頁面空間為「模塊(Module)」、「小部件(Widget)」的頁面時,此模板將分別顯示「Template-info.svg模塊文檔」或「Template-info.svg小部件文檔」。
    • 在其他頁面空間以文檔形式呈現內容時,此模板將顯示為「文檔」而不是「Template-info.svg模板文檔」。
      可以在幫助:沙盒中自行使用{{Documentation}}並顯示預覽以查看呈現效果。
  • 參數content的默認值為空。
  • 模板:Doc 作為快捷方式重新導向至此模板,輸入{{Doc}}等效於{{Documentation}}