模板:WPBannerMeta/doc

WPBannerMeta是一個元模板,能用來創建專題橫幅,能方便地在條目討論頁創建橫幅,從而使每個專題協調工作。所有使用該模板的橫幅列表見鏈入頁面:WPBannerMeta

該模板為模板,用途為構建其他模板。因此請不要在討論頁直接使用此模板,而是透過專題模板調用。

語法

WPBannerMeta能以不同的複雜度使用,既可很簡單也可極複雜。簡單的選項在此先行列出,而其餘複雜的內容則在頁面下方。

WPBannerMeta使用兩類不同的參數,分別是格式和顯示參數。格式參數可為特定專題自定義本元模板,用於定義鏈接目標、分類、圖像和文字。所有格式參數均使用大寫字母,並用下劃線(_)代替空格(例如|PROJECT=|NOTE_1_CAT= )。顯示參數則為橫幅所在的單個條目定義其模板輸出,這些參數會出現在條目討論頁(|class=|importance=等),並且在底層必須由專題橫幅「傳遞」到元模板。為傳遞參數foo,則需要包含代碼foo={{{foo|}}}

下文將以當前並不存在的鬱金香主題鬱金香專題為例介紹專題橫幅的構建。

簡單選項

  • PROJECT(專題,必填)– 專題名稱,不含「專題」二字。例如:郁金香
    • substcheck(替換引用檢查)– 該參數允許模板偵測其是否誤被替換引用,而非內嵌於頁面,並會給出錯誤消息。substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
    • small(微型,必填) – 尺寸參數必須傳遞至模板以正確顯示。例如:small={{{small|}}}
    • category(分類,必填)– 「category」參數必須傳遞至模板。例如:category={{{category|¬}}}
      • category_trad(分類是否為繁體)–當「PROJECT」參數以繁體中文填寫時,請指定該參數為yes,確保條目評級分類不會繁簡混雜。
    • listas(列為,必填)– 「listas」參數必須傳遞至模板。例如:listas={{{listas|}}}
    • BANNER_NAME={{subst:FULLPAGENAME}}(橫幅名稱,必填)– 橫幅頁面的全名。例如:Template:WikiProject Tulips
  • PROJECT_LINK(專題鏈接)– 模板默認專題位於"专题:<PROJECT>"。若屬其他情況,請在此參數定義專題頁的完整鏈接。例如:专题:郁金香
  • IMAGE_LEFT(左側圖像)– 橫幅左上角的圖像地址,請勿加入「'File:」或「File:」前綴。專題橫幅使用的圖像必須是自由圖像,不得使用合理使用圖像。例如:Tulipa suaveolens floriade to Canberra.jpg
    • IMAGE_LEFT_SMALL(左側小圖)– 橫幅以「微型」顯示時的IMAGE_LEFT的圖片大小,默認為40px。例如:25px
    • IMAGE_LEFT_LARGE(左側大圖)– 通常顯示的IMAGE_LEFT圖片大小,默認為80px。例如:50px
  • IMAGE_RIGHT(右側圖像)– 橫幅右上角的圖像地址,請勿加入「'File:」或「File:」前綴。專題橫幅使用的圖像必須是自由圖像,不得使用合理使用圖像。例如:Tulipa suaveolens floriade to Canberra.jpg
    • IMAGE_RIGHT_SMALL(右側小圖)– 橫幅以「微型」顯示時的IMAGE_RIGHT的圖片大小,默認為40px。例如:25px
    • IMAGE_RIGHT_LARGE(右側大圖)– 通常顯示的IMAGE_RIGHT圖片大小,默認為80px。例如:50px
  • MAIN_TEXT(主文本)– 默認文本為「本條目屬於[[{{{PROJECT}}}专题]]的範疇,一個旨在改善中文維基百科{{{PROJECT或MAIN_ARTICLE}}}類條目內容的項目。如果您有意參與,請瀏覽專題主頁,參與其[[Talk:{{{PROJECT_LINK}}}]]並完成相應的開放性任務。」定義本參數則可顯示其他文本。
    • MAIN_ARTICLE(主條目)– 默認條目為PROJECT,鏈接條目既可為單一的條目,亦可為更複雜的文本。例如:(默認)郁金香「……中文維基百科鬱金香類內容……」(可選)[[郁金香]]及[[百合科]]相关条目「……中文維基百科鬱金香百合科相關條目類內容……」
  • PORTAL(主題)– 若該專題包含有主題,請為此參數定義主題名。例如:郁金香
  • MAIN_CAT(主分類)– 默認不創建主分類,若定義該參數,所有顯示該模板的頁面都將歸入Category:MAIN_CAT例如:郁金香专题条目Category:鬱金香專題條目
  • BOTTOM_TEXT(底文本)– 若定義此項,文本將顯示在橫幅底部、摺疊區(若顯示)上端。請勿使用此參數掛接其他代碼到模板底部,請參見下文鈎子一節尋求更好的解決辦法。


示例
{{WPBannerMeta
|PROJECT          = 郁金香
 |BANNER_NAME     = Template:WikiProject Tulips
 |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
 |small={{{small|}}}
 |category={{{category|¬}}}
 |listas={{{listas|}}}
|PROJECT_LINK     = 专题:郁金香
|IMAGE_LEFT       = Tulipa suaveolens floriade to Canberra.jpg
|IMAGE_LEFT_SMALL = 25px
|IMAGE_LEFT_LARGE = 50px
|MAIN_ARTICLE     = [[郁金香]]及[[百合科]]相关条目
|PORTAL           = 郁金香
|PORTAL_IMG       = Tulipa florenskyi 4.jpg
}}
顯示為:
鬱金香專題 (獲評非條目級
本模板文件框架屬於鬱金香專題範疇,該專題旨在改善中文維基百科鬱金香百合科相關條目類內容。如果您有意參與,請瀏覽專題主頁、參與討論,並完成相應的開放性任務。
 非條目級非條目  根據品質評級標準,本模板文件無需評級。

評級

許多專題使用條目質量評級標準評價其條目質量,並使用條目重要度評級標準為其排定優先級。為了讓專題委員會及各專題使用機器人編制條目狀態表,您需要遵守/使用機器人指南,並掌握下列要點:

  • QUALITY_SCALE(質量評級標準)– 用於配置質量評級標準,可選項有:
      • standard(標準)– 使用標準評級標準(特色優良、丙、初、小作品特色列表、列表、非條目)。(若使用「class」參數,本項為默認。)
      • extended(擴展)– 使用標準質量標準及部分附加值(分類、消歧義、文件、主題、專題和模板)。
      • inline(內聯)– 允許使用簡單的自定義質量標準,通常搭配{{Class mask}}使用。(注意:如果橫幅需要使用乙級檢查表或任何鈎子,建議改用subpage選項。)
      • subpage(子頁面)– 允許使用更複雜的自定義質量標準,需創建名為「/class」的子頁面。詳見自定義掩碼
    • class(等級,必填)– 若使用質量標準,class參數必須傳遞至元模板。例如:class={{{class|}}}
    • auto(自動)若需要自動評級選項,auto參數必須傳遞至元模板。例如:auto={{{auto|}}}使用機器人自動為小作品分類的專題,可令機器人在其專題橫幅加入|auto=yes,橫幅即可提示該條目係由機器人自動評級。
    • B_CHECKLIST(乙級檢查表)– 若定義此項,即可啟用乙級檢查表。乙級條目官方描述包含六項指標,各條目對各項標準的符合/不符狀態通過 |b1=|b6=加以傳遞。僅當某條目六項均達標時方可評為乙級,否則則為丙級。
      • b# – 若使用乙級檢查表,六項乙級指標必須傳遞至元模板。
        • 若使用自定義等級,必須將標準參數傳遞至元模板。例如:b1={{{B-Class-1|{{{b1|}}}}}}等。
        • 若使用標準參數,則例如:b1={{{b1|}}}等即可。
  • importance(重要度)– 若定義此項,即可啟用重要度評級標準(極高、高、中、低、極低、無、不適用、未知)。例如:importance={{{importance|}}}
    • priority(優先級)– 若定義此項,即可啟用優先級評級標準(極高、高、中、低、不適用、未知)。例如:priority={{{priority|}}}。importance、priority二參數只可用其一。
    • IMPORTANCE_SCALE
      • standard(標準)– 使用標準評級標準。本項為默認。
      • inline(內聯)– 允許使用簡單的自定義質量標準,通常搭配{{Class mask}}使用。
      • subpage(子頁面)– 允許使用更複雜的自定義質量標準,需創建名為「/importance」的子頁面。詳見自定義掩碼
  • ASSESSMENT_LINK(評級鏈接)– 特定專題質量(和/或重要度)評級標準的鏈接,若存在"专题: <PROJECTLINK>/评级"頁面,則該頁即為默認鏈接。若需指定其他頁面,可將該參數設為no。詳見此處
  • ASSESSMENT_CAT(評級分類)– 條目會根據其質量等級歸入相應分類,因此鬱金香「特色條目」默認會歸類至Category:特色級鬱金香條目。若定義該參數,特色條目則會改歸類至Category:特色級ASSESSMENT_CAT. 例如:百合科条目Category:特色級百合科條目
  • COMMENTS(評論)– 部分專題可能希望使用條目討論頁的子頁面為該條目填寫簡單的評級相關評論,若評論位於「{{FULLPAGENAME}}/评论」子頁面,則該參數會自動在橫幅提示評論頁存在與否。例如:yes
示例
{{WPBannerMeta
|PROJECT             = 郁金香
 |BANNER_NAME        = Template:郁金香专题
 |small={{{small|}}}
 |category={{{category|¬}}}
 |listas={{{listas|}}}
|IMAGE_LEFT          = Tulipa suaveolens floriade to Canberra.jpg
|QUALITY_SCALE       = extended
 |class={{{class|}}}
 |auto={{{auto|}}}
 |importance={{{importance|}}}
|ASSESSMENT_LINK     = 专题:郁金香/条目评级
|COMMENTS            = yes
 |COMMENTS_CAT       = 
 |COMMENTS_FORCE     = yes
}}
顯示為:
鬱金香專題 (獲評模板級不適用重要度
本模板文件框架屬於鬱金香專題範疇,該專題旨在改善中文維基百科鬱金香類內容。如果您有意參與,請瀏覽專題主頁、參與討論,並完成相應的開放性任務。
 模板級模板  根據專題品質評級標準,本模板文件無需評級。

警報與提示

WPBannerMeta能顯示許多包含條目信息和其相關工作組的的字段,並預設有「attention」字段供標記需要立即受到關注的條目,以及「needs-infobox」字段供標記需要信息框的條目。

  • attention(關注)– 請傳遞該參數以啟用相關提示。例如:attention={{{attention|}}},然後在相關討論頁加入|attention=yes
  • infobox(信息框)– 請傳遞該參數以啟用相關提示。例如:infobox={{{needs-infobox|}}},然後在相關討論頁加入|needs-infobox=yes
  • note 1(提示1)–請傳遞該參數以定義任意提示。例如:note 1={{{needs-photo|}}},然後在相關討論頁加入|needs-photo=yes。橫幅核心內最多可定義10個提示信息。
    • NOTE_1_TEXT(提示1文本,必填)– 提示1的文本。例如:根據標記,本條目需要照片
    • NOTE_1_IMAGE(提示1圖像)– 每個提示均可指定一幅圖像,請謹記必須使用自由圖像,而非合理使用圖像。例如:Gnome-dev-camera.svg
    • NOTE_1_FORMAT(提示1格式)– 注釋表格的可選格式(如顏色等)例如:style="background:blue"
    • NOTE_1_CAT(提示1分類)–若定義此項,所有顯示提示1的條目均會歸入Category:NOTE_1_CAT例如:需要照片的郁金香条目 Category:需要照片的鬱金香條目
  • COLLAPSED(可否摺疊)–當顯示在頁面的注釋和警報多於某一臨界值時,便會自動摺疊隱藏。設置本參數即可自定義該臨界值,確定頁面上不會引發摺疊的提示的最大數量。默認為3,所以如果頁面上有三條提示,此時提示區並不會摺疊,但如果顯示出第四條便會出現摺疊框。因此若設置|COLLAPSED=0,便能使提示區始終摺疊,而設置|COLLAPSED=999則可使其永不摺疊。請參見/notecounter hook例如:6
示例
{{WPBannerMeta
|PROJECT            = 鬱金香
 |BANNER_NAME       = Template:WikiProject Tulips
 |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
 |small={{{small|}}}
 |category=no
 |listas={{{listas|}}}
|IMAGE_LEFT         = Tulipa suaveolens floriade to Canberra.jpg
|QUALITY_SCALE      = extended
 |class={{{class|}}}
|ASSESSMENT_LINK    = 專題:鬱金香/條目評級
|attention={{{attention|}}}
 |ATTENTION_CAT     = 
|infobox={{{needs-infobox|}}}
 |INFOBOX_CAT       = 
|note 1={{{needs-photo|}}}
 |NOTE_1_TEXT       = 根據標記,本條目需要[[照片]]。
 |NOTE_1_IMAGE      = Gnome-dev-camera.svg
 |NOTE_1_FORMAT     = style="background:blue"
 |NOTE_1_CAT        = 需要照片的鬱金香條目
|note 2 = {{{audio-file|}}}
 |NOTE_2_TEXT       = 本條目含有對應[[音頻文件格式|音訊檔案]]。
 |NOTE_2_IMAGE      = Nuvola apps arts.svg
 |NOTE_2_CAT        = 含音頻文件的鬱金香條目
}}
顯示為:
鬱金香專題 (獲評丙級
本模板文件框架屬於鬱金香專題範疇,該專題旨在改善中文維基百科鬱金香類內容。如果您有意參與,請瀏覽專題主頁、參與討論,並完成相應的開放性任務。
 丙級  根據專題品質評級標準,本模板文件已評為丙級
更多資訊:
 
Note icon
根據標記,本模板文件框架需要您的關注。
Note icon
根據標記,本條目需要資訊框模板
Note icon
根據標記,本條目需要照片
Note icon
本條目含有對應音訊檔案

工作組

WPBannerMeta最多能容納五個工作組,每個都可以擁有自己的圖像、鏈接和重要度評級標準。下列參數可用:

  • tf 1(工作組1)– 必須傳遞該參數以啟用工作組的功能和信息顯示。 例如:tf 1={{{floridiae|}}}
    • TF_1_LINK(工作組1鏈接)– 工作組專題頁面的完整名稱。例如:专题:郁金香/工作组/原种郁金香
    • TF_1_NAME(工作組1名稱)– 該工作組在內部連結上所顯示的名稱,若使用|TF_1_TEXT=則無需此參數。 例如:原种郁金香工作组
    • TF_1_NESTED(工作組1嵌套)– 若定義此項,則當該橫幅摺疊在{{WikiProjectBannerShell}}內時,形如「/ [[{{{TF_1_LINK}}}|{{{TF_1_NESTED}}}]]」的鏈接會加入在主專題名之後。例如:原种郁金香
    • TF_1_TEXT(工作組1文本)– 若定義此項,可替換默認「本條目由……提供支持" 文本。例如:本页面属于[[专题:郁金香/工作组/原种郁金香|原种郁金香工作组]]的范畴,欢迎新成员加入!
    • TF_1_IMAGE(工作組1圖像)– 可為每個工作組指定圖像,請謹記必須使用自由圖像,而非合理使用圖像。 例如:Tulipa florenskyi 4.jpg
      • TF_1_SIZE(工作組1尺寸)– 圖像尺寸可在此處指定,默認為30px。使用比|IMAGE_LEFT_LARGE=還要大的尺寸還出現一些……很有趣的……結果。例如:40px
    • TF_1_QUALITY(工作組1質量)– 若定義此項,即可為該特譴隊啟用與主專題相同的質量評級分類(例如:Category:特色級鬱金香條目)。評級由 |class=產生,並使用|QUALITY_SCALE=例如:yes
    • tf 1 importance(工作組1重要度)– 若定義此項,即可為該特譴隊啟用單獨的重要度(或優先級)評級標準。例如:tf 1 importance={{{原种郁金香-importance|}}}
    • TF_1_ASSESSMENT_CAT(工作組1評級分類,若啟用評級則必填)– 用於該工作組專門的質量和重要評級的分類,語法與|ASSESSMENT_CAT=相同。例如:原种郁金香条目Category:特色級原種鬱金香條目
      • tf_1_category_trad(工作組1分類是否為繁體)– 若TF_1_ASSESSMENT_CAT使用繁體中文,請指定該參數為yes,確保工作組評級分類不會繁簡混雜。
    • TF_1_MAIN_CAT(工作組1主分類)– 若定義此項,所有顯示「工作組1」的頁面均會歸入Category:TF_1_MAIN_CAT例如:原种郁金香条目Category:原種鬱金香條目
示例
{{WPBannerMeta
|PROJECT              = 郁金香
 |BANNER_NAME         = Template:郁金香专题
 |substcheck=<includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>
 |small={{{small|}}}
 |category={{{category|¬}}}
 |listas={{{listas|}}}
|IMAGE_LEFT           = Tulipa suaveolens floriade to Canberra.jpg
|QUALITY_SCALE        = standard
 |class={{{class|}}}
|tf 1={{{floridiae|}}}
 |TF_1_LINK           = 专题:郁金香/工作组/原种郁金香
 |TF_1_NAME           = 原种郁金香工作组
 |TF_1_NESTED         = 原种郁金香
 |TF_1_TEXT           = 
 |TF_1_IMAGE          = Tulipa florenskyi 4.jpg
 |tf 1 importance={{{floridiae-importance}}}
 |TF_1_ASSESSMENT_CAT = 原种郁金香条目
 |TF_1_MAIN_CAT       = 原种郁金香条目
}}
顯示為:
          本模板文件屬於下列維基專題範疇:
鬱金香專題 / 原種鬱金香 (獲評典範級
本模板文件框架屬於鬱金香專題範疇,該專題旨在改善中文維基百科鬱金香類內容。如果您有意參與,請瀏覽專題主頁、參與討論,並完成相應的開放性任務。
 典範級典範  根據品質評級標準,本模板文件已評為典範級
工作組圖標
本模板由原種鬱金香工作組(標記為極高重要度)提供支援。

高級功能

鈎子

WPBannerMeta含有許多「鈎子」,可提供更多高級和自定義功能。各子模板會傳遞至關聯鈎子參數,任何關聯參數都應再傳遞至鈎子模板——可能需要重複已經傳遞至主模板的參數(通常用 (|category={{{category|¬}}}|class={{{class|}}} )。如果您認為您寫的鈎子可能會被其他專題用到,請將其複製或移動至Template:WPBannerMeta/hooks的子頁面,並加入到該頁的列表中。

自定義掩碼

WPBannerMeta使用掩碼規範化|class=參數的值,以過濾無效輸入(如|class=燒餅),並使類似的輸入等效化(如|class=FA|class=特色)。本掩碼能有效控制可接受哪些擴展等級標準值(如「模板級」、「重定向級」等)。希望使用其他等級(如「未來級」、「乙+級」),或不想使用全部標準等級(如不用「丙級」)的專題也可以指定自己的自定義掩碼。

其他細節

本元模板會自動將所有實例(即特定的專題橫幅)歸入Category:專題橫幅,因此無需在其文檔中為各專題橫幅加入分類。

WPBannerMeta模板核心:

為降低未使用到WPBannerMeta全部功能的橫幅的字節數,大部分可選功能均被拆分至各子頁面:

參見