extension.json

{
	"name": "Spring",
	"author": [
		"Zippybonzo"
	],
	"url": "https://github.com/WikiOasis/Spring",
	"descriptionmsg": "spring-desc",
	"namemsg": "spring-extensionname",
	"license-name": "GPL-3.0-or-later",
	"type": "other",
	"requires": {
		"MediaWiki": ">= 1.45.0",
		"extensions": {
			"ManageWiki": "*"
		},
		"platform": {
			"php": ">= 8.1"
		}
	},
	"AvailableRights": [
		"spring-reset"
	],
	"LogTypes": [
		"spring"
	],
	"LogNames": {
		"spring": "spring-log-name"
	},
	"LogHeaders": {
		"spring": "spring-log-header"
	},
	"LogActionsHandlers": {
		"spring/*": "MediaWiki\\Logging\\LogFormatter"
	},
	"ActionFilteredLogs": {
		"spring": {
			"complete": [
				"complete"
			],
			"dismiss": [
				"dismiss"
			],
			"import": [
				"import"
			],
			"reset": [
				"reset"
			]
		}
	},
	"JobClasses": {
		"springImport": {
			"class": "WikiOasis\\Spring\\Jobs\\SpringImportJob",
			"services": [
				"SpringImportSources",
				"UserFactory",
				"WikiImporterFactory"
			],
			"needsPage": false
		}
	},
	"SpecialPages": {
		"Spring": {
			"class": "WikiOasis\\Spring\\Specials\\SpecialSpring",
			"services": [
				"SpringOnboardingStore",
				"SpringWizardBuilder"
			]
		}
	},
	"APIModules": {
		"springonboarding": {
			"class": "WikiOasis\\Spring\\Api\\ApiSpringOnboarding",
			"services": [
				"SpringOnboardingManager"
			]
		}
	},
	"APIListModules": {
		"springwizard": {
			"class": "WikiOasis\\Spring\\Api\\ApiQuerySpringWizard",
			"services": [
				"SpringWizardBuilder"
			]
		}
	},
	"MessagesDirs": {
		"Spring": [
			"i18n"
		]
	},
	"ExtensionMessagesFiles": {
		"SpringAliases": "SpringAliases.php"
	},
	"AutoloadNamespaces": {
		"WikiOasis\\Spring\\": "includes/",
		"WikiOasis\\Spring\\Maintenance\\": "maintenance/"
	},
	"TestAutoloadNamespaces": {
		"WikiOasis\\Spring\\Tests\\": "tests/phpunit/"
	},
	"ServiceWiringFiles": [
		"includes/ServiceWiring.php"
	],
	"ResourceFileModulePaths": {
		"localBasePath": "resources",
		"remoteExtPath": "Spring/resources"
	},
	"ResourceModules": {
		"ext.spring.styles": {
			"styles": [
				"ext.spring.styles.less"
			]
		},
		"ext.spring.wizard": {
			"class": "MediaWiki\\ResourceLoader\\CodexModule",
			"codexComponents": [
				"CdxButton",
				"CdxCheckbox",
				"CdxDialog",
				"CdxField",
				"CdxIcon",
				"CdxInfoChip",
				"CdxMessage",
				"CdxProgressBar",
				"CdxRadio",
				"CdxSearchInput",
				"CdxSelect",
				"CdxTextArea",
				"CdxTextInput"
			],
			"packageFiles": [
				{
					"name": "init.js",
					"file": "ext.spring.wizard/init.js"
				},
				{
					"name": "icons.json",
					"callback": "WikiOasis\\Spring\\SpringIcons::getIcons"
				},
				{
					"name": "registry.js",
					"file": "ext.spring.wizard/registry.js"
				},
				{
					"name": "Wizard.vue",
					"file": "ext.spring.wizard/Wizard.vue"
				},
				{
					"name": "ChoiceCard.vue",
					"file": "ext.spring.wizard/ChoiceCard.vue"
				},
				{
					"name": "StepProgress.vue",
					"file": "ext.spring.wizard/StepProgress.vue"
				},
				{
					"name": "steps/WelcomeStep.vue",
					"file": "ext.spring.wizard/steps/WelcomeStep.vue"
				},
				{
					"name": "steps/RouteStep.vue",
					"file": "ext.spring.wizard/steps/RouteStep.vue"
				},
				{
					"name": "steps/TemplateStep.vue",
					"file": "ext.spring.wizard/steps/TemplateStep.vue"
				},
				{
					"name": "steps/PresetStep.vue",
					"file": "ext.spring.wizard/steps/PresetStep.vue"
				},
				{
					"name": "steps/CatalogueStep.vue",
					"file": "ext.spring.wizard/steps/CatalogueStep.vue"
				},
				{
					"name": "steps/CatalogueRow.vue",
					"file": "ext.spring.wizard/steps/CatalogueRow.vue"
				},
				{
					"name": "steps/CompassStep.vue",
					"file": "ext.spring.wizard/steps/CompassStep.vue"
				},
				{
					"name": "steps/StylingStep.vue",
					"file": "ext.spring.wizard/steps/StylingStep.vue"
				},
				{
					"name": "steps/SettingsStep.vue",
					"file": "ext.spring.wizard/steps/SettingsStep.vue"
				},
				{
					"name": "steps/ImportStep.vue",
					"file": "ext.spring.wizard/steps/ImportStep.vue"
				},
				{
					"name": "steps/ShareStep.vue",
					"file": "ext.spring.wizard/steps/ShareStep.vue"
				},
				{
					"name": "steps/NextStepsStep.vue",
					"file": "ext.spring.wizard/steps/NextStepsStep.vue"
				}
			],
			"dependencies": [
				"mediawiki.api",
				"mediawiki.jqueryMsg",
				"mediawiki.language",
				"mediawiki.util",
				"vue"
			],
			"messages": [
				"comma-separator",
				"pipe-separator",
				"spring-button-back",
				"spring-button-close",
				"spring-button-copy",
				"spring-button-copied",
				"spring-button-dismiss",
				"spring-button-finish",
				"spring-button-next",
				"spring-button-open",
				"spring-button-reset",
				"spring-button-skip",
				"spring-button-start",
				"spring-catalogue-attention",
				"spring-catalogue-conflict",
				"spring-catalogue-default",
				"spring-catalogue-enabled",
				"spring-catalogue-farmdefault",
				"spring-catalogue-empty",
				"spring-catalogue-more",
				"spring-catalogue-needs",
				"spring-catalogue-pinned",
				"spring-catalogue-search",
				"spring-catalogue-search-placeholder",
				"spring-catalogue-selected",
				"spring-catalogue-unavailable",
				"spring-compass-description",
				"spring-compass-description-help",
				"spring-compass-error-thumbnail",
				"spring-compass-error-toolong",
				"spring-compass-extended",
				"spring-compass-extended-help",
				"spring-compass-preview",
				"spring-compass-thumbnail",
				"spring-compass-thumbnail-help",
				"spring-compass-visible",
				"spring-compass-visible-help",
				"spring-complete-body",
				"spring-complete-heading",
				"spring-error-conflict",
				"spring-error-dependency",
				"spring-error-dependency-any",
				"spring-error-load",
				"spring-error-required",
				"spring-error-save",
				"spring-help",
				"spring-import-queued",
				"spring-language-label",
				"spring-loading",
				"spring-notconfigured",
				"spring-progress",
				"spring-reason",
				"spring-share-copy-label",
				"spring-styling-preview",
				"spring-title",
				"spring-unsupported-step"
			]
		}
	},
	"ResourceModuleSkinStyles": {
		"citizen": {
			"+ext.spring.wizard": "skinStyles/citizen/ext.spring.wizard.less",
			"+ext.spring.styles": "skinStyles/citizen/ext.spring.styles.less"
		}
	},
	"Hooks": {
		"BeforePageDisplay": {
			"handler": "Main"
		},
		"LoadExtensionSchemaUpdates": {
			"handler": "Installer"
		}
	},
	"HookHandlers": {
		"Installer": {
			"class": "WikiOasis\\Spring\\HookHandlers\\Installer"
		},
		"Main": {
			"class": "WikiOasis\\Spring\\HookHandlers\\Main",
			"services": [
				"SpringWizardBuilder"
			]
		}
	},
	"config": {
		"SpringEnabled": {
			"description": "Boolean. Whether the onboarding wizard is offered at all. Turning this off stops it opening on its own and leaves Special:Spring reporting that it is switched off. To keep the wizard but stop it opening by itself, use $wgSpringAutoOpen instead.",
			"value": true
		},
		"SpringRequiredRight": {
			"description": "String. The right a user must hold for the wizard to be offered to them. Defaults to the ManageWiki right that lets a user configure the wiki in the first place.",
			"value": "managewiki-core"
		},
		"SpringAutoOpen": {
			"description": "Boolean. Whether the wizard opens by itself on the first page a privileged user views. When false it is only reachable from Special:Spring.",
			"value": true
		},
		"SpringAllowDismiss": {
			"description": "Boolean. Whether the wizard can be dismissed without being completed. Dismissal is recorded per wiki, so it stops the wizard opening for everyone.",
			"value": true
		},
		"SpringHelpUrl": {
			"description": "String. URL of a help page linked from the wizard footer. An empty string hides the link.",
			"value": ""
		},
		"SpringLogManageWikiChanges": {
			"description": "Boolean. Whether the changes the wizard makes are written to Special:Log/managewiki as well as Special:Log/spring.",
			"value": true
		},
		"SpringIntroSteps": {
			"description": "Array. Step IDs shown before the wizard branches into a flow, in order. Empty by default: Spring registers no wizard of its own, because which questions are worth asking is a decision only a farm can make. See ExampleConfiguration.php for the set Spring used to ship. Steps not listed in $wgSpringSteps are ignored.",
			"value": []
		},
		"SpringOutroSteps": {
			"description": "Array. Step IDs shown after the chosen flow has finished, in order. Empty by default; see ExampleConfiguration.php. Use this for steps that belong to every route, such as sharing and the closing list of next steps.",
			"value": []
		},
		"SpringFlows": {
			"description": "Array. The routes offered on the route step, mapped ID => definition. Empty by default; see ExampleConfiguration.php. \"steps\" is an ordered list of step IDs; \"label\", \"description\" and \"icon\" describe the route, and the \"-message\" variants of the first two take message keys instead of literal text. With one route configured the route step is skipped; with none, only the intro and outro steps run.",
			"value": []
		},
		"SpringSteps": {
			"description": "Array. The step registry, mapped step ID => ObjectFactory specification. Empty by default: a farm registers the steps it wants, and ExampleConfiguration.php holds the set Spring used to ship, ready to require or copy. \"class\", \"factory\", \"services\" and \"args\" are passed to ObjectFactory; \"config\" is handed to the step itself and is where a step's behaviour is customised. Steps are only shown if they appear in $wgSpringIntroSteps, $wgSpringOutroSteps or a flow's \"steps\" list.",
			"value": []
		},
		"SpringTemplates": {
			"description": "Array. The wiki templates offered on the template step, mapped ID => definition. Empty by default; see ExampleConfiguration.php. \"answers\" pre-fills the steps named in it, so a template configures the wiki through the same steps the manual route uses; \"extensions\", \"settings\" and \"import\" cover what no step does.",
			"value": []
		},
		"SpringDefaultExtensions": {
			"description": "Array. ManageWiki extension keys the farm switches on for a new wiki unless it is told otherwise. They are ticked on the extensions step rather than forced, so the user can untick any of them, and a template that says anything about extensions overrides them. A key the wiki is not permitted is left unticked rather than ticked and then refused.",
			"value": []
		},
		"SpringDefaultSkins": {
			"description": "Array. As $wgSpringDefaultExtensions, for the skins step.",
			"value": []
		},
		"SpringHighlightedExtensions": {
			"description": "Array. ManageWiki extension keys pinned to the top of the extensions step, in order. Everything else stays reachable through the search box.",
			"value": []
		},
		"SpringHighlightedSkins": {
			"description": "Array. ManageWiki extension keys pinned to the top of the skins step, in order.",
			"value": []
		},
		"SpringSkinSections": {
			"description": "Array. The $wgManageWikiExtensions sections that hold skins rather than extensions. These are offered on the skins step and left out of the extensions step.",
			"value": [
				"skins"
			]
		},
		"SpringSkinDefaultAdd": {
			"description": "Array. MediaWiki skin keys the farm installs on every wiki itself, rather than handing out through ManageWiki. They are always offered as the default skin and never have to be selected on the skins step first, because nothing answered there can take them away. Use MediaWiki skin keys as $wgDefaultSkin takes them, not ManageWiki keys: loading Vector everywhere gives you both 'vector' and 'vector-2022', and they are different defaults.",
			"value": []
		},
		"SpringSkinKeyOverrides": {
			"description": "Array. Maps a ManageWiki extension key to the skin key MediaWiki knows the skin by, for the skins where the two differ. Spring otherwise assumes the skin key is the lowercased name from the skin's ManageWiki entry, which is right for nearly all of them.",
			"value": []
		},
		"SpringExtensionSections": {
			"description": "Array. Restricts the extensions step to these $wgManageWikiExtensions sections. An empty array offers every section that is not listed in $wgSpringSkinSections.",
			"value": []
		},
		"SpringHideUnavailable": {
			"description": "Boolean. Whether extensions and skins the wiki cannot currently enable are left out of the catalogue rather than shown as unavailable.",
			"value": false
		},
		"SpringSharePlatforms": {
			"description": "Array. The share links offered on the share step, mapped ID => definition. 'url' is a template in which {url}, {text} and {sitename} are replaced with the URL-encoded wiki address, share message and site name.",
			"value": {
				"bluesky": {
					"label": "Bluesky",
					"url": "https://bsky.app/intent/compose?text={text}%20{url}"
				},
				"mastodon": {
					"label": "Mastodon",
					"url": "https://mastodon.social/share?text={text}%20{url}"
				},
				"reddit": {
					"label": "Reddit",
					"url": "https://www.reddit.com/submit?url={url}&title={text}"
				},
				"facebook": {
					"label": "Facebook",
					"url": "https://www.facebook.com/sharer/sharer.php?u={url}"
				}
			}
		},
		"SpringShareUrl": {
			"description": "String. The address shared on the share step. An empty string uses the wiki's own main page.",
			"value": ""
		},
		"SpringImportSources": {
			"description": "Array. The XML dumps a template may import, mapped key => definition. 'file' is a filename inside $wgSpringImportDirectory, or an absolute path when no directory is configured; 'label' and 'label-message' name it in the wizard's summary and in Special:Log/spring. Only a template can ask for an import, and it asks by key: no path ever comes from a user, and the key is resolved again when the job runs.",
			"value": []
		},
		"SpringImportDirectory": {
			"description": "String. The directory $wgSpringImportSources filenames are resolved inside. A source that resolves outside it is refused, so that a template cannot name '../../LocalSettings.php'. An empty string requires every source to give an absolute path that already exists.",
			"value": ""
		},
		"SpringWizardLanguages": {
			"description": "Array. Language codes offered by the wizard's language switcher, which changes the language the wizard is read in and not the language of the wiki. An empty array offers every language MediaWiki has messages for.",
			"value": []
		}
	},
	"ConfigRegistry": {
		"Spring": "MediaWiki\\Config\\GlobalVarConfig::newInstance"
	},
	"manifest_version": 2
}