Help:Style manual: Difference between revisions

Jump to navigation Jump to search
m
typo
No edit summary
m (typo)
(4 intermediate revisions by 2 users not shown)
Line 66: Line 66:
# 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
# Content and spoiler warnings
# Tab template: {{t link|CompanionTab}}, {{t link|CombatTab}}
# Tab template: {{t link|Companion tab}}, {{t link|Combat tab}}
# Infoboxes: {{t link|CharacterInfo}}, {{t link|relative location}}
# Infoboxes: {{t link|Infobox character}}, {{t link|Infobox statistics}}, {{t link|relative location}}
# Images
# Images
# 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.
Line 97: Line 97:


===== 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 character}} template, {{t link|Infobox statistics}} 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 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 =====
===== Locations =====
Line 149: 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 '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 267: 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 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 422: Line 448:


== Images ==
== Images ==
{{hatnote|See also: [[Help:Images]].}}
{{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.
** Galleries are the bottom of pages are an exception.
* Do not refer the positioning of images in textual contents (eg. "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 [[Help: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:

Navigation menu