模板:Message box/doc

[ 更新快取 ]

這是文檔頁面，它應該被放置到Template:Message box。查看Template:Documentation以獲取更多信息。

該模板用於向消息框添加一致的樣式。

請注意，在頁面原始碼中將該模板與{{tag}}置於同一行時會導致{{tag}}換行出錯。

用法

不推薦以行內形式使用此模板。

{{ Message box
| title = 作為標題的文本
| text = 作為普通文本的文本
| type = 消息框類型（預設樣式）
| class = 要附加的消息框基本類的名稱
| css = 要附加的消息框基本樣式（CSS文本）
| bgcol = 消息框背景色
| linecol = 消息框高亮條（左邊框）顏色
| font-size = 消息框的基本字號
| width = 消息框的寬度
| compat = 是否使用緊湊式消息框
| mini = 是否使用段落式消息框
| icon = 要在消息框中顯示的CommentSprite圖標ID
| iconlink = CommentSprite圖標要連結到的頁面名
| image = 要在消息框中顯示的圖片文件名（不含前導File:）
| imagelink = 圖片要連結到的頁面名
| imagecss = 要附加的消息框圖像區樣式（CSS文本）
| imagesize = image的大小
| imagetextbefore = 要在圖像區的圖像前顯示的文本
| imagetextafter = 要在圖像區的圖像後顯示的文本
| text-align = 消息框文本區的文本對齊方式
| textcss = 要附加的消息框文本區樣式（CSS文本）
| customaction = 要在標題文本後上標區中顯示的文本
| discuss = 是否在標題文本後上標區中顯示討論連結
| discussPage = 討論連結要指向的討論頁名稱
| discussAnchor = 討論連結要指向的討論頁段落名稱
| linkshere = 是否在標題文本後上標區中顯示鏈入頁面連結
}}

基本參數

• |title=：推薦，要作為消息框標題顯示的文本，此文本會被加粗。可以是任意wikitext。
• |text=：推薦，要作為消息框普通文本顯示的文本。可以是任意wikitext。

基本類型

• |compat=：可選，指定使用緊湊式消息框（寬度適應文本的消息框）。
• |mini=：可選，指定使用段落式消息框，適合放置在段落而不是頁面頂部時使用。

消息框基本樣式

• |type=：可選，用於代替手動指定|bgcol=和|linecol=而使用預設樣式。可用的類型見此模板的樣式表，目前可用的如下：

類型	示例
default notice （默認）
red warning
orange content
yellow style
green status
cyan version
magenta
purple move
grey protection
black

• |bgcol=：可選，指定消息框的背景色（不推薦使用，因為此方式無法適配深色模式），可以為任意CSS支持的格式。使用此參數的頁面會列入使用Message box的bgcol參數的頁面分類中。
• |linecol=：可選，指定消息框高亮條（左邊框）的顏色（不推薦使用，因為此方式無法適配深色模式），可以為任意CSS支持的格式。使用此參數的頁面會列入使用Message box的linecol參數的頁面分類中。
• |font-size=：可選，指定消息框中文字的基本字號，未單獨指定字號的文本都會使用此處指定的字號。
• |width=：可選，指定消息框的寬度，最多可為全頁寬度的80%（參見此模板的樣式表）。指定此參數後，|compat=不會起效。
• |class=：可選，指定要對整個消息框生效的附加CSS類。
• |css=：可選，指定要對整個消息框生效的內聯樣式。

消息框圖像區

• |icon=：可選，指定要顯示的CommentSprite的ID，ID定義見CommentSprite模板文檔，對應含義見Comment模板文檔。
• |iconlink=：可選，指定CommentSprite要連結到的頁面名稱。
• |image=：可選，指定要顯示的圖片名稱（顯示在CommentSprite後，不含前導File:）。
• |imagelink=：可選，指定圖片要連結到的頁面名稱。
• |imagecss=：可選，指定要對整個消息框圖像區生效的內聯樣式。
• |imagesize=：可選，指定通過|image=指定的圖像的顯示大小。若不指定，默認為16px（指定|mini=時）或32px（未指定|mini=時）。
• |imagetextbefore=：可選，指定要在消息框圖像區內，CommentSprite和圖片前顯示的文本。可以是任意wikitext。
• |imagetextafter=：可選，指定要在消息框圖像區內，CommentSprite和圖片後顯示的文本。可以是任意wikitext。

消息框文本區

• |text-align=：可選，指定消息框文本區內文本的對齊方式，可為left（左對齊，默認）、center（居中）、right（右對齊）。
• |imagecss=：可選，指定要對整個消息框文本區生效的內聯樣式。
• |customaction=：可選，指定要作為消息框標題後第一個上標的文本。可以是任意wikitext。
• |discuss=：可選，指定要在消息框標題後第二個上標處顯示自動的「討論」連結，用於連結至討論頁。
• |discussPage=：可選，指定「討論」連結的目標頁面。若不指定，則指向使用此模板的頁面對應的討論頁。
• |discussAnchor=：可選，指定「討論」連結要連結到的目標段落。若不指定，「討論」連結只會連結到頁面。
• |linkshere=：可選，指定要在消息框標題後第三個上標處顯示自動的「鏈入」連結，用於連結至使用此模板的頁面的「鏈入頁面」特殊頁面。

示例

基本用法

{{ Message box
| title = 这是一个普通的消息框
| text = 还有叙述性的副文本
}}

將如此顯示：

微型用法

{{ Message box
| mini = 1
| icon = 8
| text = 这是一个有图标并且使用[[Template:CommentSprite]]的微型消息框 
}}

將如此顯示：

高級用法

{{ Message box
| type = cyan
| title = 这是一个蓝色的消息框
| text = 它包含一个讨论链接和自定义CSS代码
| discuss = 1
| css = -moz-box-shadow: 0px 0px 6px #888; -webkit-box-shadow: 0px 0px 6px #888;
}}

將如此顯示:

{{ Message box
| type = cyan
| title = 这是一个蓝色消息框
| text = 它包含讨论链接，自定义的CSS代码以及一个自定义图片
| discuss = 1
| image = No_image.svg
| css = -moz-box-shadow: 0px 0px 6px #888; -webkit-box-shadow: 0px 0px 6px #888;
}}

將如此顯示:

自定義圖片的尺寸還可以使用"imagesize"來指定，例如：imagesize = 50px

高級微型用法

{{ Message box
| mini = 1
| image = No_image.svg
| type = cyan
| css = -moz-box-shadow: 0px 0px 6px #888; -webkit-box-shadow: 0px 0px 6px #888;
| text = 这是一个微型消息框，类似于上边的高级消息框。
}}

將如此顯示:

它的圖片同樣也能選擇尺寸。