Template:Wikibreak/doc
This is a documentation subpage for Template:Wikibreak. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 2,500 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Usage
[edit]The simplest use is to place {{wikibreak}}
on your user and/or user talk pages and the above will be displayed, but with your user name in place of "Wikibreak".
To change only the message, use {{wikibreak|message=YourMessage}}
, where YourMessage is the message you wish to use instead of the default above. Putting {{wikibreak|message=I will be on holiday}}
will produce...
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:".
{{wikibreak|message=I will be on holiday.|image=Clipart island.svg|imagesize=75px}}
I will be on holiday. |
For more options, in particular for the |type=
parameter, see below.
Syntax
[edit]Any and all parameters optional.
{{wikibreak
| [Name]
| begin =
| back =
| type =
| message =
| align =
| image =
| noimage =
| imagesize =
| spacetype =
| style =
}}
Parameter | Description | Example and default |
---|---|---|
Name | Your username or nickname. | {{wikibreak | Joe | ...}} Default: {{BASEPAGENAME}} |
type | Type of break:
|
{{wikibreak | type=long | ...}} Default: #default |
begin | Adds starting date for wikibreak to default message. | {{wikibreak | begin=December 21, 2024 | ...}} Default: <none> |
back | Replaces "soon" in the default message. Deprecated. | {{wikibreak | back=in January | ...}} Default: soon |
message | Your own message rather than the default. | {{wikibreak | message=Joe is elsewhere for now, but will check his talk page now and then. | ...}} Default: "Name is taking a short wikibreak and will be back on Wikipedia soon." |
align | The alignment of the message. Options are "left" and "center". | {{wikibreak | message=Joe is elsewhere for now, but will check his talk page now and then. | align=left |...}} Default: left |
image | Filename of the image you wish to appear beside the message (omitting "Image:" prefix). |
{{wikibreak ...| image=MyImage.jpg | ...}} Default: Sunset at Huntington Beach.jpg |
noimage | To display the template without a picture. | {{wikibreak ...| noimage= | ...}} Default: unused |
spacetype | Type of box:
tmbox (makes it appear like a tmbox) |
{{wikibreak | spacetype=tmbox | ...}} Default: mbox |
imagesize | Size of the image. | {{wikibreak ...| imagesize=100px | ...}} Default: 75px |
style | CSS style | {{wikibreak ...| style=background:#ffffff; | ...}} Default: mbox |
If you feel that you can't stay away for your entire wikibreak, add the following to your user page: {{Wikibreak break}}
See also
[edit]Places a notice for an editor taking a WikiBreak.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Username | 1 name | Username of editor taking WikiBreak
| Unknown | optional |
Type of WikiBreak | type | Changes message and/or image
| String | optional |
Begin date | begin | Start of WikiBreak | Date | optional |
Return date | back 2 | End of WikiBreak | Unknown | optional |
Message | message | Overrides default message | String | optional |
align | align | no description | Unknown | optional |
image | image | no description | Unknown | optional |
noimage | noimage | no description | Unknown | optional |
Space type | spacetype | Type of box
| String | optional |
imagesize | imagesize | no description | Unknown | optional |
style | style | no description | Unknown | optional |
imageright | imageright | no description | Unknown | optional |
imagesizeright | imagesizeright | no description | Unknown | optional |
3 | 3 | no description | Unknown | deprecated |