Template:Ambox/doc: Difference between revisions

{{Documentation subpage}}

{{Ambox

| small = {{{small|}}}

| type  =  

| image =  

| sect  = {{{1|}}}

| talk  = {{{talk|}}}

| date  = {{{date|}}}

| cat  =  

| all  =  

}}

|}

=== ''name'' ===

This parameter should be updated if the template is ever moved. The purpose of this parameter is twofold:

* It allows the template to have a more useful display on its template page, for example to show the date even when not specified, and to apply categorisation of the template itself.

=== ''small'' ===

The ''small'' parameter should be passed through the template, as this will allow editors to use the small format by specifying {{para|small|left}} on an article:

Otherwise the standard format will be produced:

Other variations:

* For templates which should ''default to small'', try {{para|small|<nowiki>{{{small|left}}}</nowiki>}}. This will allow an editor to override by using {{para|small|no}} on an article.

=== ''type'' ===

|nocat=true

| type  = delete

}}

{{Ambox

|nocat=true

| type  = notice

}}

{{Ambox

|nocat=true

| type  = move

}}

{{Ambox

|nocat=true

| type  = protection

}}

You can choose a specific image to use for the template by using the ''image'' parameter. Images are specified using the standard syntax for inserting files in Wikipedia (see [[Wikipedia:Manual of Style/Images#How to place an image]].) Widths of 40-50px are typical. For example:

* {{tl|underlinked}} specifies {{para|image|<nowiki>[[File:Ambox wikify.svg|50x40px|link=|alt=]]</nowiki>}} and looks like this:

Please note:

* If no image is specified then the default image corresponding to the ''type'' is used. (See [[#type]] above.)

* If {{para|image|none}} is specified, then no image is used and the text uses the whole message box area.

=== ''sect'' ===

=== ''issue'' and ''fix'' ===

When used stand-alone it produces the whole text:

=== ''talk'' ===

This parameter may then be used by an editor as follows:

Notes:

=== ''date'' ===

Passing this parameter also enables [[:Category:Wikipedia maintenance categories sorted by month|monthly cleanup categorisation]] when the ''cat'' parameter is also defined.

=== ''cat'' ===

* articles will be placed in '''Category:CATEGORY''' if the date is not specified.

=== ''all'' ===

The ''all'' parameter defines a category into which all articles should be placed.

=== ''imageright'' ===

An image on the right side of the message box may be specified using this parameter. The syntax is the same as for the ''image'' parameter, except that the default is no image.

=== ''class'' ===

=== ''style'' and ''textstyle'' ===

Optional CSS values may be defined, without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>.

* ''textstyle'' relates to the text cell.

Customised text for the small format can be defined using ''smalltext''.

== Technical notes ==

* 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.

</div>

}}

{{Ambox

|nocat=true

* The <code>&lt;div></code> tags that surround the text in the example above are usually not needed. But if the text contains line breaks then sometimes we get weird line spacing. This especially happens when using vertical dotted lists. Then use the div tags to fix that.

* The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent background that MediaWiki renders for svg images. The png images here have hand optimised transparent background colour so they look good in all browsers. Note that svg icons only look somewhat bad in the old browsers, thus such hand optimisation is only worth the trouble for very widely used icons.

* For more technical details see the [[Template talk:Ambox|talk page]] and the "See also" links below. Since this template works almost exactly like {{Tl|Tmbox}}, {{Tl|Imbox}}, {{Tl|Cmbox}} and {{Tl|Ombox}} their talk pages and related pages might also contain more details.

== See also ==