Difference between revisions of "Ambox/doc"

Revision as of 11:25, 3 May 2008

This is a documentation subpage for Template:Ambox.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Ambox.

{{ambox}} is the base tempate used by several "alert message boxes" which can be placed at the top of an article. It generates a two column table with an optional "message icon". The message text must be provided by the calling template in the {{{text}}} parameter.

ambox should never be used directly, but only via "proxy templates" such as {{notice}}, {{inuse}}, {{underconstruction}} or {{docstatus}}. Those templates provide default parameters to have a consistant look and feel for alert message boxes including a standard message text and optional category tags.

Parameters[edit]

Mandatory:

text: the message text to display

Optional:

style (empty): value of the HTML style attribute applied to the table element
type (notice): controls the class attribute used
image (none): an image from the Image: namespace as a notification icon
imageright (none): an supplemental image from the Image: namespace, shown in a third column

type[edit]

Value	CSS class
serious	ambox-serious
content	ambox-content
style	ambox-style
merge	ambox-merge
notice	ambox-notice
growth	ambox-growth
protection	ambox-protection
#default	ambox-notice

image[edit]

Please update this list to the image names used.

Value	Image name
serious
content	50px
style
merge	50px
notice
notice	50px
blank	empty cell
#default	empty cell

imageright[edit]

An optional, arbitrary image from the File namespace. If this value is not empty, a third right column in added to the alert box to display the given image.

Try it in the Template:Ambox/sandbox.

Stylesheet[edit]

table.ambox ambox-type
td.ambox-image
td.ambox-imageright
table.standard-main
table.standard-talk
table.standard-file
table.standard-other

@@ Line 3: / Line 3: @@
 It generates a two column table with an optional "message icon". The message <tt>text</tt> must be provided by the calling template in the <nowiki>{{{text}}}</nowiki> parameter.
-<tt>ambox</tt> '''should never be used directly''', but only via "[[:Category:Marker templates|proxy templates]]" such as '''{{tl|notice}}''', '''{{tl|inuse}}''', '''{{tl|underconstruction}}''' or '''{{tl|docstatus}}'''. Those templates provide default parameters to have a consistant look and feel for alert message boxes including a standard message text and appropriate category tags.
+<tt>ambox</tt> '''should never be used directly''', but only via "[[:Category:Marker templates|proxy templates]]" such as '''{{tl|notice}}''', '''{{tl|inuse}}''', '''{{tl|underconstruction}}''' or '''{{tl|docstatus}}'''. Those templates provide default parameters to have a consistant look and feel for alert message boxes including a standard message text and optional category tags.
 == Parameters ==

Template