Difference between revisions of "Template:Ambox/doc"

From Team Fortress Wiki
Jump to: navigation, search
m
(cleanup)
Line 1: Line 1:
An article message box or '''Ambox''' can be added to notify users of specific messages regarding the article. The <nowiki>{{</nowiki>[[Template:Cleanup|Cleanup]]<nowiki>}}</nowiki> template is an example of an ambox.
+
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.
  
==Usage==
+
== Usage ==
 
+
=== All parameters ===
The default ambox will display in the center of the page where the template is included. To include default ambox type
 
<pre>
 
{{Ambox}}
 
</pre>
 
It is recommended that you include a picture on the ambox by adding an ''image'' property by typing
 
<pre>
 
{{Ambox|image=Myimage.jpg}}
 
</pre>
 
and replacing ''Myimage.jpg'' with your own picture name.
 
 
 
===Parameters===
 
  
 
{| class="wikitable grid"
 
{| class="wikitable grid"
|-
+
! Name
!Name
+
! Examples
!Requirement
 
!Options
 
 
|-
 
|-
 
|type
 
|type
|optional
+
|''notice'' [default], ''delete'', ''serious'', <br />''content'', ''style'', ''images'', ''protection''
|''notice'', ''delete'', ''serious'', <br/>''content'', or ''style'' [''Default: notice'']
 
 
|-
 
|-
 
|image
 
|image
|optional
+
|''Example.png''
|
 
 
|-
 
|-
 
|imagewidth
 
|imagewidth
|optional
+
|''56px'' [default]
|[''Default:48px'']
 
 
|-
 
|-
 
|width
 
|width
|optional
+
|['''deprecated''']
|[''Default:80%'']
 
|-
 
|contents
 
|optional
 
|
 
 
|-
 
|-
 
|style
 
|style
|optional
+
| [''any valid CSS style'']
| rowspan="2" | (take any valid css style)
 
 
|-
 
|-
|linestyle
+
|contents
|optional
+
|  
 
|}
 
|}
  
 
+
=== Examples ===
===Examples===
 
 
 
 
<div style="background-color:white;border:solid navy 1px">
 
<div style="background-color:white;border:solid navy 1px">
 
{{Ambox}}
 
{{Ambox}}
Line 150: Line 126:
 
|}
 
|}
 
</div>
 
</div>
 
+
<noinclude>[[Category:Template documentation|{{BASEPAGENAME}}]]</noinclude>
*[[Template:Infobox class]]
 
*[[Template:Infobox map]]
 
 
 
<noinclude>
 
[[Category:Template documentation|{{PAGENAME}}]]
 
 
 
</noinclude>
 

Revision as of 09:03, 29 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
type notice [default], delete, serious,
content, style, images, protection
image Example.png
imagewidth 56px [default]
width [deprecated]
style [any valid CSS style]
contents

Examples


{{Ambox}}



{{Ambox|type=notice|contents=This is a standard notice.}}



{{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>
}}



{{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>
}}



{{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.}}