Editing Template:DropsLine/doc

{{Documentation}}
{{ToC|right}}
The '''DropsLine''' templates are used to list a monster's drops. Three templates are used to form the drop logs:

* {{T|DropsTableHead}} - Contains table headers for the top of the drop table
* {{T|DropsLine}} - Template for all of the individual drop lines
* {{T|DropsTableBottom}}  - Contains table footers for the bottom of the drop table

==Usage==
<pre>{{DropsTableHead}}
{{DropsLine
|name          = Name of item
|displayname   = Alternate name to show in the drops table
|quantity      = Quantity(s) dropped by source. Separate with commas. If unknown, leave blank or use "Unknown."
|frequency     = How frequent the item is, specify as a fraction (eg. "1/128") or use: Always, Common, Uncommon, Rare, Unknown
|image         = (Optional) Manual addition or override of the image icon. Don't add [[File:_]]
}}
{{DropsTableBottom}}
</pre>

The template should be used in one line, like the examples below.

===Unfilled drop lines for quick copy-paste===
;Standard
<code><nowiki>{{</nowiki>DropsLine|name=|quantity=|frequency=}}</code>
;Alternative name
<code><nowiki>{{</nowiki>DropsLine|name=|displayname=|quantity=|frequency=}}</code>
;Alternative image
<code><nowiki>{{</nowiki>DropsLine|name=|image=|quantity=|frequency=}}</code>

==Parameter details==
===name===
Name of the item/drop, should link directly to the article.

===displayname (optional)===
If the link to the dropped item should have text that does not match its article name, this parameter can be used to adjust the displayed text for the link.

===quantity===
Quantity of the item dropped by the source. If multiple quantities are randomly dropped, list them all and separate with commas. Do not use commas as thousand separators. If a range is dropped specify this with a dash as in ''1-3''.

The quantity column automatically detects several types of ranges:
* Several individual values separated with commas, e.g. 1,4,7
** Uses the first and the last values (not max and min; numbers in the middle ignored), so make sure to order them in ascending order.
* A range in the form ''min-max'', e.g. 1-10
** Uses the number on the left of the - as min, and the right as max
* A combination of the above two, e.g. 1-3,5,7-9,11
** First separates by commas, then if the first is a range, uses the left of the - as min; if the last is a range, uses the right of the - as max; otherwise if either is not a range uses the number that is there as min or max, respectively. In the example, the min number would be 1 and the max 11. Make sure they're ordered in ascending order.

===frequency===
Frequency of the item being dropped. Frequency can either be a number or a category, a number is preferred.

'''''Note:''' This is not the rarity of a piece of equipment.''

====Number====
They should generally be added as a fraction, e.g. <code>1/128</code>, <code>10/512</code>, <code>1/5000</code> etc. The template will automatically provide colours and similar.

====Category====
Categories should be used if there's no good way to find an accurate drop chance. There are 6 available options:
{| class="wikitable align-center-1"
! Rarity
! Explanation
|-
| class="table-bg-blue" | Always
| Always dropped
|-
| class="table-bg-green" | Common
| The most common of items. Renowned for being common. Nearly always dropped.
|-
| class="table-bg-yellow" | Uncommon
| Dropped sometimes, but not necessarily renowned for being common.
|-
| class="table-bg-orange" | Rare
| Rarely dropped. Will take quite a few drops to obtain.
|-
| class="table-bg-red" | Very rare
| Renowned for being rare among players. Hardly ever dropped.
|}

===image (optional)===
A manual configuration of the item's image. Only use this parameter when the image name (minus extension) does not exactly match the item name. Casing is important, so be sure the <code>name</code> parameter also leads directly to the item's page. Do not add square brackets and the "File:" prefix. Just use "Name.png".

{{TemplateData|<templatedata>
{
	"params": {
		"name": {
			"label": "Name",
			"description": "Name of the item's article page",
			"example": "Cabbage",
			"type": "wiki-page-name",
			"required": true
		},
		"quantity": {
			"label": "Quantity",
			"description": "Quantity of the item dropped by the source. Can be a comma-separated list and/or range. Include (noted) if it applies.",
			"example": "1-10",
			"type": "string",
			"required": true
		},
		"frequency": {
			"label": "Frequency",
			"description": "Frequency of the item dropping. Frequency can either be a number or a category, a number is preferred.",
			"example": "1/128",
			"type": "string",
			"required": true
		},
		"rarity": {
			"label": "Rarity",
			"description": "Rarity level of the item, such as Common, Uncommon, Rare, or Very rare.",
			"example": "Common",
			"type": "string",
			"required": false
		},
		"image": {
			"label": "Image",
			"description": "A manual configuration of the item's image. Only use this parameter when the image name (minus extension) does not exactly match the item name.",
			"example": "Cabbage.png",
			"type": "wiki-file-name"
		}
	},
	"description": "Template for an individual drop line inside drop tables.",
	"format": "\n{{_|_=_}}\n"
}
</templatedata>}}