Help:List of templates: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{NavWiki|help}}[[File:bg3wiki_help.png|thumb|left|Illithid wisdom sent you here...]]
{{NavWiki|help}}
This page serves as a quick reference for commonly-used templates on bg3.wiki.
{{hatnote|This is a newer, more up to date list still in construction. For the previous cheat sheet, see [[List of templates/archive]].}}
A '''list of templates''' used on BG3Wiki.


See [[Help:How to Contribute]] for general wiki editing tips, or click on a template to see its template page and documentation.
: <small>† = These templates are used for data querying.</small>
: <small>‡ = These templates are used for listing queried data.</small>
__NOTOC__
== Game mechanics ==
==== Actions and movement ====
* [[Template:Action]]: Display either in-game action resources or movement.
* [[Template:Action icon]]: Add an action or movement icon with custom text.
* [[Template:Concentration]]


More advanced template editors may also wish to view [https://bg3.wiki/wiki/Special:AllPages?namespace=10 All Pages in the Template Namespace].
==== Character stats ====
{{TOC}}
* [[Template:Ability]]: Format text to display a link to an ability with its associated icon.
== Page creation templates ==
* [[Template:Armour Class]]: Format text to display a link with the text Armour Class, and an association icon.
Arguably the most important templates on the wiki, Page Creation Templates take your input to create full, pre-formatted pages for various aspects of the game. These templates also automate SEO meta tagging and page categorisation.
* [[Template:AttributeBlock]]: Generate a table of character ability scores.


* [[Template:ConditionPage]]: Generates a full page for a [[Conditions|Condition]]. Once created, the condition's data will then be queryable via [[Template:Condition]] (see the [[#Data Querying Templates|Data Querying Templates]] section).
==== Classes ====
* [[Template:EquipmentPage]]: Generates a full page for various types of non-weapon [[Equipment]], including Clothing, Light Armour, Medium Armour, Heavy Armour, Shields, Amulets, Boots, Cloaks, Gloves, Helmets, Rings, Camp Clothes, Camp Shoes, and Undergarments.
* [[Template:Class]]: Add a link to a class or subclass, with icon.
* [[Template:MiscItemPage]]: Generates a full page for various [[Miscellaneous]] and [[Consumables|Consumable]] items, including Ammunition, Books, Food, Drinks, Potions, Scrolls, and Consumables. Useful for creating a page for an item that doesn't fit neatly into any other category.
* [[Template:Class Quote]]: Add a class quote with a class symbol.
* [[Template:SpellPage]]: Generates a full page for any [[Spells|Spell]]. This template includes multiple parameters capable of automatically parsing and formatting comma-separated lists.
* [[Template:WeaponActionPage]]: Generates a full page for any [[Weapon Actions|Weapon Action]], such as [[Backbreaker (Weapon Action)]]. Like the Condition template, this integrates with the Cargo extension.
* [[Template:WeaponPage]]: Generates a full page for any individual [[Weapons|Weapon]], such as [[Worgfang]].
* [[Template:WeaponTypePage]]: Generates a full page for a [[:Category:Weapon Types|Weapon Type]], such as [[Daggers]].


== Data querying templates ==
==== Conditions ====
These templates automate data queries for the Cargo wiki extension, allowing you to quickly assemble and insert helpful data.
* [[Template:Cond]]: Format text with a link and icon to display a condition.
* [[Condition]]†: Display a fully formatted condition. Runs the cargo query.
* [[Condition type]]: Display a text with a condition icon plus a link to curse, disease, or poison.
* [[Template:Condition sources]]‡: Builds a list of things that add the specified conditions.


* [[Template:Condition]]: Queries the Conditions table for any single condition you specify by name, and outputs pre-formatted data for that condition.
==== Description texts ====
* [[Template:WeaponAction]]: Queries the Weapon Actions table for any single weapon action you specify by name, and outputs pre-formatted data for that weapon action.
* [[Template:AOE]]: Format text to display areas of effect distance and type.
* [[Template:Prereq]]: Format text as white in-game minor warninfs.
* [[Template:Warning]]: Format text as red in-game major warnings.


== Inline templates ==
==== Dice rolls ====
These templates insert inline content - often an icon and link to the relevant page - to provide additional flair and visual consistency. Nearly all of these templates are invoked by other, larger templates automatically.
*  [[Template:Ability check]]: Format text to display ability checks as links, with a specified Difficulty Class and a d20 icon.
* [[Template:Advantage]: Format text to display an Advantage link with icon.
* [[Template:Attack roll]]: Format text to display the text Attack roll, with an icon.


* [[Template:Ability]]: Inserts an ability score, its page link, and the associated icon.
==== Miscellaneous ====
* [[Template:Action]]: Adds icons and links for Actions, Bonus Actions, Reactions, and Movement.
* [[Template:Achievement]]: Display in-game achievements
* [[Template:AOE]]: Inserts area of effect details in feet and meters, plus an AOE icon.
* [[Template:Approval]]: Format text to show Approval for companions, with icons.
* [[Template:Advantage]] / [[Template:Disadvantage]]: Inserts a link to the Advantage / Disadvantage explanations, as well as the associated icon.
* [[Template:Camp Supplies]]: Display Camp Supplies icon and amount, optionally with a text or link.
* [[Template:Armour Class]]: Inserts an armour class value, a link to the Armour Class page, and the armour class icon.
* [[Template:Attack Roll]]: Inserts a link to the Attack Roll page and the Attack Roll icon.
* [[Template:Bug]]: Insert this template to indicate that a bug has been identified, and direct users to notes in a 'Bugs' section.
* [[Template:Class]]: Inserts a class or subclass, its page link, and the associated icon.
* [[Template:Color]]: A simple template for changing the colour of some text.
* [[Template:Concentration]]: Inserts a link to the Concentration page and the Concentration icon.
* [[Temmplate:Cond]]: Inserts an icon and link to a [[Condition]].
* [[Template:Coords]]: Inserts pre-formatted X and Y coordinates for use with the ingame map.
* [[Template:DamageColor]]: A simple template for changing some text to match the colour for the specified damage type.
* [[Template:DamageText]]: An inline-friendly alternative to the DamageInfo template. Inserts colour-coded damage info and the icon for the specified damage type.
* [[Template:DamageType]]: Similar to DamageText, but without any damage numbers.
* [[Template:DieIcon]]: Inserts a colour-coded icon for the specified damage type and die type.
* [[Template:Distance]]: Inserts distance in feet and meters, plus a distance icon.
** [[Template:Distance/Transform]]: Same as [[Template:Distance]], but with automated conversion from feet to meters.
* [[Template:Duration]]: Inserts a duration value and the duration icon.
* [[Template:Enchantment]]: Inserts an enchantment value for an item, plus the enchantment icon.
* [[Template:Expertise]]: Inserts a link to the [[Expertise]] page and the expertise icon.
* [[Template:Finesse]]: Inserts a link to the [[Finesse]] page and the finesse icon.
* [[Template:FRWiki]]: Inserts an inline link to the specified Forgotten Realms Wiki page. Great for pointing wiki readers to relevant sources of additional lore about the Forgotten Realms and its denizens. If you choose to insert an external link from FRWiki to bg3.wiki (see [https://forgottenrealms.fandom.com/wiki/Template:BG3 the corresponding template on FRWiki]), please use this template to reciprocate that link on the relevant bg3.wiki page.
* [[Template:Icon]]: Inserts an icon image of adjustable size with no link. A bit more editor-readable than using MediaWiki's <nowiki>[[File]]</nowiki> markup.
** [[Template:SmallIcon]]: Like Icon, but with the icon size set to 25px (inline-appropriate).
** [[Template:IconLink]]: Like Icon, but with an associated link.
** [[Template:SmIconLink]]: Like IconLink, but with the icon size set to 25px.
* [[Template:ItemIcon]]: Automatically inserts the icon for the item. Can also automatically link the item.
** [[Template:RarityItem]]: Also colours the item icon according to its rarity.
* [[Template:Price]]: Inserts the price of an item or service in gold pieces (gp), plus the gp icon.
* [[Template:ProficiencyBonus]]: Inserts a link to the [[Proficiency Bonus]] page and the associated icon.
* [[Template:Race]]: Inserts a race name, its page link, and the associated icon.
* [[Template:Range]]: Like distance, but specifically for ranges.
* [[Template:RarityColor]]: A simple template for changing the colour of some text to match the specified rarity.
** [[Template:Story]], [[Template:Uncommon]], [[Template:Rare]], [[Template:Very rare]], [[Template:Legendary]]: Optional, abbreviated versions of RarityColor for each rarity.
* [[Template:Recharge]]: Inserts a recharge time (such as 'Long Rest') and the recharge icon.
* [[Template:Resistance]]: Inserts a Resistance icon for the given Damage Type and Resistance type.
* [[Template:SAI]]: Spell and Ability Iconlink. Adds an icon to the associated spell or ability link.
* [[Template:SavingThrow]]: Visually represent a type of Saving Throw in a semi-compact fashion.
* [[Template:Verify]]: Lets readers and fellow wiki editors know that the preceding statement is tentative and needs verification.
* [[Template:Weight]]: Inserts the weight of an item, object, or creature in lbs / kg, plus the weight icon.


== Navigational templates ==
== Infoboxes ==
These templates assist wiki readers in navigating to related pages.
* [[Template:Character info]]: Add a character infobox.


* [[Template:NavCharacters]]: Inserts a 'Characters' navbox, for use at the bottom of character pages.
== Items ==
* [[Template:NavCreatures]]: Inserts a 'Creatures' navbox, for use at the bottom of creature pages.
==== Item descriptions ====
* [[Template:NavGameplay]]: Inserts a 'Gameplay Mechanics' navbox, for use at the bottom of various mechanical pages.
* [[Template:BookText]]: Format as a book text.
* [[Template:NavQuests]]: Inserts a 'Quests' navbox, for use at the bottom of quest pages.
* [[Template:Can't Dual Wield]]: Adds an icon and text.


== Other templates ==
==== Item types ====
These templates each have unique aspects or use cases that make them different from other templates.
* [[Template:Alchemical Extracts]]
* [[Template:Alchemical Ingredients]]
* [[Template:Books]]
* [[Template:Coatings]]
* [[Template:Consumables]]


* [[Template:AttributeBlock]]: Generates an attribute block for a creature. While it can be used on its own, this template is also automatically invoked and handled by other templates, such as [[Template:CharacterInfo]].
==== Loot ====
* [[Template:Cite web]]: Inserts citation with an external url and possibly archive.
* [[Template:Chest]]: Add a collapsible box with chest contents.
* [[Template:Cw]]: Inserts a content warning for sensitive content.
* [[Template:Anchor]]: Inserts a page anchor to allow for linking to a specific part of a page, for cases in which a heading would not be stylistically appropriate.
* [[Template:DamageInfo]]: A more robust, ''non-inline-friendly'' version of the DamageText template. Inserts colour-coded damage info and the icon for the specified damage type. Invoked extensively by Page Creation Templates.
* [[Template:Hatnote]]: Creates a "hatnote", an indented and italicized note at the top of a page. Hatnotes are useful for "see also" or "do you mean...?"-type messages.
* [[Template:HealingInfo]]: Like DamageInfo, but for effects that heal hit points.
* [[Template:Div col]]: Used to arrange a set of bullets in 'newspaper-style' columns, making better use of horizontal space on a page.
** [[Template:Div col end]]: Marks the end of a [[Template:Div col]] list.
* [[Template:ImageLink]]: Inserts icons with text below, both linking to a specified page.
* [[Template:InfoBlob]]: Displays a small piece of information a nicely-styled blob in a monospace font. '''Note:''' Always inserts a new line before the infoblob; not suitable for inline usage.
* [[Template:MatureWarning]]: Inserts a mature content warning with the mature content collapsed by default. Please do still adhere to the [[BG3Wiki:Content Rules|Wiki Content Rules]].
* [[Template:Quote]]: Inserts a pre-formatted quote. Used extensively for character quotes, class descriptions, and item 'flavour text.'
* [[Template:PageSeo]]: Applies meta tags to the page for Google SEO (most commonly, the "image" and "description" tags). These meta tags are also referenced when linking to a bg3.wiki page on social media sites and Discord. '''Note:''' Page Creation Templates automatically handle this functionality, but any page created without a page creation template should also manually invoke this template.
* [[Template:Resistances]]: Inserts a pre-formatted table of resistances, vulnerabilites, and/or immunities.
* [[Template:SpoilerBox]]: Inserts a spoiler warning with the spoilery content collapsed by default.
* [[Template:SpoilerWarning]]: Inserts a generic spoiler warning for the contents of a page or page section.
* [[Template:TOC]]: Inserts the page's Table of Contents. Can be used to override the default TOC placement or limit the depth of header links included in the TOC.
* [[Template:UnderConstruction]]: Inserts an 'Under Construction' notice for in-progress pages, stub pages, and incomplete sections.


{{PageSeo
== Navigation boxes ==
| image = bg3wiki_help.png
Add NavBoxes to a page, for navigation.
| description = A quick reference guide for commonly-used templates on the Baldur's Gate 3 Community Wiki.
 
}}
==== Classes ====
[[Category:Wiki Help]]
* [[Template:BarbarianNavbox]]
* [[Template:BardNavbox]]
 
== Notices ==
== Warnings ==
* [[Template:Blur]]: Add an inline spoiler blur to a text thar disappears on hover.
* [[Template:Cw]]: Add a content warning.
* [[Template:SpoilerBlur]]: Add a spoiler blur.
* [[Template:SpoilerWarning]]: Add a spoiler warning.
 
==== Licenses ====
* [[Template:License]]: For use on pages. Publish a page under an alternative license.
* [[Template:License base/overview]]: Overview of license templates used for files and larger works.
 
== Page creation ==
* [[Template:Action Page]]: Automatically generate an action page for actions that don't fit other page generators.
* [[Template:Condition Page]]: For conditions.
 
== References ==
* [[Template:Cite web]]: Add a reference with an external url.
* [[Template:Ref]]: Add an ordinary or grouped reference.
* [[Template:Reflist]]: Display ordinary or grouped references with formatting.
 
== Wiki formatting ==
==== Layout ====
* [[Template:Blank]]: Add spaces or line breaks in texts where they would normally be removed.
* [[Template:Clear]]: Prevent overflow at the end of a section.
 
==== On-page navigation ====
* [[Template:Anchor]]: Add invisible anchor names.
* [[Template:Back to top]]: Add a link back to the top of a page.
* [[Template:Bug]]: Link to a bug section.
* [[Template:Tab]]: Add tabs to a page.
 
==== Substitution ====
* [[Template:CURRENTDATE]]: Display the current date.
 
==== Text ====
* [[Template:Code]]: Format as code.
* [[Template:Colour]]: Add colour to a text.

Revision as of 15:38, 1 November 2023

Bgwiii.png IndexGuidesModdingDiscord

This is a newer, more up to date list still in construction. For the previous cheat sheet, see List of templates/archive.

A list of templates used on BG3Wiki.

† = These templates are used for data querying.
‡ = These templates are used for listing queried data.

Game mechanics

Actions and movement

Character stats

Classes

Conditions

  • Template:Cond: Format text with a link and icon to display a condition.
  • Condition†: Display a fully formatted condition. Runs the cargo query.
  • Condition type: Display a text with a condition icon plus a link to curse, disease, or poison.
  • Template:Condition sources‡: Builds a list of things that add the specified conditions.

Description texts

Dice rolls

  • Template:Ability check: Format text to display ability checks as links, with a specified Difficulty Class and a d20 icon.
  • [[Template:Advantage]: Format text to display an Advantage link with icon.
  • Template:Attack roll: Format text to display the text Attack roll, with an icon.

Miscellaneous

Infoboxes

Items

Item descriptions

Item types

Loot

Navigation boxes

Add NavBoxes to a page, for navigation.

Classes

Notices

Warnings

Licenses

Page creation

References

Wiki formatting

Layout

  • Template:Blank: Add spaces or line breaks in texts where they would normally be removed.
  • Template:Clear: Prevent overflow at the end of a section.

On-page navigation

Substitution

Text