Template:Ambox: Difference between revisions

splitting documentation to subpage
(adding ambox-mini (since it's defined in Mediawiki:Common.css) + doc)
(splitting documentation to subpage)
Line 29: Line 29:
{{#ifeq: {{lc:{{{includecat|}}}}} | no | | {{#if: {{{category|}}} | [[Category:{{{category}}}]] }} {{{cat2|}}} }}<noinclude>
{{#ifeq: {{lc:{{{includecat|}}}}} | no | | {{#if: {{{category|}}} | [[Category:{{{category}}}]] }} {{{cat2|}}} }}<noinclude>


{{Documentation|CONTENT=
{{Documentation}}
For the creation of Wiki article message boxes.
 
== Usage ==
Full usage:
<pre>{{Ambox
|type =
|text =
|style =
|image =
|imageright =
|mini =
|category =
|includecat =
}}</pre>
 
'''text''' determines the text within the main body of the template. Use this to explain the purpose of the notice and possibly give instructions.
 
'''type''' parameter determines the color of the colorband on left and the default image by the intention of the template. The different types are as follows:
 
* "Serious" is used for major issues conserning the page, such as nomination for deletion. Type "Delete" can also be used, but it's currently identical with "serious".
{{Ambox|type=serious|text=Hello world!}}
* "Content" is used for issues in the content of the page that affect the quality and reliability of the page to the reader.
{{Ambox|type=content|text=Hello world!}}
* "Style" is used for issues in the styling of the page that may make it difficult to read or stand out among similar pages, but don't affect the content of the page itself.
{{Ambox|type=style|text=Hello world!}}
* "Merge" may be used to indicate the page should be merged, split, moved or altered in similar way.
{{Ambox|type=merge|text=Hello world!}}
* "Protection" may be used to indicate that the page is being protected against disallowed changes.
{{Ambox|type=protection|text=Hello world!}}
* "Notice" may be used to give readers information about the page without indicating it is an issue. This is the default type in case no type is given.
{{Ambox|type=notice|text=Hello world!}}
* "Blank" may be useful for some purposes.
{{Ambox|type=blank|text=Hello world!}}
 
'''style''' parameter allows including CSS style choices.
 
'''image''' parameter allows changing the left image from type specific default to another. Writing "none" will remove the image on the left completely. For optional image, use form <nowiki>[[File:File name|40px]]</nowiki> or similar.
<pre>{{Ambox|type=content|text=Hello world!|image=none}}</pre>
{{Ambox|type=content|text=Hello world!|image=none}}
<pre>{{Ambox|type=content|text=Hello world!|image=[[File:Award-goldstar.png|40px]]}}</pre>
{{Ambox|type=content|text=Hello world!|image=[[File:Award-goldstar.png|40px]]}}
 
'''imageright''' parameter allows including an image to the right of the template box. Use similar form as in '''image'''.
<pre>{{Ambox|type=content|text=Hello world!|imageright=[[File:Award-goldstar.png|40px]]}}</pre>
{{Ambox|type=content|text=Hello world!|imageright=[[File:Award-goldstar.png|40px]]}}
 
{{Ambox|type=content|text=Hello world!|mini=yes}}
'''mini''' parameter allows changing the message box to a mini version. The mini version is a smaller, right floating box with smaller text and smaller default images. Example on the right. Note that if you use custom images through '''image''' or '''rightimage''', you must change their size yourself. In order to use the mini version, write "yes".
<pre>{{Ambox|type=content|text=Hello world!|mini=yes}}</pre>
 
'''category''' parameter allows a tracking category for pages with this template. Only use the name of the category, without "Category:" in front.
 
'''cat2''' parameter allows additional or more complex tracking categorization. Can be used in addition or instead of '''category'''. Use form <nowiki>[[Category:Category name]]</nowiki> or similar.
 
'''includecat''' parameter disables the tracking category for an instant. This way the template can be used for showcasing without including it to the tracking category. Disables both '''category''' and '''cat2''' parameters. Write "no" to disable the tracking category.
}}
[[Category:Wiki System Templates]]
</noinclude>
</noinclude>
1,776

edits