Gswiki:Style guide/Item scripts

In order to streamline the process for creating and editing item/script pages on the Wiki, a series of templates have been created. These templates, along with this guide and the provided examples, serve to ensure formatting and categorization remain uniform across the various pages.

Categories

As part of this update, categories for items and their scripts have seen a revamp as well. Below is a list of what categories are to be used moving forward, as well as where they should be entered within the Iteminfo template.

Type

The entry slots for these in the iteminfo template are type, the main item type, and type2, the item's sub-type.

• Mechanical item scripts: Formally known as "functional" item scripts. These scripts provide a mechanical benefit to the user. Examples include: Mana-Infused Armor, Sigil Staff, and Sprite Weapon.
• Fluff item scripts: These types of scripts do not provide a mechanical benefit to the user, even though they may be added to things that do, such as weapons or armor. Examples include: Fuzzy Warm Parkas, Veola hair accessories, Peretta gowns.
• Feature altering item scripts: These scripts are either mechanical or fluff, but have the ability to alter a character's features. Examples include: Peretta masks, hairpicks, Veola hair accessories.
• Crafting item scripts: These scripts apply to items that can be used as part of the process to craft something, including specialized storage of crafting supplies. Examples include: Knitting needles and Yarn bowls for the knitting system.

Please note: An item will either be mechanical (ie. it provides the user with a mechanical benefit) or fluff (ie. it is meant for roleplay and provides no mechanical benefit). Items that are mechanical in nature may have fluff scripts associated with them, but fluff items do not grant a mechanical benefit at all. If an item provides a mechanical benefit off-the-shell, it will always be categorized as mechanical, not fluff, regardless of the fluff scripts associated with it. In rare cases, an item will fall into both categories, but this may only occur if the item is purely fluff up until a certain unlock in which it provides a mechanical benefit to the user.

Classification

The entry slots for these in the iteminfo template are itemclass(2-3).

• Armor item scripts: These scripts apply solely to armor.
• Weapon item scripts: These scripts apply solely to weapons.
• Shield item scripts: These scripts apply to shields.
• Clothing item scripts: These scripts apply to clothing items. Applicable worn locations (based on INVENTORY) are: shoulders-worn/draped over shoulders (also known as cloak-worn), shoulder-worn (slung over)*, front-worn*, chest-worn, under-chest-worn (layered), leg-worn (pulled over), leggings-worn (slipped into)*, & feet-worn* (shoes). Examples include: Dramatic Drapery (shoulders-worn/cloak-worn), Yansio clothing, Peretta gowns.
• Accessory item scripts: These scripts apply to accessory items only. Applicable worn locations (based on INVENTORY) are: pin-worn, waist-worn (worn as a belt, not belt-worn), head-worn, wrist-worn, finger-worn, feet-worn*, neck-worn*, arm-worn, leg-worn (attached to), ear(s)-worn, ankle-worn, front-worn*, hands-worn, feet-worn (worn as socks, slipped on), hair-worn, leggings-worn (slipped into)*. Examples include Nexus jewelry, Knee-high stockings, Veola hair accessory.
• Container item scripts: These scripts apply to containers, such as belt-worn, back-worn, front-worn*, neck-worn*, or shoulder-worn (slung over)* items. For the purpose of this classification, it does not include cloak-worn items.
• Creature item scripts: These scripts apply to creature-type items, such as pets, ex. Dhu kittens or Mounts.
• Miscellaneous item scripts: These scripts apply to items that do not fall within the aforementioned categories. Examples include: gemcutters, lapidary boxes.

*Please note: Certain worn locations may have overlap in categories based on the particular noun they use. For instance, a front-worn corset would fall under the clothing category, a front-worn harness or bandolier would fall under containers, and a front-worn piece of jewelry would fall under accessories.

Right Side Infoboxes

These templates allow for a quick at a glance look at the script.

• Template:Iteminfo - This template features all the need to know information and will either grow or shrink based on information entered.
• Template:Itemverb - This template contains a list of verbs used on the item, with clickable links to the verb page itself. This is an optional table, and can be omitted if the article is short enough to not necessitate it.

Page Subheaders

For typical item pages, the breakdown was Analyze, Usage, Additional Information (including links to other pages/resources). Going forward, pages that cover a script on a single item type (eg. Compartmentalized quiver, Pirate Harness) will be broken down into Analyze, Tiers (with each tier being its own subheader), Additional Information. Pages that cover scripts that can be applied to multiple items (eg. Yansio clothing, Veola hair accessory) will will have a similar setup, however the Item will go in place of the Tier. This will allow uniformity between fluff item script pages and mechanical item script pages. Optional templates were created that can be used for both types, one for single item type pages, and one for multi-item type pages.

• Template:Itemtier - Optional template for single item pages with spots for Tier (or tree), Item Summary (a quick breakdown of information for the unlock, if any), Analyze (if the tier unlock differs greatly from the base analyze. This does not include if there are only additional verbs for the unlock tier. An example would be Compartmentalized quivers, which note a drastic difference in the analyze between unlock tiers), Affinity (if affinity is specific to the item/tier), and Itemverbtable (this will create an additional subheader for Usage, which should be followed by the item's verb usage set up in Template:Verbtable. Each tier would require the use of this template.
  • Copy/paste Code for Template:Itemtier:

{{itemtier <!-- Copy/Paste x #Tier for item as needed. -->
|tier= <!-- REQUIRED:  Must be entered as Tier # or Tree (Name) -->
|itemsummary= <!-- Brief explanation of what this tier does, if any. -->
|analyze= <!-- Tier 1/OTS required to be listed here.  Other tiers only to list changes between analyzes (so as to not populate duplicate information), and final unlock to be listed in full. -->
|affinity= <!-- Brief explanation of affinity for that specific tier, if any.  -->
|itemverbtable= <!-- Answer YES if there are verbs associated with this tier.  If not, leave blank. -->
}}
{| {{verbtable|90}} <!-- REQUIRED if there are verbs for this tier.  For instructions on how to use this template, see Template:Verbtable. -->
|}

• Template:Itemtiermulti - Optional template for multi-item pages with spots for Item (in place of tier), Item Summary (a quick breakdown of information for the item, if any) Analyze (for the purposes of simplified formatting, only the highest tiered ANALYZE of each item under the script should be recorded here), Affinity (if affinity is specific to the item), and Itemverbtable (this will create an additional subheader for Usage, which should be followed by the item's verb usage set up in Template:Verbtable. Each item would require the use of this template.
  • Copy/paste Code for Template:Itemtiermulti:

{{itemtiermulti <!-- Copy/Paste x #Item as needed. -->
|item= <!-- REQUIRED:  Must be entered as Item Type -->
|itemsummary= <!-- Brief explanation of what this particular item does, if any. -->
|analyze= <!-- Tier 1/OTS required to be listed here.  Other tiers only to list changes between analyzes (so as to not populate duplicate information), and final unlock to be listed in full -->
|inspect= <!-- ONLY for when an item has a custom INSPECT to it. -->
|show= <!-- ONLY for when an item has a hard-coded show. -->
|affinity= <!-- Brief explanation of affinity for that specific item, if any.  -->
|itemverbtable= <!-- Answer YES if there are verbs associated with this item.  If not, leave blank. -->
}}
: {| {{verbtable|90}} <!-- REQUIRED if there are verbs for this tier.  For instructions on how to use this template, see Template:Verbtable. -->
|}

Additional Information

When creating a page for a new item, please remember to utilize <pre{{log2}}> to record the item's ANALYZE. This is unnecessary if you are placing the analyze text into the itemtier template. It should, however, still be used to record any ambients or additional logs of the item in use. An example of proper page order setup is:

* Small paragraph blurb about item and release information. (noted by {{addmetext}} in the below copy and paste code).
* Tier or Item breakdown and information (utilizing either Template:Itemtier for single item pages or Template:Itemtiermulti for multi-item pages).
** Template:Verbtable should be used and broken up between each tier/item subheader.
* Additional information (this should include any additional pertinent information not covered in the above areas).
** Ambient messaging
** Log of use (if any)
* Resources/See Also (links to additional information, festival/shop release information, saved posts subpage).

Multi-Item Pages

Multiple item pages require additional work to properly format due to the nature of the templates and pages. The Itemtiermulti template has been set up in a way that indents subheaders following the main item to keep them from blending too much into the rest of the page's content. When setting up the Verbtable template, a : should be placed before the start of the table to indent it and keep it in line with the multi-item template. Each tier should be included in one table per item, in lieu of separating tiers under separate headers. These pages are the exception, not the rule. In the event that a multi-item script requires additional formatting, it is recommended to manually create the pages without the template, but follow the same format. An example of ideal formatting for a multi-item page is Veola hair accessory.

Difference between Multi-Item Pages and Corresponding Script Pages

When attempting to determine whether a group of items should be considered for multi-item pages or separated, it is important to note the following.

• Multi-Item Pages
  • Script Variations - These are items that share the same script, but have different variations/messaging to them based on a type. Examples would be Book Buddies or saddles.
  • Script Families - Similar to Script Variations, however these items may actually be varied in type, or may each have a different script name. They can work separately, or they may work with other items within that family, but it is not necessarily required. It may also be that some of the items in the script family do not work on their own at all, and require pairing with another in the script family to work properly. This is the most common use of multi-item pages. Examples would be Ghule items or Yansio clothing.
  • Exceptions: It is important to note that not all items within the above groups would qualify to be on the same page due to the sheer length of information available. See Main/Landing Pages for an example of what qualifies for this and how to handle it.
• Corresponding Item Pages

Create separate articles in cases where there are independent scripts that work on their own and are not part of a single script family. These scripts may work with other scripts for customization, but are not all required to work together. For clarification, Script A, B, and C are on separate pages. A works with B and C, but B and C do not work together. These are corresponding item scripts and not a script family.

These types of scripts are seen less frequently than the ones noted under Multi-Item Pages. An example of this would be bloodrunes. Certain ones can be marked with blood-infused crystals to change how they display when put into a MoonShard pendant, but they can also be used in Bloodrune Holders and Moody Garments. Additionally, legendary bloodrunes can be used with a MoonShard pendant and matching Legendary Bloodrune Cloak for additional messaging.

Main/Landing Pages

When items from a script "family" (eg Legendary Bloodrune Cloak) would make more sense to be broken up into individual pages due to the length of information available or specific differences in the items, a main (or landing) page would be necessary. The main page does not need to use the templates specifically listed on this page, so long as a table or list is provided on the main page to ensure each individual item script is properly linked to it. Only the individual item pages should follow the guidelines and templating parameters listed on this page.

Item Costs on Pages

Please do not add unlock costs or item costs to the individual item script pages as these costs vary between festivals, events, and shops. When these costs are added to the item page and the costs change or vary, it is unlikely they will be updated due to the way festival, event, and shop information is added to the wiki. It is rare for editors to be able to or have the time to track down every place that someone has put the now erroneous information, leaving this incorrect information all over the wiki with only the shop page having the correct information. This leads to readers who are confused by the conflicting information and aren't sure which information is most up-to-date. Instead, provide a link to the relevant shops either in the first introductory paragraph or include links to the item shops in the Additional Information section under a third-level section header labeled Resources.

Copy/Paste Code

Below is the full copy/paste code for the templates used to create an item/script page. Optional templates are Template:Itemtier and Template:Itemverb. The below code will set the page up to allow the right side infoboxes to float properly alongside the verb tables for item usage. Text within <!-- and --> will not appear on the page; these notes are hidden instructions and should be left in the pages to inform future editors.

<table><tr valign="top"><td><!-- Please see Help:Item scripts page for instructions on how to properly create and format an item page.-->
{{addmetext}} <!-- This spot reserved for informational blurb for item. Remove as part of copy/paste.-->
{{TOC limit|2}}
{{itemtier <!-- Copy/Paste x #Tier for item as needed. -->
|tier= <!-- REQUIRED:  Must be entered as Tier # or Tree (Name) -->
|itemsummary= <!-- Brief explanation of what this tier does, if any. -->
|analyze= <!-- Tier 1/OTS required to be listed here.  Other tiers only to list changes between analyzes (so as to not populate duplicate information), and final unlock to be listed in full. -->
|affinity= <!-- Brief explanation of affinity for that specific tier, if any.  -->
|itemverbtable= <!-- Answer YES if there are verbs associated with this tier.  If not, leave blank. -->
}}
{| {{verbtable}} <!-- REQUIRED if there are verbs for this tier.  For instructions on how to use this template, see Template:Verbtable. -->
|- {{verbtableheader|90}}
! scope="col" style="width:5em;"|Verb
! scope="col" style="width:5em;"|Style <!-- (Only if applicable.  Additional options would be Demeanor, Location, Climate, etc.  Essentially, modifiers to the verbs.) -->
! scope="col"|First
! scope="col"|Second (Only if applicable)
! scope="col"|Third
|-
! scope="row"  role="rowheader"|Verb
! scope="row"  role="rowheader"|Style
|<!-- First Person View --> {{addmetext}}
|<!-- Second Person View --> {{addmetext}}
|<!-- Third Person View --> {{addmetext}}
|}
</td><td>
{{iteminfo
|type= <!-- REQUIRED: Mechanical or Fluff.  OPTIONAL: If an item is feature altering or crafting, as well, please enter "Feature altering" or "crafting" below this line for "type2=" -->
|itemclass= <!-- REQUIRED: Valid options are: Armor, Weapon, Shield, Clothing, Accessory, Container, Creature (Pets/Mounts), or Miscellaneous.  If more than one classification, additional lines can be added with "itemclass2=" & "itemclass3=" -->
|itemtype= <!-- REQUIRED: What items can this apply to.  Up to 8 can be specified by setting "itemtype2" - "itemtype8". -->
|alter= <!-- REQUIRED: Can this be altered? Valid response is Yes or No. If there are restrictions, enter in Restrictions line at the end of this particular template. -->
|ld= <!-- REQUIRED: Is this item able to be lightened or deepened?  Valid response is Yes or No. If there are restrictions, enter in Restrictions line. -->
|feature= <!-- OPTIONAL: This area is only REQUIRED if feature altering is indicated. Up to 8 features can be entered by setting "feature2=" - "feature8=". -->
|customize= <!-- OPTIONAL: Enter "Yes" if the item is customizable beyond an ALTER.  If no, leave blank. -->
|custom= <!-- OPTIONAL:  This area is REQUIRED if customization is indicated.  Up to 5 customizations can be entered with "custom2=" - "custom5=". If the messaging is alterable, simply enter "Verb".-->
|origmerch= <!-- OPTIONAL: This area is for indicating the original release merchant name, if known. If released as a quest item, please enter "Quest" ONLY.  Otherwise, leave blank.-->
|releasevenue= <!-- OPTIONAL: This area is for indicating the original release venue only, if known. If not, leave blank. -->
|releaseyear= <!-- OPTIONAL: This area is for indicating the original release year only, if known. If not, leave blank. -->
|questitem= <!-- OPTIONAL: Enter "Yes" if the item's release was part of a quest/storyline.  If no, leave blank.  -->
|tiered= <!-- OPTIONAL: Enter "Yes" if the item is tiered. If no, leave blank. -->
|tiersnumber= <!-- OPTIONAL: This area is only REQUIRED if an item has tiers. It is to note how many tiers there are (This includes off the shelf). -->
|unlock= <!-- OPTIONAL: This area is only required if an item has tiers. It is to note how tiers can be unlocked.  Valid options are "Merchant", "Certificate", or "Quest" ONLY. If more than one, enter at unlock2.-->
|legendary= <!-- OPTIONAL: Enter "Yes" if the item/script was released/distributed at an auction or was a jackpot prize.  Extremely limited release only (3 or less in existence).  -->
|demeanor= <!-- OPTIONAL: Enter "Yes" if the item's messaging is affected by DEMEANOR.  If no, leave blank. -->
|loresong= <!-- OPTIONAL:  Enter "Yes" if the item has a loresong as part of the base script.  If no, leave blank. -->
|corrscript= <!-- OPTIONAL: This area is for indicating if an item has scripts that correspond with it, specifically, they are scripts that work separately AND together in one way or another (i.e. Bloodrunes and MoonShard Pendants).  Additional slots can be added with "corrscript2=" - "corrscript5"= -->
|attune= <!-- OPTIONAL: This area is for indicating if an item attunes.  If permanent, enter Permanent; if temporary, enter Temporary (as in, it can be broken).  If there is none, leave blank. -->
|attunement= <!-- OPTIONAL: This area is only REQUIRED if attunement was indicated. Options are "Character" or "Account". Please note, "Temporary attunement" will ALWAYS be "Character". -->
|affinity= <!-- OPTIONAL: Enter "Yes" if the item requires affinity to work.  If no, leave blank. -->
|spell= <!-- OPTIONAL: This area is for indicating if an item has a spell inherent to the script ONLY.  Up to 4 may be specified with "spell2=" - "spell4=". Example to enter: Call Familiar (920). If no, leave blank. -->
|enhancive= <!-- OPTIONAL: This area is for indicating if an item has enhancives inherent to the script ONLY.  Answer YES. If no, leave blank. -->
|swap= <!-- OPTIONAL: This area is for indicating if an item is eligible for script swapping.  Answer YES. If no, leave blank. -->
|add= <!-- OPTIONAL: This area is for indicating if the script is eligible to be added to an item.  Answer YES. If no, leave blank. -->
|restrictions= <!-- OPTIONAL: This area is for indicating if an item has specific restrictions. If more than one, separate with <br>. DO NOT ENTER ON A SEPARATE LINE. -->
}}
{{itemverb
|verb= <!-- Verbs MUST be capitalized when entered. Up to 28 verbs can be added with "verb2=" - "verb28=".  Verbs should be listed in alphabetical order, not by tier.-->
}}
</td></tr></table>