Template

Difference between revisions of "Ambox/doc"

From Joomla! Documentation

< Template:Ambox
m (combined image and type tables)
m
Line 1: Line 1:
 +
{{documentation subpage}}
 
{{tlp|ambox}} is the base tempate used by several ''"alert message boxes"'' which can be placed at the top of an article.  
 
{{tlp|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 <tt>text</tt> must be provided by the calling template in the <nowiki>{{{text}}}</nowiki> parameter.
 
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.

Revision as of 11:00, 1 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 {{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.

Parameters[edit]

Mandatory:

text
the message text to display

Optional:

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
style (empty)
CSS properties for the HTML style attribute applied to the <table> element. Please try to avoid using colors and fancy font settings in inline styles as this may conflict with a skin's color schema and user settings -- think accessibility!

type and image[edit]

Internal note: Please update the list of image names if files become available.
Value CSS class Image name
serious ambox-serious Stop icon
content ambox-content 50
(paper sheet?)
style ambox-style 50
(a calamus/quill?)
merge ambox-merge 50
(arrows, bandage, symbolic diff output?)
notice ambox-notice 50
growth ambox-growth 50
blank ambox empty cell
#default ambox-notice empty cell

imageright[edit]

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

Stylesheet[edit]

table.metadata plainlinks ambox type
td.ambox-image
td.ambox-imageright