Module:Changelog/doc

Overview

Generates lines of changes for all data pages. See for the dates of all changelogs, and Changelog for list of all the data pages that contain a Changelog.

How to edit changelogs

Each changelogs should be exactly as written on the forum post, so edits are rarely justified, below are the exceptions to look out for

• Typos by the poster should have {{sic}} added so that readers know the typoe was intentionally written verbatim
• An entity's name is old, i.e. Yamato's Shadow Explosion was renamed to Shadow Transformation. See #Missing tags for detailed examples
• Similarly named but unrelated entities (tags) are both mistakenly assigned, i.e. Barrage and Heavy Barrage. See #Similar tags are assigned for detailed examples
• Entity is referenced but isn't affected by the change. See #Tag referenced but unaffected for a detailed example

What are tags?

Each line in a changelog is parsed by User:DeadBot to have certain tags assigned to it. For example, if the forum post looks like Abrams: Shoulder Bash blah blah

It will be assigned tags, Shoulder Bash since its named explicitly, and therefore Ability, Abrams, and Hero. This will make this line added to all changelogs on pages Abrams/Update history, Shoulder Bash/Update history, Ability/Update history, and Hero/Update history.

Similarly, for the line Warp Stone: Distance traveled blah blah, the tags assigned would be Warp Stone since its named explicitly, along with the tags Item and Weapon Item.

Missing tags

Given the line Yamato: Shadow Explosion bonus Spirit per victim increased from 10 to 15, User:DeadBot will be able to assign the Yamato tag, but will not know which ability it is referring to, as Yamato's ability was renamed to Shadow Transformation. This would originally appear as

        "Description": "* {{PageRef|Yamato}}: Shadow Explosion bonus Spirit per victim increased from 10 to 15",
        "Tags": [
            "Yamato",
            "Hero"
        ]

To correct is, simply add the related tags for Shadow Transformation. To determine the related tags, see To see all related tags, see Module:Changelog/doc#Tag tree. Add the call to Template:PageRef in the description. The alt_name parameter will need to be passed to nickname the ability as Shadow Explosion, so that it stays written as is, but still links and is added to the relevant pages. The corrected changelog would then be

        "Description": "* {{PageRef|Yamato}}: {{PageRef|Shadow Transformation|alt_name=Shadow Explosion}} bonus Spirit per victim increased from 10 to 15",
        "Tags": [
            "Yamato",
            "Hero",
            "Ability",
            "Shadow Transformation"
        ]

Similar tags are assigned

Given the line * McGinnis: Heavy Barrage spirit scaling increased from 0.3 to 0.35, User:DeadBot will see both [[McGinnis]' Heavy Barrage ability and Pocket's Barrage ability and assign both as tags. This would originally appear as

        "Description": "* {{PageRef|McGinnis}}: {{PageRef|Heavy Barrage}} spirit scaling increased from 0.3 to 0.35",
        "Tags": [
            "McGinnis",
            "Hero",
            "Heavy Barrage",
            "Ability",
            "Barrage",
            "Pocket"
        ]

To correct it, first determine if its referring to McGinnis' Heavy Barrage or Pocket's Barrage. In this case, it is quite obvious that its referring to McGinnis' Heavy Barrage. Then, simply remove all tags related to Pocket's Barrage. This includes both "Barrage" and "Pocket". To determine all related tags, see Module:Changelog/doc#Tag tree.

The corrected list of tags would then be

        "Tags": [
            "McGinnis",
            "Hero",
            "Heavy Barrage",
            "Ability",
        ]

Similarly, for the following example

        "Description": "* {{PageRef|Torment Pulse}}: Interval improved from 2s to 1.5s",
        "Tags": [
            "Torment Pulse",
            "Item",
            "Spirit Item",
            "Pulse",
            "Ability",
            "Rutger",
            "Hero"
        ]

It is actually referring to Torment Pulse the Item, so the tags "Pulse", "Ability", and "Rutger", "Hero" would all need to be removed.

Another example, given the line:

        "Description": "* {{PageRef|Cosmic Veil|alt_name=Veil}} {{PageRef|Walker}}: Cooldown increased from 20s to 25s",
        "Tags": [
            "Veil Walker",
            "Item",
            "Vitality Item",
            "Objective",
            "NPC",
            "Walker"
            "Cosmic Veil"
        ]

Here, the changelog is clearly referring to the item Veil Walker, not Cosmic Veils and Walkers. The fixed line would be:

        "Description": "* {{PageRef|Veil Walker}}: Cooldown increased from 20s to 25s",
        "Tags": [
            "Veil Walker",
            "Item",
            "Vitality Item",
            "Objective",
            "NPC",
        ]

Tag referenced but unaffected

Given the line Surge of Power: When the passive procs, you no longer get slowed when shooting (similar to Fleetfoot)., User:DeadBot will assign the tag Fleetfoot and all its related tags, even if Fleetfloot wasn't actually changed or modified at all. This would originally appear as

        "Description": "* {{PageRef|Surge of Power}}: When the passive procs, you no longer get slowed when shooting (similar to {{PageRef|Fleetfoot}})",
        "Tags": [
            "Fleetfoot",
            "Item",
            "Weapon Item",
            "Surge of Power",
            "Spirit Item"
        ]

To correct it, remove Fleetfoot and all its related tags (Weapon Item tag in this case), but leave the call to PageRef so that it can still refer users to the Fleetfoot page. After correction it should be

        "Description": "* {{PageRef|Surge of Power}}: When the passive procs, you no longer get slowed when shooting (similar to {{PageRef|Fleetfoot}})",
        "Tags": [
            "Item",
            "Surge of Power",
            "Spirit Item"
        ]

Tag tree

The tag tree is how to determine what tags are related. Given a tag, the tags that are in the same chain and have a shorter indentation will/should also be added to the list of tags.

For example, any change to Frost Bomb will also be referenced on the pages Ability, Kelvin, and Hero.

• Hero
  • <hero_name> i.e. Abrams
    • Ability
      • <ability_name> i.e. Frost Bomb
• Item
  • Weapon Item
    • <weapon_item_name> i.e. Basic Magazine
  • Vitality Item
    • <vitality_item_name> i.e. Extra Health
  • Spirit Item
    • <spirit_item_name> i.e. Boundless Spirit
• Map
• Other

More Tag tree examples:

• If Map tag is assigned, no other tags should be assigned
• If Weapon Item is assigned, Basic Magazine shouldn't be assigned unless it is also referenced in the line, but Item should be assigned
• If Basic Magazine is assigned, Weapon Item, and Item should be assigned

Invokes

Invokes are callable by wikitext, i.e. {{#invoke|Changelog|invokable_name|param1|paramN}}

write_changelogs

The main invokable that will be used. Given a specific tag, it outputs all relevant changelogs from all dates in a Template:Update history table.

Parameters

• tag - Tag to search relevant changelogs for. Should be localized, i.e. Abrams for hero_atlas in english.
• num_dates - (OPTIONAL) Number of dates to add, recommend 3 for articles. If unprovided, defaults to all.

Examples

For use on Pocket/Update history: {{#invoke:Changelog|write_changelogs|Pocket}}

Outputs

Update	Changes
May 10, 2024	- {{HeroIcon|Pocket}} Pocket Enchanter’s Satchel visual effects updated - Fixed a bug where {{HeroIcon|Pocket}} Pocket’s briefcase would stop animating when the duration upgrade was taken
May 3, 2024	- Pocket's nerf gun now does.. blah blah - Siphon Life now does.. blah blah

For use on Pocket#Update history: {{#invoke:Changelog|write_changelogs|Pocket|3}}

Outputs

Update	Changes
May 10, 2024	- {{HeroIcon|Pocket}} Pocket Enchanter’s Satchel visual effects updated - Fixed a bug where {{HeroIcon|Pocket}} Pocket’s briefcase would stop animating when the duration upgrade was taken
May 3, 2024	- Pocket's nerf gun now does.. blah blah - Siphon Life now does.. blah blah

write_data_pages_list

Writes list of all changelog data pages using the list of dates at Data:Changelog Dates.json. Used on .

Parameters

None

Examples

{{#invoke:Changelog|write_data_pages_list}}

Outputs

Data:Changelog 05-10-2024.json
Data:Changelog 05-03-2024.json

get_last_updated

Retrieve the last date that a tag was updated on

Parameters

• tag - Tag to search

Examples

{{#invoke:Changelog|get_last_updated|Basic Magazine}}

Outputs

05-03-2024

Todo

Frontend

• Create a more generic icon template Template:PageRef for svg's with color inverting depending on light/dark mode