Module:Changelog

From Deadlock Wiki
Revision as of 19:23, 8 October 2024 by Sur (talk | contribs) (invoke_date_tag_to_lines in place of test)
Jump to navigation Jump to search

Overview

Generates lines of changes for all data pages. See [[Category:Changelog Dates]] for the dates of all changelogs, and Changelogs for list of all the data pages that contain a Changelog.

Functions

All of these functions are callable by wikitext, i.e. {{#invoke|Changelog|invokable_name|param1|paramN}}

write_changelog_by_tag

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_changelog_by_tag|Pocket}}

Outputs Script error: The function "write_changelog_by_tag" does not exist.


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

Outputs

Script error: The function "write_changelog_by_tag" does not exist.

write_changelog_by_date_id

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

Parameters

  • date_id_to_write - Date-id to write, format yyyy-mm-dd, view all at [[Category:Changelog Dates]]

Examples

For a non-herolab patch page
{{#invoke:Changelog|write_changelog_by_date_id|2024-05-03}}

Script error: The function "write_changelog_by_date_id" does not exist.


For a herolab patch page
{{#invoke:Changelog|write_changelog_by_date_id|2024-12-06_HeroLab}}

Script error: The function "write_changelog_by_date_id" does not exist.

write_data_pages_list

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

Parameters

None

Examples

{{#invoke:Changelog|write_data_pages_list}}

Outputs

Script error: The function "write_data_pages_list" does not exist.

get_last_updated

Retrieve the last (or first) date that a tag was updated on. Planned to be used on a given tag's page, i.e. Abrams's infobox could mention that it was last updated on 2024-05-03, or that Mirage was released on 2024-05-03, etc.

Parameters

  • tag - Tag to search
  • last_or_first - Named optional - Must be last or first - defaults to last - Retrieves last or first date

Examples

Example using last {{#invoke:Changelog|get_last_updated|Basic Magazine}}

Outputs

Script error: The function "get_last_updated" does not exist.


Example using first {{#invoke:Changelog|get_last_updated|Basic Magazine|last_or_first=first}}

Outputs

Script error: The function "get_last_updated" does not exist.


local p = {};

--Only Data:Changelog_05-03-2024.json is loaded right now, as it still needs work and for now it was uploaded manually, need an uploader script to handle it
--Returns all lines of a given date that has that tag
local function date_tag_to_lines(date, tag_to_filter) 
	-- Get the data for the respective line
	local changelog_data = mw.loadJsonData("Data:Changelog_" .. date .. ".json")
	local lines = ""
	for index, line in ipairs(changelog_data) do
		description = line["Description"]
		for index2, tag in ipairs(line["Tags"]) do
			if tag == tag_to_filter then
				lines = lines .. description .. "<br>"
			end
		end
	end
	return lines
end

--testing by invoke in sandbox, will be called properly by other funcs later
p.invoke_date_tag_to_lines = function(frame)
	date = frame.args[1]
	tag = frame.args[2]
	return date_tag_to_lines(date, tag)
end

return p