Template:Noticebox/doc: Difference between revisions

From VRChat Wiki
(added template data)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
'''Please refrain from editing this template if you do not know what you are doing!'''
== Documentation ==
== Documentation ==
This is a customizable notice box that can be used on pages and acts as the foundation for other notice boxes on the wiki.
<pre><nowiki>{{Noticebox
|image=
|title=
|message=
|size=
|border=
|border-width=
|background=
|textcolor=}}</nowiki></pre>
=== Example Usage ===
=== Example Usage ===
<nowiki>{{Noticebox|Vrrat_thumbsup.png|VRRat is cool!|Please deliver upon them cheese.|size=16px|border=#F8CC3A|background=#F5EFDC}}</nowiki>
<pre><nowiki>{{Noticebox|Vrrat_thumbsup.png|VRRat is cool!|Please deliver upon them cheese.|size=16px|border=#F8CC3A|border-width=2px|background=#F5EFDC|textcolor=#000022}}</nowiki></pre>


will make:
will make:
{{Noticebox|Vrrat_thumbsup.png|VRRat is cool!|Please deliver upon them cheese.|size=16px|border=#F8CC3A|background=#F5EFDC}}
{{Noticebox|Vrrat_thumbsup.png|VRRat is cool!|Please deliver upon them cheese.|size=32px|border=#F8CC3A|border-width=2px|background=#F5EFDC|textcolor=#000022}}
 
=== Template parameters ===
=== Template parameters ===
{| class="wikitable"
{| class="wikitable"
|+ Caption text
|+ Caption text
|-
|-
! Name !! Variable !! Description
! Name !! Variable !! Description !! Default
|-
| Image || <code>image=</code><br>Can also be parameter 1.|| Noticebox image. ||[[:File:PlaceholderRoss.png]] [[File:PlaceholderRoss.png|64px|frameless]]
|-
| Title || <code>title=</code><br>Can also be parameter 2. || the title of the notice box. || <span style="color:#FF0000;">Notice</span>
|-
|-
| Image || <code>1</code>|| placeholder.png
| Message || <code>message=</code><br>Can also be parameter 3. || the description of the notice box. || <span style="color:#FF0000;">Description missing</span>
|-
|-
| Title || <code>2</code> || the title of the notice box
| Image size || <code>size=</code> || (Optional) size of the image file|| 64px
|-
|-
| Description || <code>3</code> || the description of the notice box
| border color || <code>border=</code> || (Optional) border of the notice box || #000000
|-
|-
| Image size || <code>size=</code> || (Optional) size of the image file, default is 64px
| border width || <code>border-width=</code> || (Optional) border width||1px
|-
|-
| border color || <code>border=</code> || (Optional) border of the notice box
| background color || <code>background=</code> || (Optional) background color of the notice box||#ebebeb
|-
|-
| background color || <code>background=</code> || (Optional) background color of the notice box
| text color || <code>textcolor=</code> || (Optional) font color of the notice box||#000000
|}
|}
<noinclude>[[Category:Template Documentation]]</noinclude>
<templatedata>
{
"params": {
"1": {
"aliases": [
"image"
],
"label": "Image",
"description": "Image displayed in noticebox",
"type": "wiki-file-name",
"default": "File:PlaceholderRoss.png",
"required": true
},
"2": {
"aliases": [
"title"
],
"label": "Title",
"description": "Title of the noticebox",
"type": "string",
"default": "Notice",
"required": true
},
"3": {
"aliases": [
"message"
],
"label": "Message",
"description": "Message displayed in noticebox.",
"type": "string",
"default": "Description missing",
"required": true
},
"border": {
"label": "Border color",
"description": "(Optional) border of the notice box",
"type": "string",
"default": "#000000",
"suggested": true
},
"border-width": {
"label": "Border Width",
"description": "Width of the border (in px)",
"example": "2px",
"type": "string",
"default": "1px",
"suggested": true
},
"background": {
"label": "Background Color",
"description": "(Optional) background color of the notice box",
"type": "string",
"default": "#ebebeb",
"suggested": true
},
"textcolor": {
"label": "Text Color",
"description": "(Optional) text color of the notice box.",
"type": "string",
"default": "#000000",
"suggested": true
}
},
"description": "For creating new noticeboxes",
"paramOrder": [
"1",
"2",
"3",
"border",
"border-width",
"background",
"textcolor"
]
}
</templatedata>

Latest revision as of 00:31, 18 October 2024

Please refrain from editing this template if you do not know what you are doing!

Documentation

This is a customizable notice box that can be used on pages and acts as the foundation for other notice boxes on the wiki.

{{Noticebox
|image=
|title=
|message=
|size=
|border=
|border-width=
|background=
|textcolor=}}

Example Usage

{{Noticebox|Vrrat_thumbsup.png|VRRat is cool!|Please deliver upon them cheese.|size=16px|border=#F8CC3A|border-width=2px|background=#F5EFDC|textcolor=#000022}}

will make:

Vrrat thumbsup.png
VRRat is cool!
Please deliver upon them cheese.


Template parameters

Caption text
Name Variable Description Default
Image image=
Can also be parameter 1.
Noticebox image. File:PlaceholderRoss.png PlaceholderRoss.png
Title title=
Can also be parameter 2.
the title of the notice box. Notice
Message message=
Can also be parameter 3.
the description of the notice box. Description missing
Image size size= (Optional) size of the image file 64px
border color border= (Optional) border of the notice box #000000
border width border-width= (Optional) border width 1px
background color background= (Optional) background color of the notice box #ebebeb
text color textcolor= (Optional) font color of the notice box #000000

For creating new noticeboxes

Template parameters

ParameterDescriptionTypeStatus
Image1 image

Image displayed in noticebox

Default
File:PlaceholderRoss.png
Filerequired
Title2 title

Title of the noticebox

Default
Notice
Stringrequired
Message3 message

Message displayed in noticebox.

Default
Description missing
Stringrequired
Border colorborder

(Optional) border of the notice box

Default
#000000
Stringsuggested
Border Widthborder-width

Width of the border (in px)

Default
1px
Example
2px
Stringsuggested
Background Colorbackground

(Optional) background color of the notice box

Default
#ebebeb
Stringsuggested
Text Colortextcolor

(Optional) text color of the notice box.

Default
#000000
Stringsuggested