Template:扩展安装
- 下载文件,并将解压后的
ExtensionInstall
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall - 将下列代码放置在您的LocalSettings.php 的底部:
require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
使用Lua |
用法
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 has one or more database tables that need to be created through [[update.php]], set this parameter to any value.
| Boolean | optional |
Composer | composer | If the extension uses [[Composer]] to manage dependencies, set this parameter to any value.
| 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 |
示例
以下是如何使用此模板的例子:
简单
{{ExtensionInstall}}
- 下载文件,并将解压后的
MyExtension
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- 将下列代码放置在您的LocalSettings.php 的底部:
require_once "$IP/extensions/MyExtension/MyExtension.php";- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
名称
{{ExtensionInstall|CategoryTree}}
- 下载文件,并将解压后的
CategoryTree
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CategoryTree- 将下列代码放置在您的LocalSettings.php 的底部:
require_once "$IP/extensions/CategoryTree/CategoryTree.php";- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
下載連結
{{ExtensionInstall |download-link=[http://bits.wikimedia.org/example.zip Download] }}
- Download文件,并将其放置在您
extensions/
文件夹中的MyExtension
目录内。- 将下列代码放置在您的LocalSettings.php 的底部:
require_once "$IP/extensions/MyExtension/MyExtension.php";- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
LocalSettings
{{ExtensionInstall |localsettings= $wgUseAjax = true; }}
- 下载文件,并将解压后的
MyExtension
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- 将下列代码放置在您的LocalSettings.php 的底部:
require_once "$IP/extensions/MyExtension/MyExtension.php"; $wgUseAjax = true;- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
LocalSettings 注册前
{{ExtensionInstall |localsettingsearly= $wgUseAjax = true; // 在加载扩展之前,必须包含此行 }}
- 下载文件,并将解压后的
MyExtension
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- 将下列代码放置在您的LocalSettings.php 的底部:
$wgUseAjax = true; // 在加载扩展之前,必须包含此行 require_once "$IP/extensions/MyExtension/MyExtension.php";- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
数据库更新
{{ExtensionInstall |db-update=Yes }}
- 下载文件,并将解压后的
MyExtension
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- 将下列代码放置在您的LocalSettings.php 的底部:
require_once "$IP/extensions/MyExtension/MyExtension.php";- 运行更新脚本,它将自动创建此扩展必须依赖的数据库表。
- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
Composer
{{ExtensionInstall |composer=Yes }}
- 下载文件,并将解压后的
MyExtension
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- 只有從git安裝才运行Composer来安装PHP依赖,通过发行
composer install --no-dev
至扩展目录。 (参见工單T173141了解潜在问题。)- 将下列代码放置在您的LocalSettings.php 的底部:
require_once "$IP/extensions/MyExtension/MyExtension.php";- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
自定义步骤
{{ExtensionInstall |custom-steps= * Lorem ipsum dolor sit amet * Foo bar baz quux [[sandbox]] }}
- 下载文件,并将解压后的
MyExtension
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- 将下列代码放置在您的LocalSettings.php 的底部:
require_once "$IP/extensions/MyExtension/MyExtension.php";- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
支持注册
{{ExtensionInstall |registration=1 }}
- 下载文件,并将解压后的
MyExtension
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- 将下列代码放置在您的LocalSettings.php 的底部:
wfLoadExtension( 'MyExtension' );- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
支持最低版本注册
{{ExtensionInstall |registration=1 |no-registration-version=1.39 }}
- 下载文件,并将解压后的
MyExtension
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- 将下列代码放置在您的LocalSettings.php 的底部:
wfLoadExtension( 'MyExtension' );- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
致使用MediaWiki 1.39或更早版本的用户:
上面的说明介绍的是安装此扩展的新方法,它使用
wfLoadExtension()
。 如果您需要在早期版本(MediaWiki 1.39和更早版本)中安装此扩展,而不是wfLoadExtension( 'MyExtension' );
,您需要使用:require_once "$IP/extensions/MyExtension/MyExtension.php";
这仅在指定的版本为1.35及更高版本时有效,否则模板假定没有人关心古代版本并回退到#需要注册。
需要注册
{{ExtensionInstall |registration=required }}
- 下载文件,并将解压后的
MyExtension
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MyExtension- 将下列代码放置在您的LocalSettings.php 的底部:
wfLoadExtension( 'MyExtension' );- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
任何
{{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文件,并将其放置在您
extensions/
文件夹中的Example
目录内。- 只有從git安裝才运行Composer来安装PHP依赖,通过发行
composer install --no-dev
至扩展目录。 (参见工單T173141了解潜在问题。)- 将下列代码放置在您的LocalSettings.php 的底部:
wfLoadExtension( 'Example' ); $wgUseAjax = true;- 运行更新脚本,它将自动创建此扩展必须依赖的数据库表。
- Lorem ipsum dolor sit amet
- Foo bar baz quux sandbox
- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
致使用MediaWiki 1.39或更早版本的用户:
上面的说明介绍的是安装此扩展的新方法,它使用
wfLoadExtension()
。 如果您需要在早期版本(MediaWiki 1.39和更早版本)中安装此扩展,而不是wfLoadExtension( 'Example' );
,您需要使用:require_once "$IP/extensions/Example/Example.php";
使用Vagrant安装:
- 如果使用Vagrant ,请通过
vagrant roles enable example --provision
安装