Help:Style manual: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
mNo edit summary
m (wording tweaks; british spelling (oops))
Line 3: Line 3:


== General Wiki Guidance ==
== General Wiki Guidance ==
Contributors should aim to write articles using straightforward, succinct, easily understood language where possible.
Contributors should write articles using straightforward, succinct language. Remember: ''less is more.''


=== Article Names ===
=== Article Names ===
Line 9: Line 9:


==== Concepts ====
==== Concepts ====
When both singular and plural forms of a concept are commonly used, generally opt for the singular form in article names. This enables easier linking of articles while minimizing the number of article redirects.
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.
* {{SmallIcon|greencheck.png}} [[Saving Throw]] ({{SmallIcon|redx.png}}Saving Throws)
* {{SmallIcon|greencheck.png}} [[Saving Throw]] ({{SmallIcon|redx.png}}Saving Throws)
** Link markup: {{code|<nowiki>[[Saving Throw]]</nowiki>}} and {{code|<nowiki>[[Saving Throw]]s</nowiki>}} both lead to [[Saving Throw]], allowing for easy plural usage
** Link markup: {{code|<nowiki>[[Saving Throw]]</nowiki>}} and {{code|<nowiki>[[Saving Throw]]s</nowiki>}} both lead to [[Saving Throw]], allowing for easy plural usage
Line 18: Line 18:


==== Characters ====
==== Characters ====
Opt for the character's simplest and most commonly used name, without any titles, honorifics, or nicknames. Such 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.  
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.  
* {{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)
Line 28: Line 28:
* {{SmallIcon|greencheck.png}} [[Longbow +1]]
* {{SmallIcon|greencheck.png}} [[Longbow +1]]


When an item has ''both'' an enchantment ''and'' a unique name, use the unique name without the enchantment value:
When an item has both an enchantment ''and'' a unique name, use the unique name without the enchantment value:
* {{SmallIcon|greencheck.png}} [[Merregon Halberd]]
* {{SmallIcon|greencheck.png}} [[Merregon Halberd]]
* {{SmallIcon|greencheck.png}} [[Speedy Reply]]


==== Locations ====
==== Locations ====
Line 45: Line 46:


=== Punctuation and Grammar ===
=== Punctuation and Grammar ===
In most cases, [[Baldur's Gate 3]] follows British English punctuation and grammatical rules. Aim to consistently employ these wiki-wide, but don't fuss over correcting articles to conform to a specific style, except that which is quoted directly from the game. Please avoid getting into edit wars.
[[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 errors''' over rewriting articles to conform to a specific style. Please avoid getting into edit wars.


==== Quotes ====
==== Quotes ====
Line 51: Line 54:


==== Commas ====
==== Commas ====
Use Oxford commas (also known as [https://en.wikipedia.org/wiki/Serial_comma Serial Commas]) when listing several items, unless directly quoting game text that omits this comma.
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)
* {{SmallIcon|greencheck.png}} Clerics, Rogues, and Barbarians ({{SmallIcon|redx.png}}Clerics, Rogues and Barbarians)


==== Present Tense ====
==== Present Tense ====
Write in present tense, not past tense.
Write in present tense, not past tense. bg3.wiki is first and foremost a 'snapshot' of the current version of BG3.
* {{SmallIcon|greencheck.png}} '''Gale''' is a Companion. ({{SmallIcon|redx.png}}'''Gale''' was a Companion.)
* {{SmallIcon|greencheck.png}} Wyll '''is''' a Companion. ({{SmallIcon|redx.png}}Wyll '''was''' a Companion.)
* {{SmallIcon|greencheck.png}} Mystra '''is''' the goddess of magic. ({{SmallIcon|redx.png}}Mystra '''was''' the goddess of magic.)
 
As an exception, past tense is acceptable when describing a notable change from a previous version of the game:
* {{SmallIcon|greencheck.png}} Prior to Early Access Patch 9, this weapon '''was''' dropped by Zevlor.


=== Spelling ===
=== Spelling ===
In most cases, [[Baldur's Gate 3]] follows British English spelling rules. Aim to consistently employ this spelling 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)

Revision as of 01:37, 23 February 2023

Illithid wisdom sent you here...

This page serves as a basic style reference for contributors to bg3.wiki. It is a living document and is expected to receive continual updates.

General Wiki Guidance

Contributors should write articles using straightforward, succinct language. Remember: less is more.

Article Names

Guidelines for naming articles vary based on the type of article.

Concepts

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.

  • Saving Throw (Saving Throws)
    • Link markup: [[Saving Throw]] and [[Saving Throw]]s both lead to Saving Throw, allowing for easy plural usage

As an 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.

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.

  • Gut (True Soul Gut Priestess Gut)
  • Spaw (Sovereign Spaw)

Firstname Lastname is also acceptable.

Items

Use the name of the item shown on the ingame tooltip, including the enchantment value, if any:

When an item has both an enchantment and a unique name, use the unique name without the enchantment value:

Locations

When a location has multiple names, opt for the name displayed on the minimap while standing in that location. Create redirects for alternative names.

When to Add Links

TBA

Formatting

Abbreviations

TBA

Capitalization

TBA

Punctuation and Grammar

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 errors over rewriting articles to conform to a specific style. Please avoid getting into edit wars.

Quotes

  • 'Single quotes' ("Double quotes")

Commas

Use Oxford commas (also known as Serial Commas) when listing three or more items, unless directly quoting game text that omits this comma.

  • Clerics, Rogues, and Barbarians (Clerics, Rogues and Barbarians)

Present Tense

Write in present tense, not past tense. bg3.wiki is first and foremost a 'snapshot' of the current version of BG3.

  • Wyll is a Companion. (Wyll was a Companion.)
  • Mystra is the goddess of magic. (Mystra was the goddess of magic.)

As an exception, past tense is acceptable when describing a notable change from a previous version of the game:

  • Prior to Early Access Patch 9, this weapon was dropped by Zevlor.

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.

  • Armour (Armor)
  • Defence (Defense)
  • Colour Spray (Color Spray)

Images

TBA

Placement

TBA

Icons

TBA

Lists

TBA?