10,940
editsMore actions
m
no edit summary
m (→Punctuation) |
mNo edit summary |
||
| (99 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{PageSeo | {{PageSeo | ||
| title = Style | | 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}} | ||
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 14: | Line 13: | ||
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. | 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. | ||
{{TOC|limit=3}} | {{TOC|limit=3}} | ||
== Article names == | |||
Article titles and headings are usually written in sentence case, with the exception of names (see the capitalisation section of this guide). | Article titles and headings are usually written in sentence case, with the exception of names (see the capitalisation section of this guide). | ||
=== Grammatical number === | |||
Names of articles are generally given in singular form, with a few important exceptions: | |||
* 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 ==== | ||
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). | ||
* {{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 32: | 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 39: | Line 53: | ||
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]]). | 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. | ||
The following is the correct order of elements on most pages: | |||
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. | |||
===== Characters ===== | |||
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. | |||
==== | =====Origins or permanent companions===== | ||
# 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. | |||
## 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. | |||
==== Page templates | =====Non-player characters===== | ||
# 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. | |||
===== Locations ===== | |||
Location articles, with exception of locations within Lower City, usually have a {{t link|Relative location}} template. | |||
# 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 | |||
=== Footnotes and references === | |||
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. | |||
Footnote tags are added using {{t link|note}}, and are listed using the {{t link|notelist}}. | |||
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}}. | |||
Footnote and reference tags should always be added immediately {{em|after}} punctuation, with no space or break between the tag and punctuation. | |||
References can, and often should, be added to footnotes as well. | |||
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> | |||
=== Page templates === | |||
Most action, spell and item pages have three distinct, but similar, fields: ''summary'', ''description'' and ''quote''. | Most action, spell and item pages have three distinct, but similar, fields: ''summary'', ''description'' and ''quote''. | ||
| Line 75: | Line 169: | ||
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. | 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. | ||
=== "Where to find" sections === | |||
When describing where to find an item, include all of the following details: | When describing where to find an item, include all of the following details: | ||
# A description of the location of the item - or the source, if it's a quest reward or sold by a vendor | # A description of the location of the item - or the source, if it's a quest reward or sold by a vendor | ||
| Line 81: | Line 175: | ||
# 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 | #* 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 97: | Line 191: | ||
* {{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 == | == Capitalisation == | ||
| Line 113: | Line 219: | ||
Do not generally capitalise game concepts, mechanics, terminology or rules. | 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: | 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 ( | ** Exceptions: These terms should not be capitalised when the terms are used descriptively (e.g. 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. | * The item categories Consumables, Miscellaneous and Valuables are capitalised when used standalone. | ||
* Specific abilities (Strength, Dexterity) | * Specific abilities (Strength, Dexterity) | ||
* Specific actions (Attack action, Hide action) | * Specific actions (Attack action, Hide action) | ||
| Line 148: | Line 253: | ||
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) – | ** 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 188: | Line 293: | ||
=== 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 | 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 199: | Line 304: | ||
== Punctuation == | == 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: | 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. | * 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: | 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 – gith, yank and perry. | * Lae'Zel has three actions – they are gith, yank and perry. | ||
* Perry – a gith of virtue – decided to aid the villagers. | * Perry – a gith of virtue – decided to aid the villagers. | ||
* Perry and Lae'Zel were not merely friends – they were allies. | * 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>. | 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. | Use semi-colons (;) to connect two independent clauses that are thematically connected. | ||
* Perry chose to take a level in barbarian; Lae'zel thought | * Perry chose to take a level in barbarian; Lae'zel thought Perry's decision unwise. | ||
== Grammar == | == Grammar == | ||
| Line 274: | Line 375: | ||
== Terminology == | == 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 === | === Ability checks === | ||
The term "ability check" is preferred to the term "skill check", except when the distinction is important for clarity or brevity. | The term "ability check" is preferred to the term "skill check", except when the distinction is important for clarity or brevity. | ||
| Line 295: | Line 423: | ||
=== 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 ( | 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 320: | Line 448: | ||
== Images == | == Images == | ||
{{hatnote| | {{hatnote|Also see BG3Wiki's [[BG3Wiki:Image Policy|image policy]].}} | ||
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. | ||
* 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 ( | |||
* | === 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: | Alt text can be added to the File template with this parameter: | ||
| Line 343: | Line 481: | ||
* <nowiki>{{File:Gale_Flirting.png|alt=Gale sings while sitting at lake.}}</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. | |||
Be careful not to underlink or overlink on the wiki. Generally, a link to a specific | |||
=== 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. | 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. | |||
=== Table formatting === | |||
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 ==== | |||
As with section headers, always use sentence case in table headers. | |||
For accessibility reasons, it's important to ensure that headers are properly formatted. Using wikitext, headers are defined with {{code|!}}: | |||
<pre> | |||
{| class="wikitable" | |||
! Header | |||
|- | |||
| Not header | |||
|} | |||
</pre> | |||
Which produces: | |||
{| class="wikitable" | |||
! Header | |||
|- | |||
| Not header | |||
|} | |||
==== Style ==== | |||
Colours used in tables should always be defined via classes implemented through CSS, as opposed to via style parameters | |||
=== Table usage === | |||
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. | |||
Tables are should generally only be used when the information cannot otherwise be prevented in the form of a list. | |||
Tables should {{em|not}} be used simply for visual reasons, such as for layout or presentation. | |||
==== Examples of correct table usage ==== | |||
{| 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 | === 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}}. | |||