Difference between revisions of "Template:Ambox/doc"

From Team Fortress Wiki
Jump to: navigation, search
(Fixed coloring.)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
An '''article message box''', or '''ambox''', can be added to notify users of specific messages regarding the article. The {{tl|cleanup}} template is an example of an ambox.
+
An '''ambox''', or '''article message box''', can be added to notify users of specific messages regarding the article. The {{tl|cleanup}} template is an example of an ambox.
  
 
== Usage ==
 
== Usage ==
 
=== All parameters ===
 
=== All parameters ===
 
+
{| class="wikitable"
{| class="wikitable grid"
+
! class="header" | Name
! Name
+
! class="header" | Examples
! Examples
+
! class="header" | Description
! Description
 
 
|-
 
|-
 
| colspan="3" | '''''Line colors'''''
 
| colspan="3" | '''''Line colors'''''
 
|-
 
|-
|type
+
| rowspan="6" | type
| style="margin: 0px; padding: 0px;" |  
 
{| class="wikitable grid" style="width: 100%;"
 
 
| style="border-left: 10px solid #1e90ff;" | ''type = notice'' [default]
 
| style="border-left: 10px solid #1e90ff;" | ''type = notice'' [default]
 +
| rowspan="6" | Use the correct value for the message box.
 
|-
 
|-
| class="ambox-style" | ''type = style''
+
| style="border-left: 10px solid #ffcc00;" | ''type = style''
 
|-
 
|-
| class="ambox-content" | ''type = content''
+
| style="border-left: 10px solid #f28500;" | ''type = content''
 
|-
 
|-
| class="ambox-delete" | ''type = delete''
+
| style="border-left: 10px solid #b22222;" | ''type = delete''
 
|-
 
|-
| class="ambox-images" | ''type = images''
+
| style="border-left: 10px solid #bba;" | ''type = protection''
 
|-
 
|-
| class="ambox-protection" | ''type = protection''
+
| style="border-left: 10px solid #000000;" | ''type = images''
|}
 
| Use the correct value for the message box.
 
 
|-
 
|-
 
| colspan="3" | '''''Images'''''
 
| colspan="3" | '''''Images'''''
Line 69: Line 65:
  
 
== Contents ==
 
== Contents ==
 
 
Use {{tl|ambox/message}} in the ''contents'' parameter. Example:
 
Use {{tl|ambox/message}} in the ''contents'' parameter. Example:
  
Line 86: Line 81:
 
| 2 = This article needs cleaning up.
 
| 2 = This article needs cleaning up.
 
| 3 = You can help by editing it.
 
| 3 = You can help by editing it.
 +
}}
 +
 +
== Examples ==
 +
* Ambox with no image: <code><nowiki>{{ambox | type = notice | contents = '''Lorem ipsum''' dolor sit amet.}}</nowiki></code>
 +
<br />
 +
{{ambox | type = notice | contents = '''Lorem ipsum''' dolor sit amet.}}
 +
<br />
 +
* Ambox with 2 images and custom style:
 +
<pre><nowiki>
 +
{{ambox
 +
| type    = images
 +
| image    = Copyright.png
 +
| image2  = Red copyright.png
 +
| style    = font-family: Georgia, serif;
 +
| contents = '''Lorem ipsum''' dolor sit amet.
 +
}}
 +
</nowiki></pre>
 +
<br />
 +
{{ambox
 +
| type    = images
 +
| image    = Copyright.png
 +
| image2  = Red copyright.png
 +
| style    = font-family: Georgia, serif;
 +
| contents = '''Lorem ipsum''' dolor sit amet.
 
}}
 
}}
  
 
<noinclude>[[Category:Template documentation|{{BASEPAGENAME}}]]</noinclude>
 
<noinclude>[[Category:Template documentation|{{BASEPAGENAME}}]]</noinclude>

Latest revision as of 15:47, 4 November 2014

An ambox, or article message box, can be added to notify users of specific messages regarding the article. The {{cleanup}} template is an example of an ambox.

Usage

All parameters

Name Examples Description
Line colors
type type = notice [default] Use the correct value for the message box.
type = style
type = content
type = delete
type = protection
type = images
Images
image Example.png Places an image on the left of the message box.
imagewidth 56px [default] Defines the width of the left image.
imagealt Notice Text to be displayed if image isn't shown properly.
image2 PD-icon.png Places a second image on the right of the message box
image2width 56px [default] Defines the width of the right image.
image2alt Public Domain Text to be displayed if the right image isn't shown properly.
Other
width [deprecated] No longer available
style e.g. font-size: 90%; Takes any valid CSS style.
contents (see below)

Contents

Use {{ambox/message}} in the contents parameter. Example:

{{ambox/message
| 1 = Need some help ova here!
| 2 = This article needs cleaning up.
| 3 = You can help by editing it.
}}

produces...

“Need some help ova here!”
This article needs cleaning up.
You can help by editing it.

Examples

  • Ambox with no image: {{ambox | type = notice | contents = '''Lorem ipsum''' dolor sit amet.}}



  • Ambox with 2 images and custom style:
{{ambox 
| type     = images
| image    = Copyright.png
| image2   = Red copyright.png
| style    = font-family: Georgia, serif;
| contents = '''Lorem ipsum''' dolor sit amet.
}}