Template:Location: Difference between revisions

From Yogstation-13
Jump to navigation Jump to search
m (changed clearance to access)
(Added details to documentation. Improved default-values. Fixed parameters to work the same when missing and empty. Smaller designchanges to improve readability.)
Line 1: Line 1:
<includeonly>
<includeonly>
{|width=300 cellpadding=2 cellspacing=0 bgcolor=#FFFFFF style="float: right; clear: left; margin: 0 0 20px 20px; border: 2px ridge; border-color: #d3d3d3; border-radius: 3px;"
{|width=300 cellpadding=2 cellspacing=0 bgcolor=#FFFFFF style="float: right; clear: left; margin: 0 0 20px 20px; border: 2px ridge; border-color: #d3d3d3; border-radius: 3px;"
|bgcolor="{{{headerbgcolor|#aaaaaa}}}" style="border-bottom: 1px solid; border-color: #d3d3d3" align="center" colspan=2|<font color="{{{headerfontcolor|#000000}}}">'''{{{location|Undefined}}}'''</font>
|bgcolor="{{#if: {{{headerbgcolor|}}}|{{{headerbgcolor}}}|\#aaaaaa}}" style="border-bottom: 1px solid; border-color: #d3d3d3" align="center" colspan=2|<font color="{{#if: {{{headerfontcolor|}}}|{{{headerfontcolor}}}|\#000000}}">'''{{#if: {{{location|}}}|'''{{{location}}}'''|Undefined Location}}'''</font>
|-
|-
|align=center width="350" colspan=2 |[[File:{{{image|NPA.png}}}|frameless|300px|center|link={{{big_image|File:{{{image}}}}}}]]
|align=center width="350" colspan=2 |[[File:{{#if: {{{image|}}}|{{{image}}}|NPA.png}}|frameless|300px|center|link={{{big_image|File:{{{image|}}}|{{{image}}}|NPA.png}}}}}]]
|-
|-
|style="border-bottom: 2px dashed; border-color: #d3d3d3" align="center" colspan=2|<span style="font-size:95%;">''{{{description|}}}''</span>
|style="border-bottom: 2px dashed; border-color: #d3d3d3" align="center" colspan=2|<span style="font-size:95%;">{{#if: {{{description|}}}|''{{{description}}}''|}}</span>
|-  style="border-bottom: 2px dashed; border-color: #d3d3d3; background-color: #f5f5f5;"
| style="border-color: #d3d3d3"| '''Purpose:'''
|{{#if: {{{purpose|}}}|{{{purpose}}}|Unknown}}
|-
|-
|'''Purpose'''
| style="border-color: #d3d3d3"| '''Key&nbsp;items:'''
|{{{purpose|}}}
|{{#if: {{{items|}}}|{{{items}}}|None}}
|-  style="border-bottom: 2px dashed; border-color: #d3d3d3; background-color: #f5f5f5;"
| style="border-color: #d3d3d3"| '''Workers:'''
|{{#if: {{{workers|}}}|{{{workers}}}|None}}
|-
|-
|'''Key items'''
| style="border-color: #d3d3d3"| '''Access:'''
|{{{items|}}}
|{{#if: {{{access|}}}|{{{access}}}|Everyone}}
|-  style="border-bottom: 2px dashed; border-color: #d3d3d3; background-color: #f5f5f5;"
| style="border-color: #d3d3d3"| '''Exits:'''
|{{#if: {{{exits|}}}|{{{exits}}}|Not defined}}
|-
|-
|'''Workers'''
|bgcolor="{{#if: {{{footerbgcolor|}}}|{{{footerbgcolor}}}|\#aaaaaa}}" style="border-top: 1px solid; border-color: #d3d3d3" align="center" colspan=2|<font color="{{#if: {{{footerfontcolor|}}}|{{{footerfontcolor}}}|\#000000}}">{{#if: {{{department|}}}|'''{{{department}}}'''|}}</font>
|{{{workers|}}}
|}
</includeonly><noinclude>
== About ==
This template is intended to be at the top of each of the [[Locations]] pages to provide a basic overview of each location.
 
== Parameter-Usage ==
{| class="wikitable"
!Parameter
!Default
!Description
|-
!location
|Undefined Location
|Title of the box
|-
!image
|NPA.png
|Small image of the location to be displayed
|-
!big_image
|
|Big version of the image, linked with the displayed small image
|-
!description
|
|Short decription below the image
|-
!purpose
|Unknown
|Purpose / usage and general context
|-
!items
|None
|Key items
|-
!workers
|None
|Workers
|-
!access
|Everyone
|List of roles that have access to the location
|-
|-
|'''Access'''
!exits
|{{{access|}}}
|Not defined
|List of links for neighboring locations
|-
|-
|'''Exits'''
!department
|{{{exits|Not defined}}}
|
|Department the location belongs to
|-
|-
|bgcolor="{{{footerbgcolor|#aaaaaa}}}" style="border-top: 1px solid; border-color: #d3d3d3" align="center" colspan=2|<font color="{{{footerfontcolor|#000000}}}">'''{{{department|Undefined}}}'''</font>
!headerbgcolor
|#aaaaaa
|Background-color of the header
|-
!headerfontcolor
|#000000
|Font-color of the header
|-
!footerbgcolor
|#aaaaaa
|Background-color of the footer
|-
!footerfontcolor
|#000000
|Font-color of the footer
|}
|}
</includeonly>


<noinclude>
== Examples ==
This template is intended to be at the top of each of the location pages to provide a basic overview of each location.
=== Bare 1 ===
== Usage ==
{{Location}}
Example of the finished product. Please document any changes you make to the template code in the parameters and usage sections
<pre>{{Location}}</pre>
{{Clear}}
 
=== Bare 2 ===
{{Location
|headerbgcolor=
|headerfontcolor=
|image=
|location=
|description=
|purpose=
|items=
|workers=
|access=
|exits=
|department=
|footerbgcolor=
|footerfontcolor=
}}
<pre>{{Location
|headerbgcolor=
|headerfontcolor=
|image=
|location=
|description=
|purpose=
|items=
|workers=
|access=
|exits=
|department=
|footerbgcolor=
|footerfontcolor=
}}</pre>
{{Clear}}


<pre> {{Location
=== Normal ===
|headerbgcolor=black
{{Location
|headerfontcolor=white
|headerbgcolor=black
|image=Space.png
|headerfontcolor=white
|location=Space
|image=Space.png
|description=The Final Frontier.
|location=Space
|purpose=A cold, horrible place full of vacuum and a few locations floating around
|description=The Final Frontier.
|items=Vacuum and dark matter
|purpose=A cold, horrible place full of vacuum and a few locations floating around
|workers=None
|items=Vacuum and dark matter
|access=Everyone
|workers=None
|exits=[[Space Station 13]], [[Abandoned Satellite]], [[Derelict]], [[Mining Station]]
|access=Everyone
|department=Outside
|exits=[[Space Station 13]], [[Abandoned Satellite]], [[Derelict]], [[Mining Station]]
|footerbgcolor=black
|department=Outside
|footerfontcolor=white
|footerbgcolor=black
}}</pre>
|footerfontcolor=white
}}
<pre>{{Location
|headerbgcolor=black
|headerfontcolor=white
|image=Space.png
|location=Space
|description=The Final Frontier.
|purpose=A cold, horrible place full of vacuum and a few locations floating around
|items=Vacuum and dark matter
|workers=None
|access=Everyone
|exits=[[Space Station 13]], [[Abandoned Satellite]], [[Derelict]], [[Mining Station]]
|department=Outside
|footerbgcolor=black
|footerfontcolor=white
}}</pre>


...yields:
{{Location
|headerbgcolor=black
|headerfontcolor=white
|image=Space.png
|location=Space
|description=The Final Frontier.
|purpose=A cold, horrible place full of vacuum and a few locations floating around
|items=Vacuum and dark matter
|workers=None
|access=Everyone
|exits=[[Space Station 13]], [[Abandoned Satellite]], [[Derelict]], [[Mining Station]]
|department=Outside
|footerbgcolor=black
|footerfontcolor=white
}}
[[Category:Templates]]
[[Category:Templates]]
</noinclude>
</noinclude>

Revision as of 11:56, 25 April 2020

About

This template is intended to be at the top of each of the Locations pages to provide a basic overview of each location.

Parameter-Usage

Parameter Default Description
location Undefined Location Title of the box
image NPA.png Small image of the location to be displayed
big_image Big version of the image, linked with the displayed small image
description Short decription below the image
purpose Unknown Purpose / usage and general context
items None Key items
workers None Workers
access Everyone List of roles that have access to the location
exits Not defined List of links for neighboring locations
department Department the location belongs to
headerbgcolor #aaaaaa Background-color of the header
headerfontcolor #000000 Font-color of the header
footerbgcolor #aaaaaa Background-color of the footer
footerfontcolor #000000 Font-color of the footer

Examples

Bare 1

Undefined Location
link=File:}}
Purpose: Unknown
Key items: None
Workers: None
Access: Everyone
Exits: Not defined 
{{Location}}

Bare 2

Undefined Location
link=File:}}
Purpose: Unknown
Key items: None
Workers: None
Access: Everyone
Exits: Not defined 
{{Location
|headerbgcolor=
|headerfontcolor=
|image=
|location=
|description=
|purpose=
|items=
|workers=
|access=
|exits=
|department=
|footerbgcolor=
|footerfontcolor=
}}

Normal

'Space'
link=File:Space.png}}
The Final Frontier.
Purpose: A cold, horrible place full of vacuum and a few locations floating around
Key items: Vacuum and dark matter
Workers: None
Access: Everyone
Exits: Space Station 13, Abandoned Satellite, Derelict, Mining Station
Outside 
{{Location
|headerbgcolor=black
|headerfontcolor=white
|image=Space.png
|location=Space
|description=The Final Frontier.
|purpose=A cold, horrible place full of vacuum and a few locations floating around
|items=Vacuum and dark matter
|workers=None
|access=Everyone
|exits=[[Space Station 13]], [[Abandoned Satellite]], [[Derelict]], [[Mining Station]]
|department=Outside
|footerbgcolor=black
|footerfontcolor=white
}}
Retrieved from "https://wiki.yogstation.net/index.php?title=Template:Location&oldid=31392"