View source for Template:ItemLink/doc

{{doc/start}}
This is a template for adding links to items.

{| class="wikitable"
! Code
! Result
|-
| <pre>{{ItemLink|Winterclaw}}</pre>
| {{ItemLink|Winterclaw}}
|-
| <pre>{{ItemLink|Geo-Data #3469}}</pre>
| {{ItemLink|Geo-Data #3469}}
|-
| <pre>{{ItemLink|Recruit's Scope}}</pre>
| {{ItemLink|Recruit's Scope}}
|}

== Customization ==
There are many possibitities to customize the behavior.

{| class="wikitable"
! style="width:115px" | Parameter
! style="width:100px" | Type
! style="width:90px" | Default
! Description
|-
| rowspan="3"| noIcon
| rowspan="3"| boolean (1/0)
| rowspan="3"| show (0)
|Hide (1) or show (0) the Icon
|-
|<pre>{{ItemLink|Ginger Tom. Salad|noIcon=1}}</pre>
|-
|{{ItemLink|Ginger Tom. Salad|noIcon=1}}
|-
| rowspan="3"| showName
| rowspan="3"| string
| rowspan="3"| Item-Name
|Overrides the Item-Name (alternative Name)
|-
|<pre>{{ItemLink|Ginger Tom. Salad|showName=Blattsalat}}</pre>
|-
|{{ItemLink|Ginger Tom. Salad|showName=Blattsalat}}
|-
| rowspan="3"| noLink
| rowspan="3"| boolean (1/0)
| rowspan="3"| show (0)
|Hide (1) or show (0) the Link
|-
|<pre>{{ItemLink|Chili Dog|noLink=1}}</pre>
|-
|{{ItemLink|Chili Dog|noLink=1}}
|-
| rowspan="3"| anchorOverride
| rowspan="3"| boolean (1/0)
| rowspan="3"| disabled (0)
|Internal use only (return the anchor-name if anchorOverride is 1)
|-
|<pre>{{ItemLink|Geo-Data #3469|anchorOverride=1}}</pre>
|-
|{{ItemLink|Geo-Data #3469|anchorOverride=1}}
|-
| rowspan="3"| nowrap
| rowspan="3"| boolean (1/0)
| rowspan="3"| enabled (1)
|disable (0) or enable (1) Nowrap (prevent line breaks)
|-
|<pre>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. {{ItemLink|Scrappy Plate|nowrap=0}} Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</pre>
|-
|Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. {{ItemLink|Scrappy Plate|nowrap=0}} Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
|-
| rowspan="3"| noRename
| rowspan="3"| boolean (1/0)
| rowspan="3"| disabled (0)
|disable (0) or enable (1) noRename (prevent auto-rename)
|-
|<pre>noRename: {{ItemLink|Rauser|noRename=1}} Rename: {{ItemLink|Rauser|noRename=0}}</pre>
|-
|noRename: {{ItemLink|Rauser|noRename=1}} Rename: {{ItemLink|Rauser|noRename=0}}
|}

== Special Items ==

{| class="wikitable"
! Code
! Result
|-
| <pre>{{ItemLink|Health Pickup}}</pre>
| {{ItemLink|Health Pickup}}
|}

== Default Item ==
If an item is misspelled, does not exist or simply has not been added to the template yet, it will show the default item image and link to the [[Items]] page ({{ItemLink|foo}}).

== Name ==
Names containing special characters are supported.

It is possible that the name appears different than that entered one:
<!-- please do not remove the repaced names (r) -->
<pre>{{ItemLink|Raw Steak}}</pre> Raw Steak will be displayed as {{ItemLink|Raw Steak}}. In these cases they are marked with an <sub>r</sub> (for renamed). All renamed Items will be listet in the category [[:Category:AutoRenamedItem|AutoRenamedItem]].

<pre>
* {{ItemLink|Rauser}}
* {{ItemLink|-Rauser}}
* {{ItemLink|Rauser NOEZ}}
* {{ItemLink|-Rauser NOEZ}}
* {{ItemLink|Rauser|showName=No Rauser}}
* {{ItemLink|Rauser|noRename=1}}
</pre>

* {{ItemLink|Rauser}}
* {{ItemLink|-Rauser}}
* {{ItemLink|Rauser NOEZ}}
* {{ItemLink|-Rauser NOEZ}}
* {{ItemLink|Rauser|showName=No Rauser}}
* {{ItemLink|Rauser|noRename=1}}

Wikimedia supports [https://www.mediawiki.org/wiki/Help:Interwiki_linking#linktrail linktrail] which allows to add specific charaters to an link:

<pre>[[Hedgehag]]s</pre>
[[Hedgehag]]s

Under specific conditions (parameter nowrap=0 is needed) Linktrail is supported by ItemLink:

<pre>{{ItemLink|Veggie Set|nowrap=0}}s</pre>
{{ItemLink|Veggie Set|nowrap=0}}s

If nowrap is nessesary:
<pre>{{Nowrap|{{ItemLink|Veggie Set|nowrap=0}}s}}</pre>
{{Nowrap|{{ItemLink|Veggie Set|nowrap=0}}s}}

Linktrail and renamed Items:
<pre>{{ItemLink|Rauser|nowrap=0}}s</pre>
{{ItemLink|Rauser|nowrap=0}}s

== Item Lists ==

{| class="wikitable"
! List
! Description
|-
| [[Template:ItemLink/iconList]]
| Contains all Icons
|-
| [[Template:ItemLink/nameList]]
| Contains all Items which should be Renamed
|-
| [[Template:ItemLink/anchorList]]
| Contains all Items which anchor should be Renamed
|-
| [[Template:ItemLink/linkList]]
| Contains all Links to the Item Pages
|}

Rules for the Item Lists
* All Items should be sorted by Id (That ist the position of the Entry inside the item-database.json. Alternative: [https://omegalink12.github.io/itemviewer/ ItemViewer on Github]) - Path to item-database.json:
** Mac OS
**# Open the .app package (Context Menu - show package)
**# Navigate to Contents/Resources/app.nw/data/item-database.json
** Windows
**# Create a copy of your Game (.exe)
**# Rename .exe to .zip
**# Unpack the zip file
**# Navigate to Contents/Resources/app.nw/data/item-database.json
* Only subsections should be editied
* Achor Nameing rules:
** Whitspace = _
** English Item-names only
** Only user the special Charaters _ and -
** Remove all other special Chars like ' . , # ; < > ( ) { } / \
** Remove all - if they are at first position: -Item -> Item
* Don't be shy. If there is a missing Item, add it.

{{doc/end}}