Difference between revisions of "Template:Ambox/doc"

From Team Fortress Wiki
Jump to: navigation, search
(cleanup)
Line 7: Line 7:
 
! Name
 
! Name
 
! Examples
 
! Examples
 +
! Description
 +
|-
 +
| colspan="3" | '''''Line colors'''''
 
|-
 
|-
 
|type
 
|type
−
|''notice'' [default], ''delete'', ''serious'', <br />''content'', ''style'', ''images'', ''protection''
+
| style="margin: 0px; padding: 0px;" |
 +
{| class="wikitable grid" style="width: 100%;"
 +
| style="border-left: 10px solid #1e90ff;" | ''type = notice'' [default]
 +
|-
 +
| class="ambox-style" | ''type = style''
 +
|-
 +
| class="ambox-content" | ''type = content''
 +
|-
 +
| class="ambox-delete" | ''type = delete''
 +
|-
 +
| class="ambox-images" | ''type = images''
 +
|-
 +
| class="ambox-protection" | ''type = protection''
 +
|}
 +
| Use the correct value for the message box.
 +
|-
 +
| colspan="3" | '''''Images'''''
 
|-
 
|-
 
|image
 
|image
 
|''Example.png''
 
|''Example.png''
 +
|Places an image on the left of the message box.
 
|-
 
|-
 
|imagewidth
 
|imagewidth
 
|''56px'' [default]
 
|''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.
 +
|-
 +
| colspan="3" | '''''Other'''''
 
|-
 
|-
 
|width
 
|width
 
|['''deprecated''']
 
|['''deprecated''']
 +
|''No longer available''
 
|-
 
|-
 
|style
 
|style
−
| [''any valid CSS style'']
+
| e.g. ''font-size: 90%;''
 +
| Takes any valid CSS style.
 
|-
 
|-
 
|contents
 
|contents
−
|  
+
| (see below)
 
|}
 
|}
  
−
=== Examples ===
+
== Contents ==
−
<div style="background-color:white;border:solid navy 1px">
 
−
{{Ambox}}
 
−
{|
 
−
|
 
−
<pre>
 
−
<nowiki>
 
−
{{Ambox}}
 
−
</nowiki>
 
−
</pre>
 
−
|}
 
−
</div>
 
−
<br style="clear:both" />
 
  
−
<div style="background-color:white;border:solid navy 1px">
+
Use {{tl|ambox/message}} in the ''contents'' parameter. Example:
−
{{Ambox|type=notice|contents=This is a standard notice.}}
 
−
{|
 
−
|
 
−
<pre>
 
−
<nowiki>
 
−
{{Ambox|type=notice|contents=This is a standard notice.}}
 
−
</nowiki>
 
−
</pre>
 
−
|}
 
−
</div>
 
−
<br style="clear:both" />
 
  
−
<div style="background-color:white;border:solid navy 1px">
+
<pre><nowiki>
−
{{Ambox
+
{{ambox/message
−
|image=Broom.png
+
| 1 = Need some help ova here!
−
|type=style
+
| 2 = This article needs cleaning up.
−
|contents=
+
| 3 = You can help by editing it.
−
'''This page has been marked for general cleanup'''.<br/>
 
−
<small>Please see [[Help:Team Fortress Wiki style guide|Team Fortress Wiki style guide]] for information on how to improve this article.</small>
 
 
}}
 
}}
−
{|
+
</nowiki></pre>
−
|
+
 
−
<pre>
+
produces...
−
<nowiki>
 
−
{{Ambox
 
−
|image=Broom.png
 
−
|type=style
 
−
|contents=
 
−
'''This page has been marked for general cleanup'''.<br/>
 
−
<small>Please see [[Help:{{subst:SITENAME}} style guide|{{subst:SITENAME}} style guide]]
 
−
for information on how to improve this article.</small>
 
−
}}
 
−
</nowiki>
 
−
</pre>
 
−
|}
 
−
</div>
 
−
<br style="clear:both" />
 
  
−
<div style="background-color:white;border:solid navy 1px">
+
{{ambox/message
−
{{Ambox
+
| 1 = Need some help ova here!
−
|type=content
+
| 2 = This article needs cleaning up.
−
|image=Discussion.gif
+
| 3 = You can help by editing it.
−
|contents='''This page has been marked for an open review'''.<br/>
 
−
<small>Please see the discussion pages for additional information your opinion is welcome.</small>
 
 
}}
 
}}
−
{|
 
−
|
 
−
<pre>
 
−
<nowiki>
 
−
{{Ambox
 
−
|type=content
 
−
|image=Discussion.gif
 
−
|contents='''This page has been marked for an open review'''.<br/>
 
−
<small>Please see the discussion pages for additional information your opinion is welcome.</small>
 
−
}}</nowiki>
 
−
</pre>
 
−
|}
 
−
</div>
 
  
−
<br style="clear:both" />
 
−
 
−
<div style="background-color:white;border:solid navy 1px">
 
−
{{Ambox
 
−
|type=delete
 
−
|style=background-color:#FFF0EA;
 
−
|image=Icon_trash.png
 
−
|contents=
 
−
'''This article has been marked for deletion'''.<br/>
 
−
'''Reason''': No one other than its original author has made substantial edits to this page.}}
 
−
{|
 
−
|
 
−
<pre>
 
−
<nowiki>
 
−
{{Ambox
 
−
|type=delete
 
−
|style=background-color:#FFF0EA;
 
−
|image=Icon_trash.png
 
−
|contents=
 
−
'''This article has been marked for deletion'''.<br/>
 
−
'''Reason''': No one other than its original author has made substantial edits to this page.}}
 
−
</nowiki>
 
−
</pre>
 
−
|}
 
−
</div>
 
 
<noinclude>[[Category:Template documentation|{{BASEPAGENAME}}]]</noinclude>
 
<noinclude>[[Category:Template documentation|{{BASEPAGENAME}}]]</noinclude>

Revision as of 23:26, 31 July 2010

An article message box, or ambox, 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]
type = style
type = content
type = delete
type = images
type = protection
Use the correct value for the message box.
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.

Retrieved from "https://wiki.teamfortress.com/w/index.php?title=Template:Ambox/doc&oldid=63572"