Module:Infobox - Revision history

76561197969631737: Updated doc; added generic range title; maybe fixed the extraneous separator issue

2023-12-24T15:43:25Z

Updated doc; added generic range title; *maybe* fixed the extraneous separator issue

← Older revision		Revision as of 15:43, 24 December 2023
Line 1:		Line 1:
	---		---
	--- Module to ~~create an infobox for displaying~~ on ~~a workshop's wiki page.~~		--- Module of shortcuts and layout methods to standardize infoboxes on various
	---		--- wiki pages. Supported modules should not use any mw.create or :tag methods,
	~~--- Shows the facts from the data about the specified workshop in an easy-to-~~		--- but instead call the methods of this module with the facts and rely on
	~~--- read table, with a large icon, information, categories~~, ~~and the flavor~~		--- this module to build the content.
	~~--- text.~~
	---
	~~--- This should be invoked from Template:Shopbox with~~ the ~~parameter~~ of the
	--- ~~workshop whose infobox should be shown. See~~ the ~~template documentation for~~
	~~--- more information about parameters and errors and to see examples~~.
	---		---
	--- @module Infobox		--- @module Infobox
Line 17:		Line 12:
	local GoodsData = require("Module:GoodsData")		local GoodsData = require("Module:GoodsData")
	local StyleUtils = require("Module:StyleUtils")		local StyleUtils = require("Module:StyleUtils")



Line 28:		Line 24:
	local INDEX_REQ_STACK_SIZE= "stackSize"		local INDEX_REQ_STACK_SIZE= "stackSize"
	local INDEX_REQ_GOOD_ID = "goodID"		local INDEX_REQ_GOOD_ID = "goodID"

	~~local BOLD = "'''"~~

	local PATTERN_FORMAT_TWO_DECIMALS = "%1.2f"		local PATTERN_FORMAT_TWO_DECIMALS = "%1.2f"
Line 40:		Line 34:
	--region Public constants		--region Public constants

	~~-- Infobox header labels~~
	Infobox.TITLE_ID = "ID"		Infobox.TITLE_ID = "ID"
	Infobox.TITLE_CATEGORY = "Category"		Infobox.TITLE_CATEGORY = "Category"
Line 50:		Line 43:
	Infobox.TITLE_ESSENTIAL = "Essential"		Infobox.TITLE_ESSENTIAL = "Essential"
	Infobox.TITLE_STORAGE_CAPACITY = "Storage"		Infobox.TITLE_STORAGE_CAPACITY = "Storage"
			Infobox.TITLE_RANGE = "Range"
	Infobox.TITLE_FARMING_AREA = "Farming Area"		Infobox.TITLE_FARMING_AREA = "Farming Area"
	Infobox.TITLE_GATHERING_AREA = "Gather Range"		Infobox.TITLE_GATHERING_AREA = "Gather Range"
Line 61:		Line 55:
	Infobox.ICONSIZE_MED = mw.getCurrentFrame():expandTemplate{ title="ImgM" }		Infobox.ICONSIZE_MED = mw.getCurrentFrame():expandTemplate{ title="ImgM" }

	-- Infobox styling		-- DEPRECATED Infobox styling.
	Infobox.CSS_MAIN = {		Infobox.CSS_MAIN = {
	["float"] = "right",		["float"] = "right",
Line 71:		Line 65:
	["margin"] = "0.5em 0 0.5em 1em"		["margin"] = "0.5em 0 0.5em 1em"
	}		}

	Infobox.CSS_INNER_TABLE = {		Infobox.CSS_INNER_TABLE = {
	["border-collapse"] = "collapse"		["border-collapse"] = "collapse"
	}		}

	Infobox.CSS_TR_BORDER_BOT = {		Infobox.CSS_TR_BORDER_BOT = {
	["border-bottom"] = "1px solid #a2a9b1"		["border-bottom"] = "1px solid #a2a9b1"
	}		}

	Infobox.CSS_TR_BORDER_TOP = {		Infobox.CSS_TR_BORDER_TOP = {
	["border-top"] = "1px solid #a2a9b1"		["border-top"] = "1px solid #a2a9b1"
Line 199:		Line 190:
	function Infobox.makeCategoryIcon(category, isGoodsCategory)		function Infobox.makeCategoryIcon(category, isGoodsCategory)

	local ~~class~~ = ""		local classStr = ""
	if isGoodsCategory then		if isGoodsCategory then
	~~class~~ = StyleUtils.CLASS_GOODS_CATEGORY_ICON		classStr = StyleUtils.CLASS_GOODS_CATEGORY_ICON
	else		else
	~~class~~ = StyleUtils.CLASS_CATEGORY_ICON		classStr = StyleUtils.CLASS_CATEGORY_ICON
	end		end

	return "[[File:" .. Infobox.ICON_FILENAMES_CATEGORIES[category] ..		return "[[File:" .. Infobox.ICON_FILENAMES_CATEGORIES[category] ..
	"\|" .. Infobox.ICONSIZE_MED .. "\|alt=" .. category ..		"\|" .. Infobox.ICONSIZE_MED .. "\|alt=" .. category ..
	"\|class=" .. ~~class~~ .. "]]"		"\|class=" .. classStr .. "]]"
	end		end

Line 280:		Line 271:

	local row		local row
			local nowNeedsSeparator = needsSeparator
	if check ~= nil and check ~= "" then		if check ~= nil and check ~= "" then

	row = parentNode:tag("tr")		row = parentNode:tag("tr")
	~~local~~ nowNeedsSeparator = trySeparator(row, needsSeparator)		nowNeedsSeparator = trySeparator(row, needsSeparator)

	populateStandardRow(row, header, value)		populateStandardRow(row, header, value)
Line 293:		Line 285:


	--- TODO DELETE THIS because we're not doing inline css anymore		--- DEPRECATED TODO DELETE THIS because we're not doing inline css anymore
	--- Shortcut method to build a standard row with a header and a value.		--- Shortcut method to build a standard row with a header and a value.
	---		---

76561197969631737: fixing logic for checking whether it's a good

2023-12-24T05:49:01Z

fixing logic for checking whether it's a good

← Older revision		Revision as of 05:49, 24 December 2023
Line 199:		Line 199:
	function Infobox.makeCategoryIcon(category, isGoodsCategory)		function Infobox.makeCategoryIcon(category, isGoodsCategory)

			local class = ""
			if isGoodsCategory then
			class = StyleUtils.CLASS_GOODS_CATEGORY_ICON
			else
			class = StyleUtils.CLASS_CATEGORY_ICON
			end

	return "[[File:" .. Infobox.ICON_FILENAMES_CATEGORIES[category] ..		return "[[File:" .. Infobox.ICON_FILENAMES_CATEGORIES[category] ..
	"\|" .. Infobox.ICONSIZE_MED .. "\|alt=" .. category ..		"\|" .. Infobox.ICONSIZE_MED .. "\|alt=" .. category ..
	"\|class=" .. ~~isGoodsCategory and StyleUtils.CLASS_GOODS_CATEGORY_ICON or StyleUtils.CLASS_CATEGORY_ICON~~ .. "]]"		"\|class=" .. class .. "]]"
	end		end

76561197969631737: changed category icon maker

2023-12-24T05:47:32Z

changed category icon maker

← Older revision		Revision as of 05:47, 24 December 2023
Line 197:		Line 197:
	---@param category string the category of the icon to make		---@param category string the category of the icon to make
	---@return string the wiki markup for the icon		---@return string the wiki markup for the icon
	function Infobox.makeCategoryIcon(category)		function Infobox.makeCategoryIcon(category, isGoodsCategory)

	return "[[File:" .. Infobox.ICON_FILENAMES_CATEGORIES[category] ..		return "[[File:" .. Infobox.ICON_FILENAMES_CATEGORIES[category] ..
	"\|" .. Infobox.ICONSIZE_MED .. "\|alt=" .. category ..		"\|" .. Infobox.ICONSIZE_MED .. "\|alt=" .. category ..
	"\|class=" .. StyleUtils.CLASS_CATEGORY_ICON .. "]]"		"\|class=" .. isGoodsCategory and StyleUtils.CLASS_GOODS_CATEGORY_ICON or StyleUtils.CLASS_CATEGORY_ICON .. "]]"
	end		end

76561197969631737: trying to fix the unwanted first separator!

2023-12-24T05:32:26Z

trying to fix the unwanted first separator!

← Older revision		Revision as of 05:32, 24 December 2023
Line 116:		Line 116:
	if needsSeparator then		if needsSeparator then
	StyleUtils.styleInfoboxSeparator(row)		StyleUtils.styleInfoboxSeparator(row)
	~~needsSeparator =~~ false		return false
	end		end

	return ~~needsSeparator~~		return true
	end		end

Line 276:		Line 276:

	row = parentNode:tag("tr")		row = parentNode:tag("tr")
	~~needsSeparator~~ = trySeparator(row, needsSeparator)		local nowNeedsSeparator = trySeparator(row, needsSeparator)

	populateStandardRow(row, header, value)		populateStandardRow(row, header, value)
	end		end

	return ~~needsSeparator~~		return nowNeedsSeparator
	end		end

76561197969631737: Replacing required goods repeatedly using resource link template with using construction template

2023-12-24T05:27:55Z

Replacing required goods repeatedly using resource link template with using construction template

← Older revision		Revision as of 05:27, 24 December 2023
Line 23:		Line 23:
	local RESOURCE_LINK_TEMPLATE = "rl"		local RESOURCE_LINK_TEMPLATE = "rl"
	local RESOURCE_LINK_ICONSIZE = "med"		local RESOURCE_LINK_ICONSIZE = "med"

			local CONSTRUCTION_TEMPLATE = "Construction"

	local INDEX_REQ_STACK_SIZE= "stackSize"		local INDEX_REQ_STACK_SIZE= "stackSize"
Line 316:		Line 318:
	end		end

	local ~~requiredGoodsRows~~ = ~~mw.html.create("table")~~		local templateArgs = {}
	~~requiredGoodsRows:newline()~~

	for _, requiredGroup in ipairs(requiredGoods) do		for _, requiredGroup in ipairs(requiredGoods) do

	local stackSize = requiredGroup[INDEX_REQ_STACK_SIZE]		local stackSize = requiredGroup[INDEX_REQ_STACK_SIZE]
	local ~~goodID~~ = requiredGroup[INDEX_REQ_GOOD_ID]		local goodName = GoodsData.getGoodNameByID(requiredGroup[INDEX_REQ_GOOD_ID])

	~~requiredGoodsRows:tag("tr")~~		templateArgs[goodName] = stackSize
	~~:tag("td"):wikitext(BOLD ..~~ stackSize ~~.. BOLD):done()~~
	~~:tag("td"):wikitext(Infobox.resourceLink(goodID)):done()~~
	~~:done():newline()~~
	end		end

	return ~~requiredGoodsRows~~		return mw.getCurrentFrame():expandTemplate{ title = CONSTRUCTION_TEMPLATE,
			args = templateArgs }
	end		end

76561197969631737: Adding styling class to category icon

2023-12-23T04:55:23Z

Adding styling class to category icon

← Older revision		Revision as of 04:55, 23 December 2023
Line 198:		Line 198:

	return "[[File:" .. Infobox.ICON_FILENAMES_CATEGORIES[category] ..		return "[[File:" .. Infobox.ICON_FILENAMES_CATEGORIES[category] ..
	"\|" .. Infobox.ICONSIZE_MED .. "\|alt=" .. category .. "]]"		"\|" .. Infobox.ICONSIZE_MED .. "\|alt=" .. category ..
			"\|class=" .. StyleUtils.CLASS_CATEGORY_ICON .. "]]"
	end		end

76561197969631737: Shortened a lot of header text

2023-12-23T04:52:36Z

Shortened a lot of header text

← Older revision		Revision as of 04:52, 23 December 2023
Line 40:		Line 40:
	-- Infobox header labels		-- Infobox header labels
	Infobox.TITLE_ID = "ID"		Infobox.TITLE_ID = "ID"
	Infobox.TITLE_CATEGORY = "~~Toolbar~~ Category"		Infobox.TITLE_CATEGORY = "Category"
	Infobox.TITLE_SIZE = "~~Building~~ Size"		Infobox.TITLE_SIZE = "Size"
	Infobox.TITLE_EATABLE = "Eatable"		Infobox.TITLE_EATABLE = "Eatable"
	Infobox.TITLE_BURNABLE = "Burnable"		Infobox.TITLE_BURNABLE = "Burnable"
	Infobox.TITLE_BURN_TIME = "~~Fuel burn~~ time"		Infobox.TITLE_BURN_TIME = "Burn time"
	Infobox.TITLE_MOVABLE = "Movable"		Infobox.TITLE_MOVABLE = "Movable"
	Infobox.TITLE_ESSENTIAL = "~~Initially~~ Essential"		Infobox.TITLE_ESSENTIAL = "Essential"
	Infobox.TITLE_STORAGE_CAPACITY = "Storage ~~Capacity~~"		Infobox.TITLE_STORAGE_CAPACITY = "Storage"
	Infobox.TITLE_FARMING_AREA = "Farming Area"		Infobox.TITLE_FARMING_AREA = "Farming Area"
	Infobox.TITLE_GATHERING_AREA = "~~Gathering Area~~"		Infobox.TITLE_GATHERING_AREA = "Gather Range"
	Infobox.TITLE_CONSTRUCTION_TIME = "~~Construction~~ Time"		Infobox.TITLE_CONSTRUCTION_TIME = "Build Time"
	Infobox.TITLE_CONSTRUCTION_COST = "~~Construction~~ Cost"		Infobox.TITLE_CONSTRUCTION_COST = "Build Cost"
	Infobox.TITLE_SELL_VALUE = "~~Value when sold~~"		Infobox.TITLE_SELL_VALUE = "Sell value"
	Infobox.TITLE_BUY_VALUE = "~~Price when bought~~"		Infobox.TITLE_BUY_VALUE = "Buy price"
	Infobox.TITLE_WORKPLACES = "Workplaces"		Infobox.TITLE_WORKPLACES = "Workplaces"
	Infobox.TITLE_RECIPES = "Recipes"		Infobox.TITLE_RECIPES = "Recipes"
Line 108:		Line 108:
	---		---
	---@param row table html table row we're building		---@param row table html table row we're building
	---@param ~~needSeparator~~ boolean whether we need a separator		---@param needsSeparator boolean whether we need a separator
	~~---@return table the row~~
	---@return boolean whether we still need a separator		---@return boolean whether we still need a separator
	local function trySeparator(row, ~~needSeparator~~)		local function trySeparator(row, needsSeparator)

	if ~~needSeparator~~ then		if needsSeparator then
	StyleUtils.styleInfoboxSeparator(row)		StyleUtils.styleInfoboxSeparator(row)
	~~needSeparator~~ = false		needsSeparator = false
	end		end

	return ~~row, needSeparator~~		return needsSeparator
	end		end

Line 274:		Line 273:

	row = parentNode:tag("tr")		row = parentNode:tag("tr")
	_, needsSeparator = trySeparator(row, needsSeparator)		needsSeparator = trySeparator(row, needsSeparator)

	populateStandardRow(row, header, value)		populateStandardRow(row, header, value)

76561197969631737: removing quotes around flavor text lol

2023-12-22T22:58:00Z

removing quotes around flavor text lol

← Older revision		Revision as of 22:58, 22 December 2023
Line 233:		Line 233:
	StyleUtils.styleInfoboxFlavorText(p)		StyleUtils.styleInfoboxFlavorText(p)

	p:wikitext(~~'"' ..~~ description ~~.. '"'~~):done():newline()		p:wikitext(description):done():newline()

	return p		return p

76561197969631737: fixing newlines

2023-12-22T22:44:03Z

fixing newlines

← Older revision		Revision as of 22:44, 22 December 2023
Line 343:		Line 343:
	local wikiInfobox = mw.html.create("div")		local wikiInfobox = mw.html.create("div")
	StyleUtils.styleInfobox(wikiInfobox)		StyleUtils.styleInfobox(wikiInfobox)

			wikiInfobox:newline()

	return wikiInfobox		return wikiInfobox
Line 359:		Line 361:
	local header = wikiInfobox:tag("div")		local header = wikiInfobox:tag("div")
	StyleUtils.styleInfoboxHeader(header)		StyleUtils.styleInfoboxHeader(header)

			header:newline()

	return header		return header
Line 389:		Line 393:
	local innerTable = wikiInfobox:tag("table")		local innerTable = wikiInfobox:tag("table")
	innerTable = StyleUtils.styleInfoboxInnerTable(innerTable)		innerTable = StyleUtils.styleInfoboxInnerTable(innerTable)
	innerTable.newline()
			innerTable:newline()

	return innerTable		return innerTable

76561197969631737: adding quotes around flavor text

2023-12-22T22:42:08Z

adding quotes around flavor text

← Older revision		Revision as of 22:42, 22 December 2023
Line 233:		Line 233:
	StyleUtils.styleInfoboxFlavorText(p)		StyleUtils.styleInfoboxFlavorText(p)

	p:wikitext(description):done():newline()		p:wikitext('"' .. description .. '"'):done():newline()

	return p		return p