Template:Infobox/World/doc: Difference between revisions

From VRChat Wiki
(added documentation by maebbie to proper page)
(refactored documentation to match parameter rework)
Line 1: Line 1:
{{Infobox/World
{{Infobox/World
|name=Treehouse in the Shade
|name= Example World
|developer=1001
|image= VrcHomeThumb.png
|platform= PC
|publisher= Example Publisher
|link={{World link|wrld_551c30cb-0e56-4c69-9176-10e259a89e2a|Treehouse in the Shade}}
|developers= ExampleDev1, ExampleDev2
|published=Nov 09 2018
|capacity= 80 (40)
|platforms= PC, Android, iOS
|tags= tag1, tag2, tag3, tag4, tag5
|languages= English, Japanese, French
|link= {{World link|wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd|VRChat Home}}
|labs= Jan 1 2024
|published= Jan 1 2024
}}
}}
Paste this template into a World Page to have the infobox appear on the top right. It is recommended to paste and fill this out while in the Source editor, however this can also be done in the Visual editor. For more guidance on how to best use this, see how other World pages have implemented this infobox.
Paste this template into a World Page to have the infobox appear on the top right. It is recommended to paste and fill this out while in the Source editor, however this can also be done in the Visual editor. For more guidance on how to best use this, see how other World pages have implemented this infobox.
Line 16: Line 22:
|name=
|name=
|image=
|image=
|imagecaption=
|developer=
|publisher=
|publisher=
|designer=
|developers=
|gen=
|capacity=
|platform=
|platforms=
|tags=
|languages=
|languages=
|themes=
|link=
|link=
|labs=
|labs=
Line 35: Line 39:


;image
;image
: An image representing the world.
: The image used for the thumbnail of the world.
 
;imagecaption
: A caption for the image.
 
;developer
: The developer of the VRChat world.


;publisher
;publisher
: The publisher of the VRChat world.
: The user who has the VRChat world published to their account.


;designer
;developers
: The designer of the VRChat world.
: The main developer(s) of the VRChat world. This field is optional if the publisher is the sole developer.


;gen
;platforms
: The generation of the VRChat world.
: The platforms on which the VRChat world is available. PC, Android and/or iOS.


;platform
;tags
: The platforms on which the VRChat world is available.
: The tags of the VRChat world.


;languages
;languages
: Languages used or available inside the VRChat world.
: Languages used or available inside the VRChat world.
;themes
: The themes of the VRChat world.


;link
;link
Line 65: Line 60:


;labs
;labs
: Indicates if the world is part of the Community Labs.
: The date the VRChat world was published to Community Labs.


;published
;published
: The date when the VRChat world was published.
: The date the VRChat world was published/released from Community Labs.


==Example==
==Example==
<pre>
<pre>
<nowiki>{{</nowiki>VRChat world
<nowiki>{{</nowiki>VRChat world
|name=Example World
|name= Example World
|image=ExampleImage.jpg
|image= VrcHomeThumb.png
|imagecaption=An example VRChat world
|publisher= Example Publisher
|developer=Example Developer
|developers= ExampleDev1, ExampleDev2
|publisher=Example Publisher
|capacity= 80 (40)
|designer=Example Designer
|platforms= PC, Android, iOS
|gen=1st Generation
|tags= tag1, tag2, tag3, tag4, tag5
|platform=PC, VR
|languages= English, Japanese, French
|languages=English, Spanish
|link={{World link|wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd|VRChat Home}}
|themes=Adventure, Exploration
|labs=Jan 1 2024
|link=https://vrchat.com/home/world/wrld_example
|published=Jan 1 2024
|labs=Yes
|published=2024-01-01
<nowiki>}}</nowiki>
<nowiki>}}</nowiki>
</pre>
</pre>
<noinclude>[[Category:Template Documentation]]</noinclude>
<noinclude>[[Category:Template Documentation]]</noinclude>

Revision as of 01:42, 21 August 2024

Paste this template into a World Page to have the infobox appear on the top right. It is recommended to paste and fill this out while in the Source editor, however this can also be done in the Visual editor. For more guidance on how to best use this, see how other World pages have implemented this infobox.

Fields without contents will not show up on the infobox.

Usage:

{{Infobox/World
|name=
|image=
|publisher=
|developers=
|capacity=
|platforms=
|tags=
|languages=
|link=
|labs=
|published=
}}

Parameters

name
The name of the VRChat world.
image
The image used for the thumbnail of the world.
publisher
The user who has the VRChat world published to their account.
developers
The main developer(s) of the VRChat world. This field is optional if the publisher is the sole developer.
platforms
The platforms on which the VRChat world is available. PC, Android and/or iOS.
tags
The tags of the VRChat world.
languages
Languages used or available inside the VRChat world.
link
The link to the VRChat world. Consider using Template:World link.
labs
The date the VRChat world was published to Community Labs.
published
The date the VRChat world was published/released from Community Labs.

Example

{{VRChat world
|name= Example World
|image= VrcHomeThumb.png
|publisher= Example Publisher
|developers= ExampleDev1, ExampleDev2
|capacity= 80 (40)
|platforms= PC, Android, iOS
|tags= tag1, tag2, tag3, tag4, tag5
|languages= English, Japanese, French
|link={{World link|wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd|VRChat Home}}
|labs=Jan 1 2024
|published=Jan 1 2024
}}