Ad placeholder

Help:Style manual: Difference between revisions

Jump to navigation Jump to search

Help:Style manual (view source)

Revision as of 22:03, 28 October 2024

4,014 bytes added ,  28 October
→‎Capitalisation
 
(46 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{PageSeo
{{PageSeo
| title = Style Guide
| title = Style manual
| image =  
| image =  
| description = A style reference for Baldur's Gate 3 Wiki contributors.
| description = A style reference for Baldur's Gate 3 Wiki contributors.
}}
}}
{{NavWiki|help}}
{{NavWiki|help}}
{{TocStyle}}
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.
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.


Line 21: Line 20:
* Names of articles about classes of things are generally given in plural form ([[ability scores]], [[dice rolls]]).
* 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 articles about things which are generally expressed as multiples are also given in plural form ([[hit points]]).
* Names of categories should always be given in plural form.
* Names of [[Help:Categories|categories]] should usually be given in plural form.


=== Specific guidelines ===
=== Specific guidelines ===
==== Characters ====
==== Characters ====
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.  
Character articles use the character's full name (first name and last name), without any titles, aliases. 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).
* {{SmallIcon|greencheck.png}} [[Roah Moonglow]].
* {{SmallIcon|greencheck.png}} [[Roah Moonglow]].
Nicknames or handles may be used if that is the most common usage (e.g. Rogue names):
* {{SmallIcon|greencheck.png}} [[Nine-Fingers Keene]] ({{SmallIcon|redx.png}}Astele Keene).
* {{SmallIcon|greencheck.png}} [[Lady Ague]] ({{SmallIcon|redx.png}}Ague).
* {{SmallIcon|greencheck.png}} [[Cheeky Nora]] ({{SmallIcon|redx.png}}Nora).


Companions should be named after their in-game character name instead:
Companions should be named after their in-game character name instead:
Line 65: Line 69:
# {{t link|DISPLAYTITLE}}
# {{t link|DISPLAYTITLE}}
# {{t link|hatnote}}
# {{t link|hatnote}}
# Content and spoiler warnings
# Notices: {{t link|Priority}}, {{t link|Stub}},  {{t link|Under construction}}, {{t link|Rewrite}}
# Notices: {{t link|Priority}}, {{t link|Stub}},  {{t link|Under construction}}, {{t link|Rewrite}}.
# Content and spoiler warnings: {{t link|Cw}}, {{t link|SpoilerWarning}}
# Infoboxes: {{t link|CharacterInfo}}, {{t link|relative location}}
# Tab template: {{t link|Companion tab}}, {{t link|Combat tab}}
# Images
# Infoboxes: {{t link|Infobox creature}}, {{t link|relative location}}
# Tab template: {{t link|CompanionTab}}, {{t link|CombatTab}}
## Infobox Gallery: Contains an in-game image and a portrait of the character
# Introduction: A brief and spoiler-free summary of the article's contents that gives context to the article.
# Introduction: A brief and spoiler-free summary of the article's contents that gives context to the article.
# Quote: A main quote that aptly summarizes the subject of the article {{t link|DiQ}}, {{t link|Q}}
# TOC template: {{t link|TOC}}
# TOC template: {{t link|TOC}}
# Body: Most of article's contents (see [[Help:Style manual#Body|below]]).
# Body: Most of article's contents (see [[Help:Style manual#Body|below]]).
# Related literature: A section with links to related books, letters and notes in the game.
# Achievements: A section with an {{t link|achievement}} template.
# Achievements: A section with an {{t link|achievement}} template.
# Gallery: A section with a <nowiki><gallery></nowiki>.
# Gallery: A section with a <nowiki><gallery></nowiki>. Contains any other relevant images aside from an in-game image and portrait, especially images that are too large for the infobox.
# See also: A section with links to relevant articles.
# 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.
# 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]]).
# Footnotes: A section with a {{t link|notelist}} template (see [[Help:Style manual#Footnotes and references|below]]), using the {{t link|notebegin}} and {{t link|noteend}} templates.
# References: A section with {{t link|reflist}} templates (see [[Help:Style manual#Footnotes and references|below]]).
# References: A section with {{t link|reflist}} templates (see [[Help:Style manual#Footnotes and references|below]]), using the {{t link|notebegin}} and {{t link|noteend}} templates.
# External links: A section with external links.
# External links: A section with external links.
# Navboxes
# Navboxes
Line 98: Line 103:


===== Characters =====
===== Characters =====
Character articles typically have a {{t link|CharacterInfo}} template and a {{t link|CompanionTab}} or {{t link|CombatTab}} template.
Character articles typically have a {{t link|Infobox creature}} template and a {{t link|Companion tab}} or {{t link|Combat tab}} template.
# Overview
 
## Background: Contextual information about the character's role in the game.
=====Origins or permanent companions=====
## Description: A basic description of the character, including their personality, appearance and noteworthy traits.
# Overview: A brief summary of the article as a whole for quick access to specific information.
## Personal quest: A spoiler-light overview of the character's personal quest (if applicable) or involvement in quests.
## Background: A brief introduction to the character and their role in the game.
## Recruitment
## Starting class: A short overview of their starting class and default subclass choices, if applicable.
## Approval
## Special features: Any special features available only to this character.
# History
## Personal quest: A spoiler-light summary of the character's personal quest.
# A quest section, often named after the character's personal quest, that contains major spoilers.
## Recruitment: Where and how the character can be recruited. If multiple options are available, group them by act.
# List of interactions
## Approval: A short guide to what the character generally approves and disapproves of.
# Loot
## 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.
 
=====Non-player characters=====
# Overview: A brief introduction to the character and their role in the game. (Trader, boss, where they are found, etc.).
## History: The character's backstory before the events of the game (if necessary). 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.
## Act 1: involvement in Act 1.
## Act 2: involvement in Act 2.
## Act 3: involvement in Act 3.
# Companion approval
# Combat: A section describing any combat encounters with this character. Long combat sections, especially for boss encounters, should be moved to a combat subpage.
## Attacks and abilities: Abilities and spells used by the character in combat.
## Allies/Encounter details/Tactics: Only for articles describing a notable combat encounter that are not long enough to warrant a separate combat subpage (e.g. [[Tska'an]]).
## Loot: Any items that can be looted from the character.
# Related Quests: Any quests that the character is involved in.
## Quest Reward: Any items, temporary bonuses, or permanent bonuses that can be obtained from this character as a quest reward.
 
=====Combat subpages=====
# Attacks and abilities: Abilities and spells used by the character in combat.
# Allies: Any NPCs that join the character in combat.
# Conditions: A list of immunities or vulnerabilities to conditions (if necessary).
# Encounter details: A description of ''what'' happens in the fight.
# Tactics: Methods and advice on ''how'' to overcome the fight.
# Bugs: A section on relevant bugs (if necessary).


===== Locations =====
===== Locations =====
Line 150: Line 189:
# Instructions for any additional steps necessary to find or obtain the item (e.g. 'Jump up to the ledge behind the purple mushroom.')
# 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)''
# Map coordinates of the item, if applicable, in the format ''(X:123, Y:123)''
#* This can be done in the form of the 'Coords' template: <nowiki>{{Coords|123|123}}</nowiki>
#* This can be done in the form of the {{t link|coords}} template: <nowiki>{{Coords|123|123}}</nowiki>


Lengthy instructions can be formatted with sublists, as necessary:
Lengthy instructions can be formatted with sublists, as necessary:
Line 169: Line 208:
== Abbreviations ==
== Abbreviations ==
=== Abbreviations of game concepts ===
=== Abbreviations of game concepts ===
{{hatnote|See the [[BG3Wiki:Glossary|glossary]] for common examples of abbreviations used on BG3Wiki.}}
{{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.
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.


Line 182: Line 221:
Articles and their contents, including article names and headings, are given in sentence case.
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.
Capitalise proper nouns if they are linked.


Specific in-game items, spells, characters and locations should also inherit the game's capitalisation.
Specific in-game items, spells, characters and locations should also be capitalised.


=== Article names and headers ===
=== Article names and headers ===
Line 192: Line 231:


=== Game concepts and mechanics ===
=== Game concepts and mechanics ===
Do not generally capitalise game concepts, mechanics, terminology or rules.
Capitalise game concepts, mechanics, terminology or rules.


The following abbreviations should always be capitalised: AC, DC, NPC and abbreviation of abilities (STR, DEX, CON etc).
The following abbreviations should always be capitalised: AC, DC, NPC and abbreviation of abilities like STR, DEX, CON etc.


Capitalise the following terms:
Capitalise the following terms:
* Armour Class
* Armour Class
* Classifications of weapons and armour (Longsword, Light armour).
* Classifications of weapons and armour (Longsword, Light Armour).
** Exceptions: These terms should not be capitalised when the terms are used descriptively (eg. with no mechanical significance).
* Creature sizes (Medium, Large)
* Creature sizes (Medium, Large)
* Creature types (Aberration, Humanoid)
* Creature types (Aberration, Humanoid)
* Difficulty Class
* Difficulty Class
* The item categories Consumables, Miscellaneous and Valuables are capitalised when used standalone.
* The item categories Consumables, Miscellaneous and Valuables are capitalised.
* Specific abilities (Strength, Dexterity)
* Specific abilities (Strength, Dexterity)
* Specific actions (Attack action, Hide action)
* Specific actions (Attack Action, Hide Action)
* Specific class features (Cunning Action, Rage)
* Specific class features (Cunning Action, Rage)
** Subclasses are considered class features, and are therefore also capitalised (Champion, Wildheart)
* Subclasses are considered class features, and are therefore also capitalised (Champion, Wildheart)
* Specific conditions (Bleeding, Slightly Drunk)
* Specific conditions (Bleeding, Slightly Drunk)
* Specific damage types (Fire, Piercing)
* Specific damage types (Fire, Piercing)
Line 217: Line 255:
* Specific spells
* Specific spells


Do {{em|not}} capitalise the following terms:
The following terms should not be capitalized:
* 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.
* 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.
* 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 classes (barbarian, fighter)
** Names of subclasses should still be capitalised.
* Names of races (elf, illithid, owlbear)
* Names of races (elf, illithid, owlbear)
* Spell schools (abjuration, necromancy).
* Spell schools (abjuration, necromancy)
* Subcategories of Consumables: arrows, camp supplies, coatings, dyes, elixirs, grenades, potions, scrolls.
* Subcategories of Consumables: arrows, camp supplies, coatings, dyes, elixirs, grenades, potions, scrolls.
 
Exceptions:
Exceptions:
* Races and classes may be capitalised when used as titles (Gale, Human Wizard).
* 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) – eg. the creature Mind Flayer Leader is a mind flayer.
** 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 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)
* The first letter in game concept terminology can be capitalised when used as keywords (Type: Condition)
Line 234: Line 271:
=== Other capitalisation guidelines ===
=== Other capitalisation guidelines ===
==== References to other articles ====
==== 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.
Names of articles should be capitalised on other pages if they referred to as an article.
* {{SmallIcon|greencheck.png}} For more information about potions, see Potions.
* {{SmallIcon|greencheck.png}} For more information about potions, see Potions.
* {{SmallIcon|redx.png}} For more information about potions, see potions.
* {{SmallIcon|redx.png}} For more information about potions, see potions.
Line 262: Line 299:
Use double apostrophes {{code|<nowiki>''...''</nowiki>}} to style certain terms as cursive text. On BG3Wiki, we style the following terms using italics:
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.
* 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.
* Names of vessels and ships.
* When writing about words as words (an ''ability'' is a representation of a creature's physical or mental capabilities).  
* 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.
* Terminology or phrases that are not in English.
Line 268: Line 305:


=== Semantic emphasis ===
=== 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 one <em>one</em> word per sentence. Never use apostrophes for 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 ====
==== What to avoid ====
Line 300: Line 337:


== Grammar ==
== Grammar ==
=== Collective nouns ===
Nouns as ''the party'' and ''the group'' are treated as collective nouns and are used only with plural forms
* {{SmallIcon|greencheck.png}}The party have to speak with someone.
** {{SmallIcon|redx.png}}The party has to speak with someone.
* {{SmallIcon|greencheck.png}}The party are attacked by someone.
** {{SmallIcon|redx.png}}The party is attacked by someone.
=== Grammatical person ===
=== Grammatical person ===
Most articles are written in third-person perspective:
Most articles are written in third-person perspective:
Line 307: Line 352:
** {{SmallIcon|redx.png}}We 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:
When writing sections of articles that make use of terminology such as ''the player'', or "you" then ''the party'' or ''the player character'' 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|greencheck.png}} The party cannot enter this location.
** {{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.
** {{SmallIcon|redx.png}} The player cannot enter this location.


Single or isolated instances of ''the player'' should still be written in third-person perspective.
* {{SmallIcon|greencheck.png}} The player character talks with the Dream Visitor.
* {{SmallIcon|greencheck.png}} The player will always enter this location from the east entrance.
** {{SmallIcon|redx.png}} The player talks with the Dream Visitor.
** {{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.
''Never use first-person or second-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.)
* {{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.  
''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 ===
=== Tense ===
Line 354: Line 399:
There are numerous conventions employed when describing things that a creature does:
There are numerous conventions employed when describing things that a creature does:
* Creatures roll dice.
* Creatures roll dice.
* Creatures deal damage..
* Creatures deal damage.
* Creatures take actions.
* Creatures take actions.
* Creatures take turns.
* Creatures take turns.
Line 365: Line 410:
* Creatures attempt tasks involving ability checks.
* Creatures attempt tasks involving ability checks.
* Creatures make ability checks.
* Creatures make ability checks.
* Creatures make saving throws.
* Creatures roll for initiative.
* Creatures roll for initiative.
* Creatures inflict conditions.
* Creatures inflict conditions.
Line 374: Line 420:
* Creatures use ability scores.
* Creatures use ability scores.
* Creatures have proficiency / are proficient with with weapons and armour.
* Creatures have proficiency / are proficient with with weapons and armour.
* Creatures have proficiency/ are proficient in skills and saves.
* Creatures have proficiency / are proficient in skills and saves.


=== Ability checks ===
=== Ability checks ===
Line 397: Line 443:


=== Locations ===
=== 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 (eg. [[Emerald Grove]]).
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.
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.
Line 422: Line 468:


== Images ==
== Images ==
{{hatnote|See also: [[Help: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.
 
=== 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.
* Images should be in the relevant section, and should never be placed at the bottom of a section.
** Galleries are the bottom of pages are an exception.
* Do not refer the positioning of images in textual contents (e.g. "in the image to the left" or "the image at the top".
* Do not refer the positioning of images in textual contents (eg. "in the image on the left", or "the image at the top".
 
* Textual contents of articles should function independently from its images. Images are added as an additional illustrative supplement.
=== Image sizes ===
* Add alt text to any images used in articles.
* 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.
* 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.
** Images used inline, such as this [[File:Concentration_Icons.png|20px]] Concentration icon should use pixels, usually around 20px. Images should {{em|very rarely}} be used inline like this {{em}} consult the [[Style manual#Icons|icons section below]] for appropriate icon use.
* 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 ====
=== Image alt text ===
When using the File template, alt text (text which appears when the image fails to load) should be added as necessary to improve accessibility. The text should be clear, concise and descriptive.
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:
Alt text can be added to the File template with this parameter:
Line 448: Line 501:


== Linking ==
== 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.
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 – it is not necessary to link every word that has an article.


=== Duplicate links ===
=== Duplicate links ===
Generally, a link to a specific target should only appear once per article, when the relevant word is first mentioned.
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.
Exceptions to this include infoboxes, navboxes, tables, lists and 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.
In very long or technical articles, multiple links to the same target are also appropriate.


=== What to avoid ===
=== What to avoid ===
Line 464: Line 517:


=== Linking to other wikis ===
=== Linking to other wikis ===
The [[Template:FRWiki|FRWiki]] template should be used to link to the FRWiki when appropriate.
The templates [[Template:FRWiki|FRWiki]] and [[Template:BGWiki|BGWiki]] should be used to link to the FRWiki or the BGWiki when appropriate.


== Lists and tables ==
== Lists and tables ==
Line 477: Line 530:
{{comparison table|example=
{{comparison table|example=
<pre>Description list:
<pre>Description list:
; Hit points : Determines how much damage a creature can take before being Downed.
; 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=
; Armour Class : Determines how difficult it is to hit a creature.</pre>|result=
Description list:
Description list:
; Hit points : Determines how much damage a creature can take before being Downed.
; Hit Points : Determines how much damage a creature can take before being Downed.
; Armour Class : Determines how difficult it is to hit a creature}}
; Armour Class : Determines how difficult it is to hit a creature}}


Line 487: Line 540:
<pre>Description table list:
<pre>Description table list:
{{table list|
{{table list|
; Hit points : Determines how much damage a creature can take before being Downed.
; 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=
; Armour Class : Determines how difficult it is to hit a creature.}}</pre>|result=
Description table list:
Description table list:
{{table list|
{{table list|
; Hit points : Determines how much damage a creature can take before being Downed.
; Hit Points : Determines how much damage a creature can take before being Downed.
; Armour Class : Determines how difficult it is to hit a creature}}}}
; Armour Class : Determines how difficult it is to hit a creature}}}}


Line 607: Line 660:


=== Table formatting ===
=== Table formatting ===
Table must be formatted correctly on the wiki.
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.


==== Headers ====
==== Headers ====
Line 733: Line 786:


=== Icons in sentences ===
=== Icons in sentences ===
* {{em|Do not}} use icons in flowing text or full sentences.
* Icons can be used in 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.
** 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.
* Icons, primarily for those terms which are readily identified by icons (such as conditions and features) can be used in full sentences. Repeat icons may be acceptable in this case.
** 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 ===
=== Icon frequency ===
Line 743: Line 795:


== Spoiler and content warnings ==
== Spoiler and content warnings ==
{{hatnote|See also: [[Help: Spoiler policy]] and [[Help:Content warnings]].}}
BG3Wiki employs the use of spoiler and content warnings at the top of articles or sections.
Spoiler and content 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.
 
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.


=== Spoiler and content warning templates ===
=== Content warnings ===
* '''Spoiler warnings'''
Content warnings are indicated with {{tlink|cw}}.
** [[Template: SpoilerWarning]]: Provides guidance to viewers on what part of the game they may expect to be spoiled on if they read the articles.
** [[Template: SpoilerBox]]: Intended for sections with major spoilers.
** [[Template: RomanceBox]]: Intended for the Romance sections of articles, including Romance encounters with non-companions.
** [[Template: Blur]]: Intended for inline spoilers in NavBoxes and, rarely, in lists.
** [[Template: imgblur]]: Intended for spoilery images.
* '''Content warnings'''
** [[Template: Cw]]: Used exclusively for content earnings.
Hawkeye
Maintainers
16,566
edits
Retrieved from "https://bg3.wiki/wiki/Special:MobileDiff/140680...242279"

Navigation menu