Template:Place of Interest: Difference between revisions

From HorizonXI Wiki
(added documentation and minor code readability improvements)
(added option for a second image and optional imagecaption parameters)
Line 5: Line 5:
| name =  
| name =  
| image =  
| image =  
| image 2 =
| type =  
| type =  
| type add =  
| type add =  
Line 20: Line 21:
| name = {Defaults to the page's name if blank}
| name = {Defaults to the page's name if blank}
| image = {Use the file name e.g. Imagename.png}
| image = {Use the file name e.g. Imagename.png}
| image 2 = {Filename of a second image}
| type = {Place of Interest type eg. Shop or Guild. Defaults to "Place of Interest" if left blank. Auto-categorizes}
| type = {Place of Interest type eg. Shop or Guild. Defaults to "Place of Interest" if left blank. Auto-categorizes}
| type add = {Any addition to type. Can be linked via [[name]]}
| type add = {Any addition to type. Can be linked via [[name]]}
Line 40: Line 42:
image
image
-->{{#if:{{{image|}}}<!--
-->{{#if:{{{image|}}}<!--
-->|[[Image:{{{image}}}|thumb|{{#if:{{{imageheight|}}}|{{{imageheight}}}x}}{{#if:{{{imagewidth|}}}|{{{imageheight}}}|300}}px|{{{name|{{PAGENAME}}}}}]]<!--
-->|[[Image:{{{image}}}|thumb|{{#if:{{{imageheight|}}}|{{{imageheight}}}x}}{{#if:{{{imagewidth|}}}|{{{imageheight}}}|300}}px|{{{imagecaption|{{{name|{{PAGENAME}}}}}}}}]]<!--
image 2
-->{{#if:{{{image 2|}}}<!--
-->|[[Image:{{{image 2}}}|thumb|{{#if:{{{imageheight 2|}}}|{{{imageheight 2}}}x}}{{#if:{{{imagewidth 2|}}}|{{{imageheight 2}}}|300}}px|{{{imagecaption 2|{{{name|{{PAGENAME}}}}}}}}]]<!--
-->}}<!--
-->|{{Image-stub|{{{1|}}}}}<!--
-->|{{Image-stub|{{{1|}}}}}<!--
-->}}<!--
-->}}<!--
Line 98: Line 104:


*'''name''': Name of the place
*'''name''': Name of the place
*'''image''': Filename of an image of the place
*'''image''': Filename of an image of the place. You can change the default size with '''imageheight''' and '''imagewidth''' parameters and add a caption different to the name of the place with the '''imagecaption''' parameter.
*'''image 2''': Filename of another image of the place. You can change the default size with '''imageheight 2''' and '''imagewidth 2''' parameters and add a caption different to the name of the place with the '''imagecaption 2''' parameter.
*'''type:''' The place's type, e.g. "Shop" or "Guild".
*'''type:''' The place's type, e.g. "Shop" or "Guild".
*'''type add:''' Any addition to type
*'''type add:''' Any addition to type

Revision as of 12:21, 8 August 2024

Usage

Documentation

This template is designed to be used on Category:Places of Interest pages to display various information about the place.

  • First unnamed Parameter (optional): You can set the first unnamed parameter to:
    • nc (no category) to prevent automatic categorization (e.g. for example pages)
    • nd (no documentation) to suppress the preview documentation (helpful in the editing process)
    • bp (boilerplate) to have the preview documentation without comments so you can just copy it to the page (helpful for creating new pages to just start with {{Place of Interest|bp}} and copy the boilerplate from the preview only)
  • name: Name of the place
  • image: Filename of an image of the place. You can change the default size with imageheight and imagewidth parameters and add a caption different to the name of the place with the imagecaption parameter.
  • image 2: Filename of another image of the place. You can change the default size with imageheight 2 and imagewidth 2 parameters and add a caption different to the name of the place with the imagecaption 2 parameter.
  • type: The place's type, e.g. "Shop" or "Guild".
  • type add: Any addition to type
  • location: Area and position where the place is found. See Template:Location.
  • description: A short, free-form description of the place.
  • starts quests: A list of quests that start at this place.
  • starts missions: A list of missions that start at this place.
  • involved in quests: A list of quests that the place is involved in.
  • involved in missions: A list of missions that the place is involved in.
  • involved in events: A list of special events that the place is involved in.
  • notes: Any additional notes about this place that are not covered in other sections.
  • historical background: Any background information that is relevant to this place, such as myths, legends, or pop culture that may have inspired aspects of this place.


Examples

Muckvix's Junk Shop
Name:
Muckvix's Junk Shop
Type:
Location:
Lower Jeuno (H-9), Lower Level
A small cluttered shop nestled next to Waag-Deeg's Magic Shop. The merchants here are goblins against all chance. The Dutchy has granted them amnesty so long as they mind their own business and don't start trouble. They sell items not seen anywhere else, and they all sport enviously large gobbiebags... In the very back of the shop they have a small eatery, the "Goblins' Goblet", employing a goblin cook, as well as a very skilled goblin tailor.