Guild Wars 2 wiki:Skill formatting — различия между версиями

Материал из Guild Wars 2 wiki
Перейти к: навигация, поиск
 
 
Строка 1: Строка 1:
This article documents the formatting [[Guild Wars 2 Wiki:practices and processes|practices and processes]] with regards to the documentation of skills. They are documented through the use of the [[Template:Skill infobox|skill infobox]] template.
+
{{TOCright}}
 +
This article will explain the formatting [[Guild Wars 2 Wiki:practices and processes|practices and processes]] with regards to the documentation of [[skill]]s.
  
== Skill parameters ==
+
== Skill infobox ==
 +
{{main|Template:Skill infobox}}
  
=== Skill names ===
+
Skills are described using the {{tl|Skill infobox}}. Basic parameters are outlined below; please refer to the template for a more detailed guide.
  
Skill names are documented as seen in-game, keeping the original capitalization. Therefore, the correct form is "Ray of Judgment", as opposed to "Ray of judgment" or "Ray Of Judgment". Redirects to different capitalizations are usually avoided, so keep in mind the proper form when linking to a skill.
+
<pre>
 +
{{Skill infobox
 +
| name =          <!-- Optional. Name of the skill. Only include if the name differs from the article name. Defaults to {{PAGENAME}}. -->
 +
| icon =          <!-- Optional. Icon of the skill. Only include if the icon differs from the article name. Defaults to File:{{PAGENAME}}.png -->
 +
| description =    <!-- Skill description, copied verbatim from the game, including errors. Do not include skill type, as this has its own parameter. -->
 +
| variables =      <!-- Use {{skill fact}} for each variable. See "Skill facts" documentation below for details on how to use this. -->
 +
| profession =    <!-- Profession that uses this skill. Mandatory if specialization is also set. -->
 +
| specialization = <!-- Specialization that uses this skill, if applicable. -->
 +
| type =          <!-- Skill type, e.g., signet, cantrip, etc. -->
 +
| activation =    <!-- Activation time. Enter as a decimal, e.g. 1.25 -->
 +
| activ-type =    <!-- Use for skills with a special activation type: Chain, Channeled, or Charge. -->
 +
| ground-target =  <!-- Type of ground targeting, if applicable. -->
 +
| initiative =    <!-- Initiative cost, if applicable. -->
 +
| energy =        <!-- Energy cost, if applicable. -->
 +
| upkeep =        <!-- Energy upkeep cost, if applicable. -->
 +
| recharge =      <!-- Recharge time. If there is no recharge, define the value as 0. -->
 +
| slot =          <!-- Slot in the skill bar that this skill belongs in, e.g., weapon, heal, utility, etc. -->
 +
| weapon-slot =    <!-- Weapon skills only. Slot number. -->
 +
| mainhand =      <!-- Weapon type (for mainhand weapon skills only). -->
 +
| offhand =        <!-- Weapon type (for offhand weapon skills only). -->
 +
| twohand =        <!-- Weapon type (for two-handed weapon skills only). If the skill is from a bundle, write the name of the bundle here instead. -->
 +
| tool belt =      <!-- Associated tool belt skill, if applicable. -->
 +
| attunement =    <!-- Associated attunement, if applicable. -->
 +
| kit =            <!-- Associated kit, if applicable. -->
 +
| activity =      <!-- Activity skills only. Name of activity. -->
 +
| pet =            <!-- Pet skills only. Add the pet's species here. Do not include "Juvenile". -->
 +
| pet-family =    <!-- Pet skills only. Add the pet's family here. -->
 +
| monster =        <!-- NPC skills only. Add the NPC's name here. -->
 +
| uw-replaced-by = <!-- Non-underwater skills only. Write the name of the underwater skill that replaces it; "none" if it has no replacement. -->
 +
| uw-replaces =    <!-- Underwater skills that replace a terrestrial skill only. Write the name of the terrestrial skill being replaced here. -->
 +
| parent =        <!-- Name of skill that gives access to this skill, if applicable. -->
 +
| chain1 =        <!-- Chain skills only. Name of first skill in chain. -->
 +
| chain2 =        <!-- Chain skills only. Name of second skill in chain. -->
 +
| chain3 =        <!-- Chain skills only. Name of third skill in chain. -->
 +
| hero points =    <!-- Slot skills only. Used to indicate how many hero points are required to unlock the skill. -->
 +
| id =            <!-- The skill's internal ID. Generates a game link in the infobox. -->
 +
| release =        <!-- Optional. Used to mark if a skill is from a specific release. -->
 +
| status =        <!-- Optional. Used to mark if a skill is temporary or historical and does not exist in the current state of the game. -->
 +
}}
 +
</pre>
  
When the same name is shared by multiple skills, the proper formatting is definied by the source of those skills:
+
=== Skill facts ===
*If a skill name is shared by a profession and by an environmental weapon, such as for example the elementalist skill "Burning Retreat" and the Lava Axe skill "Burning Retreat", we adopt the format:
+
{{main|Template:Skill fact}}
**Profession skill: "original skill name". In the example above, [[Burning Retreat]]
 
**Environmental weapon skill: "original skill name ('name of the environmental weapon' skill)". In the example above, [[Burning Retreat (Lava Axe skill)]]
 
*If a skill name is shared between a skill and a trait, such as the elementalist skill "Cleansing Wave" and the elementalist trait "Cleansing Wave":
 
**Skill: "original skill name". In the example above, [[Cleansing Wave]].
 
**Trait: "original skill name ('profession' trait)". In the example above, [[Cleansing Wave (trait)|Cleansing Wave (elementalist trait)]].
 
*If a skill name is shared by two professions, such as the thief skill "Smoke Bomb" and the engineer skill "Smoke Bomb", we use the format:
 
**"Original skill name ('profession' skill)". In the example above, [[Smoke Bomb (engineer skill)]] and [[Smoke Bomb (thief skill)|Smoke Bomb (thief skill)]].
 
  
The goal is to keep profession skill names as simple as possible, for easier documentation and so readers may find those skills more easily.
+
The "variables" parameter is filled in using the {{tl|Skill fact}} template, calling the template once for each variable. Please refer to the template documentation for details on using it for standard facts, as well as how to document non-standard facts.
  
=== Skill descriptions ===
+
* Whenever possible, use the standard options provided by the fact template. Avoid cluttering skill facts with non-standard formatting.
 +
* Facts should reflect the ''default'' [[PvE]] state of the skill with base attributes. Damage and healing facts scale with the character's level and attributes, thus these variables need to be standardized for consistency between skills. The (current) baseline criteria are:
 +
** Level 80 character (base value for primary attributes is 1000)
 +
** No active effects that modify attributes
 +
** No [[trait]]s that increase damage/healing, affect condition duration/damage, or otherwise modify skill facts. Traits that simply ''add'' facts are fine, since the new facts can be identified by their <span style="color:cornflowerblue">blue text</span> and ignored.
 +
*** In the current trait system, you always have 3 specializations equipped, and the minor traits in those specs are automatically selected, thus this may be difficult for some professions.
 +
** No [[armor]], [[trinket]]s, or [[back item]]s equipped
 +
** [[Weapon]]s are necessary for weapon skills, but should be unequipped otherwise
 +
*** Level 80 exotic
 +
*** No sigils that affect damage, conditions, or healing
 +
*** Ideally, the prefix should have no attributes that affect skill facts, i.e. no Power, Healing Power, Boon Duration, or Condition Duration. Thus, Dire and Rabid prefixes should be used, since they are the only two of the available [[Attribute combinations#Triple attribute|triple-attribute prefixes]] with none of those attributes.
 +
** If a skill can only be accessed in a way that forces an attribute modification (e.g. [[Banner]] bundle skills can only be accessed by holding that bundle, which gives attribute bonuses), then that modification becomes the default for that skill.
 +
* The [[sPvP]] or [[World versus World|WvW]] version of the skill may have differences to the PvE version. These are documented on their own pages, typically titled '''<Skill name> (PvP)'''.
  
Skill descriptions are copied verbatim as seen in-game, with two modifications:
+
=== Other templates ===
*The skill type is removed from the description. Skill descriptions in-game usually begin with the skill type. In the wiki, we remove this information since it is already stated in the skill infobox.
+
* {{tl|Game mode version}} — Added above the infobox if the skill has different versions for PvE and PvP.
*Capitalization is modified so only proper nouns are capitalized. Skill descriptions in-game usually capitalize condition and boon names, as well as other effect names.
+
* {{tl|Trait icon}} and {{tl|Trait description}} — Used to list traits that affect the skill. The latter will automatically display the trait's in-game description, as recorded in the trait's infobox.
Therefore, the description of [["Hold the Line!"]] seen in the game is:
+
* {{tl|Version history table header}} and {{tl|Version history table row}} — Used to display patch notes pertaining to the skill. Descriptions of any changes are copied from the official patch notes, which can be found at [[Game updates]].
*Shout. Grant Protection and Regeneration to allies.
 
The description seen in the wiki is:
 
*Grant protection and regeneration to allies.
 
Spelling mistakes are copied as seen in game and followed by the {{sic}} template.
 
  
=== Skill recharge ===
+
== Copy-paste layout ==
 +
This is a suggested layout for a skill page, based on current conventions; editors should feel free to alter it as they see fit.
 +
<pre>
 +
{{Game mode version|<game mode this skill is used in>}} <!-- Optional. Only used if PvE and PvP modes have different versions of this skill. -->
  
All skills are assigned a skill recharge time, in seconds (as seen in the game) Skills with no recharge are given a 0 second recharge time.
+
{{Skill infobox
 +
| name =
 +
| icon =
 +
| description =
 +
| variables =
 +
| profession =
 +
| specialization =
 +
| type =
 +
| activation =
 +
| activ-type =
 +
| ground-target =
 +
| recharge =
 +
| slot =
 +
| weapon-slot =
 +
| mainhand =
 +
| offhand =
 +
| twohand =
 +
| chain1 =
 +
| chain2 =
 +
| chain3 =
 +
| hero points =
 +
| id =
 +
| release =
 +
}}
  
<!-- We don't currently document this, so I'm commenting it out.
+
== Related traits ==
=== Skill activation ===
+
<!-- Optional section. List any traits which affect this skill, organized by trait line. -->
 +
=== {{trait icon|<!--Trait line-->|size=35}}===
 +
* {{trait icon|<!--Trait 1-->}} — {{trait description|<!--Trait 1-->}}
 +
* {{trait icon|<!--Trait 2-->}} — {{trait description|<!--Trait 2-->}}
  
All skills are assigned a skill activation time. Activation refers to the time in which the skill is being used, not only to the interval between the player command and the beginning of the skill effect.
+
== Notes ==
-->
+
<!-- Optional section. Any relevant notes can go here. -->
=== Skill effects ===
+
*...
Skill effects are documented using the {{tl|Skill infobox/effects}} template, calling the template once for each effect. See the template documentation for details on using it for standard effects, as well as how to document non-standard effects.
 
  
* Skill effects do not have to be documented verbatim, but should be close enough to convey the information accurately. For example, the default template output for boons, conditions, and control effects does not include the effect's description, since this is documented on the effect page and doesn't need to be repeated on skill pages.
+
== Version history ==
* Whenever possible, use a standard effect template.  For non-standard effects, use the base effect that gives the same icon and provide the effect name with the ''alt'' parameter.
+
<!-- Required for profession skills. Leave blank if unsure. -->
** Effect names like this are usually title-cased in the game, but should be converted to lower-case.
+
{{Version history table header|<!--Profession-->}}
* Effects should reflect the ''default'' state of the skill, i.e. they should not be modified by any traits (e.g. [[Deployable Turrets]] which adds a "Range" effect to all turret skills, or [[Eagle Eye]] which increases the range on longbow skills). Damage and healing effects scale with the character's level and stats, thus these variables need to be standardized for consistency between skills.  The (current) baseline criteria are:
+
{{Version history table row|<!--yyyy-mm-dd-->|<!--Profession--> }}
** Level 80
+
* <!--Description of changes, copied from the official patch notes.-->
** All trait points refunded
+
{{Version history table row|release|r=y}} <!-- Change "release" to a date if skill was not introduced with the release of Guild Wars 2 on 2012-8-28. -->
** No buffs that give stat bonuses
+
|}
** No equipped armor or accessories
 
** For weapon skills only, equip a max-strength weapon with no upgrades
 
  
[[Category:Formatting guidelines|Skill]]
+
== Trivia ==
 +
<!-- Optional section. Any trivial information can go here. -->
 +
*...
 +
</pre>
 +
 
 +
{{formatting nav}}

Текущая версия на 15:32, 23 декабря 2018

This article will explain the formatting practices and processes with regards to the documentation of skills.

Skill infobox[править]

Основная статья: Template:Skill infobox

Skills are described using the {{Skill infobox}}. Basic parameters are outlined below; please refer to the template for a more detailed guide.

{{Skill infobox
| name =           <!-- Optional. Name of the skill. Only include if the name differs from the article name. Defaults to {{PAGENAME}}. -->
| icon =           <!-- Optional. Icon of the skill. Only include if the icon differs from the article name. Defaults to File:{{PAGENAME}}.png -->
| description =    <!-- Skill description, copied verbatim from the game, including errors. Do not include skill type, as this has its own parameter. -->
| variables =      <!-- Use {{skill fact}} for each variable. See "Skill facts" documentation below for details on how to use this. -->
| profession =     <!-- Profession that uses this skill. Mandatory if specialization is also set. -->
| specialization = <!-- Specialization that uses this skill, if applicable. -->
| type =           <!-- Skill type, e.g., signet, cantrip, etc. -->
| activation =     <!-- Activation time. Enter as a decimal, e.g. 1.25 -->
| activ-type =     <!-- Use for skills with a special activation type: Chain, Channeled, or Charge. -->
| ground-target =  <!-- Type of ground targeting, if applicable. -->
| initiative =     <!-- Initiative cost, if applicable. -->
| energy =         <!-- Energy cost, if applicable. -->
| upkeep =         <!-- Energy upkeep cost, if applicable. -->
| recharge =       <!-- Recharge time. If there is no recharge, define the value as 0. -->
| slot =           <!-- Slot in the skill bar that this skill belongs in, e.g., weapon, heal, utility, etc. -->
| weapon-slot =    <!-- Weapon skills only. Slot number. -->
| mainhand =       <!-- Weapon type (for mainhand weapon skills only). -->
| offhand =        <!-- Weapon type (for offhand weapon skills only). -->
| twohand =        <!-- Weapon type (for two-handed weapon skills only). If the skill is from a bundle, write the name of the bundle here instead. -->
| tool belt =      <!-- Associated tool belt skill, if applicable. -->
| attunement =     <!-- Associated attunement, if applicable. -->
| kit =            <!-- Associated kit, if applicable. -->
| activity =       <!-- Activity skills only. Name of activity. -->
| pet =            <!-- Pet skills only. Add the pet's species here. Do not include "Juvenile". -->
| pet-family =     <!-- Pet skills only. Add the pet's family here. -->
| monster =        <!-- NPC skills only. Add the NPC's name here. -->
| uw-replaced-by = <!-- Non-underwater skills only. Write the name of the underwater skill that replaces it; "none" if it has no replacement. -->
| uw-replaces =    <!-- Underwater skills that replace a terrestrial skill only. Write the name of the terrestrial skill being replaced here. -->
| parent =         <!-- Name of skill that gives access to this skill, if applicable. -->
| chain1 =         <!-- Chain skills only. Name of first skill in chain. -->
| chain2 =         <!-- Chain skills only. Name of second skill in chain. -->
| chain3 =         <!-- Chain skills only. Name of third skill in chain. -->
| hero points =    <!-- Slot skills only. Used to indicate how many hero points are required to unlock the skill. -->
| id =             <!-- The skill's internal ID. Generates a game link in the infobox. -->
| release =        <!-- Optional. Used to mark if a skill is from a specific release. -->
| status =         <!-- Optional. Used to mark if a skill is temporary or historical and does not exist in the current state of the game. -->
}}

Skill facts[править]

Основная статья: Template:Skill fact

The "variables" parameter is filled in using the {{Skill fact}} template, calling the template once for each variable. Please refer to the template documentation for details on using it for standard facts, as well as how to document non-standard facts.

  • Whenever possible, use the standard options provided by the fact template. Avoid cluttering skill facts with non-standard formatting.
  • Facts should reflect the default PvE state of the skill with base attributes. Damage and healing facts scale with the character's level and attributes, thus these variables need to be standardized for consistency between skills. The (current) baseline criteria are:
    • Level 80 character (base value for primary attributes is 1000)
    • No active effects that modify attributes
    • No traits that increase damage/healing, affect condition duration/damage, or otherwise modify skill facts. Traits that simply add facts are fine, since the new facts can be identified by their blue text and ignored.
      • In the current trait system, you always have 3 specializations equipped, and the minor traits in those specs are automatically selected, thus this may be difficult for some professions.
    • No armor, trinkets, or back items equipped
    • Weapons are necessary for weapon skills, but should be unequipped otherwise
      • Level 80 exotic
      • No sigils that affect damage, conditions, or healing
      • Ideally, the prefix should have no attributes that affect skill facts, i.e. no Power, Healing Power, Boon Duration, or Condition Duration. Thus, Dire and Rabid prefixes should be used, since they are the only two of the available triple-attribute prefixes with none of those attributes.
    • If a skill can only be accessed in a way that forces an attribute modification (e.g. Banner bundle skills can only be accessed by holding that bundle, which gives attribute bonuses), then that modification becomes the default for that skill.
  • The sPvP or WvW version of the skill may have differences to the PvE version. These are documented on their own pages, typically titled <Skill name> (PvP).

Other templates[править]

Copy-paste layout[править]

This is a suggested layout for a skill page, based on current conventions; editors should feel free to alter it as they see fit.

{{Game mode version|<game mode this skill is used in>}} <!-- Optional. Only used if PvE and PvP modes have different versions of this skill. -->

{{Skill infobox
| name = 
| icon = 
| description = 
| variables = 
| profession = 
| specialization = 
| type = 
| activation = 
| activ-type = 
| ground-target = 
| recharge = 
| slot = 
| weapon-slot = 
| mainhand = 
| offhand = 
| twohand = 
| chain1 = 
| chain2 = 
| chain3 = 
| hero points = 
| id = 
| release = 
}}

== Related traits ==
<!-- Optional section. List any traits which affect this skill, organized by trait line. -->
=== {{trait icon|<!--Trait line-->|size=35}}===
* {{trait icon|<!--Trait 1-->}} — {{trait description|<!--Trait 1-->}}
* {{trait icon|<!--Trait 2-->}} — {{trait description|<!--Trait 2-->}}

== Notes ==
<!-- Optional section. Any relevant notes can go here. -->
*...

== Version history ==
<!-- Required for profession skills. Leave blank if unsure. -->
{{Version history table header|<!--Profession-->}}
{{Version history table row|<!--yyyy-mm-dd-->|<!--Profession--> }}
* <!--Description of changes, copied from the official patch notes.-->
{{Version history table row|release|r=y}} <!-- Change "release" to a date if skill was not introduced with the release of Guild Wars 2 on 2012-8-28. -->
|}

== Trivia ==
<!-- Optional section. Any trivial information can go here. -->
*...