docs/extension.schema.json

   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                         "additionalProperties": false,
 306                         "patternProperties": {
 307                                 "^[a-zA-Z0-9-\\.]+$": {
 308                                         "type": "object",
 309                                         "description": "A single ResourceLoader module descriptor",
 310                                         "properties": {
 311                                                 "localBasePath": {
 312                                                         "type": "string",
 313                                                         "description": "Base path to prepend to all local paths in $options. Defaults to $IP"
 314                                                 },
 315                                                 "remoteBasePath": {
 316                                                         "type": "string",
 317                                                         "description": "Base path to prepend to all remote paths in $options. Defaults to $wgScriptPath"
 318                                                 },
 319                                                 "remoteExtPath": {
 320                                                         "type": "string",
 321                                                         "description": "Equivalent of remoteBasePath, but relative to $wgExtensionAssetsPath"
 322                                                 },
 323                                                 "scripts": {
 324                                                         "type": ["string", "array"],
 325                                                         "description": "Scripts to always include (array of file paths)",
 326                                                         "items": {
 327                                                                 "type": "string"
 328                                                         }
 329                                                 },
 330                                                 "languageScripts": {
 331                                                         "type": "object",
 332                                                         "description": "Scripts to include in specific language contexts (mapping of language code to file path(s))",
 333                                                         "patternProperties": {
 334                                                                 "^[a-zA-Z0-9-]{2,}$": {
 335                                                                         "type": [
 336                                                                                 "string",
 337                                                                                 "array"
 338                                                                         ],
 339                                                                         "items": {
 340                                                                                 "type": "string"
 341                                                                         }
 342                                                                 }
 343                                                         }
 344                                                 },
 345                                                 "skinScripts": {
 346                                                         "type": "object",
 347                                                         "description": "Scripts to include in specific skin contexts (mapping of skin name to script(s)",
 348                                                         "patternProperties": {
 349                                                                 ".+": {
 350                                                                         "type": [
 351                                                                                 "string",
 352                                                                                 "array"
 353                                                                         ],
 354                                                                         "items": {
 355                                                                                 "type": "string"
 356                                                                         }
 357                                                                 }
 358                                                         }
 359                                                 },
 360                                                 "debugScripts": {
 361                                                         "type": ["string", "array"],
 362                                                         "description": "Scripts to include in debug contexts",
 363                                                         "items": {
 364                                                                 "type": "string"
 365                                                         }
 366                                                 },
 367                                                 "loaderScripts": {
 368                                                         "type": ["string", "array"],
 369                                                         "description": "Scripts to include in the startup module",
 370                                                         "items": {
 371                                                                 "type": "string"
 372                                                         }
 373                                                 },
 374                                                 "dependencies": {
 375                                                         "type": ["string", "array"],
 376                                                         "description": "Modules which must be loaded before this module",
 377                                                         "items": {
 378                                                                 "type": "string"
 379                                                         }
 380                                                 },
 381                                                 "styles": {
 382                                                         "type": ["string", "array", "object"],
 383                                                         "description": "Styles to always load",
 384                                                         "items": {
 385                                                                 "type": "string"
 386                                                         }
 387                                                 },
 388                                                 "skinStyles": {
 389                                                         "type": "object",
 390                                                         "description": "Styles to include in specific skin contexts (mapping of skin name to style(s))",
 391                                                         "patternProperties": {
 392                                                                 ".+": {
 393                                                                         "type": [
 394                                                                                 "string",
 395                                                                                 "array"
 396                                                                         ],
 397                                                                         "items": {
 398                                                                                 "type": "string"
 399                                                                         }
 400                                                                 }
 401                                                         }
 402                                                 },
 403                                                 "messages": {
 404                                                         "type": ["string", "array"],
 405                                                         "description": "Messages to always load",
 406                                                         "items": {
 407                                                                 "type": "string"
 408                                                         }
 409                                                 },
 410                                                 "group": {
 411                                                         "type": "string",
 412                                                         "description": "Group which this module should be loaded together with"
 413                                                 },
 414                                                 "position": {
 415                                                         "type": "string",
 416                                                         "description": "Position on the page to load this module at",
 417                                                         "enum": [
 418                                                                 "bottom",
 419                                                                 "top"
 420                                                         ]
 421                                                 },
 422                                                 "templates": {
 423                                                         "type": "object",
 424                                                         "description": "Templates to be loaded for client-side usage"
 425                                                 }
 426                                         }
 427                                 }
 428                         }
 429                 },
 430                 "ResourceModuleSkinStyles": {
 431                         "type": "object",
 432                         "description": "ResourceLoader modules for custom skin styles"
 433                 },
 434                 "ResourceLoaderSources": {
 435                         "type": "object",
 436                         "description": "ResourceLoader sources to register"
 437                 },
 438                 "ResourceLoaderLESSVars": {
 439                         "type": "object",
 440                         "description": "ResourceLoader LESS variables"
 441                 },
 442                 "ResourceLoaderLESSImportPaths": {
 443                         "type": "object",
 444                         "description": "ResourceLoader import paths"
 445                 },
 446                 "ConfigRegistry": {
 447                         "type": "object",
 448                         "description": "Registry of factory functions to create Config objects"
 449                 },
 450                 "namespaces": {
 451                         "type": "array",
 452                         "description": "Method to add extra namespaces",
 453                         "items": {
 454                                 "type": "object",
 455                                 "properties": {
 456                                         "id": {
 457                                                 "type": "integer"
 458                                         },
 459                                         "constant": {
 460                                                 "type": "string"
 461                                         },
 462                                         "name": {
 463                                                 "type": "string"
 464                                         },
 465                                         "gender": {
 466                                                 "type": "object",
 467                                                 "properties": {
 468                                                         "male": {
 469                                                                 "type": "string"
 470                                                         },
 471                                                         "female": {
 472                                                                 "type": "string"
 473                                                         }
 474                                                 }
 475                                         },
 476                                         "subpages": {
 477                                                 "type": "boolean",
 478                                                 "default": false
 479                                         },
 480                                         "content": {
 481                                                 "type": "boolean",
 482                                                 "default": false
 483                                         },
 484                                         "defaultcontentmodel": {
 485                                                 "type": "string"
 486                                         },
 487                                         "protection": {
 488                                                 "type": ["string", "array"],
 489                                                 "description": "Userright(s) required to edit in this namespace"
 490                                         },
 491                                         "capitallinkoverride": {
 492                                                 "type": "boolean",
 493                                                 "description": "Set $wgCapitalLinks on a per-namespace basis"
 494                                         }
 495                                 },
 496                                 "required": ["id", "constant", "name"]
 497                         }
 498                 },
 499                 "TrackingCategories": {
 500                         "type": "array",
 501                         "description": "Tracking category message keys"
 502                 },
 503                 "DefaultUserOptions": {
 504                         "type": "object",
 505                         "description": "Default values of user options"
 506                 },
 507                 "HiddenPrefs": {
 508                         "type": "array",
 509                         "description": "Preferences users cannot set"
 510                 },
 511                 "GroupPermissions": {
 512                         "type": "object",
 513                         "description": "Default permissions to give to user groups"
 514                 },
 515                 "RevokePermissions": {
 516                         "type": "object",
 517                         "description": "Default permissions to revoke from user groups"
 518                 },
 519                 "ImplicitGroups": {
 520                         "type": "array",
 521                         "description": "Implicit groups"
 522                 },
 523                 "GroupsAddToSelf": {
 524                         "type": "object",
 525                         "description": "Groups a user can add to themselves"
 526                 },
 527                 "GroupsRemoveFromSelf": {
 528                         "type": "object",
 529                         "description": "Groups a user can remove from themselves"
 530                 },
 531                 "AddGroups": {
 532                         "type": "object",
 533                         "description": "Groups a user can add to users"
 534                 },
 535                 "RemoveGroups": {
 536                         "type": "object",
 537                         "description": "Groups a user can remove from users"
 538                 },
 539                 "AvailableRights": {
 540                         "type": "array",
 541                         "description": "User rights added by the extension"
 542                 },
 543                 "ContentHandlers": {
 544                         "type": "object",
 545                         "description": "Mapping of model ID to class name"
 546                 },
 547                 "RateLimits": {
 548                         "type": "object",
 549                         "description": "Rate limits"
 550                 },
 551                 "RecentChangesFlags": {
 552                         "type": "object",
 553                         "description": "Flags (letter symbols) shown on RecentChanges pages"
 554                 },
 555                 "MediaHandlers": {
 556                         "type": "object",
 557                         "description": "Plugins for media file type handling. Each entry in the array maps a MIME type to a PHP class name."
 558                 },
 559                 "ExtensionFunctions": {
 560                         "type": [
 561                                 "array",
 562                                 "string"
 563                         ],
 564                         "description": "Function to call after setup has finished"
 565                 },
 566                 "ExtensionMessagesFiles": {
 567                         "type": "object",
 568                         "description": "File paths containing PHP internationalization data"
 569                 },
 570                 "MessagesDirs": {
 571                         "type": "object",
 572                         "description": "Directory paths containing JSON internationalization data"
 573                 },
 574                 "ExtensionEntryPointListFiles": {
 575                         "type": "object"
 576                 },
 577                 "SpecialPages": {
 578                         "type": "object",
 579                         "description": "SpecialPages implemented in this extension (mapping of page name to class name)"
 580                 },
 581                 "AutoloadClasses": {
 582                         "type": "object"
 583                 },
 584                 "Hooks": {
 585                         "type": "object",
 586                         "description": "Hooks this extension uses (mapping of hook name to callback)"
 587                 },
 588                 "JobClasses": {
 589                         "type": "object",
 590                         "description": "Job types this extension implements (mapping of job type to class name)"
 591                 },
 592                 "LogTypes": {
 593                         "type": "array",
 594                         "description": "List of new log types this extension uses"
 595                 },
 596                 "LogRestrictions": {
 597                         "type": "object"
 598                 },
 599                 "FilterLogTypes": {
 600                         "type": "object"
 601                 },
 602                 "LogNames": {
 603                         "type": "object"
 604                 },
 605                 "LogHeaders": {
 606                         "type": "object"
 607                 },
 608                 "LogActions": {
 609                         "type": "object"
 610                 },
 611                 "LogActionsHandlers": {
 612                         "type": "object"
 613                 },
 614                 "Actions": {
 615                         "type": "object"
 616                 },
 617                 "APIModules": {
 618                         "type": "object"
 619                 },
 620                 "APIFormatModules": {
 621                         "type": "object"
 622                 },
 623                 "APIMetaModules": {
 624                         "type": "object"
 625                 },
 626                 "APIPropModules": {
 627                         "type": "object"
 628                 },
 629                 "APIListModules": {
 630                         "type": "object"
 631                 },
 632                 "ValidSkinNames": {
 633                         "type": "object"
 634                 },
 635                 "SkinOOUIThemes": {
 636                         "type": "object"
 637                 },
 638                 "callback": {
 639                         "type": [
 640                                 "array",
 641                                 "string"
 642                         ],
 643                         "description": "A function to be called right after MediaWiki processes this file"
 644                 },
 645                 "config": {
 646                         "type": "object",
 647                         "description": "Configuration options for this extension",
 648                         "properties": {
 649                                 "_prefix": {
 650                                         "type": "string",
 651                                         "default": "wg",
 652                                         "description": "Prefix to put in front of configuration settings when exporting them to $GLOBALS"
 653                                 }
 654                         },
 655                         "patternProperties": {
 656                                 "^[a-zA-Z_\u007f-\u00ff][a-zA-Z0-9_\u007f-\u00ff]*$": {
 657                                         "type": ["object", "array", "string", "integer", "null", "boolean"],
 658                                         "properties": {
 659                                                 "_merge_strategy": {
 660                                                         "type": "string",
 661                                                         "enum": [
 662                                                                 "array_merge_recursive",
 663                                                                 "array_plus_2d",
 664                                                                 "array_plus",
 665                                                                 "array_merge"
 666                                                         ],
 667                                                         "default": "array_merge"
 668                                                 }
 669                                         }
 670                                 }
 671                         }
 672                 },
 673                 "ParserTestFiles": {
 674                         "type": "array",
 675                         "description": "Parser test suite files to be run by parserTests.php when no specific filename is passed to it"
 676                 }
 677         }
 678 }