Template:ItemLink/doc: Difference between revisions
Streetclaw (talk | contribs) |
Streetclaw (talk | contribs) (→Return information (internal use): Anchor & Link deprecated) |
||
| Line 74: | Line 74: | ||
=== Return information (internal use) === | === Return information (internal use) === | ||
{{TemplateData| | {{TemplateData| | ||
{{TemplateData/entry|name=Anchor return (Data override)|param=anchorOverride|desc=Internal use only (return the anchor-name) - overrides all other parameter except linkOverride and nowrap|def=0|example={{ItemLink|Geo-Data #3469|anchorOverride=1}} <pre>{{ItemLink|Geo-Data #3469|anchorOverride=1}}</pre> {{ItemLink|Grasswalkers|anchorOverride=1}} <pre>{{ItemLink|Grasswalkers|anchorOverride=1}}</pre>|type=Boolean|status= | {{TemplateData/entry|name=Anchor return (Data override)|param=anchorOverride|desc=Internal use only (return the anchor-name) - overrides all other parameter except linkOverride and nowrap|def=0|example={{ItemLink|Geo-Data #3469|anchorOverride=1}} <pre>{{ItemLink|Geo-Data #3469|anchorOverride=1}}</pre> {{ItemLink|Grasswalkers|anchorOverride=1}} <pre>{{ItemLink|Grasswalkers|anchorOverride=1}}</pre>|type=Boolean|status=Deprecated}} | ||
{{TemplateData/entry|name=Link return (Data override)|param=linkOverride|desc=Internal use only (return the link) - overrides all other parameter and anchorOverride|def=0|example={{ItemLink|Geo-Data #3469|linkOverride=1}} <pre>{{ItemLink|Geo-Data #3469|linkOverride=1}}</pre>|type=Boolean|status= | {{TemplateData/entry|name=Link return (Data override)|param=linkOverride|desc=Internal use only (return the link) - overrides all other parameter and anchorOverride|def=0|example={{ItemLink|Geo-Data #3469|linkOverride=1}} <pre>{{ItemLink|Geo-Data #3469|linkOverride=1}}</pre>|type=Boolean|status=Deprecated}} | ||
{{TemplateData/entry|name=Level return (Data override)|param=levelOverride|desc=disable or enable levelOverride (return the level)|def=0|example= | {{TemplateData/entry|name=Level return (Data override)|param=levelOverride|desc=disable or enable levelOverride (return the level)|def=0|example= | ||
* levelOverride: {{ItemLink|Scrappy Plate|levelOverride=1}} | * levelOverride: {{ItemLink|Scrappy Plate|levelOverride=1}} | ||
Revision as of 14:14, 14 July 2020
This is a template for adding links to items.
About
Add a link to the Item. There are many possibitities to customize the behavior.
Parameter
Item name
Do not use named parameter for 1 ... x. The first Parameter will be automatically marked as 1, the second as 2 and so on.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Item Name | 1
|
Item name
|
String | Required |
| Name Override | showName
|
Shows the defined name/Overrides the Item-Name (alternative Name)
|
String | Optional |
See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Item Name | 1 | Item name
| String | required |
| Name Override | showName | Shows the defined name/Overrides the Item-Name (alternative Name)
| String | optional |
Hide and show elements
Do not use named parameter for 1 ... x. The first Parameter will be automatically marked as 1, the second as 2 and so on.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| No Icon | noIcon
|
Hides the Icon
|
Boolean | Optional |
| No Link | noLink
|
Removes the link |
Boolean | Optional |
| No level | noLevel
|
Hides the level
|
Boolean | Optional |
| Show Food Icon | showFoodIcon
|
Show the food icon
|
Boolean | Optional |
See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| No Icon | noIcon | Hides the Icon
| Boolean | optional |
| No Link | noLink | Removes the link
| Boolean | optional |
| No level | noLevel | Hides the level
| Boolean | optional |
| Show Food Icon | showFoodIcon | Show the food icon
| Boolean | optional |
Wrap behavior
Do not use named parameter for 1 ... x. The first Parameter will be automatically marked as 1, the second as 2 and so on.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Disable brakes | nowrap
|
disable or enable Nowrap (prevent line breaks)
|
Boolean | Optional |
See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Disable brakes | nowrap | disable or enable Nowrap (prevent line breaks)
| Boolean | optional |
Custom Level
The associated equipment level is shown by default. Use the option only for an deviating equipment level or for adding a level to non equipment items.
Do not use named parameter for 1 ... x. The first Parameter will be automatically marked as 1, the second as 2 and so on.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Level override | level
|
Set a custom level to display. Use e.g.
|
LevelNumberFill | Optional |
See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Level override | level | Set a custom level to display. Use e.g. <code>02</code> not <code>2</code>.
| Number | optional |
Custom Food icon
The food icon is hidden by default see Hide and show elements for showing the associated food icon.
Do not use named parameter for 1 ... x. The first Parameter will be automatically marked as 1, the second as 2 and so on.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Food icon override | foodIcon
|
Set a custom food icon
|
String | Optional |
See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Food icon override | foodIcon | Set a custom food icon
| String | optional |
Disable auto-rename
Do not use named parameter for 1 ... x. The first Parameter will be automatically marked as 1, the second as 2 and so on.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| No Rename | noRename
|
disable or enable noRename (prevent auto-rename) |
Boolean | Optional |
See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| No Rename | noRename | disable or enable noRename (prevent auto-rename)
| Boolean | optional |
Return information (internal use)
Do not use named parameter for 1 ... x. The first Parameter will be automatically marked as 1, the second as 2 and so on.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Anchor return (Data override) | anchorOverride
|
Internal use only (return the anchor-name) - overrides all other parameter except linkOverride and nowrap
|
Boolean | Deprecated |
| Link return (Data override) | linkOverride
|
Internal use only (return the link) - overrides all other parameter and anchorOverride
|
Boolean | Deprecated |
| Level return (Data override) | levelOverride
|
disable or enable levelOverride (return the level)
|
Boolean | Optional |
See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Anchor return (Data override) | anchorOverride | Internal use only (return the anchor-name) - overrides all other parameter except linkOverride and nowrap
| Boolean | deprecated |
| Link return (Data override) | linkOverride | Internal use only (return the link) - overrides all other parameter and anchorOverride
| Boolean | deprecated |
| Level return (Data override) | levelOverride | disable or enable levelOverride (return the level)
| Boolean | optional |
Special Items
| Code | Result |
|---|---|
{{ItemLink|Health Pickup}}
|
 Health Pickup
|
Invalid Item
If an item is misspelled, does not exist or simply has not been added to the template will show a broken icon.
Name
Names containing special characters (#) are not supported. Remove them and use showName for this characters.
It is possible that the name appears different than that entered one:
{{ItemLink|Rauser}} Rauser will be displayed as LV01
-Rauserr. In these cases they are marked with an r (for renamed). All renamed Items will be listet in the category AutoRenamedItem.
* {{ItemLink|Rauser}}
* {{ItemLink|-Rauser}}
* {{ItemLink|Rauser|showName=No Rauser}}
* {{ItemLink|Rauser|noRename=1}}
Wikimedia supports linktrail which allows to add specific characters to an link:
[[Hedgehag]]s
{{ItemLink|Veggie Set}}s results in 
Veggie Sets
Under specific conditions (parameter nowrap=0 is needed) Linktrail is supported by ItemLink:
{{ItemLink|Veggie Set|nowrap=0}}s
If nowrap is necessary:
{{Nowrap|{{ItemLink|Veggie Set|nowrap=0}}s}}
Linktrail and renamed Items:
{{ItemLink|Rauser|nowrap=0}}s
LV01-Rauserrs
Item Lists
| List | Description |
|---|---|
| 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 |
| Template:ItemLink/levelList | Contains all Level data |
| Template:ItemLink/foodIconList | Contains all Food icons |
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: 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
- Mac OS
- Only subsections should be editied
- Achor Nameing rules:
- Whitspace = _
- English Item-names only
- Only use the special characters _ 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.
Examples
| Code | Result |
|---|---|
{{ItemLink|Winterclaw}}
|
LV26 Winterclaw
|
{{ItemLink|Geo-Data 3469|showName=Geo-Data #3469}}
|
 Geo-Data #3469
|
{{ItemLink|Recruit's Scope}}
|
LV11 Recruit's Scope
|
{{ItemLink|Ginger Tom. Salad|showName=Blattsalat|noLink=1}}
|
 Blattsalat
|
Raw Example text
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Thief's Key Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.