Template:IconLink: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 9: Line 9:
{{#vardefine: max-h | {{{h | {{{size | 40}}} }}} }}
{{#vardefine: max-h | {{{h | {{{size | 40}}} }}} }}
}}{{#if: {{{block|}}} | <span style="display: inline-flex; align-items: center; {{#if: {{{gap|}}} | gap: {{{gap}}}px; }}"> }}<span style="display: inline-flex; align-items: center; justify-content: center; min-width: {{#var:min-w}}px; height: {{#var:max-h}}px;">{{icon | {{#var:icon}} | link = {{#var:icon-link}} | caption = {{#var:icon-caption}} | w = {{#var:max-w}} | h = {{#var:max-h}} }}</span>&nbsp;[[ {{#var:link}} | {{#var:text}} ]]{{#if: {{{block|}}} | </span> }}</includeonly><noinclude>
}}{{#if: {{{block|}}} | <span style="display: inline-flex; align-items: center; {{#if: {{{gap|}}} | gap: {{{gap}}}px; }}"> }}<span style="display: inline-flex; align-items: center; justify-content: center; min-width: {{#var:min-w}}px; height: {{#var:max-h}}px;">{{icon | {{#var:icon}} | link = {{#var:icon-link}} | caption = {{#var:icon-caption}} | w = {{#var:max-w}} | h = {{#var:max-h}} }}</span>&nbsp;[[ {{#var:link}} | {{#var:text}} ]]{{#if: {{{block|}}} | </span> }}</includeonly><noinclude>
Usage: {{code|<nowiki>{{IconLink|Flourish Icon.png|Flourish}}</nowiki>}}
Usage: {{code|<nowiki>{{IconLink | Flourish Icon.png | Flourish }}</nowiki>}}


Result: {{IconLink|Flourish Icon.png|Flourish}}
Result: {{IconLink | Flourish Icon.png | Flourish }}


The link text can be changed with a third parameter:
The link text can be changed with a third parameter:


Usage: {{code|<nowiki>{{IconLink|Flourish Icon.png|Flourish|Custom Text}}</nowiki>}}
Usage: {{code|<nowiki>{{IconLink | Flourish Icon.png | Flourish | Custom Text }}</nowiki>}}


Result: {{IconLink|Flourish Icon.png|Flourish|Custom Text}}
Result: {{IconLink | Flourish Icon.png | Flourish | Custom Text }}


The default size is {{code|x40px}} meaning the icon is scaled until the '''height''' is 40 px.  It's usually important to limit the height since the icons are used inline, and a very high inline image makes for an unpleasant text layout.
The default size is {{code|x40px}} meaning the icon is scaled until the '''height''' is 40 px.  It's usually important to limit the height since the icons are used inline, and a very high inline image makes for an unpleasant text layout.
Line 23: Line 23:
An alternative value for the height can be provided via the {{code|size}} or {{code|h}} parameters, which are synonyms:
An alternative value for the height can be provided via the {{code|size}} or {{code|h}} parameters, which are synonyms:


Usage: {{code|<nowiki>{{IconLink|size=25|Flourish Icon.png|Flourish}}</nowiki>}}
Usage: {{code|<nowiki>{{IconLink | size = 25 | Flourish Icon.png | Flourish }}</nowiki>}}


Result: {{IconLink|Flourish Icon.png|Flourish|size=30}}
Result: {{IconLink | size = 25 | Flourish Icon.png | Flourish }}


Usage: {{code|<nowiki>{{IconLink|size=25|Flourish Icon.png|Flourish|Custom Text}}</nowiki>}}
Usage: {{code|<nowiki>{{IconLink | size = 25 | Flourish Icon.png | Flourish | Custom Text }}</nowiki>}}


Result: {{IconLink|Flourish Icon.png|Flourish|Custom Text|size=30}}
Result: {{IconLink | size = 25 | Flourish Icon.png | Flourish | Custom Text }}


Behavior on missing icon:
Behavior on missing icon:

Revision as of 04:00, 21 August 2023

Usage: {{IconLink | Flourish Icon.png | Flourish }}

Result: Flourish  Flourish

The link text can be changed with a third parameter:

Usage: {{IconLink | Flourish Icon.png | Flourish | Custom Text }}

Result: Custom Text  Custom Text

The default size is x40px meaning the icon is scaled until the height is 40 px. It's usually important to limit the height since the icons are used inline, and a very high inline image makes for an unpleasant text layout.

An alternative value for the height can be provided via the size or h parameters, which are synonyms:

Usage: {{IconLink | size = 25 | Flourish Icon.png | Flourish }}

Result: Flourish  Flourish

Usage: {{IconLink | size = 25 | Flourish Icon.png | Flourish | Custom Text }}

Result: Custom Text  Custom Text

Behavior on missing icon:

File:Missing Icon 123.png  Custom Text

The width can be set via the w parameter. This could be useful if several elements are supposed to align vertically for design purposes, such as in the following table shown on our main page as of the writing of this documentation. This also uses the block and gap parameters. View the source of this page for usage.

Rolls
Attack Roll  Attack Roll The roll you make to determine whether an attack hits an enemy at all.
Damage Roll  Damage Roll The roll you make to determine the amount of damage done by a successful attack.
Saving Throw  Saving Throw The roll you make to attempt avoiding various threats other than direct attacks.
Ability Check  Ability Check The roll you make when attempting anything else that requires a roll to succeed.
Modifiers
Advantage  Advantage Roll the die twice, and use the higher result. Disadvantage is the exact opposite.
Ability Score Modifier  Ability Score Modifier The number you add to your rolls based on your Ability Scores.
Proficiency Bonus  Proficiency Bonus The number you add to your rolls based on whether you have Proficiency.