Jump to content

Manual: Desenvolvimento de Extensões

From mediawiki.org
This page is a translated version of the page Manual:Developing extensions and the translation is 64% complete.
Languages:
Extensions:
Extensões do MediaWiki

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 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 .

Nós recomendamos que durante o processo de desenvolvimento, desative a cache definindo $wgMainCacheType = CACHE_NONE e $wgCacheDirectory = false, caso contrário as mensagens do sistema e as outras alterações poderão não aparecer.

Estrutura

Uma extensão mínima tem a seguinte estrutura:

MyExtension/extension.json
Guarda as instruções de configuração. O nome do ficheiro tem de ser extension.json. (Antes do MediaWiki 1.25, as instruções de configuração estavam num ficheiro MyExtension/MyExtension.php com o nome igual ao da extensão. Muitas extensões ainda têm calços para compatibilidade com versões anteriores neste ficheiro PHP).
MyExtension/includes/ (or MyExtension/src/)
Guarda o código de execução PHP para a extensão.
MyExtension/resources/ (or MyExtension/modules/)
Guarda os recursos do lado do cliente, tais como JavaScript, CSS e LESS para a extensão.
MyExtension/i18n/*.json
Guarda a informação de localização para a extensão.
MyExtension/README.md
A boa prática é adicionar um ficheiro README com informação básica sobre como instalar e configurar a extensão. Utilize texto simples ou a "Marcação". Para um exemplo de texto simples, veja a página de Phabricator Diffusion para Extensão: Page Forms . Se for utilizado a "Marcação", adicione a extensão de ficheiro .md. Por exemplo, veja o ficheiro README.md para Parsoid em Phabricator Diffusion.

Quando desenvolver uma extensão, substitua MyExtension em cima com o nome da sua extensão. Utilize os nomes UpperCamelCase para a sua diretoria e ficheiros PHP; esta é a convenção geral da nomeação de ficheiro.[1]

Registo

Versão MediaWiki:
≥ 1.25

O ficheiro extension.json contém os dados de configuração para a extensão. Aqui tem um exemplo de um extension.json mínimo: 

{
	"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
}

Muitos dos campos são opcionais, mas preenchê-los por completo é uma boa prática. Para um exemplo mais completo de extension.json, veja a extensão BoilerPlate.

O manifest_version refere-se à versão do esquema com o qual o ficheiro extension.json . está escrito. Consulte a documentação sobre esta funcionalidade. A menos que precise de oferecer suporte para uma versão mais antiga do MediaWiki, escolha a versão mais recente.

Assim que tenha configurado um ficheiro extension.json para a sua extensão, a extensão irá aparecer na sua página local Special:Version.

Licença

MediaWiki is an open-source project and users are encouraged to make any MediaWiki extensions under an Open Source Initiative (OSI) approved license compatible with GPL-2.0-or-later (Wikimedia's standard software license).

We recommend adopting one of the following compatible licenses for your projects in Gerrit:

For extensions that have a compatible license, you can request developer access to the MediaWiki source repositories for extensions. To specify the licence in code and with "license-name" a key should be used to provide its short name, e.g. "GPL-2.0-or-later" or "MIT" adhering to the list of identifiers at spdx.org.

Tornar a extensão configurável pelo utilizador

Idealmente, os utilizadores deverão poder instalar a sua extensão, adicionando apenas uma linha no LocalSettings.php. 

wfLoadExtension( 'MyExtension' );

Se quer que a sua extensão seja configurável pelo utilizador, deve definir e documentar alguns parâmetros de configuração e a configuração do utilizador deverá ser parecida com isto: 

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

Se quer que o utilizador possa configurar a sua extensão, terá de fornecer uma ou mais variáveis de configuração. É boa ideia dar a essas variáveis um nome único. Eles também deveriam seguir as convenções para a nomeação do MediaWiki (Por exemplo, as variáveis globais deveriam começar com $wg).

Por exemplo, se a sua extensão se chama MyExtension, pode querer nomear todas as suas variáveis ​​de configuração para começarem com $wgMyExtension. É importante que nenhum do núcleo do MediaWiki inicie as suas variáveis desta maneira e que você tenha feito um trabalho razoável ao verificar se nenhuma das extensões publicadas começa as suas variáveis deste modo. Os utilizadores não gostarão de ter de escolher entre a sua extensão e outras por ter escolhido usar nomes de variáveis sobrepostos.

Também é boa ideia incluir documentação completa de todas as variáveis de configuração nas suas notas de instalação.

Aqui tem um exemplo de como configurar uma variável de configuração em extension.json: 

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

Note que depois de chamar wfLoadExtension( 'BoilerPlate' ); a variável global $wgBoilerPlateEnableFoo não existe. Se definir a variável, por exemplo, em LocalSettings.php, então o valor predefinido em extension.json não será utilizado.

Para mais detalhes em como utilizar a variável global dentro das extensões personalizadas, por favor, consulte Configuração para os programadores .

Preparar classes para carregamento automático

Se decidir utilizar as classes para implementar a sua extensão, o MediaWiki fornece um mecanismo simplificado para auxiliar o PHP a encontrar o ficheiro fonte onde a sua classe está localizada. Na maioria dos casos, isto deveria evitar que tenha de escrever o seu próprio método __autoload($classname).

Para utilizar o mecanismo de carregamento automático do MediaWiki, adicione as entradas no campo AutoloadClasses . A chave de cada entrada é o nome da classe; o valor é o ficheiro que guarda a definição da classe. Para uma extensão simples de uma só classe, a classe recebe normalmente o mesmo nome que a extensão, pelo que a sua secção de carregamento automático deve ter a seguinte forma (neste exemplo, a extensão chama-se MyExtension): 

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

O nome do ficheiro é relativo ao diretório onde se encontra o ficheiro extension.json.

Para mais extensões complexas, deveriam ser considerados os espaços nominais. Consulte Manual:Extension.json/Schema#AutoloadNamespaces para detalhes.

Manipulação de dependências

Assume that an extension requires the presence of another extension, for example because functionalities or database tables are to be used and error messages are to be avoided in case of non-existence.

For example the extension CountingMarker requires the presence of the extension HitCounters for certain functions.

One way to specify this would be by using the requires key in extension.json .

Another option is using ExtensionRegistry (available since MW 1.25): 

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

Currently (as of February 2024, MediaWiki 1.41.0) the name of the extension-to-be-checked needs to exactly match the name in their extension.json.[2][3]

Exemplo: if you want to check the load status of extension OpenIDConnect, you have to use it with a space 

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

Implementação

Para obter uma visão geral da arquitetura, estrutura e convenções de código para as extensões, consulte Best practices for extensions .

Pontos de extensão

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 .

Geral

  • 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
  • Módulos de API : Define API modules based on the Action API or REST API . These modules can be called by bots or clients.
  • Tarefas : Add jobs to MediaWiki's JobQueue to perform process-intensive tasks asynchronously, such as sending notification emails.

Páginas

  • Exibir uma página especial : Special pages provide dynamically generated content, often based on system state, database queries, and user inputs.
  • Realizar uma ação de página : 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.
  • Adicionar uma categoria de rastreamento : Help users find pages with similar characteristics by automatically adding pages to custom categories.

Conteúdo

  • Marcação de wiki estendida : 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.
  • Suporta um modelo de conteúdo : 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.
  • Suporta um tipo de unidade : Extensions can add to the default set of supported media file types by adding a media handler.

Ferramentas de moderação

  • Registar um utilizador ou ação do sistema : 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.

Autenticação

  • Adicionar um provedor : As extensões podem adicionar suporte para os novos mecanismos de autenticação e métodos de gestão de sessões.

Adicionar tabelas à base de dados

Certifique-se que a extensão não modifica as tabelas principais da base de dados Instead, extension should create new tables with foreign keys to the relevant MW tables.

Aviso Aviso: Se a sua extensão for utilizada em qualquer produção da wiki alojada pela WMF, por favor, siga estes guias para criar novas tabelas e alterações de esquema.

Se a sua extensão precisa de adicionar tabelas próprias à base de dados, utilize o hook LoadExtensionSchemaUpdates . Consulte a página do manual para mais informação sobre a utilização.


Registar atributos para outras extensões

Attributes allow extensions to register something, such as a module, with another extension. For example, extensions can use attributes to register a plugin module with the VisualEditor extension. Para mais informação, consulte Registo de Extensão .

Localização

Enquanto estiver desenvolvendo, experimente desativar o cache com as configurações $wgMainCacheType = CACHE_NONE e $wgCacheDirectory = false, caso contrário suas mudanças nas mensagens do sistema poderão não ser exibidas.

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.

Guardar mensagens em <language-key>.json

Store message definitions in a localisation JSON file, one for each language key your extension is translated in. The messages are saved with a message key and the message itself using standard JSON format. Each message id should be lowercase and may not contain spaces. Each key should begin with the lowercased extension name. An example you can find in the MobileFrontend extension. Here is an example of a minimal JSON file (in this case en.json):

en.json 

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

Guardar a documentação de mensagem em qqq.json

The documentation for message keys can be stored in the JSON file for the pseudo language with code qqq. A documentation of the example above can be:

qqq.json: 

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

Carregar o ficheiro de tradução

In your extension.json, define the location of your messages files (e.g. in directory i18n/): 

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

utilizar wfMessage no PHP

In your setup and implementation code, replace each literal use of the message with a call to wfMessage( $msgID, $param1, $param2, ... ). In classes that implement IContextSource (as well as some others such as subclasses of SpecialPage), you can use $this->msg( $msgID, $param1, $param2, ... ) instead. Exemplo: 

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

Utilizar mw.message no JavaScript

It's possible to use i18n functions in JavaScript too. Para detalhes, consulte Manual: API das Mensagens .


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.

Implementar e registar

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

If your extension adds namespaces, you may wish to register its default namespaces; likewise, if it adds database tables or fields, you may want to register those at database field prefixes .

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

Deveria proporcionar documentação de ajuda do domínio público para as funcionalidades fornecidas pela sua extensão. 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 é um exemplo de boa documentação. Deveria fornecer aos utilizadores uma hiperligação para a documentação através da função addHelpLink() .

Lançamento de atualizações

Há várias abordagens comuns para lançar atualizações para as extensões. 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.

Suporte para outras versões principais

There are two widespread conventions for supporting older versions of MediaWiki core:

  • 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 maintainers should declare with the compatibility policy parameter of the {{Extensão }} template which convention they follow.

Fornecer apoio / colaboração

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.


Consultar também

Aprender pelo exemplo

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

    • "Leia" a extensão Example, baseie o seu próprio código na extensão BoilerPlate.
  • cookiecutter-mediawiki-extension – Um modelo cookiecutter que gera uma extensão boilerplate (com variáveis, etc.).
    • Permite-lhe começar rapidamente com a sua própria extensão.
    • Também pode gerar a extensão BoilerPlate.
  • Lista de extensões simples – copiar código específico delas.

Referências

  1. ↑ mailarchive:wikitech-l/2011-August/054839.html
  2. ↑ https://www.mediawiki.org/wiki/Project%3ASupport%20desk/Flow/2024/02#h-%5BDeveloper_question%5D_ExtensionRegistry%3A%3AgetInstance%28%29-%3EisLoaded%28_%27OpenIDConnect%27-20240204084500
  3. ↑ https://phabricator.wikimedia.org/T356596
  4. ↑ phabricator:T148848
Retrieved from "https://www.mediawiki.org/w/index.php?title=Manual:Developing_extensions/pt&oldid=7981417"