View source for Template:Wikibreak/doc

{{Documentation subpage}}

=== Usage ===

The simplest use is to place <code><nowiki>{{wikibreak}}</nowiki></code> on your user and/or user talk pages and the above will be displayed, but with your user name in place of "'''Wikibreak'''".<br>
To change only the message, use <code><nowiki>{{wikibreak|message=</nowiki>''YourMessage''}}</code>, where ''YourMessage'' is the message you wish to use instead of the default above. Putting <code><nowiki>{{wikibreak|message=</nowiki>I will be on holiday}}</code> will produce... {{wikibreak|message=I will be on holiday.}}
It is possible to adjust the size and change the type of image for your Wikibreak template. Note that to change the file name you should not add "File:".
<code><nowiki>{{wikibreak|message=I will be on holiday.|image=Clipart island.svg|imagesize=75px}}</nowiki></code>

{{wikibreak|message=I will be on holiday.|image=Clipart island.svg|imagesize=75px}}

For more options, in particular for the {{para|type}} parameter, see below.

=== Syntax ===
''Any and all parameters optional.''
<syntaxhighlight lang="wikitext">{{wikibreak
| [Name]
| begin     =
| back      =
| type      =
| message   =
| align     =
| image     =
| noimage   =
| imagesize =
| spacetype =
| style     =
}}</syntaxhighlight>

{| class="wikitable"
!width=80px| Parameter !! width=300px| Description
! Example and default
|-

| '''Name'''   || Your username or nickname.
| <code><nowiki>{{wikibreak | Joe | ...}}</nowiki></code><br>''Default:'' <nowiki>{{BASEPAGENAME}}</nowiki>
|-

| '''type'''   || Type of break: 
#exams (changes image and message)
#attempting (changes message)
#semi (changes message)
#long (changes message)
#wikibreak, normal, short (the default message)  

| <code><nowiki>{{wikibreak | type=long | ...}}</nowiki></code><br>''Default:'' <nowiki>#default</nowiki>
|-

| '''begin'''   || Adds starting date for wikibreak to default message.
| <code><nowiki>{{wikibreak | begin=</nowiki>{{Yesterday}}<nowiki> | ...}}</nowiki></code><br>''Default:'' &lt;none&gt;
|-

|-

| '''back'''   || Replaces "soon" in the default message.  Deprecated.
| <code><nowiki>{{wikibreak | back=in January | ...}}</nowiki></code><br>''Default:'' soon
|-

| '''message'''    || Your own message rather than the default.
| <code><nowiki>{{wikibreak | message=Joe is elsewhere for now, but will check his talk page now and then. | ...}}</nowiki></code><br>''Default:'' "''Name'' is taking a short [[Wikipedia:Wikiholiday|wikibreak]] and will be back on Wikipedia soon."
|-

| '''align'''    || The alignment of the message. Options are "left" and "center".
| <code><nowiki>{{wikibreak | message=Joe is elsewhere for now, but will check his talk page now and then. | align=left |...}}</nowiki></code><br>''Default:'' left
|-

| '''image'''      || Filename of the image you wish to appear<br>beside the message (omitting "Image:" prefix).
| <code><nowiki>{{wikibreak ...| image=MyImage.jpg | ...}}</nowiki></code><br>''Default:'' Sunset at Huntington Beach.jpg
|-

| '''noimage'''    || To display the template without a picture.
|  <code><nowiki>{{wikibreak ...| noimage= | ...}}</nowiki></code><br>''Default:'' unused
|-
| '''spacetype'''   || Type of box: 
tmbox (makes it appear like a tmbox)  
| <code><nowiki>{{wikibreak | spacetype=tmbox | ...}}</nowiki></code><br>''Default:'' <nowiki>mbox</nowiki>
|-
| '''imagesize'''  || Size of the image.
| <code><nowiki>{{wikibreak ...| imagesize=100px | ...}}</nowiki></code><br>''Default:'' 75px
|-
| '''style'''  || CSS style
| <code><nowiki>{{wikibreak ...| style=background:#ffffff; | ...}}</nowiki></code><br>''Default:'' <nowiki>mbox</nowiki>
|}
----