Template:Noticebox/doc: Difference between revisions
From VRChat Wiki
(Added textcolor documentation) |
m (Reverted edits by Usr 578aa632-439b-4c41-9266-776323ba9ad2 (talk) to last revision by TrixxedHeart) Tag: Rollback |
||
(7 intermediate revisions by 3 users not shown) | |||
Line 2: | Line 2: | ||
== 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. | 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=32px|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 === | ||
Line 12: | Line 23: | ||
|+ 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> | ||
|- | |- | ||
| | | Message || <code>message=</code><br>Can also be parameter 3. || the description of the notice box. || <span style="color:#FF0000;">Description missing</span> | ||
|- | |- | ||
| | | Image size || <code>size=</code> || (Optional) size of the image file|| 64px | ||
|- | |- | ||
| | | border color || <code>border=</code> || (Optional) border of the notice box || #000000 | ||
|- | |- | ||
| border | | border width || <code>border-width=</code> || (Optional) border width||1px | ||
|- | |- | ||
| background color || <code>background=</code> || (Optional) background color of the notice box | | background color || <code>background=</code> || (Optional) background color of the notice box||#ebebeb | ||
|- | |- | ||
| text color || <code>textcolor=</code> || (Optional) font color of the notice box | | text color || <code>textcolor=</code> || (Optional) font color of the notice box||#000000 | ||
|} | |} | ||
<noinclude>[[Category:Template Documentation]]</noinclude> |
Latest revision as of 15:46, 24 August 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 is cool! Please deliver upon them cheese. |
Template parameters
Name | Variable | Description | Default |
---|---|---|---|
Image | image= Can also be parameter 1. |
Noticebox image. | File: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 |