Template:LocationItem/doc: Difference between revisions

(4 intermediate revisions by one other user not shown)

Line 1:

The LocationItem template is used to display items acquired at various locations in Dragon Quest games. It applies to items found in treasure chests, in various furniture, or from non-player characters.

The LocationItem template is used to display items acquired at various locations in Dragon Quest games. It applies to items found in treasure chests, in various furniture, or from non-player characters. Each set of LocationItem calls is made to represent a '''single game''' in cases where there is more than 1 game/version.

==Usage==

Line 5:

===Header===

A header call to this template should be the first usage of this template on any page.

<pre>{{LocationItem|header|~~float~~=~~right~~}}</pre>

<pre>{{LocationItem|header|title={{Dragon Quest III}}|subtitle={{NES}}}}</pre>

*header: A required parameter which marks this as the start of an items table.

*~~float~~: ~~The float~~ parameter ~~is optional~~. ~~It represents~~ the ~~CSS float style and~~ should be ~~'left', 'right', or 'center'~~. ~~The default~~ is ~~''left''~~.

*title: A required parameter specifying the title of the item table. This should be a link to the game name in cases where there is more than 1, otherwise it should simply be "Items".

*subtitle: An optional parameter to enhance the title. Used only in cases where title is the game name, subtitle will then be the console version (i.e NES).

===Entries===

Each entry in the items table is represented by a single template call.

<pre>{{~~LocationItems~~|entry|item=[[Boxer ~~Shorts~~]]|location=~~B2 left corner|game=~~[[~~Dragon Warrior~~]]~~|console=NES~~}}</pre>

<pre>{{LocationItem|entry|item=[[Boxer shorts]]|location=In a drawer in the [[inn]]}}</pre>

*entry: A required parameter which marks this as a single item table entry.

*item: The item name. Should be a link to an interwiki article.

*location: Location of the item. Should be descriptive enough that it is easy to locate.

*game: The game this item is in. Should be an interwiki link. This parameter can contain multiple games if applicable.

*console: The console version of the game. '''Note:''' This parameter should contain multiple console values separated by commas if the game, item, and location parameters are the same!

===Footer===

The footer call marks the end of the item table.

Line 22:

==Example==

===Sample===

{{LocationItem|header|title={{Dragon Quest III}}|subtitle={{NES}}}}

{{LocationItem|entry|item=[[~~Antidote Herb~~]]|location=Barrel in southwest house~~|game=[[Dragon Warrior II]]|console=NES~~}}

{{LocationItem|entry|item=[[Antidotal herb]]|location=Barrel in southwest house}}

{{LocationItem|entry|item=[[Leather ~~Shield~~]]|location=Behind [[~~Final~~ Key]] door~~|game=[[Dragon Warrior III]]|console=GBC~~}}

{{LocationItem|entry|item=[[Leather shield]]|location=Behind [[Ultimate Key]] door}}

===Code===

<pre>

{{LocationItem|header|title={{Dragon Quest III}}|subtitle={{NES}}}}

{{LocationItem|entry|item=[[~~Antidote Herb~~]]|location=Barrel in southwest house~~|game=[[Dragon Warrior II]]|console=NES~~}}

{{LocationItem|entry|item=[[Antidotal herb]]|location=Barrel in southwest house}}

{{LocationItem|entry|item=[[Leather ~~Shield~~]]|location=~~Treasure chest behind~~ [[~~Final~~ Key]] door~~|game=[[Dragon Warrior III]]|console=GBC~~}}

{{LocationItem|entry|item=[[Leather shield]]|location=Behind [[Ultimate Key]] door}}

{{LocationItem|footer}}}

</pre>

@@ Line 1: / Line 1: @@
-The LocationItem template is used to display items acquired at various locations in Dragon Quest games.  It applies to items found in treasure chests, in various furniture, or from non-player characters.
+The LocationItem template is used to display items acquired at various locations in Dragon Quest games.  It applies to items found in treasure chests, in various furniture, or from non-player characters.  Each set of LocationItem calls is made to represent a '''single game''' in cases where there is more than 1 game/version.
 ==Usage==
@@ Line 5: / Line 5: @@
 ===Header===
 A header call to this template should be the first usage of this template on any page.
-<pre>{{LocationItem|header|float=right}}</pre>
+<pre>{{LocationItem|header|title={{Dragon Quest III}}|subtitle={{NES}}}}</pre>
 *header: A required parameter which marks this as the start of an items table.
-*float: The float parameter is optional.  It represents the CSS float style and should be 'left', 'right', or 'center'.  The default is ''left''.
+*title: A required parameter specifying the title of the item table.  This should be a link to the game name in cases where there is more than 1, otherwise it should simply be "Items".
+*subtitle: An optional parameter to enhance the title.  Used only in cases where title is the game name, subtitle will then be the console version (i.e NES).
 ===Entries===
 Each entry in the items table is represented by a single template call.
-<pre>{{LocationItems|entry|item=[[Boxer Shorts]]|location=B2 left corner|game=[[Dragon Warrior]]|console=NES}}</pre>
+<pre>{{LocationItem|entry|item=[[Boxer shorts]]|location=In a drawer in the [[inn]]}}</pre>
 *entry: A required parameter which marks this as a single item table entry.
 *item: The item name.  Should be a link to an interwiki article.
 *location: Location of the item.  Should be descriptive enough that it is easy to locate.
-*game: The game this item is in.  Should be an interwiki link. This parameter can contain multiple games if applicable.
-*console: The console version of the game. '''Note:''' This parameter should contain multiple console values separated by commas if the game, item, and location parameters are the same!
 ===Footer===
 The footer call marks the end of the item table.
@@ Line 22: / Line 22: @@
 ==Example==
 ===Sample===
-{{LocationItem|header}}
+{{LocationItem|header|title={{Dragon Quest III}}|subtitle={{NES}}}}
-{{LocationItem|entry|item=[[Antidote Herb]]|location=Barrel in southwest house|game=[[Dragon Warrior II]]|console=NES}}
+{{LocationItem|entry|item=[[Antidotal herb]]|location=Barrel in southwest house}}
-{{LocationItem|entry|item=[[Leather Shield]]|location=Behind [[Final Key]] door|game=[[Dragon Warrior III]]|console=GBC}}
+{{LocationItem|entry|item=[[Leather shield]]|location=Behind [[Ultimate Key]] door}}
 {{LocationItem|footer}}
 ===Code===
 <pre>
-{{LocationItem|header}}
+{{LocationItem|header|title={{Dragon Quest III}}|subtitle={{NES}}}}
-{{LocationItem|entry|item=[[Antidote Herb]]|location=Barrel in southwest house|game=[[Dragon Warrior II]]|console=NES}}
+{{LocationItem|entry|item=[[Antidotal herb]]|location=Barrel in southwest house}}
-{{LocationItem|entry|item=[[Leather Shield]]|location=Treasure chest behind [[Final Key]] door|game=[[Dragon Warrior III]]|console=GBC}}
+{{LocationItem|entry|item=[[Leather shield]]|location=Behind [[Ultimate Key]] door}}
-{{LocationItem|footer}}}
+{{LocationItem|footer}}
 </pre>