Editing Template:Tooltip job/doc

<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

Premade tooltips for jobs variants.

== Parameters ==
{| class="wikitable plainlist"
|-
! Parameter || Description || Required ||  Default 
|-
| 1 || Sets a premade tooltip from the [[#Samples|Samples]] section || '''required''' || —
|-
| 2 || Text inserted between job name and icon. || optional || —
|-
| text || Overrides the underlined text, including the icon. || optional || [[Template:Icon|<nowiki>{{icon|[1]|24px}}</nowiki>]] [2] [1]
|-
| plural
| 
* If set to <code>yes</code>, sets the jobs within the tooltip and the underlined text to plural
* If set to <code>head</code>, only sets the jobs within the underlined text to plural
* If set to <code>body</code>, only sets the jobs within the tooltip to plural
| optional
| —
|-
| exclude || Specifies a job group to exclude (see more info in [[#Samples|Samples]] section) || optional || —
|-
| include || Specifies a job group to include (see more info in [[#Samples|Samples]] section) || optional || —
|-
| index || Allows tooltip-in-a-tooltip functionality, only set to <code>2</code> or <code>3</code> || optional || —
|}

== Examples ==
<code><nowiki>{{Tooltip job|Miner|{{green|+1}}}}</nowiki></code>
{{Tooltip job|Miner|{{green|+1}}}}
<code><nowiki>{{Tooltip job|Metallurgist|{{green|+2}}|plural=yes}}</nowiki></code>
{{Tooltip job|Metallurgist|{{green|+2}}|plural=yes}}
<code><nowiki>{{Tooltip job|Administrator|{{green|+2}}|plural=yes|include=gestalt}}</nowiki></code>
{{Tooltip job|Administrator|{{green|+2}}|plural=yes|include=gestalt}}

== Samples ==
List of job samples transcluded into the tooltip from [[Template:Tooltip job/variants|Tooltip job/variants]].

{| class="wikitable plainlist"
! Parameter 1 !! Produces
! Excluded with "exclude="<br><span style="font-weight:normal">(included by default)</span>
! Included with "include="<br><span style="font-weight:normal">(not included by default)</span>
|-
| Metallurgist || {{Tooltip job|Metallurgist|include=prison}}
|
* {{tooltip job|metallurgist|exclude=gestalt|text={{iconify|Individualist}} jobs}} ('individual')
* {{tooltip job|metallurgist|exclude=individual|text={{iconify|Gestalt}} jobs}} ('gestalt')
* {{tooltip job|catalytic technician|text={{icon split|catalytic processing|catalytic processing corporate|catalytic processing hive dark|catalytic processing machine|cross=yes}} Catalytic jobs}} ('catalytic')
| {{tooltip job|penal metallurgist|text={{icon|penal colony modifier}} Penal Colony jobs}} ('prison')
|-
| Artisan || {{Tooltip job|Artisan|include=prison}} ||
* {{iconify|Artisan Drone}} ('gestalt')
* {{iconify|Artificer}} ('crafter')
| {{tooltip job|penal artisan|text={{icon|penal colony modifier}} Penal Colony jobs}} ('prison')
|-
| Researcher || {{Tooltip job|Researcher}} || {{iconify|Brain Drone}} ('hive') ||
|-
| Administrator || {{Tooltip job|Administrator|include=gestalt}} ||
* {{tooltip job|administrator|text={{iconify|Individualist}} jobs}} ('individual')
* {{tooltip job|manager|text={{iconify|Corporate}} jobs}} ('corporate')
|
* {{iconify|Synapse Drone}} ('gestalt', 'hive')
* {{iconify|Coordinator}} ('gestalt', 'machine')
* Included by default if excluded individualist jobs
|-
| Priest || {{Tooltip job|Priest|include=death priest}} || || {{iconify|Death Priest}} ('death priest')
|-
| High Priest || {{Tooltip job|High Priest}} || ||
|-
| Wrangler || {{Tooltip job|Wrangler}} || ||
|-
| Culture Worker || {{Tooltip job|Culture Worker}} || ||
|-
| Roboticist || {{Tooltip job|Roboticist}} || ||
|-
| Enforcer || {{Tooltip job|Enforcer}} || ||
|-
| Technician || {{Tooltip job|Technician}} || ||
|-
| Miner || {{Tooltip job|Miner|include=scrap miner}} || || {{Tooltip job|Scrap Miner}} ('scrap miner')
|-
| Scrap Miner || {{Tooltip job|Scrap Miner}} || ||
|-
| Farmer || {{Tooltip job|Farmer|include=angler}} || || {{iconify|Angler}} ('angler')
|-
| Clerk || {{Tooltip job|Clerk}} || ||
|-
| Soldier || {{Tooltip job|Soldier|include=slave}} || || {{iconify|Battle Thrall}} ('slave')
|-
| Chemist || {{Tooltip job|Chemist}} || ||
|-
| Gas Refiner || {{Tooltip job|Gas Refiner}} || ||
|-
| Translucer || {{Tooltip job|Translucer}} || ||
|-
| Mote Harvester || {{Tooltip job|Mote Harvester}} || ||
|-
| Gas Extractor || {{Tooltip job|Gas Extractor}} || ||
|-
| Crystal Miner || {{Tooltip job|Crystal Miner}} || ||
|}