Help:Style manual: Difference between revisions

Jump to navigation Jump to search

Help:Style manual (view source)

Revision as of 20:39, 1 June 2024

34,112 bytes added ,  1 June
m
no edit summary
(add common creature exception for character images)
mNo edit summary
(409 intermediate revisions by 9 users not shown)
Line 1: Line 1:
[[File:bg3wiki_help.png|thumb|right|Illithid wisdom sent you here...]]
{{PageSeo
This page serves as a basic style reference for contributors to bg3.wiki. Everything written here is intended as a ''guideline'' to be referenced when needed, not as a rule.
| title = Style manual
| image =
| description = A style reference for Baldur's Gate 3 Wiki contributors.
}}
{{NavWiki|help}}
This is BG3.Wiki's '''style manual'''. It serves as a style reference for contributors to the wiki, and is regularly updated and maintained as necessary.


== General Wiki Guidance ==
Also see the wiki's [[Help:Editing_Policy|editing policy]].
Contributors should write articles using straightforward, succinct language. Remember: ''less is more.''


=== Article Names ===
Bg3Wiki articles use clear and easily understood language that prioritises readability over flair. Editors should strive for clarity, consistency and conciseness – {{em|less is more}}.
Guidelines for naming articles vary based on the type of article.


==== Concepts ====
Always discuss major changes to the format of well-established articles. When the style guide is unable to provide guidance, follow current wiki convention until a consensus is reached.
When both singular and plural forms of a concept are viable, opt for the singular form. This enables easier linking while minimising the number of article redirects.
{{TOC|limit=3}}
* {{SmallIcon|greencheck.png}} [[Saving Throw]] ({{SmallIcon|redx.png}}Saving Throws)
== Article names ==
** Link markup: {{code|<nowiki>[[Saving Throw]]</nowiki>}} and {{code|<nowiki>[[Saving Throw]]s</nowiki>}} both lead to [[Saving Throw]], allowing for easy plural usage
Article titles and headings are usually written in sentence case, with the exception of names (see the capitalisation section of this guide).


''Exception:'' When a concept is frequently searched for or described as a plural, use the plural form instead. Additionally, create a redirect for the singular form. This enables easier linking of articles.
=== Grammatical number ===
* {{SmallIcon|greencheck.png}} [[Feats]] ({{SmallIcon|redx.png}}Feat)
Names of articles are generally given in singular form, with a few important exceptions:
* {{SmallIcon|greencheck.png}} [[Spells]] ({{SmallIcon|redx.png}}Spell)
* Names of articles about classes of things are generally given in plural form ([[ability scores]], [[dice rolls]]).
* Names of articles about things which are generally expressed as multiples are also given in plural form ([[hit points]]).
* Names of [[Help:Categories|categories]] should usually be given in plural form.


=== Specific guidelines ===
==== Characters ====
==== Characters ====
Opt for the character's simplest name, without any titles, aliases, or nicknames. Titles and aliases can be described in the text of the article itself. If a title or alias is very frequently used in-game, consider adding a redirect for it.  
Character articles use the character's full name (first name and last name), without any titles, aliases or nicknames. Titles and aliases can be described in the text of the article. If a title or alias is very frequently used in-game, consider adding a redirect for it.  
* {{SmallIcon|greencheck.png}} [[Gut]] ({{SmallIcon|redx.png}}True Soul Gut {{SmallIcon|redx.png}}Priestess Gut)
* {{SmallIcon|greencheck.png}} [[Gut]] ({{SmallIcon|redx.png}}True Soul Gut, {{SmallIcon|redx.png}}Priestess Gut).
* {{SmallIcon|greencheck.png}} [[Spaw]] ({{SmallIcon|redx.png}}Sovereign Spaw)
* {{SmallIcon|greencheck.png}} [[Spaw]] ({{SmallIcon|redx.png}}Sovereign Spaw).
''Firstname Lastname'' is also acceptable.
* {{SmallIcon|greencheck.png}} [[Roah Moonglow]].
* {{SmallIcon|greencheck.png}} [[Roah Moonglow]]
 
Companions should be named after their in-game character name instead:
* {{SmallIcon|greencheck.png}} [[Astarion]] ({{SmallIcon|redx.png}}Astarion Ancunín).


==== Items ====
==== Items ====
Line 31: Line 39:
* {{SmallIcon|greencheck.png}} [[Merregon Halberd]]
* {{SmallIcon|greencheck.png}} [[Merregon Halberd]]
* {{SmallIcon|greencheck.png}} [[Speedy Reply]]
* {{SmallIcon|greencheck.png}} [[Speedy Reply]]
==== Lists ====
Lists should generally be named using the ''List of ...'' nomenclature.
* {{SmallIcon|greencheck.png}} [[List of features and items that affect saving throws]]
Sometimes it may be acceptable to drop the ''List of ...'' nomenclature, such as when the list isn't sole purpose of the page:
* {{SmallIcon|greencheck.png}} [[Greatswords]]


==== Locations ====
==== Locations ====
Line 36: Line 51:
* {{SmallIcon|greencheck.png}} [[Ebonlake Grotto]] ({{SmallIcon|redx.png}}Myconid Colony)
* {{SmallIcon|greencheck.png}} [[Ebonlake Grotto]] ({{SmallIcon|redx.png}}Myconid Colony)


If a notable location does not have a minimap name, opt for the name of the nearest [[Waypoint]] or fold the location into a subsection of an existing article for the broader area encompassing that location (such as [[The Risen Road]]).
If a notable location does not have a minimap name, opt for the name of the nearest [[Waypoint]] or fold the location into a larger region or area that encompasses that location (such as [[The Risen Road]]).
 
==== Subpages ====
Except when implemented as part of internal navigation on a page (such via the {{t link|CombatTab}} template), subpages should be avoided.
 
Subpages should generally not be capitalised.
 
== Article layout ==
=== Structure ===
The following is the correct order of elements on most pages (pages using page templates follow [[Help:Style manual#Page templates|separate guidelines]]):
# {{t link|PageSeo}}
# {{t link|DISPLAYTITLE}}
# {{t link|hatnote}}
# Notices: {{t link|Priority}}, {{t link|Stub}},  {{t link|Under construction}}, {{t link|Rewrite}}
# Content and spoiler warnings
# Tab template: {{t link|Companion tab}}, {{t link|Combat tab}}
# Infoboxes: {{t link|Infobox character}}, {{t link|Infobox statistics}}, {{t link|relative location}}
# Images
# Introduction: A brief and spoiler-free summary of the article's contents that gives context to the article.
# TOC template: {{t link|TOC}}
# Body: Most of article's contents (see [[Help:Style manual#Body|below]]).
# Achievements: A section with an {{t link|achievement}} template.
# Gallery: A section with a <nowiki><gallery></nowiki>.
# See also: A section with links to relevant articles.
# Related literature: A section with links to related books, letters and notes in the game.
# Notes: A section with bulleted notes, using the {{t link|notebegin}} and {{t link|noteend}} templates.
# Footnotes: A section with a {{t link|notelist}} template (see [[Help:Style manual#Footnotes and references|below]]).
# References: A section with {{t link|reflist}} templates (see [[Help:Style manual#Footnotes and references|below]]).
# External links: A section with external links.
# Navboxes
# Categories
 
=== Body ===
The body of an article is divided into multiple sections, each with its own heading. The exact sections used, as well as their order, vary depending on the subject matter as well as the needs of the article.
 
==== Headings ====
A page's headings are arranged using a six-level hierarchy. Heading 1 (<nowiki>=Heading 1=</nowiki>) is automatically generated as the title of the page. The highest hierarchy of a section heading is (<nowiki>==Heading 2==</nowiki>), followed by Heading 3 (<nowiki>===Heading 3===</nowiki>), Heading 4 (<nowiki>====Heading 4====</nowiki>), Heading 5 (<nowiki>=====Heading 5=====</nowiki>) and Heading 6 (<nowiki>======Heading 6======</nowiki>).
 
Section headings should always be used in consecutive order, starting with the largest (Heading 2). They should not skip numbers, for accessibility reasons.
 
==== Section order ====
Generally speaking, sections near the top of an article should cover more broad and contextual information, whereas sections near the bottom should include more specific information. Most spoilers should be centered in the middle sections of the article.
 
Information that may be difficult to place in the body of an article can be placed either in the notes (see {{t link|notebegin}}) or footnotes of an article.


=== Wiki Organisational Terms ===
===== Characters =====
==== Chapters or Acts? ====
Character articles typically have a {{t link|Infobox character}} template, {{t link|Infobox statistics}} template, and a {{t link|Companion tab}} or {{t link|Combat tab}} template.
Follow the 'Chapter' nomenclature used by the quest journal, rather than the 'Act' nomenclature used in marketing materials. Additionally, spell out the chapter number as a word.
* {{SmallIcon|greencheck.png}} Chapter One ({{SmallIcon|redx.png}}Act 1)


=== Links ===
=====Origins or permanent companions=====
==== Frequency of Link Usage ====
# Overview: A brief summary of the article as a whole for quick access to specific information.
Linking to other articles is an important part of wiki information discoverability, but inserting too many inline links can break the flow of text. A general guideline to follow when a term is mentioned several times in quick succession is to '''link the first instance of that term in each section''' of an article.
## Background: A brief introduction to the character and their role in the game.
## Starting class: A short overview of their starting class and default subclass choices, if applicable.
## Special features: Any special features available only to this character.
## Personal quest: A spoiler-light summary of the character's personal quest.
## Recruitment: Where and how the character can be recruited. If multiple options are available, group them by act.
## Approval: A short guide to what the character generally approves and disapproves of.
## Romance: Indicate whether the character can be romanced or not, with a short summary of the relationship's progression or themes.
# Description
## Appearance: How the character looks and dresses.
## Personality: How the character is like, their behaviour, expressions, etc.
# History: The character's backstory before the events of the game. Particularly long history sections can be broken down into relevant subsections.
# Involvement: The character's involvement in the story, as seen by the player and the party. Contains major spoilers.
## Name of personal quest: This section describes the events of the character's personal quest. Can be further broken into acts.
## Endings: All of the character's possible story endings.
# Quest rewards: Any quest rewards the character may receive during their personal quest and related sub-quests.
# Interactions: A brief listing of all interaction events with the character (events where the character has an exclamation mark above their head), grouped into acts.
# Loot: Whether the character can be killed or not, and if so, the loot the character carries by default.
## Starting equipment: The character's starting equipment when recruited or playing as an origin, if applicable.


==== Linking Related Articles "Out of Context" ====
=====Non-player characters=====
TBA
# Overview: A brief summary of the article as a whole for quick access to specific information.
## Background: A brief introduction to the character and their role in the game.
## Gameplay: A bulleted list of the character's gameplay role (vendor, boss, where they are found, etc.).
## Quests: Any quests that the character is involved in.
## Related quest rewards: Any items that the character may reward for completing a quest.
# Description
## Appearance: How the character looks and dresses.
## Personality: How the character is like, their behaviour, expressions, etc.
# History: The character's backstory before the events of the game. Particularly long history sections can be broken down into relevant subsections.
# Involvement: The character's involvement in the story as seen by the player and the party, broken down into encounters per act.
# Combat: A section describing any combat encounters with this character. Long combat sections, especially for boss encounters, should be moved to a combat subpage.
## Spells and abilities: Abilities and spells used by the character in combat.
## Loot: Any items that can be looted from the character.


== Formatting ==
===== Locations =====
=== Abbreviations ===
Location articles, with exception of locations within Lower City, usually have a {{t link|Relative location}} template.
TBA
# Overview
## Description, or alternatively a sequence of sections named after and detailing specific locations within the location.
## List of characters: If the article lacks a NavBox, characters in this location can be listed in a dedicated section.
## Related quests: A list of quests related to the location.
# History
# Quests: A quest section that contains major spoilers.
# List of interactions
# Notable loot
## Quest items
## Quest rewards
## Other


=== Capitalisation ===
=== Footnotes and references ===
Follow [https://www.chicagomanualofstyle.org/book/ed17/frontmatter/toc.html Chicago Manual of Style] guidelines for capitalisation of titles, item names, location names, game concepts, bg3wiki page names, page headings, and other proper nouns, even when in-game capitalisation differs.
Footnotes add additional explanations or detail to a statement that would otherwise be difficult to place in the articles, whereas references inform the viewer where the information comes from.
* {{SmallIcon|greencheck.png}} Circle of the Moon ({{SmallIcon|redx.png}}Circle Of The Moon)
* {{SmallIcon|greencheck.png}} The Festering Cove ({{SmallIcon|redx.png}}the Festering Cove)


In short:
Footnote tags are added using {{t link|note}}, and are listed using the {{t link|notelist}}.
* Capitalise nouns, pronouns, adjectives, verbs, and adverbs.
* Use lowercase for articles (a, an, the) and prepositions, except at the beginning of a proper noun clause


=== Punctuation and Grammar ===
Footnote tags are added using {{t link|ref}} or {{t link|cite web}} (in the case or URLs), and are listed using {{t link|reflist}}.
[[Baldur's Gate 3]] follows British English punctuation and grammatical rules (barring a few errors and inconsistencies). Aim to consistently employ these rules wiki-wide.


Regarding disputes and disagreements: Always prioritise '''fixing factual errors''' over rewriting articles to conform to a specific style. Please avoid getting into edit wars.
Footnote and reference tags should always be added immediately {{em|after}} punctuation, with no space or break between the tag and punctuation.


==== Quotes ====
References can, and often should, be added to footnotes as well.
* {{SmallIcon|greencheck.png}} 'Single quotes' ({{SmallIcon|redx.png}}"Double quotes")


==== Commas ====
On articles with a limited amount of footnotes and references, the two sections can be combined into a single section, using <nowiki>{{reflist|note}}</nowiki> to list notes.</small>
Use Oxford commas (also known as [https://en.wikipedia.org/wiki/Serial_comma Serial Commas]) when listing three or more items, unless directly quoting game text that omits this comma.
* {{SmallIcon|greencheck.png}} Clerics, Rogues, and Barbarians ({{SmallIcon|redx.png}}Clerics, Rogues and Barbarians)


==== Perspective ====
=== Page templates ===
Write from a third-person perspective. Ideally, omit the perspective entirely.
Most action, spell and item pages have three distinct, but similar, fields: ''summary'', ''description'' and ''quote''.
* {{SmallIcon|greencheck.png}} This is item bugged in Patch 9. ({{SmallIcon|redx.png}}We know this item is bugged in Patch 9.)
* {{SmallIcon|greencheck.png}} A Bard can use this to inspire allies. ({{SmallIcon|redx.png}}We can use this to inspire allies.)


Second-person is also acceptable when the tone of a statement benefits from a more direct addressing of the reader, but try not to switch between third- and second-person perspectives too often.
The summary field should contain a summary of the subject matter of the article. The description field is a concise but precise description of the what the action, spell or item does. The quote field is reserved for quotes from the game.
* {{SmallIcon|greencheck.png}} Your choice of reward does not matter here.


''Never use first-person perspective in the main wiki namespace'', even when making conjectures. If a statement is tentative and needs to be verified, that's okay - simply include the {{code|<nowiki>{{Verify}}</nowiki>}} template to let readers and other wiki editors know.
Neither the summary nor the description of a page need to be identical to the description used in the game, but it should still accurately reflect the game. If the in-game description is incorrect, the description used on the wiki should reflect the gameplay, and any contradictions noted on the page, such as in a notes section.
* {{SmallIcon|greencheck.png}} This is also dropped by John Baldursgate.{{Verify}} ({{SmallIcon|redx.png}}I think this is also dropped by John Baldursgate.)


==== Present Tense ====
=== "Where to find" sections ===
Write in present tense, not past tense. bg3.wiki is first and foremost a 'snapshot' of the current version of BG3.
When describing where to find an item, include all of the following details:
* {{SmallIcon|greencheck.png}} Wyll '''is''' a Companion. ({{SmallIcon|redx.png}}Wyll '''was''' a Companion.)
# A description of the location of the item - or the source, if it's a quest reward or sold by a vendor
* {{SmallIcon|greencheck.png}} Mystra '''is''' the goddess of magic. ({{SmallIcon|redx.png}}Mystra '''was''' the goddess of magic.)
#* Include both {{em|broad}} and {{em|specific}} information in this description, as needed (e.g. "Found in Act One in the Underdark. The sword is near the [[Selûnite Outpost]], embedded in a rock (X:116, Y:-192).")
# Instructions for any additional steps necessary to find or obtain the item (e.g. 'Jump up to the ledge behind the purple mushroom.')
# Map coordinates of the item, if applicable, in the format ''(X:123, Y:123)''
#* This can be done in the form of the {{t link|coords}} template: <nowiki>{{Coords|123|123}}</nowiki>


''Exception:'' Past tense is acceptable when describing a notable change from a previous version of the game:
Lengthy instructions can be formatted with sublists, as necessary:
* {{SmallIcon|greencheck.png}} Prior to Early Access Patch 9, this weapon '''was''' dropped by Zevlor.
<small>
* Can be found near the sign that says "Here Lies Our Dear Leader", after solving the Torch Puzzle.
** By the north end of Pickens' farm, jump across the gap onto the three large rocks, then light the numbered torches in the following patterns: 6, 9, 2, 3. The item will then appear near the sign.</small>


Try to avoid slipping into future tense unless absolutely necessary.
When an item can be found in multiple places, list '''all''' known locations. ''Exception:'' For common and very plentiful items, don't worry about documenting every location via text. Instead, consider working with other wiki editors to generate a map of all locations or include a link to an external map resource.
* {{SmallIcon|greencheck.png}} You regain 10 Hit Points. ({{SmallIcon|redx.png}}You will regain 10 Hit Points.)


==== Pronouns ====
== Spelling ==
Mimic pronoun usage from in-game text, where available. Otherwise, maintain gender neutrality when a pronoun is called for, and use 'they/them' for both singular and plural cases.
The wiki, like ''Baldur's Gate 3'', follows British English grammar and punctuation rules. Aim to consistently employ these rules wiki-wide for consistency.
* {{SmallIcon|greencheck.png}} The Paladin can heal their allies. ({{SmallIcon|redx.png}}The Paladin can heal her allies.)


=== Spelling ===
Aim to consistently employ British spelling rules wiki-wide, ''particularly'' when copying text directly from the game, as with item, feature, and spell descriptions.
Aim to consistently employ British spelling rules wiki-wide, ''particularly'' when copying text directly from the game, as with item, feature, and spell descriptions.
* {{SmallIcon|greencheck.png}} Armour ({{SmallIcon|redx.png}}Armor)
* {{SmallIcon|greencheck.png}} Armour ({{SmallIcon|redx.png}}Armor)
* {{SmallIcon|greencheck.png}} Defence ({{SmallIcon|redx.png}}Defense)
* {{SmallIcon|greencheck.png}} Defence ({{SmallIcon|redx.png}}Defense)
* {{SmallIcon|greencheck.png}} Colour Spray ({{SmallIcon|redx.png}}Color Spray)
* {{SmallIcon|greencheck.png}} Colour Spray ({{SmallIcon|redx.png}}Color Spray)
== Abbreviations ==
=== Abbreviations of game concepts ===
{{hatnote|See the [[BG3Wiki:Glossary|glossary]] for common examples of abbreviations used on BG3Wiki.}}
On articles introducing and describing commonly abbreviated mechanics and concepts, the first mention of a word on those articles should use the non-abbreviated version and should introduce the abbreviation immediately after. Uses after this should usually use the abbreviated versions.
Other pages should use abbreviations for game mechanics when they're consistent with the game's usage. The terms AC and DC should almost always be abbreviated.
Quotes should always use the abbreviations (or lack thereof) used by the source they are quoting.
=== Contractions ===
Avoid contractions such {{color|red|''it's''}}, {{color|red|''aren't''}} or {{color|red|''doesn't''}}. Instead use {{color|green|''it is''}}, {{color|green|''are not''}} and {{color|green|''does not''}}.
== Capitalisation ==
Articles and their contents, including article names and headings, are given in sentence case.
Capitalise proper nouns and adjectives when appropriate, but avoid unnecessary capitalisation.
Specific in-game items, spells, characters and locations should also inherit the game's capitalisation.
=== Article names and headers ===
Use the the same capitalisation as you would for a any other sentence on the wiki.
* {{SmallIcon|greencheck.png}} Game mechanics
* {{SmallIcon|redx.png}} Game Mechanics
=== Game concepts and mechanics ===
Do not generally capitalise game concepts, mechanics, terminology or rules.
The following abbreviations should always be capitalised: AC, DC, NPC and abbreviation of abilities like STR, DEX, CON etc.
Capitalise the following terms:
* Armour Class
* Classifications of weapons and armour (Longsword, Light armour).
** Exceptions: These terms should not be capitalised when the terms are used descriptively (e.g. with no mechanical significance).
* Creature sizes (Medium, Large)
* Creature types (Aberration, Humanoid)
* Difficulty Class
* The item categories Consumables, Miscellaneous and Valuables are capitalised when used standalone.
* Specific abilities (Strength, Dexterity)
* Specific actions (Attack action, Hide action)
* Specific class features (Cunning Action, Rage)
** Subclasses are considered class features, and are therefore also capitalised (Champion, Wildheart)
* Specific conditions (Bleeding, Slightly Drunk)
* Specific damage types (Fire, Piercing)
* Specific difficulty modes (Balanced, Tactician)
* Specific feats (Tavern Brawler)
* Specific items
* Specific skills (Athletics, Sleight of Hand)
* Specific racial features (Keen Senses)
* Specific spells
Do {{em|not}} capitalise the following terms:
* Common nouns such as ability, action, armour, check, class, condition, creature, damage, feat, feature, hit, initiative, item, miss, proficiency, race, resistance, rest, roll, save, skill, spell, weapon.
* Compound terms such as ability check, ability score, attack roll, critical hit, damage resistance, damage type, hit points, long rest, saving throw, short rest.
* Names of classes (barbarian, fighter).
** Names of subclasses should still be capitalised.
* Names of races (elf, illithid, owlbear)
* Spell schools (abjuration, necromancy).
* Subcategories of Consumables: arrows, camp supplies, coatings, dyes, elixirs, grenades, potions, scrolls.
Exceptions:
* Races and classes may be capitalised when used as titles (Gale, Human Wizard).
** This includes specific individual creatures, which may have identical names to their race (which is not capitalised) – e.g. the creature Mind Flayer Leader is a mind flayer.
* The term attack is only capitalised when it's referring to the Attack action. Otherwise, it is not capitalised (take an Attack action, roll an attack roll)
* The first letter in game concept terminology can be capitalised when used as keywords (Type: Condition)
=== Other capitalisation guidelines ===
==== References to other articles ====
Names of articles should be capitalised on other pages when they referred to as an article, but not when they are simply linked to.
* {{SmallIcon|greencheck.png}} For more information about potions, see Potions.
* {{SmallIcon|redx.png}} For more information about potions, see potions.
==== Cultures, regions and languages ====
Cultures, languages and regional descriptors should all be capitalised.
* {{SmallIcon|greencheck.png}} Perry speaks Common.
* {{SmallIcon|redx.png}} Perry speaks common.
* {{SmallIcon|greencheck.png}} This elf speaks Elvish.
* {{SmallIcon|redx.png}} The elf speaks elfish.
* {{SmallIcon|greencheck.png}} It's a Baldurian beverage.
* {{SmallIcon|redx.png}} It's a baldurian beverage.
== Text formatting ==
The following text formatting guidelines apply only to textual article contents. They do <em> not </em> apply to templates.
=== Bold font ===
Use triple apostrophes {{code|<nowiki>'''...'''</nowiki>}} to highlight the first occurrence article's subject matter (usually its title) in the introduction of its page.
==== Strong ====
Strong formatting {{code|<nowiki>{{strong}}</nowiki>}} or {{code|<nowiki><strong>...</strong></nowiki>}} should never be used in article texts. It can be used on non-article pages, such as project and talk pages, to denote urgency or importance.
=== Italicisation ===
Use double apostrophes {{code|<nowiki>''...''</nowiki>}} to style certain terms as cursive text. On BG3Wiki, we style the following terms using italics:
* Titles of entries in the ''Forgotten Realms'' franchise, including ''Baldur's Gate 3'' and the franchise itself. Other franchises may also be italicised when appropriate.
* Names of vessels and ships, but not the nautiloid ship.
* When writing about words as words (an ''ability'' is a representation of a creature's physical or mental capabilities).
* Terminology or phrases that are not in English.
* Items or titles that are stylised using italics in-game should be similarly stylised on the wiki.
=== Semantic emphasis ===
Use {{code|<nowiki>{{em}}</nowiki>}} or {{code|<nowiki><em>...</em></nowiki>}} for emphasis, for example to place emphasis (stress) on a certain word in a sentence, or to clarify the meaning of a sentence. In most cases, you should only use emphasis on <em>one</em> word per sentence. Never use apostrophes for emphasis.
==== What to avoid ====
* Do note use '''bold''' or <nowiki>{{strong}}</nowiki> for emphasis.
* Do note use capitalisation for emphasis.
* Do not use quotation marks (") for emphasis.
=== Font size ===
Font size in article texts should primarily be managed via templates. Never use the <nowiki><small> ... </small></nowiki> tag in article texts, due to accessibility concerns.
== Punctuation ==
General punctuation guidelines:
* Do not use exclamation marks (!), except in direct quotes.
* Use straight "double quotes", as opposed to 'single quotes'.
* When writing a list, optionally insert a comma before the "and" (or "or") if it adds clarify to the sentence: Fire, Cold, Poison, and Thunder damage.
=== Colons ===
Use colons (:) at the end of complete sentences, when it precedes a definition, description, explanation or a list:
* Perry looked at all the animals at the grove: birds, bears and oxes.
=== En dashes ===
Spaced en dashes (–) are preferred over em dashes (—), and can be used as a replacement for parentheses, commas, colons and full stops, when more than one option could be appropriate:
* Lae'Zel has three actions – they are gith, yank and perry.
* Perry – a gith of virtue – decided to aid the villagers.
* Perry and Lae'Zel were not merely friends – they were allies.
Avoid the use of closed dashes (like—this or like–this). Do not use hyphens (-) to approximate en dashes – instead use the template <nowiki>{{-}}</nowiki>.
=== Semi-colons ===
Use semi-colons (;) to connect two independent clauses that are thematically connected.
* Perry chose to take a level in barbarian; Lae'zel thought Perry's decision unwise.
== Grammar ==
=== Grammatical person ===
Most articles are written in third-person perspective:
* {{SmallIcon|greencheck.png}} This item is bugged in Patch 9.
** {{SmallIcon|redx.png}}We know this item is bugged in Patch 9.
* {{SmallIcon|greencheck.png}} A Bard can use this to inspire allies.
** {{SmallIcon|redx.png}}We can use this to inspire allies.
When writing sections of articles that make frequent or confusing use of terminology such as ''the player'', second-person perspective should be used instead, for consistency and readability:
* {{SmallIcon|greencheck.png}} You cannot enter this location if in a multiplayer session with another player that is controlling Astarion, unless you have the key as well.
** {{SmallIcon|redx.png}} The player cannot enter this location if in a multiplayer session with another player that is controlling Astarion, unless they have the key as well.
Single or isolated instances of ''the player'' should still be written in third-person perspective.
* {{SmallIcon|greencheck.png}} The player will always enter this location from the east entrance.
** {{SmallIcon|redx.png}} You will always enter this location from the east entrance.
''Never use first-person perspective in the main wiki namespace'', even when making conjectures. If a statement is tentative and needs to be verified, that's okay - simply include the {{code|<nowiki>{{Verify}}</nowiki>}} template to let readers and other wiki editors know.
* {{SmallIcon|greencheck.png}} This is also dropped by John Baldursgate.{{Verify}} ({{SmallIcon|redx.png}}I think this is also dropped by John Baldursgate.)
''Exception for guides:'' When writing content for the [[:Category:Guides|Guide:]] namespace, feel free to write subjectively and from any perspective. This namespace is your place to interject your opinions and recommendations for players. Additional guidelines tailored for this namespace may be added at a later date.
=== Tense ===
==== Present tense ====
Use present tense when describing the current state of the game:
* {{SmallIcon|greencheck.png}} Wyll '''is''' a Companion.
* {{SmallIcon|greencheck.png}} Mystra '''is''' the goddess of magic.
Use present tense when describing potential events and conditional outcomes:
* {{SmallIcon|greencheck.png}} When they accept, they acquire 3000 gold.
* {{SmallIcon|greencheck.png}} When Gale arrives in the city, he discovers that Astarion already bought a house for them.
* {{SmallIcon|greencheck.png}} If you use this spell, you regain 10 Hit Points.
==== Past tense ====
Use past tense when describing previous versions of the game:
* {{SmallIcon|greencheck.png}} Prior to Early Access Patch 9, this weapon was dropped by Zevlor
Use past tense when describing past events:
* {{SmallIcon|greencheck.png}} Astarion was a magistrate in the city of Baldur's Gate.
==== Future tense ====
Use future tense when describing possible future events:
* {{SmallIcon|greencheck.png}} If Gale accepts Astarion's proposal, he too will become a magistrate.
* {{SmallIcon|greencheck.png}} If you reject Withers's advances, he will later ask you why you are alone.
=== Pronouns ===
Mimic pronoun usage from in-game text, where available. Otherwise, maintain gender neutrality when a pronoun is called for, and use "they/them" for both singular and plural cases.
* {{SmallIcon|greencheck.png}} The Paladin can heal their allies. ({{SmallIcon|redx.png}}The Paladin can heal her allies.)
When describing illithids, use the "it" for singular case and "they" for plural case.
* {{SmallIcon|greencheck.png}} The mind flayer leader summoned its allies, and they were up dancing all night.
== Terminology ==
=== Verbs ===
There are numerous conventions employed when describing things that a creature does:
* Creatures roll dice.
* Creatures deal damage.
* Creatures take actions.
* Creatures take turns.
* Creatures take rests.
* Creatures take damage.
* Creatures expend resources.
* Creatures expend spell slots.
* Creatures cast spell.
* Creatures attempt saves.
* Creatures attempt tasks involving ability checks.
* Creatures make ability checks.
* Creatures make saving throws.
* Creatures roll for initiative.
* Creatures inflict conditions.
* Creatures add modifiers to rolls.
* Creatures add bonuses to rolls.
* Creatures recover hp.
* Creatures improve abilities.
* Creature use weapons.
* Creatures use ability scores.
* Creatures have proficiency / are proficient with with weapons and armour.
* Creatures have proficiency / are proficient in skills and saves.
=== Ability checks ===
The term "ability check" is preferred to the term "skill check", except when the distinction is important for clarity or brevity.
For example, "Investigate ability check" is preferred to "Investigate skill check", but "skill check" is a useful shorthand for phrasing that would otherwise be overly long, such as "ability check that allows you to add a skill's proficiency bonus to the result of the roll".
=== Features ===
Features are unique qualities that set a creature apart from others. They can either be passive (meaning it is always in effect) or active (meaning it has to be activated, and often had limited uses per rest).
Any features from class levels are called ''class features''. Subclasses, class actions, passives, spellcasting and feats unlocked from classes are all examples of class features.
Any features gained from race are called ''racial features''.
=== Actions ===
Actions are things that a creature can do. The terminology used on the wiki to describe the activation of actions is ''take:''. A creature ''takes'' an action. This is to avoid ambiguity in sentences, as the term ''action'' is also the name of the respective resource. In most cases, ''taking an action'' uses an ''action resource''. Taking actions that use the bonus action or reaction resources may be referred to as ''taking a bonus action'' or ''taking a reaction'', respectively.
The vast majority of actions are additionally classified as ''class actions''. These are actions that are neither spells nor weapon actions.
==== Spells ====
When the action taken is a spell, the terminology used is ''cast:'', as in ''cast a spell'. If a spell uses a bonus action, the correct terminology would be that the creature ''casts a spell using a bonus action''.
=== Locations ===
Use the term ''region'' to refer to multi-location areas that have their own map (e.g. [[Wilderness]]), and the term ''location'' to refer to named places within those regions that appear on the minimap or the name of the save file, (e.g. [[Goblin Camp]], [[Sacred Pool]]), even if they themselves contain smaller locations (e.g. [[Emerald Grove]]).
For other places at the lowest scale, describe the place based on what the in-game map calls it, such as ''entrance'', ''waypoint'', or ''secret'', or a similarly descriptive term if it's unmarked.
==== Acts ====
Follow the "Act" nomenclature when describing the three acts in the game.
* Act 1 begins when the party arrives on the [[Ravaged Beach]] at the start of the game. While the game labels the [[Mountain Pass]] as 1b, the wiki includes it under Act 1.
* Act 2 begins when the party enters the [[Shadow-Cursed Lands]].
* Act 3 begins when the player exits the [[Shadow-Cursed Lands]] and takes a [[Long Rest|long rest]].
Whether the numerals should be given in letters (Act One) or numbers (Act 1) depends on context.
Use letters (Act One) in the following contexts:
* Page names and headings.
* Names of categories.
Use numerals (Act 1) in the following contexts:
* Infoboxes and Navboxes.
* Spoiler warnings and spoiler boxes.
* Hatnotes and references.
Only use Roman numerals (Act I) in reference to the Steam achievements.


== Images ==
== Images ==
Guidelines for image style, placement, and so on.
{{hatnote|Also see BG3Wiki's [[BG3Wiki:Image Policy|image policy]].}}
=== Character Images ===
Images are frequently used on BG3Wiki, but correct usage is important for article quality. While images can be helpful in improving an article, textual contents of articles should function independently from its images. Images are added as an additional illustrative supplement.
For character pages, whenever possible, include ''both'' a cinematic portrait/screenshot ''and'' a 3D model of the character. Display the cinematic portrait first and ensure the [[Template:PageSeo|PageSeo]] template has been invoked with the cinematic portrait as the '''image''' parameter. This will help ensure consistency across character pages and external link previews (e.g. social media sites and Discord).
 
=== Image usage ===
* Images should serve an informative and educational purpose, and should not merely be used for decorative or aesthetics reasons.
* Images should be both accurate and representative of the subject, whether it is a character, item, feature or a location.
* Articles should not rely on images in order to be understood – images should be supplementary to an article's textual contents.
 
=== Image placement ===
* Images should be in the relevant section, and should never be placed at the bottom of a section.
* Do not refer the positioning of images in textual contents (e.g. "in the image to the left" or "the image at the top".
 
=== Image sizes ===
* Images should never use pixels for scaling, and should instead use the use the {{code|upright}} parameter (<nowiki>upright=scaling_factor</nowiki>), where scaling_factor is a number, usually 1.0, that uses the user's own image size preferences to scale the images. This value should never be above 1.3, and most of the time should be 1.0.
* Icons, such as this [[File:Concentration_Icons.png|20px]] Concentration icon should use pixels, usually between 16px and 32px.
** Inline usage of icons should generally set icons around 16px to 24 px.
 
=== Image alt text ===
Alt text (text which appears when the image fails to load) should be added when using images in articles, since this is important for accessibility. The text should be clear, concise and descriptive.
 
Alt text can be added to the File template with this parameter:
 
<big><nowiki>|alt=</nowiki></big>
 
==== Examples ====
{{SmallIcon|greencheck.png}} '''Good alt text''':
* <nowiki>  {{File:A_Nice_Summer_Stay.png|alt=Astarion flinching in pain after being hurt by concentrated sunlight at the Githyanki Créche.}} </nowiki>
* <nowiki>{{File:Gale_Flirting.png|alt=Gale is serenading Tav while sitting on Mystra's picnic blanket at Lake Hurricane.}}</nowiki>
 
{{SmallIcon|redx.png}} '''Poor alt text''':
* <nowiki>{{File:A_Nice_Summer_Stay.png|alt=Astarion discovering the difference between a nice Summer stay and the full concentrated power of the sun.}} </nowiki>
* <nowiki>{{File:Gale_Flirting.png|alt=Gale sings while sitting at lake.}}</nowiki>
 
== Linking ==
Link to other articles when they have relevant additional information. Be careful not to underlink or overlink on the wiki. Only use links when they're helpful to the reader – every word that has an article does not need to be linked.
 
=== Duplicate links ===
Generally, a link to a specific target should only appear once per article, when the relevant word is first mentioned.
 
Exceptions to this include infoboxes, navboxes, tables, lists and, in some cases, the description of spells or special abilities. In these cases, multiple links per article may be appropriate.
 
In very long or technical articles, it may sometimes it may also be appropriate to link to a subject introduced at the start of a section, even if the target article has already been linked to previously in that article.
 
=== What to avoid ===
* Do not unnecessarily link to other articles – the mere mention of a word with an article is not reason enough to link to it.
* Do not link to disambiguation pages, except in hatnotes.
* Section headers should never have links in them. Use {{t link|hatnote}} or {{t link|see also}} instead.
* Do not place links immediately next to each other. Either omit one of the links or rephrase the sentence so that the links aren't adjacent.
 
=== Linking to other wikis ===
The [[Template:FRWiki|FRWiki]] template should be used to link to the FRWiki when appropriate.
 
== Lists and tables ==
Lists are commonly used on BG3Wiki. Lists can improve presentation and layout, improving readability and make otherwise dense information easier to parse.
 
For paragraphs or flowing text, prose should be used instead.
 
For accessibility reasons, lists should always be used correctly; lists can improve accessibility and readability when used with care and consideration, but when used incorrectly, they can become a hindrance.
 
=== Description lists ===
Description lists are used for lists that consist of names and values, terms and definitions, items and descriptions or questions and answers. They are added using semi-colons and colons:
{{comparison table|example=
<pre>Description list:
; Hit points : Determines how much damage a creature can take before being Downed.
; Armour Class : Determines how difficult it is to hit a creature.</pre>|result=
Description list:
; Hit points : Determines how much damage a creature can take before being Downed.
; Armour Class : Determines how difficult it is to hit a creature}}
 
Description lists can be formatted similarly to a table with {{t link|table list}}:
{{comparison table|example=
<pre>Description table list:
{{table list|
; Hit points : Determines how much damage a creature can take before being Downed.
; Armour Class : Determines how difficult it is to hit a creature.}}</pre>|result=
Description table list:
{{table list|
; Hit points : Determines how much damage a creature can take before being Downed.
; Armour Class : Determines how difficult it is to hit a creature}}}}
 
=== Ordered and unordered lists ===
Ordered and unordered lists can be used to list items.
 
These lists are intended for items that consist largely of names or simple phrases. If a bulleted list item consists of several sentences, it is generally best {{em|not}} to include it on a list, and instead work it into the textual body of the article.
 
; Important considerations
* Only include a full stop at the end of an item if it consists of a full sentence.
* Do not use '''bold''' typeface to format the list – use a description list instead.
* Do not leave blank spaces between items (asterisks or hash symbols), since this breaks the single list into multiple lists.
 
==== Bulleted lists ====
Bulleted lists, or ''unordered lists'', are added using asterisks (*):
{{comparison table|example=
<pre>
List of bulleted items:
* unordered item
* unordered item</pre>|result=
List of bulleted items:
* unordered item
* unordered item}}
 
===== Indented bullets =====
Bulleted list items can be indented using double asterisks:
{{comparison table|example=
<pre>List with indented item:
* unordered item
** indented item</pre>|result=
List with indented item:
* unordered item
** indented item}}
 
==== Numbered lists ====
Numbered lists, or ''ordered lists'' are used where numerical order (arrangement) is important. They are added using hash symbols (#):
{{comparison table|example=
<pre>List with numbered items:
# numbered item
# numbered item</pre>|result=
List with numbered items:
# numbered item
# numbered item}}
 
=== Plain and horizontal lists ===
Plain and horizontal lists are frequently used in templates such as navboxes or infoboxes, but can also be used in article contents.
 
=== Horizontal lists ===
Horizontal lists can be used where a vertical list may be undesirable. They are added simply by listing items in succession, in a single line:
: item 1, item 2, item 3 ...
: or
: item 1 • item 2 • item 3 ...
 
The template {{t link|horizontal list}} can also be used to add horizontal lists:
; Using bulleted lists
{{comparison table|example=
Horizontal bulleted list:
<pre>{{horizontal list|
* item 1
* item 2
}}</pre>|result=
Horizontal bulleted list:
{{horizontal list|
* item 1
* item 2
}}}}
 
; Using description lists
{{comparison table|example=
Horizontal description list:
<pre>{{horizontal list|
; term : definition
; term : definition
}}</pre>|result=
Horizontal description list:
{{horizontal list|
; term : definition
; term : definition
}}}}
 
Nested lists can also be made horizontal this way:
; Using bulleted lists
{{comparison table|example=
Horizontal bulleted list:
<pre>{{horizontal list|
* item 1
** item 2
* item 3
** item 4
}}</pre>|result=
Horizontal bulleted list:
{{horizontal list|
* item 1
** item 2
* item 3
** item 4
}}}}
 
==== Unbulleted lists ====
Unbulleted lists can be added with {{t link|unbulleted list}} template:
{{comparison table|example=
<pre>Unbulleted list:
{{unbulleted list|
* item 1
* item 2}}</pre>|result=
Unbulleted list:
{{unbulleted list|
* item 1
* item 2}}}}
 
== Tables ==
Tables can be useful, but must always be carefully implemented in order to ensure accessibility and usability across a wide variety of devices.
 
This section is about tables used in the bodies of articles, and not about tables implemented as infoboxes or navboxes, which follow separate guidelines.


<gallery widths="200px" heights="200px" mode="nolines" perrow="2" style="margin:auto">
=== Table formatting ===
Halsin_headshot.jpg|Cinematic Portrait Example - display this first.
Table must be formatted correctly on the wiki. Tables should always be 100% width, and should be limited using max-width and, ideally, ems or % instead.
Halsin_Model.png|3D Model Example
</gallery>


''Exception:'' When an official render or character art is available - as in the case of [[Origins|Origin]] characters such as [[Lae'zel]] - display that image firt.
==== Headers ====
As with section headers, always use sentence case in table headers.


<gallery widths="200px" heights="200px" mode="nolines" perrow="1" style="margin:auto">
For accessibility reasons, it's important to ensure that headers are properly formatted. Using wikitext, headers are defined with {{code|!}}:
Laezel.png|Official 3D Art - display this firt.
<pre>
</gallery>
{| class="wikitable"
! Header
|-
| Not header
|}
</pre>


''Exception:'' For common, non-named creatures, it is okay to display a 3D model first.
Which produces:
{| class="wikitable"
! Header
|-
| Not header
|}


<gallery widths="200px" heights="200px" mode="nolines" perrow="1" style="margin:auto">
==== Style ====
Imp Model.png|3D model for the common, non-named [[Lesser Imp]]
Colours used in tables should always be defined via classes implemented through CSS, as opposed to via style parameters
</gallery>


=== Image Placement ===
=== Table usage ===
TBA
Tables on BG3Wiki are used to present complex information and data of tabular nature. Tables are also used on cargo pages and selectively on project and help pages.


=== Item and Ability Icons ===
Tables are should generally only be used when the information cannot otherwise be prevented in the form of a list.
TBA


{{#seo:
Tables should {{em|not}} be used simply for visual reasons, such as for layout or presentation.
| image = bg3wiki_help.png
 
| title = Style Guide - Baldur's Gate 3 Wiki
==== Examples of correct table usage ====
| description = A style reference for bg3.wiki contributors
{| class="wikitable"
}}
! Character !! Race !! Class
|-
! Astarion
| High-elf || Rogue
|-
! Karlach
| Tiefling || Barbadian
|-
! Gale
| Human || Wizard
|-
|}
 
{| class="wikitable"
|+ Odds of landing on a target number when rolling a d20.
! Target !! Ordinary chance !! Advantage !! Disadvantage
|-
! 1
| 5% || 0.25% || 9.75%
|-
! 10
| 5% || 5.25% || 4.75%
|-
! 20
| 5% || 9.75% || 0.25%
|-
|}
 
{| class="wikitable"
! Item !! Description !! Location
|-
! Longsword
| Can cast a spell. || Found in this location.
|-
! Greatsword
| Can cast two spells. || Found in this location.
|-
! Dagger
| Cannot cast spells. || Found in this location.
|-
|}
 
==== Examples of incorrect table usage ====
{| class="wikitable"
! Act !! Expected level
|-
! Act One
| 1-4
|-
! Act Two
| 5-8
|-
! Act Three
| 9-12
|-
|}
 
{| class="wikitable"
! Action !! Description
|-
! Attack
| Used to attack a target.
|-
! Hide
| Used to hide from sight.
|-
! Jump
| Used to jump to a location.
|-
|}
 
{| class="wikitable"
! Item !! Location
|-
| Longsword
| Found in this location.
|-
| Greatsword
| Found in this location.
|-
| Dagger
| Found in this location.
|-
|}
 
== Icons ==
Icons accompanying a term or link, commonly used via templates on BG3Wiki, should be used when they serve an important illustrative purpose, or serve as a visual aid to improve readability, such as under the following circumstances:
* When a term is used as a keyword or in a list, as opposed to in a full sentence.
* When used in a table, and the icon improves the readability of the table.
 
Icons should {{em|never}} be used in section headers.
 
=== Icons in sentences ===
* {{em|Do not}} use icons in flowing text or full sentences.
** Icons can be used at the start of flowing text (such as before the first word of a paragraph or immediately before the word it is describing) the first time a term is mentioned in an article, and the icon serves an important illustrative purpose.
** Some icons, primarily those readily identified by an icon (such as conditions and features) can be used in full sentences of technical descriptions of item, action or feature properties when they serve as a useful visual cue to the reader. Repeat icons may be acceptable in this case.
 
=== Icon frequency ===
* Avoid overuse of icons, particularly in already icon dense paragraphs.
* Do not unnecessarily repeat icons.
* Do not introduce a term with an icon multiple times in an article.
 
== Spoiler and content warnings ==
BG3Wiki employs the use of spoiler and content warnings at the top of articles or sections.
 
For the purposes of articles this wiki, excluding the main page, the following is considered a spoiler:
* Plot development and story beats of the main narrative of the game.
* Scripted character deaths in any act, including deaths outside of player control.
 
=== Spoiler warnings ===
When creating an article that includes spoilers, you should add a {{tlink|spoiler warning}} to the top of the page or section, if no spoilers appear above that section in the article.
<pre>{{SpoilerWarning|act=1}}</pre>
{{SpoilerWarning|act=1}}
Specify which act the spoiler applies to, per the example. For recurring characters who appear in more than one act, it may make more sense to use the general act-agnostic spoiler warning:
<pre>{{SpoilerWarning}}</pre>
{{SpoilerWarning}}
 
Spoiler andcontent warnings should be used in accordance with the [[Help: Spoiler Policy|Spoiler Policy]] and the [[Help:Content warnings|Content Warning Policy]]. Ideally, they should not disrupt the user experience, but should effectively warn the user of spoilers and sensitive topics.
 
=== Content warnings ===
Content warnings are indicated with {{tlink|cw}}.
Retrieved from "https://bg3.wiki/wiki/Special:MobileDiff/21285...188327"

Navigation menu