Template:Wikibreak/doc: Difference between revisions
Created page with "{{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=</nowi..." |
+ |
||
| Line 82: | Line 82: | ||
| <code><nowiki>{{wikibreak ...| style=background:#ffffff; | ...}}</nowiki></code><br>''Default:'' <nowiki>mbox</nowiki> |
| <code><nowiki>{{wikibreak ...| style=background:#ffffff; | ...}}</nowiki></code><br>''Default:'' <nowiki>mbox</nowiki> |
||
|} |
|} |
||
==see also== |
|||
{{Wikibreak templates}} |
|||
---- |
---- |
||
Revision as of 03:14, 28 September 2024
 | This is a documentation subpage for Template:Wikibreak. It contains usage information, categories, and other content that is not part of the original template page. |
Usage
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
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=November 24, 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 |