| blob | 19c2b3771a7818fbc2b1333dd7a169c8c7fea0dc |
1 {
2 "$schema": "http://json-schema.org/schema#",
3 "description": "MediaWiki extension.json schema",
4 "type": "object",
5 "properties": {
6 "manifest_version": {
7 "type": "integer",
8 "description": "Version of the extension.json schema the extension.json file is in.",
9 "required": true
10 },
11 "name": {
12 "type": "string",
13 "description": "The extension's canonical name.",
14 "required": true
15 },
16 "namemsg": {
17 "type": "string",
18 "description": "i18n message key of the extension's name."
19 },
20 "type": {
21 "type": "string",
22 "description": "The extension's type, as an index to $wgExtensionCredits.",
23 "default": "other"
24 },
25 "author": {
26 "type": [
27 "string",
28 "array"
29 ],
30 "description": "Extension's authors.",
31 "items": {
32 "type": "string"
33 }
34 },
35 "version": {
36 "type": "string",
37 "description": "The version of this release of the extension."
38 },
39 "url": {
40 "type": "string",
41 "description": "URL to the homepage for the extension.",
42 "format": "uri"
43 },
44 "description": {
45 "type": "string",
46 "description": "Raw description of the extension."
47 },
48 "descriptionmsg": {
49 "type": "string",
50 "description": "Message key for a i18n message describing the extension."
51 },
52 "license-name": {
53 "type": "string",
54 "description": "Short identifier for the license under which the extension is released.",
55 "enum": [
56 "AFL-1.1",
57 "AFL-1.2",
58 "AFL-2.0",
59 "AFL-2.1",
60 "AFL-3.0",
61 "APL-1.0",
62 "Aladdin",
63 "ANTLR-PD",
64 "Apache-1.0",
65 "Apache-1.1",
66 "Apache-2.0",
67 "APSL-1.0",
68 "APSL-1.1",
69 "APSL-1.2",
70 "APSL-2.0",
71 "Artistic-1.0",
72 "Artistic-1.0-cl8",
73 "Artistic-1.0-Perl",
74 "Artistic-2.0",
75 "AAL",
76 "BitTorrent-1.0",
77 "BitTorrent-1.1",
78 "BSL-1.0",
79 "BSD-2-Clause",
80 "BSD-2-Clause-FreeBSD",
81 "BSD-2-Clause-NetBSD",
82 "BSD-3-Clause",
83 "BSD-3-Clause-Clear",
84 "BSD-4-Clause",
85 "BSD-4-Clause-UC",
86 "CECILL-1.0",
87 "CECILL-1.1",
88 "CECILL-2.0",
89 "CECILL-B",
90 "CECILL-C",
91 "ClArtistic",
92 "CNRI-Python",
93 "CNRI-Python-GPL-Compatible",
94 "CPOL-1.02",
95 "CDDL-1.0",
96 "CDDL-1.1",
97 "CPAL-1.0",
98 "CPL-1.0",
99 "CATOSL-1.1",
100 "Condor-1.1",
101 "CC-BY-1.0",
102 "CC-BY-2.0",
103 "CC-BY-2.5",
104 "CC-BY-3.0",
105 "CC-BY-ND-1.0",
106 "CC-BY-ND-2.0",
107 "CC-BY-ND-2.5",
108 "CC-BY-ND-3.0",
109 "CC-BY-NC-1.0",
110 "CC-BY-NC-2.0",
111 "CC-BY-NC-2.5",
112 "CC-BY-NC-3.0",
113 "CC-BY-NC-ND-1.0",
114 "CC-BY-NC-ND-2.0",
115 "CC-BY-NC-ND-2.5",
116 "CC-BY-NC-ND-3.0",
117 "CC-BY-NC-SA-1.0",
118 "CC-BY-NC-SA-2.0",
119 "CC-BY-NC-SA-2.5",
120 "CC-BY-NC-SA-3.0",
121 "CC-BY-SA-1.0",
122 "CC-BY-SA-2.0",
123 "CC-BY-SA-2.5",
124 "CC-BY-SA-3.0",
125 "CC0-1.0",
126 "CUA-OPL-1.0",
127 "D-FSL-1.0",
128 "WTFPL",
129 "EPL-1.0",
130 "eCos-2.0",
131 "ECL-1.0",
132 "ECL-2.0",
133 "EFL-1.0",
134 "EFL-2.0",
135 "Entessa",
136 "ErlPL-1.1",
137 "EUDatagrid",
138 "EUPL-1.0",
139 "EUPL-1.1",
140 "Fair",
141 "Frameworx-1.0",
142 "FTL",
143 "AGPL-1.0",
144 "AGPL-3.0",
145 "GFDL-1.1",
146 "GFDL-1.2",
147 "GFDL-1.3",
148 "GPL-1.0",
149 "GPL-1.0+",
150 "GPL-2.0",
151 "GPL-2.0+",
152 "GPL-2.0-with-autoconf-exception",
153 "GPL-2.0-with-bison-exception",
154 "GPL-2.0-with-classpath-exception",
155 "GPL-2.0-with-font-exception",
156 "GPL-2.0-with-GCC-exception",
157 "GPL-3.0",
158 "GPL-3.0+",
159 "GPL-3.0-with-autoconf-exception",
160 "GPL-3.0-with-GCC-exception",
161 "LGPL-2.1",
162 "LGPL-2.1+",
163 "LGPL-3.0",
164 "LGPL-3.0+",
165 "LGPL-2.0",
166 "LGPL-2.0+",
167 "gSOAP-1.3b",
168 "HPND",
169 "IBM-pibs",
170 "IPL-1.0",
171 "Imlib2",
172 "IJG",
173 "Intel",
174 "IPA",
175 "ISC",
176 "JSON",
177 "LPPL-1.3a",
178 "LPPL-1.0",
179 "LPPL-1.1",
180 "LPPL-1.2",
181 "LPPL-1.3c",
182 "Libpng",
183 "LPL-1.02",
184 "LPL-1.0",
185 "MS-PL",
186 "MS-RL",
187 "MirOS",
188 "MIT",
189 "Motosoto",
190 "MPL-1.0",
191 "MPL-1.1",
192 "MPL-2.0",
193 "MPL-2.0-no-copyleft-exception",
194 "Multics",
195 "NASA-1.3",
196 "Naumen",
197 "NBPL-1.0",
198 "NGPL",
199 "NOSL",
200 "NPL-1.0",
201 "NPL-1.1",
202 "Nokia",
203 "NPOSL-3.0",
204 "NTP",
205 "OCLC-2.0",
206 "ODbL-1.0",
207 "PDDL-1.0",
208 "OGTSL",
209 "OLDAP-2.2.2",
210 "OLDAP-1.1",
211 "OLDAP-1.2",
212 "OLDAP-1.3",
213 "OLDAP-1.4",
214 "OLDAP-2.0",
215 "OLDAP-2.0.1",
216 "OLDAP-2.1",
217 "OLDAP-2.2",
218 "OLDAP-2.2.1",
219 "OLDAP-2.3",
220 "OLDAP-2.4",
221 "OLDAP-2.5",
222 "OLDAP-2.6",
223 "OLDAP-2.7",
224 "OPL-1.0",
225 "OSL-1.0",
226 "OSL-2.0",
227 "OSL-2.1",
228 "OSL-3.0",
229 "OLDAP-2.8",
230 "OpenSSL",
231 "PHP-3.0",
232 "PHP-3.01",
233 "PostgreSQL",
234 "Python-2.0",
235 "QPL-1.0",
236 "RPSL-1.0",
237 "RPL-1.1",
238 "RPL-1.5",
239 "RHeCos-1.1",
240 "RSCPL",
241 "Ruby",
242 "SAX-PD",
243 "SGI-B-1.0",
244 "SGI-B-1.1",
245 "SGI-B-2.0",
246 "OFL-1.0",
247 "OFL-1.1",
248 "SimPL-2.0",
249 "Sleepycat",
250 "SMLNJ",
251 "SugarCRM-1.1.3",
252 "SISSL",
253 "SISSL-1.2",
254 "SPL-1.0",
255 "Watcom-1.0",
256 "NCSA",
257 "VSL-1.0",
258 "W3C",
259 "WXwindows",
260 "Xnet",
261 "X11",
262 "XFree86-1.1",
263 "YPL-1.0",
264 "YPL-1.1",
265 "Zimbra-1.3",
266 "Zlib",
267 "ZPL-1.1",
268 "ZPL-2.0",
269 "ZPL-2.1",
270 "Unlicense"
271 ]
272 },
273 "requires": {
274 "type": "object",
275 "description": "Indicates what versions of MediaWiki core are required. This syntax may be extended in the future, for example to check dependencies between other extensions.",
276 "properties": {
277 "MediaWiki": {
278 "type": "string",
279 "description": "Version constraint string against MediaWiki core."
280 }
281 }
282 },
283 "ResourceFileModulePaths": {
284 "type": "object",
285 "description": "Default paths to use for all ResourceLoader file modules",
286 "additionalProperties": false,
287 "properties": {
288 "localBasePath": {
289 "type": "string",
290 "description": "Base path to prepend to all local paths, relative to current directory"
291 },
292 "remoteExtPath": {
293 "type": "string",
294 "description": "Base path to prepend to all remote paths, relative to $wgExtensionAssetsPath"
295 },
296 "remoteSkinPath": {
297 "type": "string",
298 "description": "Base path to prepend to all remote paths, relative to $wgStylePath"
299 }
300 }
301 },
302 "ResourceModules": {
303 "type": "object",
304 "description": "ResourceLoader modules to register",
305 "patternProperties": {
306 "^[a-zA-Z0-9-\\.]+$": {
307 "type": "object",
308 "anyOf": [
309 {
310 "description": "A ResourceLoaderFileModule definition",
311 "additionalProperties": false,
312 "properties": {
313 "localBasePath": {
314 "type": "string",
315 "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
316 },
317 "remoteBasePath": {
318 "type": "string",
319 "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
320 },
321 "remoteExtPath": {
322 "type": "string",
323 "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
324 },
325 "scripts": {
326 "type": ["string", "array"],
327 "description": "Scripts to always include (array of file paths)",
328 "items": {
329 "type": "string"
330 }
331 },
332 "languageScripts": {
333 "type": "object",
334 "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
335 "patternProperties": {
336 "^[a-zA-Z0-9-]{2,}$": {
337 "type": [
338 "string",
339 "array"
340 ],
341 "items": {
342 "type": "string"
343 }
344 }
345 }
346 },
347 "skinScripts": {
348 "type": "object",
349 "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
350 "patternProperties": {
351 ".+": {
352 "type": [
353 "string",
354 "array"
355 ],
356 "items": {
357 "type": "string"
358 }
359 }
360 }
361 },
362 "debugScripts": {
363 "type": ["string", "array"],
364 "description": "Scripts to include in debug contexts",
365 "items": {
366 "type": "string"
367 }
368 },
369 "loaderScripts": {
370 "type": ["string", "array"],
371 "description": "Scripts to include in the startup module",
372 "items": {
373 "type": "string"
374 }
375 },
376 "dependencies": {
377 "type": ["string", "array"],
378 "description": "Modules which must be loaded before this module",
379 "items": {
380 "type": "string"
381 }
382 },
383 "styles": {
384 "type": ["string", "array", "object"],
385 "description": "Styles to always load",
386 "items": {
387 "type": "string"
388 }
389 },
390 "skinStyles": {
391 "type": "object",
392 "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
393 "patternProperties": {
394 ".+": {
395 "type": [
396 "string",
397 "array"
398 ],
399 "items": {
400 "type": "string"
401 }
402 }
403 }
404 },
405 "messages": {
406 "type": ["string", "array"],
407 "description": "Messages to always load",
408 "items": {
409 "type": "string"
410 }
411 },
412 "group": {
413 "type": "string",
414 "description": "Group which this module should be loaded together with"
415 },
416 "position": {
417 "type": "string",
418 "description": "Position on the page to load this module at",
419 "enum": [
420 "bottom",
421 "top"
422 ]
423 },
424 "templates": {
425 "type": "object",
426 "description": "Templates to be loaded for client-side usage"
427 },
428 "targets": {
429 "type": ["string", "array"],
430 "description": "ResourceLoader target the module can run on",
431 "items": {
432 "type": "string"
433 }
434 }
435 }
436 },
437 {
438 "description": "A ResourceLoaderImageModule definition",
439 "additionalProperties": false,
440 "properties": {
441 "class": {
442 "enum": ["ResourceLoaderImageModule"]
443 },
444 "data": {
445 "type": "string"
446 },
447 "prefix": {
448 "type": "string"
449 },
450 "selector": {
451 "type": "string"
452 },
453 "selectorWithoutVariant": {
454 "type": "string"
455 },
456 "selectorWithVariant": {
457 "type": "string"
458 },
459 "variants": {
460 "type": "object"
461 },
462 "images": {
463 "type": "object"
464 },
465 "position": {
466 "enum": [
467 "top",
468 "bottom"
469 ]
470 }
471 }
472 },
473 {
474 "description": "An arbitrary ResourceLoaderModule definition",
475 "properties": {
476 "class": {
477 "type": "string",
478 "pattern": "^((?!ResourceLoader(File|Image)Module).)*$"
479 }
480 },
481 "required": ["class"]
482 }
483 ]
484 }
485 }
486 },
487 "ResourceModuleSkinStyles": {
488 "type": "object",
489 "description": "ResourceLoader modules for custom skin styles"
490 },
491 "ResourceLoaderSources": {
492 "type": "object",
493 "description": "ResourceLoader sources to register"
494 },
495 "ResourceLoaderLESSVars": {
496 "type": "object",
497 "description": "ResourceLoader LESS variables"
498 },
499 "ResourceLoaderLESSImportPaths": {
500 "type": "object",
501 "description": "ResourceLoader import paths"
502 },
503 "ConfigRegistry": {
504 "type": "object",
505 "description": "Registry of factory functions to create Config objects"
506 },
507 "CentralIdLookupProviders": {
508 "type": "object",
509 "description": "Central ID lookup providers"
510 },
511 "namespaces": {
512 "type": "array",
513 "description": "Method to add extra namespaces",
514 "items": {
515 "type": "object",
516 "properties": {
517 "id": {
518 "type": "integer"
519 },
520 "constant": {
521 "type": "string"
522 },
523 "name": {
524 "type": "string"
525 },
526 "gender": {
527 "type": "object",
528 "properties": {
529 "male": {
530 "type": "string"
531 },
532 "female": {
533 "type": "string"
534 }
535 }
536 },
537 "subpages": {
538 "type": "boolean",
539 "default": false
540 },
541 "content": {
542 "type": "boolean",
543 "default": false
544 },
545 "defaultcontentmodel": {
546 "type": "string"
547 },
548 "protection": {
549 "type": ["string", "array"],
550 "description": "Userright(s) required to edit in this namespace"
551 },
552 "capitallinkoverride": {
553 "type": "boolean",
554 "description": "Set $wgCapitalLinks on a per-namespace basis"
555 }
556 },
557 "required": ["id", "constant", "name"]
558 }
559 },
560 "TrackingCategories": {
561 "type": "array",
562 "description": "Tracking category message keys"
563 },
564 "DefaultUserOptions": {
565 "type": "object",
566 "description": "Default values of user options"
567 },
568 "HiddenPrefs": {
569 "type": "array",
570 "description": "Preferences users cannot set"
571 },
572 "GroupPermissions": {
573 "type": "object",
574 "description": "Default permissions to give to user groups"
575 },
576 "RevokePermissions": {
577 "type": "object",
578 "description": "Default permissions to revoke from user groups"
579 },
580 "ImplicitGroups": {
581 "type": "array",
582 "description": "Implicit groups"
583 },
584 "GroupsAddToSelf": {
585 "type": "object",
586 "description": "Groups a user can add to themselves"
587 },
588 "GroupsRemoveFromSelf": {
589 "type": "object",
590 "description": "Groups a user can remove from themselves"
591 },
592 "AddGroups": {
593 "type": "object",
594 "description": "Groups a user can add to users"
595 },
596 "RemoveGroups": {
597 "type": "object",
598 "description": "Groups a user can remove from users"
599 },
600 "AvailableRights": {
601 "type": "array",
602 "description": "User rights added by the extension"
603 },
604 "ContentHandlers": {
605 "type": "object",
606 "description": "Mapping of model ID to class name"
607 },
608 "RateLimits": {
609 "type": "object",
610 "description": "Rate limits"
611 },
612 "RecentChangesFlags": {
613 "type": "object",
614 "description": "Flags (letter symbols) shown on RecentChanges pages"
615 },
616 "MediaHandlers": {
617 "type": "object",
618 "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
619 },
620 "ExtensionFunctions": {
621 "type": [
622 "array",
623 "string"
624 ],
625 "description": "Function to call after setup has finished"
626 },
627 "ExtensionMessagesFiles": {
628 "type": "object",
629 "description": "File paths containing PHP internationalization data"
630 },
631 "MessagesDirs": {
632 "type": "object",
633 "description": "Directory paths containing JSON internationalization data"
634 },
635 "ExtensionEntryPointListFiles": {
636 "type": "object"
637 },
638 "SpecialPages": {
639 "type": "object",
640 "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
641 },
642 "AutoloadClasses": {
643 "type": "object"
644 },
645 "Hooks": {
646 "type": "object",
647 "description": "Hooks this extension uses (mapping of hook name to callback)"
648 },
649 "JobClasses": {
650 "type": "object",
651 "description": "Job types this extension implements (mapping of job type to class name)"
652 },
653 "LogTypes": {
654 "type": "array",
655 "description": "List of new log types this extension uses"
656 },
657 "LogRestrictions": {
658 "type": "object"
659 },
660 "FilterLogTypes": {
661 "type": "object"
662 },
663 "LogNames": {
664 "type": "object"
665 },
666 "LogHeaders": {
667 "type": "object"
668 },
669 "LogActions": {
670 "type": "object"
671 },
672 "LogActionsHandlers": {
673 "type": "object"
674 },
675 "Actions": {
676 "type": "object"
677 },
678 "APIModules": {
679 "type": "object"
680 },
681 "APIFormatModules": {
682 "type": "object"
683 },
684 "APIMetaModules": {
685 "type": "object"
686 },
687 "APIPropModules": {
688 "type": "object"
689 },
690 "APIListModules": {
691 "type": "object"
692 },
693 "ValidSkinNames": {
694 "type": "object"
695 },
696 "SkinOOUIThemes": {
697 "type": "object"
698 },
699 "callback": {
700 "type": [
701 "array",
702 "string"
703 ],
704 "description": "A function to be called right after MediaWiki processes this file"
705 },
706 "config": {
707 "type": "object",
708 "description": "Configuration options for this extension",
709 "properties": {
710 "_prefix": {
711 "type": "string",
712 "default": "wg",
713 "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
714 }
715 },
716 "patternProperties": {
717 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
718 "properties": {
719 "_merge_strategy": {
720 "type": "string",
721 "enum": [
722 "array_merge_recursive",
723 "array_plus_2d",
724 "array_plus",
725 "array_merge"
726 ],
727 "default": "array_merge"
728 }
729 }
730 }
731 }
732 },
733 "ParserTestFiles": {
734 "type": "array",
735 "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
736 },
737 "load_composer_autoloader": {
738 "type": "boolean",
739 "description": "Load the composer autoloader for this extension, if one is present"
740 }
741 }
742 }