Template:LocationAttr/doc: Difference between revisions

(9 intermediate revisions by 2 users not shown)

Line 2:

==Usage==

In almost all cases, using this template should be preceded by an '''Other notable attributes''' heading on the article it is being transcluded onto~~. This is because there is no label marking the table data within this template. This is consistent with other location templates.~~

In almost all cases, using this template should be preceded by an '''Other notable attributes''' heading on the article it is being transcluded onto.

~~===Header===~~

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

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

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

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

~~===Entries===~~

~~Each entry in the location attribute table is represented by a single template call. There are 3 specialty entry types along with the generic entry type.~~

~~<pre>{{LocationAttr|entry|info=The game can be saved in this location.|game=[[Dragon Warrior]]|console=NES}}</pre>~~

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

*info: General info about the attribute.

*game: The game this attribute represents. 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 and info parameters are the same.

====Save entry====

The save entry is a pre-populated entry for marking a location as a save point.

<pre>{{LocationAttr|save~~|game=[[Dragon Quest VI]]|console=SNES~~}}</pre>

~~The game and console parameters are the same as for a normal entry.~~

<pre>{{LocationAttr|save}}</pre>

====Zoom entry====

The zoom entry is a pre-populated entry for marking a location as a zoom point.

<pre>{{LocationAttr|zoom~~|game=[[Dragon Quest VI]]|console=SNES~~}}</pre>

~~The game and console parameters are the same as for a normal entry.~~

<pre>{{LocationAttr|zoom}}</pre>

====Lottery entry====

The lottery entry is a pre-populated entry for marking a location as having a lottery location.

<pre>{{LocationAttr|lottery|~~game~~=~~[[Dragon Quest II]]~~|~~console~~=~~SNES~~}}</pre>

The ~~game and console parameters are the same~~ as for a ~~normal~~ entry.

<pre>{{LocationAttr|lottery}}</pre>

===~~Footer~~===

====Party entry====

~~The footer call marks~~ the ~~end of~~ the location ~~attribute table~~.

The party entry is a pre-populated entry for marking a location as having a location where party members can be changed.

<pre>{{LocationAttr|~~footer~~}}</pre>

*footer: A required parameter marking the ~~template as~~ the ~~footer~~.

<pre>{{LocationAttr|party}}</pre>

====Monster entry====

The monster entry is a pre-populated entry for marking a location as having a location where monster companions can be changed.

<pre>{{LocationAttr|monster}}</pre>

====Casino entry====

The casino entry is a pre-populated entry for marking a location as having a casino or other gambling facility.

<pre>{{LocationAttr|casino}}</pre>

====Bank entry====

The bank entry is a pre-populated entry for marking a location as having a bank or vault location.

<pre>{{LocationAttr|bank}}</pre>

====Poison entry====

The poison entry is a pre-populated entry for marking a location as having a poisonous marsh/swamp.

<pre>{{LocationAttr|poison}}</pre>

====Lava entry====

The lava entry is a pre-populated entry for marking a location as having a lava marsh/swamp.

<pre>{{LocationAttr|lava}}</pre>

===Other entry===

For any other entry use the following syntax.

<pre>{{LocationAttr|text=This is the only location with ninjas.}}</pre>

You can also assign an icon for the entry.

{{LocationAttr|other|image=FyggIcon.png|text=This is a location where a [[Fygg]] can be collected.}}

<pre>{{LocationAttr|other|image=FyggIcon.png|text=This is a location where a [[Fygg]] can be collected.}}</pre>

{{LocationAttr|other|image=DQXI Camp icon.png|text=This is a location where the party can set up camp for the night.}}

<pre>{{LocationAttr|other|image=DQXI Camp icon.png|text=This is a location where the party can set up camp for the night.}}</pre>

{{LocationAttr|other|image=DQXI Horse Call icon.png|text=This is a location where a [[Horse and monster riding|horse]] can be called.}}

<pre>{{LocationAttr|other|image=DQXI Horse Call icon.png|text=This is a location where a [[Horse and monster riding|horse]] can be called.}}</pre>

==Example==

===Sample===

{{LocationAttr|~~save~~|~~game=[[Dragon Quest II]]~~|~~console=NES~~}}

{{LocationAttr|~~zoom~~|~~game=[[Dragon Quest]]~~|~~console=GBC~~}}

{{LocationAttr|~~lottery~~|~~game~~=~~[[Dragon Quest II]]~~|~~console~~=~~NES,GBC~~}}

{{LocationAttr|~~entry~~|~~info~~=This is a location where ~~party members can be changed.|game=~~[[~~Dragon Warrior III~~]]~~|console=NES~~}}

{{LocationAttr|other|image=DQXI Camp icon.png|text=This is a location where the party can set up camp for the night.}}

{{LocationAttr|other|image=DQXI Horse Call icon.png|text=This is a location where a [[Horse and monster riding|horse]] can be called.}}

{{LocationAttr|text=This is a location where party members can change class.}}

===Code===

<pre>

{{LocationAttr|~~save~~|~~game=[[Dragon Quest II]]~~|~~console=NES~~}}

{{LocationAttr|~~zoom~~|~~game=[[Dragon Quest]]~~|~~console=GBC~~}}

{{LocationAttr|~~lottery~~|~~game~~=~~[[Dragon Quest II]]~~|~~console~~=~~NES,GBC~~}}

{{LocationAttr|~~entry~~|~~info~~=This is a location where ~~party members can be changed.|game=~~[[~~Dragon Warrior III~~]]~~|console=NES~~}}

{{LocationAttr|other|image=DQXI Camp icon.png|text=This is a location where the party can set up camp for the night.}}

{{LocationAttr|other|image=DQXI Horse Call icon.png|text=This is a location where a [[Horse and monster riding|horse]] can be called.}}

{{LocationAttr|text=This is a location where party members can change class.}}

</pre>

@@ Line 2: / Line 2: @@
 ==Usage==
-In almost all cases, using this template should be preceded by an '''Other notable attributes''' heading on the article it is being transcluded onto.  This is because there is no label marking the table data within this template.  This is consistent with other location templates.
+In almost all cases, using this template should be preceded by an '''Other notable attributes''' heading on the article it is being transcluded onto.
-===Header===
-A header call to this template should be the first usage of this template on any page.
-<pre>{{LocationAttr|header|float=right}}</pre>
-*header: A required parameter which marks this as the start of an teleportal table.
-*float: The float parameter is optional.  It represents the CSS float style and should be 'left', 'right', or 'center'.  The default is ''left''.
-===Entries===
-Each entry in the location attribute table is represented by a single template call. There are 3 specialty entry types along with the generic entry type.
-<pre>{{LocationAttr|entry|info=The game can be saved in this location.|game=[[Dragon Warrior]]|console=NES}}</pre>
-*entry: A required parameter which marks this as a single location attribute table entry.
-*info: General info about the attribute.
-*game: The game this attribute represents. 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 and info parameters are the same.
 ====Save entry====
 The save entry is a pre-populated entry for marking a location as a save point.
-<pre>{{LocationAttr|save|game=[[Dragon Quest VI]]|console=SNES}}</pre>
+{{LocationAttr|save}}
-The game and console parameters are the same as for a normal entry.
+<pre>{{LocationAttr|save}}</pre>
 ====Zoom entry====
 The zoom entry is a pre-populated entry for marking a location as a zoom point.
-<pre>{{LocationAttr|zoom|game=[[Dragon Quest VI]]|console=SNES}}</pre>
+{{LocationAttr|zoom}}
-The game and console parameters are the same as for a normal entry.
+<pre>{{LocationAttr|zoom}}</pre>
 ====Lottery entry====
 The lottery entry is a pre-populated entry for marking a location as having a lottery location.
-<pre>{{LocationAttr|lottery|game=[[Dragon Quest II]]|console=SNES}}</pre>
+{{LocationAttr|lottery}}
-The game and console parameters are the same as for a normal entry.
+<pre>{{LocationAttr|lottery}}</pre>
-===Footer===
+====Party entry====
-The footer call marks the end of the location attribute table.
+The party entry is a pre-populated entry for marking a location as having a location where party members can be changed.
-<pre>{{LocationAttr|footer}}</pre>
+{{LocationAttr|party}}
-*footer: A required parameter marking the template as the footer.
+<pre>{{LocationAttr|party}}</pre>
+====Monster entry====
+The monster entry is a pre-populated entry for marking a location as having a location where monster companions can be changed.
+{{LocationAttr|monster}}
+<pre>{{LocationAttr|monster}}</pre>
+====Casino entry====
+{{LocationAttr|casino}}
+The casino entry is a pre-populated entry for marking a location as having a casino or other gambling facility.
+<pre>{{LocationAttr|casino}}</pre>
+====Bank entry====
+The bank entry is a pre-populated entry for marking a location as having a bank or vault location.
+{{LocationAttr|bank}}
+<pre>{{LocationAttr|bank}}</pre>
+====Poison entry====
+The poison entry is a pre-populated entry for marking a location as having a poisonous marsh/swamp.
+{{LocationAttr|poison}}
+<pre>{{LocationAttr|poison}}</pre>
+====Lava entry====
+The lava entry is a pre-populated entry for marking a location as having a lava marsh/swamp.
+{{LocationAttr|lava}}
+<pre>{{LocationAttr|lava}}</pre>
+===Other entry===
+For any other entry use the following syntax.
+{{LocationAttr|text=This is the only location with ninjas.}}
+<pre>{{LocationAttr|text=This is the only location with ninjas.}}</pre>
+You can also assign an icon for the entry.
+{{LocationAttr|other|image=FyggIcon.png|text=This is a location where a [[Fygg]] can be collected.}}
+<pre>{{LocationAttr|other|image=FyggIcon.png|text=This is a location where a [[Fygg]] can be collected.}}</pre>
+{{LocationAttr|other|image=DQXI Camp icon.png|text=This is a location where the party can set up camp for the night.}}
+<pre>{{LocationAttr|other|image=DQXI Camp icon.png|text=This is a location where the party can set up camp for the night.}}</pre>
+{{LocationAttr|other|image=DQXI Horse Call icon.png|text=This is a location where a [[Horse and monster riding|horse]] can be called.}}
+<pre>{{LocationAttr|other|image=DQXI Horse Call icon.png|text=This is a location where a [[Horse and monster riding|horse]] can be called.}}</pre>
 ==Example==
 ===Sample===
-{{LocationAttr|header}}
+{{LocationAttr|save}}
-{{LocationAttr|save|game=[[Dragon Quest II]]|console=NES}}
+{{LocationAttr|zoom}}
-{{LocationAttr|zoom|game=[[Dragon Quest]]|console=GBC}}
+{{LocationAttr|lottery}}
-{{LocationAttr|lottery|game=[[Dragon Quest II]]|console=NES,GBC}}
+{{LocationAttr|party}}
-{{LocationAttr|entry|info=This is a location where party members can be changed.|game=[[Dragon Warrior III]]|console=NES}}
+{{LocationAttr|monster}}
-{{LocationAttr|footer}}
+{{LocationAttr|casino}}
+{{LocationAttr|bank}}
+{{LocationAttr|other|image=DQXI Camp icon.png|text=This is a location where the party can set up camp for the night.}}
+{{LocationAttr|other|image=DQXI Horse Call icon.png|text=This is a location where a [[Horse and monster riding|horse]] can be called.}}
+{{LocationAttr|text=This is a location where party members can change class.}}
 ===Code===
 <pre>
-{{LocationAttr|header}}
+{{LocationAttr|save}}
-{{LocationAttr|save|game=[[Dragon Quest II]]|console=NES}}
+{{LocationAttr|zoom}}
-{{LocationAttr|zoom|game=[[Dragon Quest]]|console=GBC}}
+{{LocationAttr|lottery}}
-{{LocationAttr|lottery|game=[[Dragon Quest II]]|console=NES,GBC}}
+{{LocationAttr|party}}
-{{LocationAttr|entry|info=This is a location where party members can be changed.|game=[[Dragon Warrior III]]|console=NES}}
+{{LocationAttr|monster}}
-{{LocationAttr|footer}}
+{{LocationAttr|casino}}
+{{LocationAttr|bank}}
+{{LocationAttr|other|image=DQXI Camp icon.png|text=This is a location where the party can set up camp for the night.}}
+{{LocationAttr|other|image=DQXI Horse Call icon.png|text=This is a location where a [[Horse and monster riding|horse]] can be called.}}
+{{LocationAttr|text=This is a location where party members can change class.}}
 </pre>