Module:Changelog/doc: Difference between revisions

Generates lines of changes for all data pages. See [[Category:Changelog Dates]] 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 it was intentionally written verbosely by the wiki

* An entity's name is old, i.e. [[Yamato]]'s [[Shadow Explosion]] was renamed to [[Shadow Transformation]]. See [[Module:Changelog/doc#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]] for detailed examples

* Entity is referenced but isn't affected by the change. See [[Module:Changelog/doc#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

The "Abrams: Shoulder Bash blah blah" line will be assigned tags, 'Shoulder Bash' since its named explicitly, and therefore 'Abilities', 'Abrams', and 'Heroes'. This will make this line added to all changelogs on pages [[Abrams/Update history]], [[Shoulder Bash/Update history]], [[Abilities/Update history]], and [[Heroes/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 'Items' and 'Weapon Items'.

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

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

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

            "Yamato",

==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

        "Description": "* {{PageRef|McGinnis}}: {{PageRef|Heavy Barrage}} spirit scaling increased from 0.3 to 0.35",

        "Tags": [

Similarly, for the following example

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

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

 

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

 

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 [[Abilities]], [[Kelvin]], and [[Heroes]].

 

** <hero_name> i.e. [[Abrams]]

 

* If <code>Weapon Items</code> is assigned, <code>Basic Magazine</code> shouldn't be assigned unless it is also referenced in the line, but <code>Items</code> should be assigned

* If <code>Basic Magazine</code> is assigned, <code>Weapon Items</code>, and <code>Items</code> should be assigned

 

 

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]].

* '''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.

<code><nowiki>{{#invoke:Changelog|write_changelogs|Pocket}}</nowiki></code>

 

 

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

 

 

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

{{#invoke:Changelog|write_data_pages_list}}

 

=Todo=

* <s>Switch <code><nowiki>{{Icon}} with {{PageRef}}</nowiki></code></s>