Plantilla:ExtensionInstall

From mediawiki.org
This page is a translated version of the page Template:ExtensionInstall and the translation is 96% complete.
  • Descarga y extrae los archivos en un directorio denominado «ExtensionInstall» dentro de la carpeta extensions/.
  • Añade el código siguiente al final de LocalSettings.php :
    require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
    
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.
Template documentation

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

Ejemplos

Debajo hay algunos ejemplos de cómo usar esta plantilla:

Simple

{{ExtensionInstall}}
  • Descarga y extrae los archivos en un directorio denominado «MyExtension» dentro de la carpeta extensions/.
  • Añade el código siguiente al final de LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Nombre

{{ExtensionInstall|CategoryTree}}
  • Descarga y extrae los archivos en un directorio denominado «CategoryTree» dentro de la carpeta extensions/.
  • Añade el código siguiente al final de LocalSettings.php :
    require_once "$IP/extensions/CategoryTree/CategoryTree.php";
    
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Enlace de descarga

{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
  • Download y extrae los archivos en el directorio «MyExtension» dentro del directorio extensions/ existente.
  • Añade el código siguiente al final de LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

LocalSettings

{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
  • Descarga y extrae los archivos en un directorio denominado «MyExtension» dentro de la carpeta extensions/.
  • Añade el código siguiente al final de LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    $wgUseAjax = true;
    
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

LocalSettings anticipado

{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // this must be included before the extension is loaded
}}
  • Descarga y extrae los archivos en un directorio denominado «MyExtension» dentro de la carpeta extensions/.
  • Añade el código siguiente al final de LocalSettings.php :
    $wgUseAjax = true; // this must be included before the extension is loaded
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Actualización de base de datos

{{ExtensionInstall
|db-update=Yes
}}
  • Descarga y extrae los archivos en un directorio denominado «MyExtension» dentro de la carpeta extensions/.
  • Añade el código siguiente al final de LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Ejecuta la secuencia de actualización, que creará automáticamente las tablas de la base de datos que necesita esta extensión.
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Composer

{{ExtensionInstall
|composer=Yes
}}
  • Descarga y extrae los archivos en un directorio denominado «MyExtension» dentro de la carpeta extensions/.
  • Cuando se efectúa la instalación desde Git, hay que ejecutar Composer para que se instalen las dependencias de PHP; para este efecto, ejecute composer install --no-dev en el directorio de la extensión. (ver task T173141 para complicaciones potenciales)
  • Añade el código siguiente al final de LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Pasos personalizados

{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
  • Descarga y extrae los archivos en un directorio denominado «MyExtension» dentro de la carpeta extensions/.
  • Añade el código siguiente al final de LocalSettings.php :
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Registro para asistencia

{{ExtensionInstall
|registration=1
}}
  • Descarga y extrae los archivos en un directorio denominado «MyExtension» dentro de la carpeta extensions/.
  • Añade el código siguiente al final de LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Para quienes usan MediaWiki 1.24 o versiones anteriores:

Estas instrucciones describen la nueva forma de instalar extensiones usando wfLoadExtension(). Si necesitas instalar esta extensión en versiones anteriores (MediaWiki 1.24 y anteriores), debes usar lo siguiente en lugar de wfLoadExtension( 'MyExtension' );:

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

Establecer el registro recomendado de la versión de MediaWiki

{{ExtensionInstall
|registration=1
|no-registration-version=1.25
}}
  • Descarga y extrae los archivos en un directorio denominado «MyExtension» dentro de la carpeta extensions/.
  • Añade el código siguiente al final de LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Para quienes usan MediaWiki 1.25 o versiones anteriores:

Estas instrucciones describen la nueva forma de instalar extensiones usando wfLoadExtension(). Si necesitas instalar esta extensión en versiones anteriores (MediaWiki 1.25 y anteriores), debes usar lo siguiente en lugar de wfLoadExtension( 'MyExtension' );:

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

Requiere registro

{{ExtensionInstall
|registration=required
}}
  • Descarga y extrae los archivos en un directorio denominado «MyExtension» dentro de la carpeta extensions/.
  • Añade el código siguiente al final de LocalSettings.php :
    wfLoadExtension( 'MyExtension' );
    
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Todo

{{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 y extrae los archivos en el directorio «Example» dentro del directorio extensions/ existente.
  • Cuando se efectúa la instalación desde Git, hay que ejecutar Composer para que se instalen las dependencias de PHP; para este efecto, ejecute composer install --no-dev en el directorio de la extensión. (ver task T173141 para complicaciones potenciales)
  • Añade el código siguiente al final de LocalSettings.php :
    wfLoadExtension( 'Example' );
    $wgUseAjax = true;
    
  • Ejecuta la secuencia de actualización, que creará automáticamente las tablas de la base de datos que necesita esta extensión.
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Hecho – Navega a Special:Version en el wiki para verificar que la extensión se haya instalado correctamente.

Para quienes usan MediaWiki 1.24 o versiones anteriores:

Estas instrucciones describen la nueva forma de instalar extensiones usando wfLoadExtension(). Si necesitas instalar esta extensión en versiones anteriores (MediaWiki 1.24 y anteriores), debes usar lo siguiente en lugar de wfLoadExtension( 'Example' );:

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


Vagrant installation:

  • Si se utiliza Vagrant , instala con vagrant roles enable example --provision