bg3wiki:Image policy: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
No edit summary
m (Willowisp moved page Help:Images to BG3Wiki:Image policy)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{NavWiki|help}}
{{NavWiki|help}}
{{TocStyle}}
It is important to be use the correct file format and to follow toe appropriate naming convention when uploading images to BG3Wiki.
{{hatnote|For file uploads and naming conventions, see [[Help:Files]].}}
 
__NOTOC__
== Naming convention ==
Image names should be brief, concise and descriptive. They use the following format:
<div>Prefix_name_suffix.fileformat.png/.webp</div>
 
; Prefix : A brief term that gives context to the image. When contextually applicable, it can be the primary [[:Category:Images|category]] of the image.
; File name : The file name is simply the name of the image. More specific guidelines can be found under the appropriate sections.
; Suffix : Added when further classification of needed, and can be a single word or an abbreviation.
 
The following image names use a Prefix_Page_name_Suffix format:
* Underdark_Sussur_Tree.png
* Underdark_Mushrooms.png
* Underdark_Mush_Bibberbang.png
* Underdark_Arcane_Tower_NE.png
* Underdark_Arcane_Tower_S.png
 
=== Items and objects ===
Includes in-game items and objects.
* '''Faded images, 380x380'''
** Prefix_Itemname_Faded.png/.webp
* '''Unfaded images, 144x144'''
** Prefix_Itemname_Unfaded.png/.webp
* '''Unfaded images, 64x64'''
* Prefix_Itemname_Unfaded_Icon.png/.webp
 
The '''Prefix''' is usually the [[:Category:Images|category]] of the item, and does not need to be included when it is unnecessary or the item or object lacks any specific category.
 
In cases where an item or object has multiple image variations, distinguish them by using a single letter following the item name:
* Backpack_A_Unfaded_Icon.png
* Backpack_B_Unfaded_Icon.png
 
When multiple items or objects share the same in-game image, only one file should be uploaded. Instead of uploading duplicate images, create Redirects to that image using the same naming conventions as above, corresponding to each item using that image.
 
=== Game mechanics ===
Includes spells, actions, abilities, conditions, passive features, and feats.
 
* '''Large faded images'''
** Page_Name.webp
* '''Small unfaded icons'''
** '''Transparent background'''
*** Page_Name_Icon.webp
** '''Opaque background'''
*** Page_Name_Condition_Icon.webp
 
== Image layout and presentation ==
== Image layout and presentation ==
==== Character images ====
=== Character images ===
For character pages, whenever possible, include {{em|both}} a cinematic portrait/screenshot {{em|and}} a transparent full-body model of the character. Display the cinematic portrait first and ensure the [[Template:PageSeo|PageSeo]] template has been invoked with the cinematic portrait as the '''image''' parameter. This will help ensure consistency across character pages and external link previews (e.g. social media sites and Discord).
For character pages, whenever possible, include {{em|both}} a cinematic portrait/screenshot {{em|and}} a transparent full-body model of the character. Display the cinematic portrait first and ensure the [[Template:PageSeo|PageSeo]] template has been invoked with the cinematic portrait as the '''image''' parameter. This will help ensure consistency across character pages and external link previews (e.g. social media sites and Discord).


Line 24: Line 66:
</gallery>
</gallery>


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


Line 31: Line 73:
<big><nowiki>|alt=</nowiki></big>
<big><nowiki>|alt=</nowiki></big>


==== Examples ====
=== Examples ===
{{SmallIcon|greencheck.png}} '''Good alt text''':
{{SmallIcon|greencheck.png}} '''Good alt text''':
* <nowiki>  {{File:A_Nice_Summer_Stay.png|alt=Astarion flinching in pain after being hurt by concentrated sunlight at the Githyanki Créche.}} </nowiki>
* <nowiki>  {{File:A_Nice_Summer_Stay.png|alt=Astarion flinching in pain after being hurt by concentrated sunlight at the Githyanki Créche.}} </nowiki>

Latest revision as of 22:32, 7 February 2024

Bgwiii.png IndexGuidesModdingDiscord

It is important to be use the correct file format and to follow toe appropriate naming convention when uploading images to BG3Wiki.

Naming convention

Image names should be brief, concise and descriptive. They use the following format:

Prefix_name_suffix.fileformat.png/.webp
Prefix
A brief term that gives context to the image. When contextually applicable, it can be the primary category of the image.
File name
The file name is simply the name of the image. More specific guidelines can be found under the appropriate sections.
Suffix
Added when further classification of needed, and can be a single word or an abbreviation.

The following image names use a Prefix_Page_name_Suffix format:

  • Underdark_Sussur_Tree.png
  • Underdark_Mushrooms.png
  • Underdark_Mush_Bibberbang.png
  • Underdark_Arcane_Tower_NE.png
  • Underdark_Arcane_Tower_S.png

Items and objects

Includes in-game items and objects.

  • Faded images, 380x380
    • Prefix_Itemname_Faded.png/.webp
  • Unfaded images, 144x144
    • Prefix_Itemname_Unfaded.png/.webp
  • Unfaded images, 64x64
  • Prefix_Itemname_Unfaded_Icon.png/.webp

The Prefix is usually the category of the item, and does not need to be included when it is unnecessary or the item or object lacks any specific category.

In cases where an item or object has multiple image variations, distinguish them by using a single letter following the item name:

  • Backpack_A_Unfaded_Icon.png
  • Backpack_B_Unfaded_Icon.png

When multiple items or objects share the same in-game image, only one file should be uploaded. Instead of uploading duplicate images, create Redirects to that image using the same naming conventions as above, corresponding to each item using that image.

Game mechanics

Includes spells, actions, abilities, conditions, passive features, and feats.

  • Large faded images
    • Page_Name.webp
  • Small unfaded icons
    • Transparent background
      • Page_Name_Icon.webp
    • Opaque background
      • Page_Name_Condition_Icon.webp

Image layout and presentation

Character images

For character pages, whenever possible, include both a cinematic portrait/screenshot and a transparent full-body model of the character. Display the cinematic portrait first and ensure the PageSeo template has been invoked with the cinematic portrait as the image parameter. This will help ensure consistency across character pages and external link previews (e.g. social media sites and Discord).

Exception: When an official render or character art is available - as in the case of Origin characters such as Lae'zel - display that image first.

Exception: For common, non-named creatures, it is okay to display a model first.

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 can be added to the File template with this parameter:

|alt=

Examples

Good alt text:

  • {{File:A_Nice_Summer_Stay.png|alt=Astarion flinching in pain after being hurt by concentrated sunlight at the Githyanki Créche.}}
  • {{File:Gale_Flirting.png|alt=Gale is serenading Tav while sitting on Mystra's picnic blanket at Lake Hurricane.}}

Poor alt text:

  • {{File:A_Nice_Summer_Stay.png|alt=Astarion discovering the difference between a nice Summer stay and the full concentrated power of the sun.}}
  • {{File:Gale_Flirting.png|alt=Gale sings while sitting at lake.}}