模板:Ambox/doc

出自Rotaeno中文维基

本模板是條目信息框的元模板。用於創造文章信息框模板。此外本模板具有自由選擇不同顏色、顯示特定預設圖片等功能。

請注意:這個模板只用於在條目名字空間使用的模板,其他名字空間使用的模板請不要使用。模板:Ombox適用於其他名字空間。

常用參數

右側的方框內為本模板最常用的參數。每種參數的說明如下:

常用參數
{{Ambox
| name  = 
| subst = <includeonly>{{subst:substcheck}}</includeonly>
| small = {{{small|}}}
| type  = 
| image = 
| sect  = {{{1|}}}
| issue = 
| talk  = {{{talk|}}}
| fix   = 
| date  = {{{date|}}}
| time  = {{{time|}}}
| cat   = 
| all   = 
}}

name

name參數指定模板的名字,不需要加上模板名字空間前綴。

本參數應該模板被移動時更新。本參數的指定有兩個目的:

如果模板被錯誤的替換引用(substituded),這個參數能讓元模板顯示一段警告文字,將可幫助編輯者修復問題。

能讓模板在模板頁中更有效地展示,例如在沒有填入日期的情況下自動顯示日期,並能讓模板準確分類。

subst

subst參數讓元模板能檢測此模板是否被錯誤替代引用的,並顯示一段警告文字。完全複製上述方框中的代碼即可。一般情況下,請勿更改本參數內容,直接複製上方的模板代碼即可。

small

small參數可讓編輯者在條目中使用模板時輸入 |small=left 來產生一個小型的模板。

一般情況下本模板的顯示效果如下:

其他參數設置方式:

  • 如果模板「永遠」不應以縮小的方式顯示,請在模板原始碼中使用 |small=no
  • 如果模板應「總是」以縮小的方式顯示,請在模板原始碼中使用 |small=left
  • 如果模板「默認為縮小顯示」,請在模板原始碼中使用 |small={{{small|left}}}。可讓編輯者在條目中輸入 |small=no 參數時無效。

type

type 參數能指定的模板默認的左側直條顏色和圖片。本參數的選擇並非依據編輯者對顏色的偏好,而是根據模板內訊息的類型來決定。以下是七種可在「type」參數中填入的值:

如果沒有指定 type 參數,默認為 notice。

image

您可以使用 image 參數來指定模板中顯示的圖片。圖片的指定語法與維基百科放置圖片的默認語法相同(參見:如何放置圖片)。一般來說,圖片的寬度約為 40-50px。示例如下:

  • {{POV}} 中參數設置為 |image=[[File:Unbalanced scales.svg|40px|link=|alt=]],其顯示效果如下:

請注意:

  • 如果沒有指定圖片,模板將會配合「type」參數的內容選擇適當的圖片(參見:#type)
  • 如果參數設置為 |image=none 時將不會顯示任何圖片,訊息框內將僅顯示文字。
  • 如果圖片僅為裝飾功能,並屬於公共領域,可如在參數中加上 "|link= 以產生連往圖片描述頁的連結,以及 |alt=" 來產生替代文字;以上兩種做法可提升頁面親和力。

sect

許多條目訊息模板開頭文字為「此條目⋯⋯」,如果此模板用於章節,則應該更適當地使用「此章節⋯⋯」。其他可能性包括「此列表⋯⋯」和「此人物傳記⋯⋯」。

為了實現這個功能。請使用 |sect={{{1|}}} 參數。這將使編輯者能在第一個無名的參數中輸入「章節'」來改變模板所指的條目部分。

在使用這個功能時,在模板原始碼中應移除開頭的幾個字(例如:本條目),否則會造成重複顯示。

issue & fix

issue 參數用於描述條目的問題。請儘量保持文字敘述簡潔有力(約在 10-20 個字內),並包含一個連結至有關的方針與指引頁面。

fix 參數包含描述如何改進條目的指導文字。文字內容可比 issue 參數中所填入的字數多,在大多數情況下,請保持在兩句話內敘述完畢。

當模板以集成狀態(例如放置在 {{multiple issues}} 中)或小型狀態(使用 |small=left 參數)顯示時,只有 issue 參數中的文字會顯示。例如在 {{citation style}} 模板中的參數設置為:

  • |issue = 本条目的'''引用需要进行清理。'''
  • | fix = 参考文献应符合正确的[[Wikipedia:列明来源|引用]]、[[Wikipedia:脚注|脚注]]及[[Wikipedia:外部链接|外部链接]]格式。

talk

某些條目訊息框模板包含了一個通往其討論頁的連結,並讓編輯者能指定相關議題所在的章節位置。如要達成這項功能,請使用 talk 參數,使用方式為 |talk={{{talk|}}}

這項參數將可被編輯者以下述方式使用:

  • |talk=章节标题 - 連結可通往條目討論頁中的特定章節。例如:|talk=西瓜
  • |talk=完整页面名称 - 連結將通往指定的頁面。例如:|talk=Talk:香蕉#西瓜

請注意:

  • 當模板中使用本參數時,模板本身將會顯示一個通往討論頁的連結(為了顯示支持此功能),但僅有在參數被確實定義時才會在條目中的模板內顯示。
  • 如果要讓模板永遠顯示一個通往討論頁的連結,請使用 |talk={{{talk|#}}} 參數。
  • 如果討論頁面不存在,無論參數設置為何,都將不會顯示任何連結。

date

date 直接發送至元模板可讓編輯者(或機械人)自行輸入模板被放置在條目中的日期。日期將會以較小的字體在主要文字後顯示。

cat 參數同時獲得定義時,將 date 參數發送至元模板可實現將條目自動按月分類的功能。

time

timedate用法差不多,但是time可以配合{{#time:c}},例如:

{{ambox|issue=内容|fix=附加文字|date={{subst:#time:c}}}}會顯示為:

{{ambox|issue=内容|fix=附加文字|time={{subst:#time:c}}}}會顯示為:

cat

這個參數定義了清理分類的名稱。使用 |cat=CATEGORY 參數:

  • 並同時使用 |date=DATE,則條目會被自動分類至 Category:自DATE起CATEGORY 中。
  • 若無指定日期,條目會被自動分類至 Category:CATEGORY 中。

all

all 參數可用來指定所有包含模板之條目的分類。

其他參數

右側方框內展示了此模版的所有參數。由於幾乎不可能同時用到所有參數,因此不建議複製此處的空白模版。

完整的所有參數
{{Ambox
| name        = 
| subst       = <includeonly>{{subst:substcheck}}</includeonly>
| small       = {{{small|}}}
| type        = 
| image       = 
| imageright  = 
| smallimage  = 
| smallimageright = 
| class       = 
| style       = 
| textstyle   = 
| sect        = {{{1|}}}
| issue       = 
| talk        = {{{talk|}}}
| fix         = 
| date        = {{{date|}}}
| time        = {{{time|}}}
| text        = 
| smalltext   = 
| cat         = 
| all         = 
| cat2        = 
| all2        = 
| cat3        = 
| all3        = 
}}<noinclude>
{{Documentation}}
</noinclude>

imageright

在訊息框右側顯示圖片。填入方式與 image 參數相同,默認為不顯示任何圖片。

smallimage & smallimageright

可在此參數指定模板縮小顯示後所使用的圖片。僅在定義 |small=left 時有效。

class

可自行定義使用在訊息框的CSS類型選擇器(Class)。

style & textstyle

可選擇定義CSS樣式,不需加上引號 " ",但必須在結尾加上分號 ;

  • style 為套用至整個訊息框的樣式
  • textstyle 為僅套用在文字上的樣式

text & smalltext

除了指定 issuefix 參數外,也可使用 text 參數來定義要顯示的文字(不建議使用text,不支持移動版)

smalltext 則用來定義要以較小字體顯示的文字

其他分類相關參數

  • cat2cat3 可增加按月分類時所用的分類名稱,用法與 #cat 參數相同。
  • all2all3 可增加所有包含模板之條目的分類名稱,用法與 #all 參數相同。

技術細節

如果你需要在text參數中使用一些特殊字符的話,那麼就需要像這樣將它們換碼:

{{ambox
| text  = 
等号 = 与前后大括号{ }可以正常地使用。
但是管道符{{!}}与两个连着的后大括号<nowiki>}}</nowiki>则不能直接使用。
一起用同样要带nowiki标记<nowiki>|}}</nowiki>。
}}

此模板使用CSS類來確定顯示風格,因此可被更換到其他風格。

在此元模板內使用了HTML的表格標示法,而沒有使用維基式的表格標示法。在製作元模板時這是一個常見的方法,因為維基式標示法存在一些缺陷。譬如,維基式標示法會加大模板擴展語法及參數中特殊字符使用的難度。

更多的技術細節參見維基百科頁面。