Template:Place of Interest: Difference between revisions

From HorizonXI Wiki
mNo edit summary
(added documentation and minor code readability improvements)
Line 51: Line 51:
--><div style="display:table-row"><!--
--><div style="display:table-row"><!--
--><b style="display:table-cell; padding-right:0.5em;">Type:</b><!--
--><b style="display:table-cell; padding-right:0.5em;">Type:</b><!--
--><div style="display:table-cell;">{{#if:{{{type|}}}|<!--
--><div style="display:table-cell;">{{#if:{{{type|}}}<!--
if type is given, then categorize and display
if type is given, then categorize and display
-->{{categorize|{{{1|}}}|[[Category:{{{type}}}s]]}}[[:Category:{{{type}}}s|{{{type}}}]]<!--
-->|{{categorize|{{{1|}}}|[[Category:{{{type}}}s]]}}[[:Category:{{{type}}}s|{{{type}}}]]<!--
if type add is given, display after type
if type add is given, display after type
-->{{#if:{{{type add|}}}|, {{{type add|}}}|}}<!--
-->{{#if:{{{type add|}}}|, {{{type add|}}}|}}<!--
-->|<!--
if no type given, display places of interest category link
if no type given, display places of interest category link
-->[[:Category:Place of Interest|Place of Interest]]}}</div><!--
-->|[[:Category:Place of Interest|Place of Interest]]}}</div><!--
--></div><!--
--></div><!--
--><div style="display:table-row"><!--
--><div style="display:table-row"><!--
--><b style="display:table-cell; padding-right:0.5em;">Location:</b><!--
--><b style="display:table-cell; padding-right:0.5em;">Location:</b><!--
--><div style="display:table-cell;">{{default|{{{location|}}}|{{Information Needed|{{{1|}}}}}}}{{#if:{{{location add|}}}|, {{{location add}}}}}</div><!--
--><div style="display:table-cell;">{{#if:{{{location|}}}<!--
if location is given, then display (categorization is on top of the page)
-->|{{{location}}}<!--
if location add is given, display after location
-->{{#if:{{{location add|}}}|, {{{location add}}}}}<!--
if no location is given, display information needed
-->|{{Information Needed|{{{1|}}}}}}}</div><!--
--></div><!--
--></div><!--
--></div><!--
--></div><!--
Line 84: Line 89:
[[Category:Templates|{{PAGENAMEE}}]]
[[Category:Templates|{{PAGENAMEE}}]]
==Usage==
==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 {{fontaccent|<nowiki>{{Place of Interest|bp}}</nowiki>}} and copy the boilerplate from the preview only)
*'''name''': Name of the place
*'''image''': Filename of an image of the place
*'''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 [[quest]]s that start at this place.
*'''starts missions:''' A list of [[mission]]s that start at this place.
*'''involved in quests:''' A list of [[quest]]s that the place is involved in.
*'''involved in missions:''' A list of [[mission]]s that the place is involved in.
*'''involved in events:''' A list of [[Special Event|special event]]s 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===
{{Place of Interest|nc
{{Place of Interest|nc
| name = Muckvix's Junk Shop
| name = Muckvix's Junk Shop

Revision as of 14:03, 6 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
  • 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.