Template:Quest/doc: Difference between revisions
>OmegaK2 |
(Use Template:Tooltip unless it's actually an abbreviation.) |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | |||
{{lua|Module:Quest}} | {{lua|Module:Quest}} | ||
| Line 4: | Line 6: | ||
==Overview== | ==Overview== | ||
In order to stream-line quest pages and make further additions easier to track as well as automatically populating certain section this template exists. | |||
See the arguments below for a description on the options of this template. In particular, there are also the following automatic features: | |||
* Creating & populating quest rewards and vendor rewards automatically if those exist | |||
* Adding quest and quest act categories | |||
* Creating a formatted infobox with the main information | |||
==Arguments== | ==Arguments== | ||
| Line 11: | Line 20: | ||
! Argument | ! Argument | ||
! Description | ! Description | ||
! {{ | ! {{tooltip|Lua|Used in the lua moduled?}} | ||
! {{ | ! {{tooltip|Min|Should this option be included in a minimal template?}} | ||
! {{ | ! {{tooltip|Opt|Is this optional optional?}} | ||
|- | |- | ||
| name | | name | ||
| Line 28: | Line 37: | ||
|- | |- | ||
| boss | | boss | ||
| | | Either accepts the boss name or a number. | ||
If a boss is specified, it will generate a link and image to the boss in the appropinate field. | |||
If a number is specified, it is the number of bosses. Each individual boss can then be specified as boss1, boss2, boss3 ... bossN | |||
| {{yes}} | |||
| {{no}} | |||
| {{yes}} | |||
|- | |||
| boss_link | |||
| Specifiy this if the linked boss page differs from the boss name. | |||
| {{yes}} | | {{yes}} | ||
| {{no}} | | {{no}} | ||
| Line 34: | Line 52: | ||
|- | |- | ||
| boss_image | | boss_image | ||
| | | Specify this if the boss image is different from the default "boss.png". Consider moving the image for consistency before setting this option | ||
| {{yes}} | | {{yes}} | ||
| {{no}} | | {{no}} | ||
| Line 70: | Line 88: | ||
|- | |- | ||
| act | | act | ||
| | | | ||
| {{no}} | | {{no}} | ||
| Line 81: | Line 93: | ||
| {{yes}} | | {{yes}} | ||
|} | |} | ||
==Template== | |||
===Minimal=== | |||
<nowiki>{{Quest | |||
|name= | |||
|boss= | |||
|required= | |||
|start= | |||
|objective= | |||
|completion= | |||
|act= | |||
}}</nowiki> | |||
===Full=== | |||
<nowiki>{{Quest | |||
|name= | |||
|icon= | |||
|boss= | |||
|boss_image= | |||
|required= | |||
|start= | |||
|objective= | |||
|completion= | |||
|key_item= | |||
|act= | |||
}}</nowiki> | |||
{{Documentation categories| | |||
<!-- Categories and interwikis go here. --> | |||
[[Category:Query templates]] | |||
[[Category:Table templates]] | |||
{{sister|poewiki}} | |||
}} | |||
Latest revision as of 18:25, 20 March 2025
This subpage provides documentation for Template:Quest.
Overview
In order to stream-line quest pages and make further additions easier to track as well as automatically populating certain section this template exists.
See the arguments below for a description on the options of this template. In particular, there are also the following automatic features:
- Creating & populating quest rewards and vendor rewards automatically if those exist
- Adding quest and quest act categories
- Creating a formatted infobox with the main information
Arguments
| Argument | Description | Lua | Min | Opt |
|---|---|---|---|---|
| name | ||||
| icon | ||||
| boss | Either accepts the boss name or a number.
If a boss is specified, it will generate a link and image to the boss in the appropinate field. If a number is specified, it is the number of bosses. Each individual boss can then be specified as boss1, boss2, boss3 ... bossN |
|||
| boss_link | Specifiy this if the linked boss page differs from the boss name. | |||
| boss_image | Specify this if the boss image is different from the default "boss.png". Consider moving the image for consistency before setting this option | |||
| key_item | ||||
| required | ||||
| start | ||||
| objective | ||||
| completion | ||||
| act |
Template
Minimal
{{Quest |name= |boss= |required= |start= |objective= |completion= |act= }}
Full
{{Quest |name= |icon= |boss= |boss_image= |required= |start= |objective= |completion= |key_item= |act= }}