Template:Favilink: Difference between revisions

From Caves of Qud Wiki
Jump to navigation Jump to search
(doc update)
m (Add link to the style guide page.)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<includeonly>{{#invoke:Favilink| favilink |{{#if:{{{Page|}}}|{{{Page}}}|{{{1|}}} }}|{{{2|}}}}}</includeonly><noinclude>
<includeonly>{{#invoke:Favilink| favilink |{{#if:{{{Page|}}}|{{{Page}}}|{{{1|}}} }}|{{{2|}}}}}</includeonly><noinclude>
[[Category:Shorthand Templates]]
[[Category:Shorthand Templates]]
!!Currently only for use for objects in the tables: ItemsTable, Food, Corpses, Characters, Locations. All possible items can be found here: [[Special:CargoTables/GeneralData]]. If an item is missing, please let [[User:Teamtoto]] know.
NOTE: this can also be invoked with [[Template:F]], which is fewer characters to type. !!Currently only for use for objects in the tables: ItemsTable, Food, Corpses, Characters, Locations. All possible items can be found here: [[Special:CargoTables/GeneralData]]. If an item is missing, please let [[User:Teamtoto]] know.
==Usage==
==Usage==
Used similar to regular wikipage linking syntax. First argument takes name of the page and will pull the image from that item. This is not case sensitive!
Used similar to regular wikipage linking syntax. First argument takes name of the page and will pull the image from that item. This is not case sensitive!
Line 8: Line 8:
</pre>
</pre>
{{favilink|Stopsvalinn}}
{{favilink|Stopsvalinn}}
If you want to use the wiki's page name instead, see [[Template:Favilink page]]. For the ObjectBlueprint id (which IS case sensitive), use [[Template:Favilink id]].
If you want to use the wiki's page name instead, see [[Template:Favilink page]]. For the ObjectBlueprint id (which IS case sensitive), use [[Template:Favilink id]]. See [[Style Guide#Colored Names]] for more information on when to use these different favilink types.


==Optional Parameters==
==Optional Parameters==
Line 55: Line 55:


{{favilink | mental aggregator | prefix:&ylant&Ye&Wr&Yn&yed}}
{{favilink | mental aggregator | prefix:&ylant&Ye&Wr&Yn&yed}}
|-
! style="white-space:nowrap;" | <code>suffix:<suffix></code>
| Postpends a suffix to the name, which can include qud text color styles.
<pre>
{{favilink | plasma grenade | suffix:mk II}}
</pre>
{{favilink | plasma grenade | suffix:mk II}}
|-
|-
! ''<any other value>''  
! ''<any other value>''  

Latest revision as of 17:21, 18 December 2023

NOTE: this can also be invoked with Template:F, which is fewer characters to type. !!Currently only for use for objects in the tables: ItemsTable, Food, Corpses, Characters, Locations. All possible items can be found here: Special:CargoTables/GeneralData. If an item is missing, please let User:Teamtoto know.

Usage

Used similar to regular wikipage linking syntax. First argument takes name of the page and will pull the image from that item. This is not case sensitive!

{{favilink|Stopsvalinn}}

Stopsvalinn If you want to use the wiki's page name instead, see Template:Favilink page. For the ObjectBlueprint id (which IS case sensitive), use Template:Favilink id. See Style Guide#Colored Names for more information on when to use these different favilink types.

Optional Parameters

You can use the following values as the second argument:

plural pluralizes the item name while preserving the color formatting.
{{favilink |antimatter cell|plural}}

antimatter cells

possessive makes the item name possessive while preserving the color formatting.
{{favilink | Q Girl | possessive}}

Q Girl's

displayname-tooltip-override makes the hover tooltip equal to the display name for items whose display name doesn't match their page name, such as cybernetics credit wedge 1¢. This is probably only needed in special locations where part of the favilink can get truncated, such as in the Character infobox's Inventory list.
{{favilink | cybernetics credit wedge 1¢ | displayname-tooltip-override}}

Compare to tooltip when this parameter is not specified:

prefix:<prefix> Prepends a prefix to the name, which can include qud text color styles.
{{favilink | mental aggregator | prefix:&ylant&Ye&Wr&Yn&yed}}

lanterned mental aggregator

suffix:<suffix> Postpends a suffix to the name, which can include qud text color styles.
{{favilink | plasma grenade | suffix:mk II}}

plasma grenade mk II

<any other value> completely overrides the name shown in the favilink to whatever argument specified.
{{favilink|torch|A &Rreally&y spicy meatball}}

A really spicy meatball