Template:Mastery group/doc: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Documentation subpage}} {{Lua|Module:Mastery group}} __TOC__ The '''Mastery group''' template is used to submit mastery group data to the cargo data base. It should be use...") |
|||
(2 intermediate revisions by one other user not shown) | |||
Line 16: | Line 16: | ||
Example for exporting by id: | Example for exporting by id: | ||
<code>pypoe_exporter wiki mastery groups id --wiki --wiki-user <username> --wiki-password <bot_password> < | <code>pypoe_exporter wiki mastery groups id --wiki --wiki-user <username> --wiki-password <bot_password> <id_of_the_mastery_group1> [id_of_the_mastery_group2] [...] [id_of_the_mastery_group3]</code> | ||
==Parameters== | ==Parameters== | ||
Line 37: | Line 37: | ||
| {{yes}} | | {{yes}} | ||
| mastery_groups.id | | mastery_groups.id | ||
| Internal Id of the mastery | | Internal Id of the mastery group. | ||
| {{n/a}} | | {{n/a}} | ||
|- | |- | ||
Line 53: | Line 53: | ||
| {{no}} | | {{no}} | ||
| mastery_groups.main_page | | mastery_groups.main_page | ||
| Name of the main article for this mastery | | Name of the main article for this mastery in the wiki. | ||
This is used for linking to articles; if left empty, the name will be used instead. | This is used for linking to articles; if left empty, the name will be used instead. | ||
| {{n/a}} | |||
|- | |||
| '''icon''' | |||
| str | |||
| {{yes}} | |||
| {{yes}} | |||
| mastery_groups.icon | |||
| Filename of the icon of the mastery group | |||
| {{n/a}} | |||
|- | |||
| '''mastery_effects''' | |||
| list of str | |||
| {{yes}} | |||
| {{yes}} | |||
| mastery_groups.mastery_effects | |||
| A list of ids of mastery effects for this mastery. Points to <code>mastery_effects</code> | |||
| {{n/a}} | | {{n/a}} | ||
|} | |} | ||
==Cargo | ==Cargo== | ||
{| class="wikitable" | |||
{|class="wikitable" | ! Table !! Declared by !! Attached by | ||
! | |- | ||
! | | [[Special:CargoTables/mastery_groups|mastery_groups]] | ||
|- | | {{tl|Mastery group/cargo/mastery groups/declare}} | ||
| mastery_groups | | {{tl|Mastery group/cargo/mastery groups/attach}} | ||
| {{ | |||
|} | |} | ||
Latest revision as of 16:28, 27 June 2022
This subpage provides documentation for Template:Mastery group.
The Mastery group template is used to submit mastery group data to the cargo data base. It should be used from the main page for the mastery group.
Overview
The template will do the following:
- add cargo data to the page
- show an infobox showing the information for a mastery
PyPoE export
PyPoE can be used to export this data from the game to the wiki. pypoe_exporter wiki mastery groups
is responsible for handling the export.
Example for exporting by id:
pypoe_exporter wiki mastery groups id --wiki --wiki-user <username> --wiki-password <bot_password> <id_of_the_mastery_group1> [id_of_the_mastery_group2] [...] [id_of_the_mastery_group3]
Parameters
These correspond to fields in the cargo tables.
General
Parameter | Type | PyPoE Export |
Required | Field | Description | Default |
---|---|---|---|---|---|---|
id | str (unique) | ✓
|
✓
|
mastery_groups.id | Internal Id of the mastery group. | N/A |
name | str | ✓
|
✓
|
mastery_groups.name | Name of the mastery as it appears in the skill tree | N/A |
main_page | str | ✗
|
✗
|
mastery_groups.main_page | Name of the main article for this mastery in the wiki.
This is used for linking to articles; if left empty, the name will be used instead. |
N/A |
icon | str | ✓
|
✓
|
mastery_groups.icon | Filename of the icon of the mastery group | N/A |
mastery_effects | list of str | ✓
|
✓
|
mastery_groups.mastery_effects | A list of ids of mastery effects for this mastery. Points to mastery_effects
|
N/A |
Cargo
Table | Declared by | Attached by |
---|---|---|
mastery_groups | {{Mastery group/cargo/mastery groups/declare}} | {{Mastery group/cargo/mastery groups/attach}} |