Template:Infobox neighborhood/doc: Difference between revisions
sims>SimDestroyer No edit summary |
No edit summary |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{Uses TemplateStyles| |
|||
;Usage: |
|||
* [[Template:Metainfobox/styles.css]]}} |
|||
==Description== |
|||
Infobox for [[neighborhood]]s. For [[world]]s, use {{tl|Infobox world}}. |
|||
==Syntax== |
|||
<pre> |
<pre> |
||
{{Infobox neighborhood |
{{Infobox neighborhood |
||
Line 11: | Line 15: | ||
</pre> |
</pre> |
||
==Parameters== |
|||
*'''name''': Name of the neighborhood. |
*'''name''': Name of the neighborhood. |
||
*'''image''': <nowiki>[[File:Example.jpg|250px]]</nowiki> The image should be 250px or smaller. |
*'''image''': <nowiki>[[File:Example.jpg|250px]]</nowiki> The image should be 250px or smaller. |
||
Line 19: | Line 22: | ||
*'''game''': The main game this neighborhood is featured in. |
*'''game''': The main game this neighborhood is featured in. |
||
<includeonly>[[Category:Metainfobox templates| |
<includeonly>[[Category:Metainfobox templates|Neighborhood]] [[Category:Neighborhood templates|Infobox]]</includeonly> |
||
<noinclude>[[Category:Template documentation]]</noinclude> |
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
||
==TemplateData== |
|||
{{TemplateData header}} |
|||
<templatedata> |
|||
{ |
|||
"params": { |
|||
"basegame": { |
|||
"label": "Base Game", |
|||
"description": "Causes the template to be styled after the specified base game theme (e.g. red for TS1, dark blue for TS2, green for TS3). This should only be used if the \"game\" parameter is used in an unusual format (e.g. listing multiple games at once) that causes the template to display its default gray scheme.", |
|||
"example": "The Sims 3", |
|||
"type": "string" |
|||
}, |
|||
"game": { |
|||
"label": "Game", |
|||
"description": "The game the neighborhood appears in.", |
|||
"example": "The Sims 2", |
|||
"type": "string", |
|||
"suggested": true |
|||
}, |
|||
"name": { |
|||
"label": "Name", |
|||
"description": "The name of the neighborhood. If left blank, will default to the name of the page.", |
|||
"example": "Pleasantview", |
|||
"type": "string" |
|||
}, |
|||
"image": { |
|||
"label": "Image", |
|||
"description": "An image of the neighborhood, usually an in-game thumbnail or an overhead shot. Requires full wiki markup.", |
|||
"example": "[[File:Pleasantview.png]]", |
|||
"type": "content" |
|||
}, |
|||
"caption": { |
|||
"label": "Caption", |
|||
"description": "Caption to be displayed under the image. This is usually used for the neighborhood description.", |
|||
"type": "string" |
|||
}, |
|||
"world": { |
|||
"label": "World", |
|||
"description": "If the neighborhood is located within a larger world, as is the case with The Sims 4, specify the name of the world here.", |
|||
"example": "Oasis Springs", |
|||
"type": "string" |
|||
}, |
|||
"cat": { |
|||
"label": "Categorize?", |
|||
"description": "If set to \"no\", the template will not add categories to the page. Defaults to \"yes\" if left blank. Used for testing and demonstration purposes only.", |
|||
"type": "string" |
|||
} |
|||
}, |
|||
"description": "Infobox for neighborhoods, like Pleasantview and Strangetown. For worlds, use {{Infobox world}}.", |
|||
"paramOrder": [ |
|||
"name", |
|||
"image", |
|||
"game", |
|||
"basegame", |
|||
"caption", |
|||
"world", |
|||
"cat" |
|||
], |
|||
"format": "{{_\n|_______________ = _\n}}\n" |
|||
} |
|||
</templatedata> |
Latest revision as of 16:05, 29 August 2019
Description[edit source]
Infobox for neighborhoods. For worlds, use {{Infobox world}}.
Syntax[edit source]
{{Infobox neighborhood |name = |image = |caption = |world = |game = }}
Parameters[edit source]
- name: Name of the neighborhood.
- image: [[File:Example.jpg|250px]] The image should be 250px or smaller.
- caption: Caption for the image.
- world: The world this neighborhood is located in.
- game: The main game this neighborhood is featured in.
TemplateData[edit source]
TemplateData for Infobox neighborhood
Infobox for neighborhoods, like Pleasantview and Strangetown. For worlds, use {{Infobox world}}.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | name | The name of the neighborhood. If left blank, will default to the name of the page.
| String | optional |
Image | image | An image of the neighborhood, usually an in-game thumbnail or an overhead shot. Requires full wiki markup.
| Content | optional |
Game | game | The game the neighborhood appears in.
| String | suggested |
Base Game | basegame | Causes the template to be styled after the specified base game theme (e.g. red for TS1, dark blue for TS2, green for TS3). This should only be used if the "game" parameter is used in an unusual format (e.g. listing multiple games at once) that causes the template to display its default gray scheme.
| String | optional |
Caption | caption | Caption to be displayed under the image. This is usually used for the neighborhood description. | String | optional |
World | world | If the neighborhood is located within a larger world, as is the case with The Sims 4, specify the name of the world here.
| String | optional |
Categorize? | cat | If set to "no", the template will not add categories to the page. Defaults to "yes" if left blank. Used for testing and demonstration purposes only. | String | optional |