Help:Templates

From bg3.wiki
Revision as of 10:44, 24 November 2023 by Willowisp (talk | contribs)
Jump to navigation Jump to search

Bgwiii.png IndexGuidesModdingDiscord

This article is a technical guide to the use of templates on BG3Wiki. For a guide on how to use templates, see Help:Using templates. See Help:List of templates for a list of templates.

A Template is a special type of page designed to be transcluded within other pages. Templates allow editors to automatically insert frequently-used images, code, and formatting on a page. We use templates extensively on BG3Wiki, as they allow the use of easily accessible and consistent design, layout and formatting.

Template creation

Template creation is an essential part of the technical BG3Wiki workflow. However, it's important to take care when creating or improving templates.

To create or edit templates you need access to them. This can be requested on the Discord or by visiting an admin's talk page.

What to keep in mind

Ideally, new templates should be:

  1. Easy to use, with as few parameters as possible.
  2. Have clear and easy to understand template documentation with examples.
  3. Have easy to use TemplateData.

Template documentation

Template creators are encouraged to document (on the template's page itself as well as via the TemplateData button on the same page) how to use that template, including usage examples and accepted values for any template parameters. If you're unfamiliar with a particular template, navigate to its page to learn how it works. If a template page does not show any usage instructions, it could still be a work in progress, and you may want to check with its creator before using it.

See All Pages (Template namespace) for a full list of available templates on bg3.wiki.

Cargo database

Templates also allow the wiki to populate database tables with stored values using [Cargo queries. This allows the wiki to create automatically generated lists of items or spells.

Additional resources