Module:Favilink/doc

Documentation

[purge]

!!Currently only for use for objects in the tables: ItemsTable, Food, Corpses, Characters, Locations. All possible items can be found here: Special:CargoTables/GeneralData.

Usage

Used similar to regular wikipage linking syntax. First argument takes name of the object and will pull the image from that item. This must be called using Template:Favilink.

{{favilink|Stopsvalinn}}

Stopsvalinn

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}} cybernetics credit wedge 1¢ Compare to tooltip when this parameter is not specified: cybernetics credit wedge 1¢
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

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.