FFXIV Wiki:Style guide

From Final Fantasy XIV Online Wiki
Jump to navigation Jump to search

Community portal • Help & editing • Style guide • To-Do List • Historical


This style guide and its related pages describe rules and guidelines for creating and editing wiki pages. Editors should follow these guidelines in order to maintain consistency and organization across the wiki.

Topics covered in their own pages:


Text Guidelines

Tone

  • 1Do Do maintain an objective writing style.
  • 0Do not Do not use "I", "We", "You".

Language

  • Be concise and omit needless words. Don't use 5 words when 3 will do.
    • 1Do "Using enmity-increasing actions will prevent mobs from aggroing on other players."
    • 0Do not "Whenever actions which increase enmity are used the aggro from other players will go off them."
  • Reserve ultimatums/absolutes for actual 100% cases
    • 1Do "A very rare item to drop."
    • 0Do not "Extremely close to impossible item to drop."

Formatting

  • 0Do not Do not use CAPITAL LETTERS for emphasis.
  • 0Do not Do not use Capitalized Case for every word in a sentence.
    • Capitalized Case only applies to in-game names and descriptions such as Quest Titles, Actions, or Item Titles.
  • ⚠️ Limit bold words. In most cases there is a precedent set for what can be bolded.
    • Language that needs to be emphasized should never be bold but can be italicized (this includes single words and short phrases).
  • Only link a term at most once per major section, at the first occurrence.
    • 1Do "Rowena tells you about a weaponsmith of no small repute named Gerolt, who she claims is skilled in the restoration of ancient relics. Find Gerolt at Hyrstmill in the North Shroud, and show him the promise of payment that Rowena has given you."
    • 0Do not "Rowena tells you about a weaponsmith of no small repute named Gerolt, who she claims is skilled in the restoration of ancient relics. Find Gerolt at Hyrstmill in the North Shroud, and show him the promise of payment that Rowena has given you."

Categories

Categories are tags that provide automatic indexes of pages they're applied to.

In general, it is best practice to make sure:

  1. Every page has at least one category
  2. The main category set should be the most specific category available.

Refer to the Wikipedia:Categorization page for detailed guidelines on setting and managing categories.

Setting categories

Most categories are automatically applied to pages by our infobox templates. As a general rule, set the most specific category possible, and then set the parent category on the subcategory page.

For example the {{Armor infobox}} sets the subcategory Category:Paladin headwear but not the parent category Category:Armor.

To avoid setting categories on the template pages themselves, any categorization should be done in a conditional block that ensures that categories are only set on pages in the main namespace (excluding templates, sandbox pages, etc.): 

<!-- AUTOCATEGORIZATION -->
{{#if:{{NAMESPACE}}<!-- no categories if outside of article namespace -->
|<!-- Do not categorize -->|
<!-- Categorization code goes here -->
}}

Category pages

The category pages themselves should contain a minimal amount of content. Category pages will automatically display a list of pages in the category (example: Category:Conjurer footwear) or their own subcategories (example: Category:Conjurer Armor).

A category page may also include {{see also}} or {{main}} templates linking to relevant pages. Example (Category:Paladin headwear): 

{{see also|Paladin|Head}}
[[Category:Paladin Armor]]

Future content

  • 0Do not Do not publish NDA-protected or unauthorized material.
  • 0Do not Do not publish rumours or speculation.
  • 1Do Content from the game's files but not yet live can be published but must have the template {{Future content}} placed at the top of the page.

Spoilers

  • Given that story is a core pillar of Final Fantasy XIV players coming across spoilers for story can ruin their experience.
  • As such when incorporating information that pertain to spoilers on the wiki, discretion should be used to make sure a player cannot accidentally stumble upon main scenario story line spoilers.
  • Where applicable the {{Spoiler section}} template should be used to require a user to click to see the information considered a spoiler.

Patch pages

  • Patch pages (Example: Patch 7.4) contain a summary of content released in that patch.
  • Patch pages should not be a copy and paste of official patch notes but instead summarize major details and outline new items, quests, etc.
  • For patches that start a new expansion (x.0) keep the article about new features introduced specifically with the x.0 patch itself.
    • Features that are added later in the expansion should not be included.
    • Use the page for the patch in which the feature was introduced, or the expansion page itself for that.

Specific page's guidelines

Guide to Potentially Disturbing or Upsetting Content

  • Try to keep the content warnings in roughly chronological order. In each expansion section, main story quests and duties should be listed first in chronological order, followed by any content outside of the main story.
  • In the interest of keeping spoilers to the minimum needed to provide sufficient warning, try to keep descriptions as generic as possible. Don't give specific character names, i.e. instead of saying "John Doe is murdered", say "A character is murdered". Don't give story context unless it is necessary for the content warning.
  • Be respectful! Many players will be able to watch everything on the list and it will be no big deal for them, but others may have experienced real life trauma, or may be particularly upset by some of the occurrences listed below, or have phobias or medical issues that may cause certain content to be problematic for them.

Page Structure by Type

Ability & Trait pages

These pages contain details about an action or trait the Player can use. The creation of these pages is scripted.

Examples: Berserk, Surecast, Enhanced GP Regeneration

Structure


Achievement pages

These pages contain information about in-game achievements. The creation of these pages is scripted.

Examples: Skyward Gemstone II, A Line in the Storm II

Structure


Content pages

These pages contain an overview of a type of content.

Examples: Cosmic Exploration, Island Sanctuary

Structure

  • {{Lead icon}}
  • Summary of content
  • Page contents
  • References (if applicable)


Dungeon pages

These pages contain details about a dungeon.

Examples: Snowcloak, Cutter's Cry

Structure

  • {{Duty infobox}}
  • Duty Support (if applicable)
  • Objectives
  • Enemies
  • Bosses
    • Boss Name
      • Mechanics
  • Loot
    • Chest
  • Achievements
  • Music
  • Lore (if applicable)
  • Trivia (if applicable)
  • Images
  • {{Duties nav/dungeon}}


Enemy pages

These pages contain information about an enemy. The creation of these pages is scripted.

Examples: Mhachi Bhoot, Fenrir

Note: NPCs can also be enemies.

Example: Gaius van Baelsar vs. Gaius van Baelsar (boss)

Structure


Equipment pages

These pages contain armor, accessories, tools and weapons. The creation of these pages is scripted.

Examples: Phantasmal Robe, Courtly Lover's Blade

Structure


FATE pages

These pages contain details about a FATE. The creation of these pages is scripted.

Examples: Deadly Nightshade, The Four Winds

Structure

  • {{FATE infobox}}
  • Trivia (if applicable)
  • Images (if applicable)


Guides

These pages contain written guides for players. These have no set structure.

Examples: Content Unlock, Gear Guide


Lore pages

These pages contain information regarding lore in the game. These do not have a set structure, however citations must be used.

Examples: Timeline, Languages


NPC pages

These pages contain information about a character in game. The creation of these pages is scripted.

Examples: Y'shtola, Hildibrand

Structure


Patch pages

These pages contain information about a patch's content.

Examples: Patch 7.4

Structure

  • {{Patch infobox}}
  • Summary
  • Main Scenario Quests (if applicable)
    • Query for MSQ quests
  • Dungeons (if applicable)
    • Query for dungeons
  • Raids (if applicable)
    • Query for raids
  • Trials (if applicable)
    • Query for trials
  • PvP (if applicable)
    • Note changes for PvP
  • Gold Saucer (if applicable)
    • Note changes to Gold Saucer
  • System Changes
    • Note major system changes, including added duty support
  • Items
    • Gear
    • Mounts
    • Minions
    • Triple Triad Cards
    • Emotes
    • Hair
    • Orchestrion Rolls
    • Facewear
    • Barding
    • Fashion Accessories
    • Outfits?
    • Framer's Kits
    • Housing Items
  • Other
    • Achievements
    • Recipes
  • Media
    • Trailers
    • Images
  • {{Patches nav}}


Quest pages

These pages contain details about a quest. The creation of these pages is scripted.

Examples: It's Probably Pirates, A Debt Unpaid, Paladin's Pledge

Structure

Retrieved from "https://ffxiv.consolegameswiki.com/mediawiki/index.php?title=FFXIV_Wiki:Style_guide&oldid=1207474"