Extensions:

• Installation and upgrade
• Development
• Registration
• Translation
• All extensions
• Category
• Extensions FAQ

Se pretende que a sua extensão seja instalada nos sites da Wikimédia, leia Escrever uma extensão para a implementação

Esta página é um guia de desenvolvimento das extensões para o MediaWiki. Antes de começar, explore complete list in: Category:Extensions by category ^{pt[[::Category:Extensions by category| ]]} para ver se uma extensão já existe para o seu caso de utilização.

O desenvolvimento de extensão consiste nestas partes:

1. Configuração
2. Implementação
3. Tradução
4. Publicação

Configuração

Para configurar uma nova extensão, comece por configurar um ambiente de desenvolvimento para o MediaWiki , e siga as instruções para instalar e copiar a extensão BoilerPlate .

{
	"name": "MyExtension",
	"author": "John Doe",
	"url": "https://www.mediawiki.org/wiki/Extension:MyExtension",
	"description": "This extension is an example.",
	"version": "1.5",
	"license-name": "GPL-2.0-or-later",
	"type": "validextensiontype",
	"manifest_version": 2
}

wfLoadExtension( 'MyExtension' );

wfLoadExtension( 'MyExtension' );
$wgMyExtensionConfigThis = 1;
$wgMyExtensionConfigThat = false;

{
	"config": {
		"BoilerPlateEnableFoo": {
			"value": true,
			"description": "Enables the foo functionality"
		}
	}
}

{
	"AutoloadClasses": {
		"MyExtension": "includes/MyExtension.php"
	}
}

	if ( ExtensionRegistry::getInstance()->isLoaded( 'HitCounters', '>=1.1' ) ) {
		/* do some extra stuff, if extension HitCounters is present in version 1.1 and above */
	}

	if ( ExtensionRegistry::getInstance()->isLoaded( 'OpenID Connect' ) ) {
    ...
	}

MediaWiki core provides several ways for extensions to change the behavior, functionality, and appearance of a wiki. Most extensions use more than one of these extension points. For a complete list of extension points supported in extension.json, see the schema reference .

• Hooks : Inject custom code at key points in MediaWiki core code, such as when a user logs in or saves a page. Extensions can also define new hooks.
• Domain events : React to changes to the wiki's state, such as when a page is edited. Extensions can also define their own events. 1.44
• API modules : Define API modules based on the Action API or REST API . These modules can be called by bots or clients.
• Jobs : Add jobs to MediaWiki's JobQueue to perform process-intensive tasks asynchronously, such as sending notification emails.

• Display a special page : Special pages provide dynamically generated content, often based on system state, database queries, and user inputs.
• Perform a page action : The action URL parameter generates a custom page based on the current page, usually to provide information (such as page history) or to perform an action (such as edit the page). In addition to the default actions provided by MediaWiki core, extensions can define a new page action.
• Add a tracking category : Help users find pages with similar characteristics by automatically adding pages to custom categories.

• Extend wiki markup : Extensions can add custom functionality to MediaWiki's wikitext markup using template syntax ({{...}}) or tags (‎<example />). These customizations are used to generate content and to interact with MediaWiki during page rendering.
• Support a content model : By default, wiki pages can be stored using a few standard content models, such as wikitext and JSON. Extensions can provide support for new content models by adding a content handler.
• Support a media type : Extensions can add to the default set of supported media file types by adding a media handler.

• Log a user or system action : On wiki, actions are tracked for transparency and collaboration. To support this feature, extensions can add custom entries and functionality to Special:Log.
• Add a recent-changes flag : Extensions can add custom flags to the following special pages to help moderators track page changes: Special:RecentChanges, Special:Watchlist, Special:RecentChangesLinked
• Add a revision tag : Extensions can add annotations associated with a revision or log entry, such as for edits made using the VisualEditor extension.

• Add a provider : Extensions can add support for new login mechanisms and session management methods.

Adicionar tabelas à base de dados

Make sure the extension doesn't modify the core database tables. Instead, extension should create new tables with foreign keys to the relevant MW tables.

Aviso:

Se a sua extensão for usada em alguma wiki alojada pela WMF, siga o guia de alterações do esquema.

Se a sua extensão precisa de adicionar tabelas próprias à base de dados, use o hook LoadExtensionSchemaUpdates . Ver a página do manual para mais informação em uso.

Localização

Localisation – trata sobre o motor de localização do MediaWiki. Em particular, há uma lista das características que se podem localizar e alguma análise das classes do código-fonte do MediaWiki envolvidas na localização. Criação de novas mensagens Localization checks – discusses common problems with localized messages Namespaces

If you want your extension to be used on wikis that have a multi-lingual readership, you will need to add localisation support to your extension.

{
	"myextension-desc": "Adds the MyExtension great functionality.",
	"myextension-action-message": "This is a test message"
}

{
	"myextension-desc": "The description of MyExtension used in Extension credits.",
	"myextension-action-message": "Adds 'message' after 'action' triggered by user."
}

{
	"MessagesDirs": {
		"MyExtension": [
			"i18n"
		]
	}
}

wfMessage( 'myextension-addition', '1', '2', '3' )->parse()

Publicação

To autocategorize and standardize the documentation of your existing extension, please see Modelo: Extensão . To add your new extension to this Wiki:

A developer sharing their code in the MediaWiki code repository should expect:

Feedback / Criticism / Code reviews

Review and comments by other developers on things like framework use, security, efficiency and usability.

Developer tweaking

Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.

Improved access for wiki sysadmins

If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then create a Conta de programador to continue maintaining it.

Future versions by other developers

New branches of your code being created automatically as new versions of MediaWiki are released. You should backport to these branches if you want to support older versions.

Incorporation of your code into other extensions with duplicate or similar purposes — incorporating the best features from each extension.

Credit

Credit for your work being preserved in future versions — including any merged extensions.

Similarly, you should credit the developers of any extensions whose code you borrow from — especially when performing a merger.

Any developer who is uncomfortable with any of these actions occurring should not host in the code repository. You are still encouraged to create a summary page for your extension on the wiki to let people know about the extension, and where to download it.

If you intend to have your extension deployed on Wikimedia sites (including possibly Wikipedia), additional scrutiny is warranted in terms of performance and security. Consultar Escrever uma extensão para a implementação .

Please be aware that review and deployment of new extensions on Wikimedia sites can be extremely slow, and in some cases has taken more than two years.^[4]

Documentação de ajuda

You should provide public domain help documentation for features provided by your extension. The convention is for extensions to have their user-focused help pages under a pseudo-namespace of Help:Extension:<ExtensionName>, with whatever subpages are required (the top level page will be automatically linked from the extension infobox if it exists). Ajuda:CirrusSearch is a example of good documentation. You should give users a link to the documentation via the addHelpLink() function.

There are a number of common approaches to releasing updates to extensions. These are generally defined according to the compatibility policy of the extension (master, rel, or ltsrel):

• master – Releases may be tagged with version numbers on the master branch, and documentation provided on the extension's homepage describing which extension versions are compatible with which core versions. Release branches will still be created automatically, and you may wish to delete these if they are not intended to be used.
• rel e ltsrel – Release by backporting changes to the REL1_* branches (either all changes, or only critical ones). Version numbers are generally not needed unless the extension is a dependency of another (the version number can then be provided in the other extension's configuration to ensure that incompatible combinations aren't installed). Many extensions will stay at the same version number for years.

• Master: the master branch of the extension is compatible with as many old versions of core as possible. This results in a maintenance burden (backwards-compatibility hacks need to be kept around for a long time, and changes to the extension need to be tested with several versions of MediaWiki), but sites running old MediaWiki versions benefit from functionality recently added to the extension.
• Release branches: release branches of the extension are compatible with matching branches of core, e.g. sites using MediaWiki 1.44 need to use the REL1_44 branch of the extension. (For extensions hosted on Gerrit, these branches are automatically created when new versions of MediaWiki are released.) This results in cleaner code and faster development but users on old core versions do not benefit from bugfixes and new features unless they are backported manually.

Extension developers should open an account on Wikimedia's Phabricator , and request a new project for the extension. This provides a public venue where users can submit issues and suggestions, and you can collaborate with users and other developers to triage bugs and plan features of your extension.

Ver também

• Manual:Registo de Extensão – provides further developer documentation on how to register extensions and skins.
• API: Extensões – explains how your extension can provide an API to clients.
• Manual: Estender a marcação da wiki
• Manual:Convenções de programação
• Best practices for extensions
• ResourceLoader

• Extensão:Exemplos – implements some example features with extensive inline documentation.
  • examples git repo with this and other example code
• Extension:BoilerPlate –

uma extensão clichê funcionando, útil como um ponto de partida para o seu próprio ramal (repositório git).

• • Read the Example extension, base your own code on the BoilerPlate extension.
• cookiecutter-mediawiki-extension – a cookiecutter template which generates a boilerplate extension (with variables etc.).

• • Can also generate the BoilerPlate extension.
• List of simple extensions – copy specific code from them.

Referências