Editing Template:Jobs/doc

== Description ==
{{Lua|Module:Jobs|Module:Jobs/Data Crush Crush|Module:Jobs/Data Blush Blush}}
This template creates the icon and link for a [[:Category:Jobs|job]]. If job level is set to 0, outputs "Work at [Job]".

New job data can be added in the data modules.

'''NB''': As Crush Crush has two variations of the job ''Farmer'', the [[High Fantasy Event]] version should be referred to with the name ''Farmer (High Fantasy)''.

== List of Parameters ==
This template has 2 unnamed parameters:
#'''(mandatory)''' Name of the job. If set to Unknown no link is set.
#'''(optional)''' Height of the icon. Defaults to 20.
There is 1 mandatory named parameter:
*'''level''': Level of the job. Part of the text.
There are also 2 optional named parameters:
*'''title''': Displays the inputted title instead of the default output.
*'''bb''': Indicates if the job is in Blush Blush.

== Syntax ==
<pre>
{{Jobs
 | 1             = job name (i.e. image name)
 | 2             = image size
 | level         = 
 | title         = 
 | bb            = flag if the job is from Blush Blush
}}
</pre>

== Sample output ==
{{Jobs|Burger|level=1}}
<pre>
{{Jobs|Burger|level=1}}
</pre>
----
{{Jobs|Love|level=0}}
<pre>
{{Jobs|Love|level=0}}
</pre>
----
{{Jobs|A Job in Isengard|level=9|title=Uruk'hai}}
<pre>
{{Jobs|A Job in Isengard|level=9|title=Uruk'hai}}
</pre>

== Errors ==
* '''Incorrect Job name''': This error indicates that the template could not find data for job matching the name given. This likely indicates one of three issues:
# A typo in the template parameters
# Incorrect "bb" parameter (trying to show a BB job and no parameter, or other way round)
# The data is not present in the data modules
----
<templatedata>
{
	"format": "inline",
	"params": {
		"1": {
			"required": true,
			"description": "The name of the Job.",
			"example": "Burger",
			"type": "string",
			"label": "Job Name"
		},
        "2": {
			"suggested": false,
			"description": "The pixel size of the job icon",
			"example": "25",
			"type": "string",
			"label": "Icon Size",
            "default": "20"
		},
        "level": {
			"required": true,
			"description": "The level of the job.",
			"example": "5",
			"type": "string",
			"label": "Job Level"
		},
        "title": {
			"suggested": false,
			"description": "The title of the job at that level.",
			"example": "Flipper",
			"type": "string",
			"label": "Job Level Title"
		},
        "bb": {
			"suggested": false,
			"description": "Indicator if the job is from Blush Blush",
			"example": "yes, y",
			"type": "string",
			"label": "Blush Blush Job Flag",
            "default": "no"
		}
	},
	"paramOrder": [
		"1",
        "2",
        "level",
        "title",
        "bb"
	],
	"format": "{{_\n|_________________ = _\n}}\n",
	"description": "Template that creates an inline string with Job Icon and job title."
}
</templatedata>
<includeonly>[[Category:Display Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>