Module:Categories/Headers

---

local p = {}

local utilsError = require('Module:UtilsError')
local Franchise = require('Module:Franchise')
local utilsMarkup = require('Module:UtilsMarkup')

function p.Main(frame)
    return p.main(frame.args)
end

function p.main(args)
	local hType = args[1] -- "Header Type," The type of header that is being called (Improvement, Lacking Images, Invalid Terms, etc.) See [[Template:Category Header]] for a list of accepted values.
    local game = args[2] -- The game relating to the category (A Link to the Past Articles Needing Improvement would use ALttP, Breath of the Wild Articles Lacking Sources would use BotW, etc.)

	if (hType == "Conjectural Titles") then --for Category:Articles with Conjectural Titles
		returnHeader = "__HIDDENCAT__ __EXPECTUNUSEDCATEGORY__\nThe following articles use titles that are fan-created and unofficial; official names should replace all the names of these articles based on the [[Guidelines:Terminology|Terminology]] and [[Guidelines:References|Reference Guidelines]]. All articles in this category are marked with the <code>{{[[Template:Name|Name]]|Fan}}</code> template which should be removed when an official name is found. This category is hidden from view on mainspace articles.\n[[Category:Articles Lacking Sources]]"
		
    elseif (hType == "Lacking Sources") then --for Category:X Articles Lacking Sources
    	if (game == "Main") then
	        returnHeader = "__HIDDENCAT__ __EXPECTUNUSEDCATEGORY__\nThe following articles lack citations. All articles in this category contain pieces of information that are possibly false and require verification to be kept on the page. This category also contains subcategories that separate this large list by piece of media, and all of these categories are hidden from view on mainspace articles.\n\nTo ''remove'' articles from this category, you must either:\n*Add a citation next to the skeptical information on the page. For more information on how to add citations effectively, see [[Guidelines:References]].\n*Remove the information from the page if you are confident that it is untrue and cannot find any references to back it up. If the information in question is an entire article, you may use the <code>{{[[Template:Delete|Delete]]}}</code> template to mark the page for deletion.\n\nTo ''add'' articles to this category, you can use one of these two templates:\n*<code>{{[[Template:Lacking Sources|Lacking Sources]]}}</code>, if whole articles or sections generally lack citations. Place this underneath the header for the section in question, or in the case of an article, place it underneath the lead sentence and infobox.\n*<code>{{[[Template:Fact|Fact]]}}</code>, if a specific portion of info needs a citation. Place this after the punctuation in the skeptical sentence.\nIf the information that needs a citation pertains to a specific game or other piece of media, you may add the abbreviation of said media to the template. For example, if a statement about ''Breath of the Wild'' seems untrue, you may use <code>{{Fact|BotW}}</code> to add it to the \"[[:Category:Breath of the Wild Articles Lacking Sources|Breath of the Wild Articles Lacking Sources]]\" category.\n[[Category:Articles Needing Attention]]"
    	else
	        returnHeader = string.format("__HIDDENCAT__ __EXPECTUNUSEDCATEGORY__\nThe following articles lack citations pertaining to %s. All articles in this category contain pieces of information that are possibly false and require verification to be kept on the page. This category is hidden on mainspace articles.\n\nTo ''remove'' articles from this category, you must either:\n*Add a citation next to the skeptical information on the page. For more information on how to add citations effectively, see [[Guidelines:References]].\n*Remove the information from the page if you are confident that it is untrue and cannot find any references to back it up. If the information in question is an entire article, you may use the <code>{{[[Template:Delete|Delete]]}}</code> template to mark the page for deletion.\n\nTo ''add'' articles to this category, you can use one of these two templates:\n*<code>{{[[Template:Lacking Sources|Lacking Sources]]|%s}}</code>, if whole articles or sections generally lack citations. Place this underneath the header for the section in question, or in the case of an article, place it underneath the lead sentence and infobox.\n*<code>{{[[Template:Fact|Fact]]|%s}}</code>, if a specific portion of info needs a citation. Place this after the punctuation in the skeptical sentence.\n[[Category:Articles Lacking Sources]]\n[[Category:%s Articles Needing Attention]]", Franchise.link(game), game, game, Franchise.shortName(game))
		end

    elseif (hType == "Needing Improvement") then --for Category:X Articles Needing Improvement
    	if (game == "Main") then
	        returnHeader = "__HIDDENCAT__ __EXPECTUNUSEDCATEGORY__\nThe following articles (or sections within articles) are in general need of improvement. They may be poorly written, disorganized, unprofessional, or otherwise not up to Zelda Wiki's [[Guidelines:Main|quality standards]]. These articles require general clean up and fixes throughout a large area of the page, and in some cases complete rewrites may be required. This category also contains subcategories that separate this large list by piece of media, and all of these categories are hidden from view on mainspace articles.\n\nMore articles can be added to this list by tagging them with the <code>{{[[Template:Improve|Improve]]}}</code> template. If the article (or section of the article) that needs clean-up pertains to a specific piece of media, you may add the abbreviation of the media into the template to sort the page into a specific subcategory. The template should be formatted as \"<code>{{Improve|Date Added|Game Code}}</code>.\" For example, if the area of the page that needs fixing relates to ''Phantom Hourglass'', you may tag the section with <code>{{Improve|<date>|PH}}</code>. When a page on this list is fixed, be sure to remove the template from the page to remove it from this category.\n[[Category:Articles Needing Attention]]"
		else
	        returnHeader = string.format("__HIDDENCAT__ __EXPECTUNUSEDCATEGORY__\nThe following articles (or sections within articles) relating to %s are in general need of improvement. They may be poorly written, disorganized, unprofessional, or otherwise not up to Zelda Wiki's [[Guidelines:Main|quality standards]]. These articles require general clean up and fixes throughout a large area of the page, and in some cases complete rewrites may be required. This category is hidden from view on mainspace articles.\n\nMore articles can be added to this list by tagging them with the <code>{{[[Template:Improve|Improve]]}}</code> template, which should be formatted as \"<code>{{Improve|Date Added|%s}}</code>.\" When a page on this list is fixed, be sure to remove the template from the page to remove it from this category.\n[[Category:Articles Needing Improvement]]\n[[Category:%s Articles Needing Attention]]", Franchise.link(game), game, Franchise.shortName(game))
    	end
	
    elseif (hType == "Unsourced Excerpt") then
		returnHeader = "__HIDDENCAT__ __EXPECTUNUSEDCATEGORY__\nThe following articles contain excerpts from official media that have not been properly sourced and therefore constitute plagiarism and copyright infringement. The unsourced information should either have a citation added to it in accordance with the [[Guidelines:References|Reference Guidelines]] or should be removed. All articles in this category are marked with the <code>{{[[Template:Unsourced Excerpt|Unsourced Excerpt]]}}</code> template which should be removed when the excerpt is dealt with. This category is hidden from view on mainspace articles.\n[[Category:Articles Lacking Sources]]\n[[Category:Articles with Copyright Infringements]]"

	else --Activates when someone enters an invalid value for "hType"
		utilsError.warn(string.format("\"%s\" is not a valid header parameter, see [[Template:Category Header|here]] for all accepted values. If this is a mistake, please [https://discord.gg/eJnnvYb contact a staff member on the Discord server].", hType))
    end
    return returnHeader
end

return p