Difference between revisions of "Template:MapCard/doc"

From comp.tf
Jump to navigation Jump to search
m (documentation about superscript)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''Template:MapCard''' displays a 250x137px rectangular card containing a map image.
+
'''Template:MapCard''' displays a 152x86px rectangular card containing a map image. For a smaller 100x56px image, you can use [[Template:MapCardSmall|MapCardSmall]].
  
 
== Usage ==
 
== Usage ==
<code><nowiki>{{MapCard |</nowiki>'''<nowiki>map</nowiki>'''<nowiki>|</nowiki>'''<nowiki>filename</nowiki>'''<nowiki>|</nowiki>'''<nowiki>image</nowiki>'''<nowiki>}}</nowiki></code>
+
<code><nowiki>{{MapCard |</nowiki>'''<nowiki>map</nowiki>'''<nowiki>|</nowiki>'''<nowiki>filename</nowiki>'''<nowiki>|</nowiki>'''<nowiki>image</nowiki>'''<nowiki>|</nowiki>'''<nowiki>superscript</nowiki>'''<nowiki>}}</nowiki></code>
 
*'''map''' - name of the map. Displayed as the card's title/caption and image if no '''image''' parameter is entered. Is case-sensitive.
 
*'''map''' - name of the map. Displayed as the card's title/caption and image if no '''image''' parameter is entered. Is case-sensitive.
*'''filename''' - file name of the map. Displayed upon hovering. All letters should be lowercase.
+
*'''filename''' - optional, file name of the map. Displayed upon hovering. All letters should be lowercase.  
 
*'''image''' - optional, image of the map. Will override the image that is automatically shown by the '''map''' parameter. Should only be used if the image shown by the '''map''' parameter is not appropriate (e.g. shows an error, bad dimensions). Is not case-sensitive.
 
*'''image''' - optional, image of the map. Will override the image that is automatically shown by the '''map''' parameter. Should only be used if the image shown by the '''map''' parameter is not appropriate (e.g. shows an error, bad dimensions). Is not case-sensitive.
 
*'''superscript''' - optional, adds a superscript after the map name. To use, you must also include the '''image''' parameter.
 
*'''superscript''' - optional, adds a superscript after the map name. To use, you must also include the '''image''' parameter.
Line 10: Line 10:
 
== Examples ==
 
== Examples ==
 
{{box|start|padding=8em}}
 
{{box|start|padding=8em}}
<code><nowiki>{{MapCard |Mojave|cp_mojave_b2}}</nowiki></code>
+
<code><nowiki>{{MapCard |Mojave}}</nowiki></code>
{{MapCard |Mojave|cp_mojave_b2}}
+
{{MapCard |Mojave}}
 
{{box|break}}
 
{{box|break}}
 
<code><nowiki>{{MapCard |Mojave|cp_mojave_b2|Reckoner.jpg|2}}</nowiki></code>
 
<code><nowiki>{{MapCard |Mojave|cp_mojave_b2|Reckoner.jpg|2}}</nowiki></code>
 
{{MapCard |Mojave|cp_mojave_b2|reckoner.jpg|2}}
 
{{MapCard |Mojave|cp_mojave_b2|reckoner.jpg|2}}
 
{{box|end}}
 
{{box|end}}

Latest revision as of 23:22, 28 September 2022

Template:MapCard displays a 152x86px rectangular card containing a map image. For a smaller 100x56px image, you can use MapCardSmall.

Usage[edit]

{{MapCard |map|filename|image|superscript}}

  • map - name of the map. Displayed as the card's title/caption and image if no image parameter is entered. Is case-sensitive.
  • filename - optional, file name of the map. Displayed upon hovering. All letters should be lowercase.
  • image - optional, image of the map. Will override the image that is automatically shown by the map parameter. Should only be used if the image shown by the map parameter is not appropriate (e.g. shows an error, bad dimensions). Is not case-sensitive.
  • superscript - optional, adds a superscript after the map name. To use, you must also include the image parameter.

Examples[edit]

{{MapCard |Mojave}}

Mojave
Mojave.jpg

{{MapCard |Mojave|cp_mojave_b2|Reckoner.jpg|2}}

Mojave2
Reckoner.jpg