Help:Style manual: Difference between revisions

Jump to navigation Jump to search
No edit summary
Line 581: Line 581:
: {{strong|Notice}}: The [[Guide:Guide namespace|guide]] and [[Modding:Modding resources|modding]] namespaces may use tables more freely.
: {{strong|Notice}}: The [[Guide:Guide namespace|guide]] and [[Modding:Modding resources|modding]] namespaces may use tables more freely.


== Templates ==
== Icons ==
Limit usage of unnecessary templates in sentences, such templates that add an icon and a link.
Icons accompanying a term or link, commonly used via templates on BG3Wiki, should be used when they serve an 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.


If adding an inline template would violate the capitalisation or linking guidelines if added, it should usually not be used.
Icons should {{em|never}} be used in section headers.


=== Spoiler and content warnings ===
=== Icons in sentences ===
* {{em|Do not}} use icons in flowing text or full sentences, except for illustrative, technical and introductory purposes:
** Icons can be used in flowing text the first time a term is mentioned in an article, and the icon serves an important illustrative purpose.
** Icons 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 ==
{{hatnote|See also: [[Help: Spoiler policy]] and [[Help:Content warnings]].}}
{{hatnote|See also: [[Help: Spoiler policy]] and [[Help:Content warnings]].}}
Spoiler and content 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.
Spoiler and content 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.


==== Spoiler and content warning templates ====
=== Spoiler and content warning templates ===
* '''Spoiler warnings'''
* '''Spoiler warnings'''
** [[Template: SpoilerWarning]]: Provides guidance to viewers on what part of the game they may expect to be spoiled on if they read the articles.  
** [[Template: SpoilerWarning]]: Provides guidance to viewers on what part of the game they may expect to be spoiled on if they read the articles.  
Line 599: Line 611:
* '''Content warnings'''
* '''Content warnings'''
** [[Template: Cw]]: Used exclusively for content earnings.
** [[Template: Cw]]: Used exclusively for content earnings.
=== Creating a new page ===
When creating a new page, whenever possible, try and use a [[Help:Template_Quick_Reference|Page Creation Template]].