Editing Module:Changelog/doc

=Overview=
Generates lines of changes for all data pages. See [[Category:Changelog Dates.json]] 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 <code><nowiki>{{sic}}</nowiki></code> 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 [[Module:Changelog/doc#Missing tags|#Missing tags]] for detailed examples
* Similarly named but unrelated entities (tags) are both mistakenly assigned, i.e. [[Barrage]] and [[Heavy Barrage]]. See [[Module:Changelog/doc#Similar tags are assigned|#Similar tags are assigned]] for detailed examples
* Entity is referenced but isn't affected by the change. See [[Module:Changelog/doc#Tag referenced but unaffected|#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 <code>Abrams: Shoulder Bash blah blah</code>

It will be assigned tags, <code>Shoulder Bash</code> since its named explicitly, and therefore <code>Ability</code>, <code>Abrams</code>, and <code>Hero</code>. 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 <code>Warp Stone: Distance traveled blah blah</code>, the tags assigned would be <code>Warp Stone</code> since its named explicitly, along with the tags <code>Item</code> and <code>Weapon Item</code>. 


==Missing tags==
Given the line <code>Yamato: Shadow Explosion bonus Spirit per victim increased from 10 to 15</code>, [[User:DeadBot]] will be able to assign the <code>Yamato</code> 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

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

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 <code>alt_name</code> 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

<pre>
        "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"
        ]
</pre>


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

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

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 <code>"Barrage"</code> and <code>"Pocket"</code>. To determine all related tags, see [[Module:Changelog/doc#Tag tree]].

The corrected list of tags would then be

<pre>
        "Tags": [
            "McGinnis",
            "Hero",
            "Heavy Barrage",
            "Ability",
        ]
</pre>

Similarly, for the following example

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

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



Another example, given the line:

<pre>
        "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"
        ]
</pre>

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

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

==Tag referenced but unaffected==
Given the line <code>Surge of Power: When the passive procs, you no longer get slowed when shooting (similar to Fleetfoot).</code>, [[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

<pre>
        "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"
        ]
</pre>

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

<pre>
        "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"
        ]
</pre>

=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 <code>Map</code> tag is assigned, no other tags should be assigned
* If <code>Weapon Item</code> is assigned, <code>Basic Magazine</code> shouldn't be assigned unless it is also referenced in the line, but <code>Item</code> should be assigned
* If <code>Basic Magazine</code> is assigned, <code>Weapon Item</code>, and <code>Item</code> should be assigned

=Invokes=
Invokes are callable by wikitext, i.e. <code><nowiki>{{#invoke|Changelog|invokable_name|param1|paramN}}</nowiki></code>

==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]]:
<code><nowiki>{{#invoke:Changelog|write_changelogs|Pocket}}</nowiki></code>

Outputs
{{#invoke:Changelog|write_changelogs|Pocket}}


For use on [[Pocket#Update history]]:
<code><nowiki>{{#invoke:Changelog|write_changelogs|Pocket|3}}</nowiki></code>

Outputs

{{#invoke:Changelog|write_changelogs|Pocket|3}}

==write_data_pages_list==
Writes list of all changelog data pages using the list of dates at [[Data:Changelog Dates.json]]. Used on [[Category:Changelog Dates]].

===Parameters===
None

===Examples===
<code><nowiki>{{#invoke:Changelog|write_data_pages_list}}</nowiki></code>

Outputs

{{#invoke:Changelog|write_data_pages_list}}

==write_changelog_by_date==
Write's a specific date's changelog, as opposed to a specific tag's changelog.

===Parameters===
* '''date_to_write''' - Date to write, format dd-mm-yyyy (for now)

===Examples===
<code><nowiki>{{#invoke:Changelog|write_changelog_by_date|05-03-2024}}</nowiki></code>

{{#invoke:Changelog|write_changelog_by_date|05-03-2024}}

==get_last_updated==
Retrieve the last date that a tag was updated on

===Parameters===
* '''tag''' - Tag to search

===Examples===
<code><nowiki>{{#invoke:Changelog|get_last_updated|Basic Magazine}}</nowiki></code>

Outputs

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


=Todo=
<b>Frontend</b>
* <i>Create a more generic icon template [[Template:PageRef]] for svg's with color inverting depending on light/dark mode