फलकम्:Ambox/doc

This documentation subpage contains instructions, categories, or other information for technical reasons.
To view the फलकम् page itself, see फलकम्:Ambox.

This is the ambox or article message box meta template.

It is used to create article message box templates such as {{wikify}} etc. It offers several different colours, uses default images if no image parameter is given and it has some other features.

Usage

Simple usage example:

{{ambox | text = Some text.}}

Complex example:

{{ambox
 | type  = style
 | image = [[Image:Icon apps query.svg|38px]]
 | style = width: 400px; color: red; font-weight: bold; font-style: italic
 | text  = The message body text.
 | lang  = 
}}

Default images

The following examples use different type parameters but use no image parameters thus they use the default images for each type.

Other images

The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the image parameter to specify an image other than the default images.

Special

Some other parameter combinations.

Parameters

List of all parameters:

{{ambox
 | type  = type
 | image = none / blank / [[Image:Some image.svg|40px]]
 | imageright = [[Image:Some image.svg|40px]]
 | style = Cascading Style Sheets value
 | text  = The message body text. 
 | lang  = Whether to provide a link to a language list located at {{../lang}}
}}

type

If no type parameter is given the template defaults to type notice which is used for "article notices". That means it gets a blue side bar like in the simple usage example above.

image

No parameter = If no image parameter is given the template uses a default image. Which default image it uses depends on the type parameter.

An image = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. For example:

[[Image:Unbalanced scales.svg|40px]]

none = Means that no image is used.

blank = Means that no image is used but an empty area the same size as a default image is used, which means that text in the message box gets aligned well with other article message boxes. (See the "special" examples above.)

imageright

No parameter = If no imageright parameter is given then no image is shown on the right side.

An image = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. For example:

[[Image:Nuvola apps bookcase.png|40px]]

Anything = Any other object that you want to show on the right side.

style

An optional Cascading Style Sheets value used by article message box enclosing HTML:

<table style="फलकम्:(({style|फलकम्:))}" class="..."> ... </table>

lang

Any non-blank entry here will cause the sibling page at {{../lang}} to transclude to the bottom of the text area. This is used for template translated subpages such as {{OTRS pending/en}}. if you don't need this parameter, omit it or leave it blank.

text

The message body text.

Technical details

If you need to use special characters in the text parameter then you need to escape them like this:

{{ambox
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are. 
But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>. 
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
}}

This template will use CSS classes soon, due to the 30 day waiting period.

Internally this meta template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta templates since wiki markup has several drawbacks. For instance it makes it harder to use parser functions and special characters in parameters.