Template:Cdx-message/doc

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search

Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab.

Displays a smaller and more compact notice as compared to the {{mbox}} series. Good for tips or notes in documentation and help pages. Not for article namespace. It looks similar to the Codex cdxMessage component, as it was originally styled to resemble it before that component became available in MediaWiki. Imported from mw:Template:Note.

Standard

[edit source]

Standard type that appears identical to the Codex style guide cdxMessage component:

Additional

[edit source]

In order of visual severity, all set with |mbox=true like mbox templates:

Auto width

[edit source]

Inline use

[edit source]

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Float right

[edit source]

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Multi-line

[edit source]

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Parameters

[edit source]

Adds message template. To inform the user of something noteworthy or give the user feedback.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Content1 text content 1

Contents of notice.

Contentrequired
Inlineinline

'True' will set inline instead of a block.

Default
false
Auto value
0
Booleansuggested
contentcontent

no description

Unknownoptional
texttext

no description

Unknownoptional
Mbox appearancembox message box infobox

Appears like an Mbox/message box. Centered, 10% left and right margins.

Default
false
Auto value
0
Booleansuggested
Type2 type

Type of notice or style to show; i.e. border/background coloring and icon. May be null to show the pin.

Suggested values
plain notice info success reminder flag warning warn caution error
Default
plain
Auto value
plain
Stringsuggested
typetype

no description

Unknownoptional
Float rightright float

Set to float right with a restricted width of 238px.

Suggested values
1 0
Default
false
Auto value
0
Booleansuggested
Widthwidth

To set width to auto, then set auto.

Suggested values
auto fit-content -webkit-fill-available 100%
Default
100%
Auto value
100%
Stringsuggested
Classclass

Custom classes

Example
nomobile noprint nosnippet nopagecontent
Stringoptional
Stylestyle

Custom CSS styling

Example
padding: 0px 10%;
Contentoptional
floatfloat

no description

Unknownoptional
infoboxinfobox

no description

Unknownoptional
message boxmessage box

no description

Unknownoptional

See also

[edit source]
  • {{mbox}}, and in particular the namespace-agnostic {{ombox}}, which by default resembles a typical "info" template.
  • {{notice}}
  • Codex
To-do
Could we change icon color with CSS filter function? Or should I reimplement entire thing following div and span tags used by new cdxMessage. And then copy their CSS for ease of use actually.