Predefinição:Instalação de extensão
- Baixe e mova a pasta extraída
ExtensionInstallao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall
- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
| Utiliza Lua: |
Uso
Installation instructions.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Extension name | 1 | Set the extension name manually.
| String | optional |
| Git submodule | git-submodule | Add --recurse-submodules to the git clone command | Boolean | optional |
| Vagrant role name | vagrant | If given, shows how to install extension with the Vagrant's enable-role command | String | optional |
| Download link | download-link | Overwrite the download link.
| URL | optional |
| LocalSettings early | localsettingsearly | Pass custom php code that the user should include in [[LocalSettings.php]] before the extension is loaded.
| Unknown | optional |
| LocalSettings | localsettings | Pass custom PHP code that the user should include in [[LocalSettings.php]].
| Unknown | optional |
| Database update | db-update | If the extension requires the update script to be run, set this parameter to any value. (For example, if it has one or more database tables that need to be created.)
| Boolean | optional |
| Composer | composer | If the extension uses Composer to manage dependencies, set this parameter to any value. Not that this does not indicate that the extension is able to be installed with Composer.
| Boolean | optional |
| Custom steps 0 | custom-steps0 | Additional steps before download, e.g. other required extensions (as an unordered "* list"). | Content | optional |
| Custom steps | custom-steps | Additional steps (as an unordered "* list"). | Content | optional |
| Supports registration | registration | Changes the template to use <code>wfLoadExtension()</code> if it supports registration. Set to any value if the extension supports registration, or to <code>required</code> if it <em>only</em> supports registration and doesn't support the old-style of loading. | String | optional |
| No registration version | no-registration-version | The MediaWiki version for which extension registration should not be used.
| Unknown | optional |
See also
Exemplos
A seguir, há alguns exemplos de como usar essa predefinição:
Simples
{{ExtensionInstall}}
- Baixe e mova a pasta extraída
MyExtensionao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
require_once "$IP/extensions/MyExtension/MyExtension.php";Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Nome
{{ExtensionInstall|CategoryTree}}
- Baixe e mova a pasta extraída
CategoryTreeao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
require_once "$IP/extensions/CategoryTree/CategoryTree.php";Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Ligação para baixar
{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
- Download e coloque o(s) arquivo(s) num diretório chamado
MyExtensionna sua pastaextensions/.- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
require_once "$IP/extensions/MyExtension/MyExtension.php";Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
LocalSettings
{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
- Baixe e mova a pasta extraída
MyExtensionao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
require_once "$IP/extensions/MyExtension/MyExtension.php"; $wgUseAjax = true;Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
LocalSettings “antecipado”
{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // Isso deve ser incluido antes do carregamento da extensão
}}
- Baixe e mova a pasta extraída
MyExtensionao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
$wgUseAjax = true; // Isso deve ser incluido antes do carregamento da extensão require_once "$IP/extensions/MyExtension/MyExtension.php";Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Atualizando o banco de dados
{{ExtensionInstall
|db-update=Yes
}}
- Baixe e mova a pasta extraída
MyExtensionao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Execute o script de atualização que criará automaticamente as tabelas necessárias a essa extensão no banco de dados.
Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Composer
{{ExtensionInstall
|composer=Yes
}}
- Baixe e mova a pasta extraída
MyExtensionao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Se estiver instalando a partir do Git, execute o Composer para instalar as dependências do PHP através do comando
composer install --no-devno diretório da extensão. (Veja T173141 para possíveis complicações.)- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
require_once "$IP/extensions/MyExtension/MyExtension.php";Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Passos personalizados
{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
- Baixe e mova a pasta extraída
MyExtensionao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Compatível com registro
{{ExtensionInstall
|registration=1
}}
- Baixe e mova a pasta extraída
MyExtensionao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
wfLoadExtension( 'MyExtension' );Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Compatível com registro e com versão mínima
{{ExtensionInstall
|registration=1
|no-registration-version=1.39
}}
- Baixe e mova a pasta extraída
MyExtensionao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
wfLoadExtension( 'MyExtension' );Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Para usuários executando o MediaWiki 1.39 ou anteriores:
As instruções acima descrevem a nova forma de instalar essa extensão utilizando a
wfLoadExtension(). Se precisar instalar essa extensão em versões antigas (MediaWiki 1.39 e anteriores), em vez dawfLoadExtension( 'MyExtension' );, você precisa usar:require_once "$IP/extensions/MyExtension/MyExtension.php";
Isso somente funcionará se a versão especificada for 1.35 ou posterior. Caso contrário, a predefinição assumirá que ninguém se importa sobre versões tão antigas assim, e fará o mesmo que em #Requer registro.
Requer registro
{{ExtensionInstall
|registration=required
}}
- Baixe e mova a pasta extraída
MyExtensionao seu diretórioextensions/.
Desenvolvedores e colaboradores de código, por outro lado, deverão instalar a extensão a partir do Git, usando:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
wfLoadExtension( 'MyExtension' );Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Tudo
{{ExtensionInstall|Example
|download-link=[http://bits.wikimedia.org/example.zip Download]
|vagrant=example
|localsettings=
$wgUseAjax = true;
|db-update=Yes
|composer=Yes
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
|registration=yes
}}
- Download e coloque o(s) arquivo(s) num diretório chamado
Examplena sua pastaextensions/.- Se estiver instalando a partir do Git, execute o Composer para instalar as dependências do PHP através do comando
composer install --no-devno diretório da extensão. (Veja T173141 para possíveis complicações.)- Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
wfLoadExtension( 'Example' ); $wgUseAjax = true;- Execute o script de atualização que criará automaticamente as tabelas necessárias a essa extensão no banco de dados.
- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Para usuários executando o MediaWiki 1.39 ou anteriores:
As instruções acima descrevem a nova forma de instalar essa extensão utilizando a
wfLoadExtension(). Se precisar instalar essa extensão em versões antigas (MediaWiki 1.39 e anteriores), em vez dawfLoadExtension( 'Example' );, você precisa usar:require_once "$IP/extensions/Example/Example.php";
Instalação com o Vagrant:
- Se estiver usando o Vagrant, instale com
vagrant roles enable example --provision