Template:ExtensionInstall

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:ExtensionInstall and the translation is 96% complete.
Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎galego • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎čeština • ‎български • ‎македонски • ‎русский • ‎українська • ‎العربية • ‎فارسی • ‎हिन्दी • ‎বাংলা • ‎中文 • ‎日本語 • ‎한국어
  • Baixe e coloque o(s) arquivo(s) num diretório chamado ExtensionInstall na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
    require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
    
  • Yes Pronto – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
Documentação da predefinição

Uso

Add instructions about installing an extension.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Extension name1

Set the extension name manually.

Default
The current page name without namespace prefix.
Auto value
{{ROOTPAGENAME}}, i.e. the page name without namespace nor subpages
Stringoptional
Vagrant role namevagrant

If given, shows how to install extension with the vagrant's enable-role command

Auto value
Stringoptional
Download linkdownload-link

Overwrite the download link.

Default
Link to ExtensionDistributor with the extension name.
URLoptional
LocalSettings earlylocalsettingsearly

Pass custom php code that the user should include in [[LocalSettings.php]] before the extension is loaded.

Example
$wgUseAjax = true; //must be included before the extension is loaded
Unknownoptional
LocalSettingslocalsettings

Pass custom php code that the user should include in [[LocalSettings.php]].

Example
$wgUseAjax = true;
Unknownoptional
Database updatedb-update

If the extension has one or more database tables that need to be created through [[update.php]], set this parameter to any value.

Default
false
Booleanoptional
Composercomposer

If the extension uses [[Composer]] to manage dependencies, set this parameter to any value.

Default
false
Booleanoptional
Custom steps 0custom-steps0

Additional steps before download, e.g. other required extensions (as an unordered "* list")

Contentoptional
Custom stepscustom-steps

Additional steps (as an unordered "* list")

Contentoptional
Supports registrationregistration

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.

Stringoptional
No registration versionno-registration-version

The MediaWiki version for which extension registration should not be used

Default
1.24
Unknownoptional

Exemplos

A seguir, há alguns exemplos de como usar essa predefinição:

Simples

{{ExtensionInstall}}
  • Baixe e coloque o(s) arquivo(s) num diretório chamado MyExtension na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Pronto – 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 coloque o(s) arquivo(s) num diretório chamado CategoryTree na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
    require_once "$IP/extensions/CategoryTree/CategoryTree.php";
    
  • Yes Pronto – 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 MyExtension na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Pronto – 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 coloque o(s) arquivo(s) num diretório chamado MyExtension na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    $wgUseAjax = true;
    
  • Yes Pronto – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.

LocalSettings early

{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // this must be included before the extension is loaded
}}
  • Baixe e coloque o(s) arquivo(s) num diretório chamado MyExtension na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
    $wgUseAjax = true; // this must be included before the extension is loaded
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Pronto – 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 coloque o(s) arquivo(s) num diretório chamado MyExtension na sua pasta extensions/.
  • 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 de banco de dados necessárias a essa extensão.
  • Yes Pronto – 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 coloque o(s) arquivo(s) num diretório chamado MyExtension na sua pasta extensions/.
  • Execute o Composer para instalar as dependências PHP através de composer install --no-dev no 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";
    
  • Yes Pronto – 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 coloque o(s) arquivo(s) num diretório chamado MyExtension na sua pasta extensions/.
  • 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
  • Yes Pronto – 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 coloque o(s) arquivo(s) num diretório chamado MyExtension na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Pronto – 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.24 ou anteriores:

As instruções acima descrevem a nova forma de instalar essa extensão utilizando wfLoadExtension(). Se precisar instalar essa extensão em versões antigas (MediaWiki 1.24 e anteriores), em vez de wfLoadExtension( 'MyExtension' );, você precisa usar:

require_once "$IP/extensions/MyExtension/MyExtension.php";

Definindo registro recomendado da versão do MediaWiki

{{ExtensionInstall
|registration=1
|no-registration-version=1.25
}}
  • Baixe e coloque o(s) arquivo(s) num diretório chamado MyExtension na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Pronto – 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.25 ou anteriores:

As instruções acima descrevem a nova forma de instalar essa extensão utilizando wfLoadExtension(). Se precisar instalar essa extensão em versões antigas (MediaWiki 1.25 e anteriores), em vez de wfLoadExtension( 'MyExtension' );, você precisa usar:

require_once "$IP/extensions/MyExtension/MyExtension.php";

Requer registro

{{ExtensionInstall
|registration=required
}}
  • Baixe e coloque o(s) arquivo(s) num diretório chamado MyExtension na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Pronto – 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
}}
  • Se estiver usando o Vagrant , instale com vagrant roles enable example --provision
Instalação manual
  • Download e coloque o(s) arquivo(s) num diretório chamado Example na sua pasta extensions/.
  • Execute o Composer para instalar as dependências PHP através de composer install --no-dev no 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 de banco de dados necessárias a essa extensão.
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Pronto – 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.24 ou anteriores:

As instruções acima descrevem a nova forma de instalar essa extensão utilizando wfLoadExtension(). Se precisar instalar essa extensão em versões antigas (MediaWiki 1.24 e anteriores), em vez de wfLoadExtension( 'Example' );, você precisa usar:

require_once "$IP/extensions/Example/Example.php";