Jump to content

Vorlage:ExtensionInstall

From mediawiki.org
This page is a translated version of the page Template:ExtensionInstall and the translation is 84% complete.
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens ExtensionInstall im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall
    
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
    
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.
Vorlagendokumentation

Verwendung

Installation instructions.

Template parameters[Edit template data]

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}}
Stringoptional
Git submodulegit-submodule

Add --recurse-submodules to the git clone command

Booleanoptional
Vagrant role namevagrant

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

Stringoptional
Download linkdownload-link

Overwrite the download link.

Default
Link to Special: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 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.)

Example
1
Booleanoptional
Composercomposer

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.

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

See also

Beispiele

Unten einige Beispiele, wie diese Vorlage zu verwenden ist:

Einfach

{{ExtensionInstall}}
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens MyExtension im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Name

{{ExtensionInstall|CategoryTree}}
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens CategoryTree im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree
    
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    require_once "$IP/extensions/CategoryTree/CategoryTree.php";
    
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Herunterladen

{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
  • Die Download und die Datei(en) in ein Verzeichnis namens MyExtension im Ordner extensions/ ablegen.
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

LocalSettings

{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens MyExtension im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    $wgUseAjax = true;
    
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

LocalSettings früher

{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // This must be included before the extension is loaded
}}
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens MyExtension im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    $wgUseAjax = true; // This must be included before the extension is loaded
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Datenbank-Aktualisierung

{{ExtensionInstall
|db-update=Yes
}}
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens MyExtension im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Führen Sie das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Composer

{{ExtensionInstall
|composer=Yes
}}
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens MyExtension im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Wird von git aus installiert, ist Composer auszuführen, um PHP-Abhängigkeiten zu installieren, indem composer install --no-dev im Erweiterungsverzeichnis ausgeführt wird. (Siehe T173141 für mögliche Komplikationen.)
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Anpassungsschritte

{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens MyExtension im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Registrierung unterstützt

{{ExtensionInstall
|registration=1
}}
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens MyExtension im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Support registration with minimum version

{{ExtensionInstall
|registration=1
|no-registration-version=1.39
}}
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens MyExtension im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Für Benutzer, die MediaWiki in der Version 1.39 und früher betreiben:

Die oben stehenden Anweisungen beschreiben die neue Installationsanweisung für diese Erweiterung unter der Verwendung von wfLoadExtension(). Wird diese Erweiterung in einer dieser früheren Versionen (MediaWiki 1.39 und früher)  – an Stelle von wfLoadExtension( 'MyExtension' ); – installiert, benutzen Sie:

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

This only works if the version specified is 1.39 or later, otherwise the template assumes nobody cares about ancient versions and falls back to #Require registration.

Registrierung erforderlich

{{ExtensionInstall
|registration=required
}}
  • Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens MyExtension im Ordner extensions/ ablegen.
    Developers and code contributors should install the extension from Git instead, using:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Alles

{{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
}}
  • Die Download und die Datei(en) in ein Verzeichnis namens Example im Ordner extensions/ ablegen.
  • Wird von git aus installiert, ist Composer auszuführen, um PHP-Abhängigkeiten zu installieren, indem composer install --no-dev im Erweiterungsverzeichnis ausgeführt wird. (Siehe T173141 für mögliche Komplikationen.)
  • Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:
    wfLoadExtension( 'Example' );
    $wgUseAjax = true;
    
  • Führen Sie das Aktualisierungsskript aus, welches automatisch die notwendigen Datenbanktabellen erstellt, die diese Erweiterung braucht.
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Für Benutzer, die MediaWiki in der Version 1.39 und früher betreiben:

Die oben stehenden Anweisungen beschreiben die neue Installationsanweisung für diese Erweiterung unter der Verwendung von wfLoadExtension(). Wird diese Erweiterung in einer dieser früheren Versionen (MediaWiki 1.39 und früher)  – an Stelle von wfLoadExtension( 'Example' ); – installiert, benutzen Sie:

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


Vagrant-Installation:

  • Wird Vagrant benutzt, ist mit vagrant roles enable example --provision zu installieren