Template:IconLink: Difference between revisions

From bg3.wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<includeonly>{{trim|
<includeonly>{{IconText
{{#vardefine: min-w | {{{w | {{{size | 40}}} }}} }}
| {{{1}}}
{{#vardefine: max-w | {{{w|}}} }}
| {{{3|{{{2}}}}}}
{{#vardefine: max-h | {{{h | {{{size | 40}}} }}} }}
| link = {{{2}}}
}}{{#if: {{{block|}}} | <span style="display: inline-flex; align-items: center;"> }}<span style="display: inline-flex; align-items: center; justify-content: center; min-width: {{#var:min-w}}px; height: {{#var:max-h}}px;">[[File:{{{1}}}|frameless|link={{{2}}}|{{#var:max-w}}x{{#var:max-h}}px|{{{2}}}]]</span>&nbsp;[[ {{{2}}} |{{{ 3 |{{{ 2 }}} }}} ]]{{#if: {{{block|}}} | </span> }}</includeonly><noinclude>
| size = {{{size|}}}
Usage: {{code|<nowiki>{{IconLink|Flourish Icon.png|Flourish}}</nowiki>}}
| w = {{{w|}}}
| h = {{{h|}}}
| block = {{{block|}}}
| gap = {{{gap|}}}
| nowrap = {{{nowrap|}}}
| class = {{{class|}}}
}}</includeonly><noinclude>
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 18: Line 25:
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 }}


The width can be set via the {{code|w}} parameter.  This could be useful if several elements are supposed to align vertically for design purposes, such as in this table shown on our main page as of the writing of this documentation:
Behavior on missing icon:
 
{{IconLink | Missing Icon 123.png | Flourish | Custom Text | size = 30 }}
 
The width can be set via the {{code|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 {{code|block}} and {{code|gap}} parameters.  View the source of this page for usage.


{| class="wikitable" style="width: 50%;"
{| class="wikitable" style="width: 50%;"
! colspan="2" | Rolls
! colspan="2" | Rolls
|-
|-
| {{IconLink|w=20|h=20|D20.png|Attack Roll}} || The roll you make to determine whether an attack hits an enemy at all.
| {{IconLink | block = yes | w = 22 | h = 22 | gap = 2 | D20.png | Attack Roll }}
| The roll you make to determine whether an attack hits an enemy at all.
|-
|-
| {{IconLink|w=20|h=20|D6 Thunder.png|Damage Roll}} || The roll you make to determine the amount of damage done by a successful attack.
| {{IconLink | block = yes | w = 22 | h = 22 | gap = 2 | D6 Thunder.png | Damage Roll }}
| The roll you make to determine the amount of damage done by a successful attack.
|-
|-
| {{IconLink|w=20|h=20|Saving Throw Icon.png|Saving Throw}} || The roll you make to attempt avoiding various threats other than direct attacks.
| {{IconLink | block = yes | w = 22 | h = 22 | gap = 2 | Saving Throw Icon.png | Saving Throw }}
| The roll you make to attempt avoiding various threats other than direct attacks.
|-
|-
| {{IconLink|w=20|h=20|D20.png|Ability Check}} || The roll you make when attempting anything else that requires a roll to succeed.
| {{IconLink | block = yes | w = 22 | h = 22 | gap = 2 | D20.png | Ability Check }}
| The roll you make when attempting anything else that requires a roll to succeed.
|-
|-
! colspan="2" | Modifiers
! colspan="2" | Modifiers
|-
|-
| {{IconLink|w=20|h=20|Advantage Icon.png|Advantage}} || Roll the die twice, and use the higher result. [[Disadvantage]] is the exact opposite.  
| {{IconLink | block = yes | w = 22 | h = 22 | gap = 2 | Advantage_Icon.png | Advantage }}
| Roll the die twice, and use the higher result. [[Disadvantage]] is the exact opposite.  
|-
|-
| {{IconLink|block=yes|w=20|h=20|Charisma Ability Icon.png|Ability Score Modifier}} || The number you add to your rolls based on your [[Ability Scores]].
| {{IconLink | block = yes | w = 22 | h = 22 | gap = 2 | Charisma Ability Icon.png | Ability Score Modifier }}
| The number you add to your rolls based on your [[Ability Scores]].
|-
|-
| {{IconLink|block=yes|w=20|h=20|Proficiency Icon.png|Proficiency Bonus}} || The number you add to your rolls based on whether you have [[Proficiency]].
| {{IconLink | block = yes | w = 22 | h = 22 | gap = 2 | Proficiency Icon.png | Proficiency Bonus }}
| The number you add to your rolls based on whether you have [[Proficiency]].
|}
|}


[[Category:Icon Templates]]
[[Category:Icon templates]]
</noinclude>
 
== Template parameters ==
<templatedata>
{
"params": {
"1": {
"description": "The file to display as an icon, without the File: prefix.",
"type": "string",
"required": true
},
"2": {
"description": "Where to link to.",
"type": "wiki-page-name",
"required": true
},
"3": {
"description": "(optional) Replaces the link text with this if specified.",
"type": "string"
},
"w": {
"description": "(optional) Override the width of the image.",
"type": "number"
},
"h": {
"description": "(optional) Override the height of the image.",
"type": "number"
},
"size": {
"description": "(optional) Set the size of the image to this by this.",
"type": "number"
},
"block": {},
"gap": {},
"nowrap": {
"description": "If specified, will add the nowrap css style to the span.",
"type": "boolean"
},
"class": {
"description": "Any classes to add to the img"
}
},
"paramOrder": [
"1",
"2",
"3",
"w",
"h",
"size",
"block",
"gap",
"nowrap",
"class"
],
"description": "Insert a linked icon."
}
</templatedata></noinclude>

Latest revision as of 15:27, 23 June 2024

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.

Template parameters

Insert a linked icon.

Template parameters

ParameterDescriptionTypeStatus
11

The file to display as an icon, without the File: prefix.

Stringrequired
22

Where to link to.

Page namerequired
33

(optional) Replaces the link text with this if specified.

Stringoptional
ww

(optional) Override the width of the image.

Numberoptional
hh

(optional) Override the height of the image.

Numberoptional
sizesize

(optional) Set the size of the image to this by this.

Numberoptional
blockblock

no description

Unknownoptional
gapgap

no description

Unknownoptional
nowrapnowrap

If specified, will add the nowrap css style to the span.

Booleanoptional
classclass

Any classes to add to the img

Unknownoptional
Retrieved from "https://dev.bg3.wiki/w/index.php?title=Template:IconLink&oldid=198872"