Jump to content

Manual:Extensões

From mediawiki.org
This page is a translated version of the page Manual:Extensions and the translation is 100% complete.

Uma extensão permite a você personalizar a aparência e o funcionamento do MediaWiki.

  • Administradores de sistema podem instalar (ou remover) extensões nas instalações do MediaWiki gerenciadas por eles.
  • Desenvolvedores podem criar novas extensões ou contribuir com as já existentes.
Enquanto algumas extensões são mantidas por desenvolvedores do MediaWiki, outras são escritas por desenvolvedores terceiros e podem não ter manutenção. Como resultado, várias extensões são sucetíveis a bugs — incluindo, em alguns casos, falhas de segurança. Nem todas as extensões funcionam em todas as versões do MediaWiki, e não há garantia de que todas sejam compatíveis entre si. Use extensões por sua conta e risco, especialmente aquelas marcadas como inseguras. Se uma extensão que requer correções (patches) ao software principal, certifique-se de fazer um backup do seu banco de dados com antecedência para evitar o risco de quebrar sua wiki.

Selecionando extensões

Extensões agrupadas

Diversas extensões são incluídas no MediaWiki por padrão.

Essas extensões devem, em geral, ser de alta utilidade, ter um desempenho eficiente, ser estáveis, bem escritas e não apresentar problemas de segurança graves conhecidos. Elas também devem ser compatíveis com as versões mais recentes do MediaWiki e entre si (ou seja, uma extensão não deve bloquear as funções da outra). Uma extensão agrupada pode ter dependência de uma ou mais outras extensões, desde que estas também estejam agrupadas.

Os administradores do site recebem as extensões automaticamente ao instalar ou atualizar o MediaWiki. Ao atualizar o MediaWiki, quaisquer atualizações de extensões também serão aplicadas automaticamente. Os administradores do site podem optar por desinstalar qualquer uma delas, se assim desejarem.

Há discussões abertas e em andamento sobre quais extensões devem fazer parte deste grupo. Você pode sugerir extensões adicionais para serem agrupadas . Extensões serão agrupadas assim que os desenvolvedores chegarem a um consenso sobre isso.

Uma extensão pode ser removida do pacote se sua funcionalidade for incorporada ao núcleo do MediaWiki , se for substituída por uma alternativa ou na improvável hipótese de serem descobertas vulnerabilidades de segurança graves e insolucionável.

Procurar extensões

Navegue por Category:Todas as extensões ou Category:Extensões por categoria para ver todas as variedades de extensões disponíveis.

Verificar extensões instaladas

É possível verificar quais extensões estão ativas em uma instância do MediaWiki acessando a página Special:Version e rolando para baixo até o título Extensões instaladas (âncora #mw-version-ext). Por exemplo, estas extensões estão instaladas nesta wiki, e estas extensões estão ativas na Wikipédia em português.

Extensões populares

WikiApiary contabiliza wikis nas quais extensões estão instaladas. Isso representa instalações reais e não apenas downloads (ou seja, consulta as APIs da wiki), mas também (em 2023) não está completamente atualizado. Também não inclui instalações em wikis privadas.

Instalar uma extensão

Para obter mais orientações, consulte também Manual:Extensões/Instalação e atualização

O MediaWiki estará pronto para aceitar extensões logo após a instalação concluir-se. Para adicionar uma extensão, siga os passos a seguir:

  1. Antes de você começar
    Várias extensões fornecem instruções elaboradas para a instalação utilizando comandos do Unix. Você precisa de acesso ao shell (SSH) para inserir esses comandos listados nas páginas de ajuda da extensão.
  2. Baixe a extensão.
    O Distribuidor de Extensões ajuda você a selecionar e baixar as extensões mais populares.
    As extensões costumam ser distribuídas em pacotes modulares. Elas geralmente ficam em seu próprio subdiretório em $IP /extensions/. Uma lista de extensões armazenadas no repositório Git da Wikimedia está localizada em git:mediawiki/extensions. Algumas extensões não usam controle de versão e não são recomendadas.
    Algumas extensões também estão disponíveis em bundles, via Composer ou repositórios de pacotes.
    Recomenda-se a leitura do arquivo README antes da instalação. Geralmente contém informações importantes sobre a configuração.
  3. Instale a extensão.
    No final do arquivo LocalSettings.php , adicione:
    wfLoadExtension( 'ExtensionName' );
    
    Esta linha força o interpretador do PHP a ler o arquivo da extensão, tornando-o assim acessível ao MediaWiki.
    Algumas extensões podem entrar em conflito com scripts de manutenção, por exemplo, se acessarem diretamente $_SERVER (não recomendado). Nesse caso, elas podem ser envolvidas na condicional para que os scripts de manutenção ainda possam ser executados.
    if ( !$wgCommandLineMode ) {
       wfLoadExtension ( 'ExtensionName' );
    }
    
    O script de manutenção importDump.php vai falhar para qualquer extensão que exija espaços nominais customizados que estejam incluídos dentro da condicional acima, assim como Extension:Semantic MediaWiki , Extension:Page Forms .
Garanta que as permissões necessárias estão definidas para as extensões!
Embora este procedimento de instalação é suficiente para a maioria das extensões, algumas requerem um procedimento de instalação diferente. Verifique a documentação de sua extensão para mais detalhes.
Se você quer alterar a configuração dos variáves no LocalSettings.php, você deverá fazer isso depois de incluir a extensão. Caso contrário, os padrões definidos na extensão irão substituir suas configurações.

Atualizar uma extensão

Algumas extensões requerem serem atualizadas cada vez que você atualizar o MediaWiki, enquanto outras funcionam em múltiplas versões. Para atualizar a uma nova versão de uma extensão:

  1. Baixe a nova versão da extensão.
  2. Substitua todos os arquivos da extensão no diretório extensions/ExtensionName pelos novos arquivos. Não remova a configuração da extensão presente no LocalSettings.php.
  3. Se a extensão exigir alterações no banco de dados do MediaWiki, você precisará executar o script de manutenção update.php . A maioria das extensões irá mencionar se este script precisa ou não ser executado. (Faça backup de seus dados antes de executar o script). Se você não tem acesso à linha de comando, você também pode usar o web updater.
Estas instruções cobrem 99% das extensões. Se a extensão específica que você estiver atualizando possuir instruções que são diferentes destas, você provavelmente deverá seguir as instruções da extensão específica.

Desinstalando uma extensão 

Remova a linha de LocalSettings.php com o nome da extensão para desinstalá-lo:

wfLoadExtension( 'ExtensionName' );
  • Você deve remover todas as linhas referentes à configuração da extensão.

Desenvolvimento de extensões

O núcleo do MediaWiki oferece diversas maneiras para que extensões alterem o comportamento e a aparência de uma wiki. Vários pontos de extensão oferecem às extensões flexibilidade para adicionar recursos e funcionalidades, como exibir uma página especial ou definir um módulo de API. Para começar, consulte o guia para desenvolvimento de extensões . Antes de escrever uma nova extensão, considere contribuir para uma extensão existente ou ajudar com uma extensão sem manutenção .

Os usuários também podem fazer uma solicitação geral no Phabricator e torcer para que sua boa ideia seja escolhida por um desenvolvedor. Consulte https://phabricator.wikimedia.org/tag/mediawiki-extension-requests/

Ver também