Module:Soysphere site categorizer/config

From Soyjak Wiki, the free ensoyclopedia
Jump to navigationJump to search

Documentation for this module may be created at Module:Soysphere site categorizer/config/doc

return {
	namespaces = { 0, 2 },
	-- /sites entries that are buckets rather than real sites
	-- a link that resolves to one of these keeps its own page title as the name
	bucketSites = {
		['Other-site'] = true, -- bucket is a temporary transition solution here and should not be used permanently
	},
	-- where splinter chains start: non-soysphere sites, named like the splinter categories
	-- (the /sites name when listed, otherwise the article title) these pages are never read
	rootSites = {
		['4chan'] = true, -- ground zero pages to terminate on
	},
	dimensions = {
		type = {
			-- needs a name for every type key in Module:Site categorizer/config except the skipped ones
			-- these two modules are connected at the hip,
			-- >> do not ignore Module:Site categorizer's config when adjusting this one or vice versa or you will break it <<

			-- >>> Include a category name for EVERY type value emitted by Module:Site categorizer <<<
			name = {
				archive = 'Soysphere web archives',
				booru = 'Soysphere boorus',
				imageboard = 'Soysphere imageboards',
				wiki = 'Soysphere wikis',
				forum = 'Soysphere forums',
				chat = 'Soysphere messaging platforms',
			},
			maintenance = {
				missing = 'Soysphere websites without a type',
				unrecognized = 'Soysphere websites with an unrecognized type',
				overflow = 'Soysphere websites with multiple types',
			},
		},
		launched = {
			name = 'Soysphere websites launched in $1',
			undated = 'Undated soysphere websites',
		},
		terminated = {
			name = 'Soysphere websites terminated in $1',
		},
		parent = {
			name = '$1 splinters',
			maintenance = {
				missing = 'Soysphere websites without a parent site',
				undetected = 'Soysphere websites with an undetected parent site',
				overflow = 'Soysphere websites with multiple parent sites',
			},
		},
		sister = {
			name = '$1',
			maintenance = {
				undetected = 'Soysphere websites with an undetected main site',
				overflow = 'Soysphere websites with multiple main sites',
			},
		},
		generation = {
			-- position in the list is the generation. deeper chains get maintenance.beyond, the module will refuse to count further, this is relatively quite resource intensive
			name = {
				'First-generation soysphere websites',
				'Second-generation soysphere websites',
				'Third-generation soysphere websites',
				'Fourth-generation soysphere websites',
				'Fifth-generation soysphere websites',
			},
			-- pages read per walk before giving up as a loop
			-- increasing this parameter in odd situations will cause limits to be reached super fast
			maxSteps = 6,
			maintenance = {
				unknown = 'Soysphere websites with unknown generation',
				loop = 'Soysphere websites with a splinter loop', -- if something is looping it needs to be resolved asap
				beyond = 'Soysphere websites exceeding configured generations',
			},
		},
	},
	maintenance = {
		invalidOverride = 'Soysphere websites with invalid categorization overrides',
		usingOverride = 'Soysphere websites using categorization overrides',
	},
}