Help:Using templates: Difference between revisions

From Baldur's Gate 3 Wiki
Jump to navigation Jump to search
Line 7: Line 7:
A '''Template''' is a special type of page designed to be embedded within other pages, providing editors  with access to consistent design and formatting.
A '''Template''' is a special type of page designed to be embedded within other pages, providing editors  with access to consistent design and formatting.


== How to use templates ==
A '''template''' is a special type of page designed to be included within other pages. Templates are used extensively on BG3Wiki.
=== Adding templates to pages ===
 
==== Visual editor ====
== Adding templates to pages ==
=== Via the visual editor ===
[[File:visual_editor_template.png|right|thumb|Inserting a template with the Visual Editor]]
[[File:visual_editor_template.png|right|thumb|Inserting a template with the Visual Editor]]
Templates can be searches for and added via the toolbar above the visual editor by clicking ''''Insert''', and in the dropdown box, selecting '''Templates'''. Most templates can be easily inserted onto a page this way. To later edit its contents, simply click on the inserted template in the visual editor for options.
Templates can be searched for and added via the toolbar above the visual editor by clicking ''Insert'', and in the dropdown box, selecting ''Templates''. Most templates can be easily inserted onto a page this way. To later edit its contents, simply click on the inserted template in the visual editor for options.


==== Source editor ====
=== Via the source editor ===
Templates are added by using double brackets ({{code|<nowiki>{{ ... }}</nowiki>}}. For example, the template {{code|foo}} is added by typing ({{code|<nowiki>foo</nowiki>}}.
Templates are added by using double brackets ({{code|<nowiki>{{ ... }}</nowiki>}}. For example, the template {{code|foo}} is added by typing ({{code|<nowiki>foo</nowiki>}}.


Line 26: Line 27:
{{AttributeBlock|8|15|7|6|10|8|hp=12|dex save = yes|race=Bird|hp=10}}
{{AttributeBlock|8|15|7|6|10|8|hp=12|dex save = yes|race=Bird|hp=10}}


== Specific uses of templates ==
=== Adding navigation to pages ===
=== Adding navigation to pages ===
==== Hatnotes ====
==== Hatnotes ====

Revision as of 13:10, 28 November 2023

This article is a beginner friendly introduction to templates. For a more technical guide, see Help:Templates.

A Template is a special type of page designed to be embedded within other pages, providing editors with access to consistent design and formatting.

A template is a special type of page designed to be included within other pages. Templates are used extensively on BG3Wiki.

Adding templates to pages

Via the visual editor

Inserting a template with the Visual Editor

Templates can be searched for and added via the toolbar above the visual editor by clicking Insert, and in the dropdown box, selecting Templates. Most templates can be easily inserted onto a page this way. To later edit its contents, simply click on the inserted template in the visual editor for options.

Via the source editor

Templates are added by using double brackets ({{ ... }}. For example, the template foo is added by typing (foo.

A template's parameters are specified through the use of pipes (|).

  • Template with one parameter:
    • Code: {{enchantment|+1}}
    • Result: Enchantment: + 1
  • Template with multiple parameters:
    • Code: {{AttributeBlock|8|15|7|6|10|8|hp=12|dex save = yes|race=Bird|hp=10}}
    • Result:

STR

8
(-1)

DEX

15
(+2)

CON

7
(-2)

INT

6
(-2)

WIS

10

CHA

8
(-1)

Creature Race Icon.png Race

Bird

HP Icon.png Hit Points

10

Specific uses of templates

Adding navigation to pages

Hatnotes

When an article is of a similar, but distinct, subject to another, the Hatnote template can be used to add a note at the top of an article with a link to the other article.

Disambiguation pages

The Disambig template can be used to create disambiguation pages when there are multiple articles with the same name.

Navboxes

Many pages on BG3Wiki makes use of "navboxes" to create navigation between pages of related topics. A full list of navboxes can be found here: Navboxes.

Page creation

Templates can take input in the form of standard parameters and use it to generate a pre-formatted page.

See also