Jump to content

Templat:ExtensionInstall

From mediawiki.org
This page is a translated version of the page Template:ExtensionInstall and the translation is 100% complete.
  • Unduh dan pindahkan folder ExtensionInstall yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall
    
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
    
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.
Dokumentasi templat

Penggunaan

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

Contoh

Berikut adalah beberapa contoh cara menggunakan templat ini:

Sederhana

{{ExtensionInstall}}
  • Unduh dan pindahkan folder MyExtension yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

Nama

{{ExtensionInstall|CategoryTree}}
  • Unduh dan pindahkan folder CategoryTree yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree
    
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    require_once "$IP/extensions/CategoryTree/CategoryTree.php";
    
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

Pranala unduhan

{{ExtensionInstall
|download-link=[http://bits.wikimedia.org/example.zip Download]
}}
  • Download dan letakkan berkas yang diperlukan di sebuah direktori bernama MyExtension di folder extensions/ Anda.
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

LocalSettings

{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
  • Unduh dan pindahkan folder MyExtension yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    $wgUseAjax = true;
    
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

LocalSettings awal

{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // Ini harus disertakan sebelum pengaya dimuat.
}}
  • Unduh dan pindahkan folder MyExtension yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    $wgUseAjax = true; // Ini harus disertakan sebelum pengaya dimuat
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

Pembaruan pangkalan data

{{ExtensionInstall
|db-update=Yes
}}
  • Unduh dan pindahkan folder MyExtension yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Jalankan skrip pembaruan yang akan membuat tabel pangkalan data yang diperlukan pengaya ini secara otomatis.
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

Composer

{{ExtensionInstall
|composer=Yes
}}
  • Unduh dan pindahkan folder MyExtension yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Hanya ketika memasang dari Git, jalankan Composer untuk memasang ketergantungan PHP, dengan mengeluarkan perintah composer install --no-dev di direktori pengaya. (Lihat T173141 untuk komplikasi yang mungkin terjadi.)
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

Langkah tambahan

{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
  • Unduh dan pindahkan folder MyExtension yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

Mendukung pendaftaran

{{ExtensionInstall
|registration=1
}}
  • Unduh dan pindahkan folder MyExtension yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

Mendukung pendaftaran dengan versi minimum

{{ExtensionInstall
|registration=1
|no-registration-version=1.39
}}
  • Unduh dan pindahkan folder MyExtension yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

Bagi pengguna yang menjalankan MediaWiki 1.39 atau lebih lama:

Petunjuk di atas menjelaskan cara baru untuk memasang pengaya ini menggunakan wfLoadExtension(). Jika Anda perlu memasang pengaya ini di versi yang lebih lama (MediaWiki 1.39 dan sebelumnya), alih-alih wfLoadExtension( 'MyExtension' );, Anda perlu menggunakan:

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

Ini hanya berfungsi jika versi yang ditentukan adalah 1.39 atau lebih baru, jika tidak, templat menganggap tidak ada yang peduli dengan versi lama dan kembali ke #Membutuhkan pendaftaran.

Mengharuskan pendaftaran

{{ExtensionInstall
|registration=required
}}
  • Unduh dan pindahkan folder MyExtension yang diekstrak ke direktori extensions/ Anda.
    Pengembang dan penyumbangsih kode sebaiknya memasang pengaya dari Git sebagai gantinya, menggunakan:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension
    
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    wfLoadExtension( 'MyExtension' );
    
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

Semuanya

{{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 dan letakkan berkas yang diperlukan di sebuah direktori bernama Example di folder extensions/ Anda.
  • Hanya ketika memasang dari Git, jalankan Composer untuk memasang ketergantungan PHP, dengan mengeluarkan perintah composer install --no-dev di direktori pengaya. (Lihat T173141 untuk komplikasi yang mungkin terjadi.)
  • Tambahkan kode berikut di bawah berkas LocalSettings.php Anda:
    wfLoadExtension( 'Example' );
    $wgUseAjax = true;
    
  • Jalankan skrip pembaruan yang akan membuat tabel pangkalan data yang diperlukan pengaya ini secara otomatis.
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes Selesai – Telusuri ke Special:Version di wiki Anda untuk memastikan pengayanya berhasil dipasang.

Bagi pengguna yang menjalankan MediaWiki 1.39 atau lebih lama:

Petunjuk di atas menjelaskan cara baru untuk memasang pengaya ini menggunakan wfLoadExtension(). Jika Anda perlu memasang pengaya ini di versi yang lebih lama (MediaWiki 1.39 dan sebelumnya), alih-alih wfLoadExtension( 'Example' );, Anda perlu menggunakan:

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


Pemasangan Vagrant:

  • Jika menggunakan Vagrant , pasanglah dengan vagrant roles enable example --provision