Difference between revisions of "Template:NeighborhoodCard/doc"

From ThresholdRPG Wiki
(Documentation for Template:NeighborhoodCard)
 
(Document new image parameter)
 
Line 8: Line 8:
  
 
== Usage ==
 
== Usage ==
{{tlx|NeighborhoodCard|name|region|restriction}}
+
{{tlx|NeighborhoodCard|name|region|restriction|image}}
  
 
=== Parameters ===
 
=== Parameters ===
All parameters are optional.
+
All parameters are optional. Rows for empty parameters are hidden.
 
; name
 
; name
 
: When not used, the page name is shown.
 
: When not used, the page name is shown.
Line 18: Line 18:
 
; restriction
 
; restriction
 
: Any race or heritage restriction on moving in. Omit if there are no restrictions.
 
: Any race or heritage restriction on moving in. Omit if there are no restrictions.
 +
; image
 +
: Filename of an image (without ''File:'' prefix) to display in the card, sized to 200px wide. Omit if there is no image yet.
  
 
{{doc/end}}
 
{{doc/end}}

Latest revision as of 01:27, 22 May 2026

{{#vardefine: nodoc | {{{nodoc}}} }}{{#vardefine: baddoc | {{{baddoc}}} }}

Template-info.png Documentation

This template creates a card to show a neighborhood's name, the region it's located in, and any racial or other restriction on moving in. It also adds the page to the Category:Neighborhoods category.

Example : {{NeighborhoodCard|name=Parkside Manors|region=Thrace}}
Result :

Parkside Manors
Region Thrace



Usage

{{NeighborhoodCard|name|region|restriction|image}}

Parameters

All parameters are optional. Rows for empty parameters are hidden.

name
When not used, the page name is shown.
region
The region the neighborhood is in. Examples: Thrace, Sable, Kelnore, Androctonus, Banyee.
restriction
Any race or heritage restriction on moving in. Omit if there are no restrictions.
image
Filename of an image (without File: prefix) to display in the card, sized to 200px wide. Omit if there is no image yet.

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.