Help:Style manual: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
m (some additions)
m (some additions)
Line 4: Line 4:
Contributors should aim to write articles using straightforward, succinct, easily understood language where possible.
Contributors should aim to write articles using straightforward, succinct, easily understood language where possible.


== General Guidance ==
== General Wiki Guidance ==


General guidance will go here.
=== Article Names ===
Guidelines for naming articles vary based on the type of article.


== Article Names ==
==== Concepts ====
Guidelines for naming articles vary based on the type of article.
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.
* {{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
 
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.
* {{SmallIcon|greencheck.png}} [[Feats]] ({{SmallIcon|redx.png}}Feat)
* {{SmallIcon|greencheck.png}} [[Spells]] ({{SmallIcon|redx.png}}Spell)


=== Concepts ===
==== Characters ====
When both singular and plural forms of a concept are commonly used, opt for the singular form in article names. This enables easier linking of articles while minimizing the number of article redirects.
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.  
* {{SmallIcon|greencheck.png}} Saving Throw ({{SmallIcon|redx.png}}Saving Throws)
* {{SmallIcon|greencheck.png}} [[Gut]] ({{SmallIcon|redx.png}}True Soul Gut {{SmallIcon|redx.png}}Priestess Gut)
** Link markup: {{code|<nowiki>[[Saving Throw]]</nowiki>}} and {{code|<nowiki>[[Saving Throw]]s</nowiki>}} both lead to [[Saving Throw]], allowing for easy plural usage when describing [[Saving Throw]]s
* {{SmallIcon|greencheck.png}} [[Spaw]] ({{SmallIcon|redx.png}}Sovereign Spaw)
''Firstname Lastname'' is also acceptable.
* {{SmallIcon|greencheck.png}} [[Roah Moonglow]]


As an exception, when a concept is nearly always 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.
==== Items ====
* {{SmallIcon|greencheck.png}} Feats ({{SmallIcon|redx.png}}Feat)
Use the name of the item shown on the ingame tooltip, including the enchantment value, if any:
* {{SmallIcon|greencheck.png}} Spells ({{SmallIcon|redx.png}}Spell)
* {{SmallIcon|greencheck.png}} [[Longbow +1]]


=== Characters ===
When an item has ''both'' an enchantment ''and'' a unique name, use the unique name without the enchantment value:
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.
* {{SmallIcon|greencheck.png}} [[Merregon Halberd]]
* {{SmallIcon|greencheck.png}} Gut ({{SmallIcon|redx.png}}True Soul Gut {{SmallIcon|redx.png}}Priestess Gut)
* {{SmallIcon|greencheck.png}} Spaw ({{SmallIcon|redx.png}}Sovereign Spaw)


=== Items ===
==== Locations ====
TBA
When a location has multiple names, opt for the name displayed on the minimap while standing in that location. Create redirects for alternative names.
* {{SmallIcon|greencheck.png}} [[Ebonlake Grotto]] ({{SmallIcon|redx.png}}Myconid Colony)


=== Places ===
=== When to Add Links ===
TBA
TBA


== When to Add Links ==
TBA
== Formatting ==
== Formatting ==
=== Abbreviations ===
=== Abbreviations ===
Line 40: Line 46:


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


==== Quotes ====
==== Quotes ====
Line 48: Line 54:
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 several 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 ====
Write in present tense, not past tense.
* {{SmallIcon|greencheck.png}} '''Gale''' is a Companion. ({{SmallIcon|redx.png}}'''Gale''' was a Companion.)


=== Spelling ===
=== Spelling ===

Revision as of 01:08, 22 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.

Contributors should aim to write articles using straightforward, succinct, easily understood language where possible.

General Wiki Guidance

Article Names

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

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.

  • 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 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.

  • 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

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.

Quotes

  • 'Single quotes' ("Double quotes")

Commas

Use Oxford commas (also known as Serial Commas) when listing several 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.

  • Gale is a Companion. (Gale was a Companion.)

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.

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

Images

TBA

Placement

TBA

Icons

TBA

Lists

TBA?