模板:扩展安装

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.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎Ελληνικά • ‎български • ‎македонски • ‎русский • ‎українська • ‎العربية • ‎فارسی • ‎हिन्दी • ‎বাংলা • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어
  • 下载文件,并将其放置在您extensions/文件夹中的ExtensionInstall目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
    
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。
模板文档

用法

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

例子

以下是如何使用此模板的例子:

简单

{{ExtensionInstall}}
  • 下载文件,并将其放置在您extensions/文件夹中的MyExtension目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

名称

{{ExtensionInstall|CategoryTree}}
  • 下载文件,并将其放置在您extensions/文件夹中的CategoryTree目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    require_once "$IP/extensions/CategoryTree/CategoryTree.php";
    
  • Yes 完成 – 在您的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";
    
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

LocalSettings

{{ExtensionInstall
|localsettings=
$wgUseAjax = true;
}}
  • 下载文件,并将其放置在您extensions/文件夹中的MyExtension目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    $wgUseAjax = true;
    
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

LocalSettings early

{{ExtensionInstall
|localsettingsearly=
$wgUseAjax = true; // this must be included before the extension is loaded
}}
  • 下载文件,并将其放置在您extensions/文件夹中的MyExtension目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    $wgUseAjax = true; // this must be included before the extension is loaded
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

数据库更新

{{ExtensionInstall
|db-update=Yes
}}
  • 下载文件,并将其放置在您extensions/文件夹中的MyExtension目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • 运行更新脚本,它将自动创建此扩展必须依赖的数据库表。
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

Composer

{{ExtensionInstall
|composer=Yes
}}
  • 下载文件,并将其放置在您extensions/文件夹中的MyExtension目录内。
  • 只有從git安裝才运行Composer来安装PHP依赖,通过发行composer install --no-dev至扩展目录。 (参见任务T173141了解潜在问题。)
  • 将下列代码放置在您的LocalSettings.php的底部:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

自定义步骤

{{ExtensionInstall
|custom-steps=
* Lorem ipsum dolor sit amet
* Foo bar baz quux [[sandbox]]
}}
  • 下载文件,并将其放置在您extensions/文件夹中的MyExtension目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    require_once "$IP/extensions/MyExtension/MyExtension.php";
    
  • Lorem ipsum dolor sit amet
  • Foo bar baz quux sandbox
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

支持注册

{{ExtensionInstall
|registration=1
}}
  • 下载文件,并将其放置在您extensions/文件夹中的MyExtension目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    wfLoadExtension( 'MyExtension' );
    
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

致使用MediaWiki 1.24或更早版本的用户:

上面的说明介绍的是安装此扩展的新方法,它使用wfLoadExtension()。 如果您需要在早期版本(MediaWiki 1.24和更早版本)中安装此扩展,而不是wfLoadExtension( 'MyExtension' );,您需要使用:

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

设置推荐的MediaWiki版本

{{ExtensionInstall
|registration=1
|no-registration-version=1.25
}}
  • 下载文件,并将其放置在您extensions/文件夹中的MyExtension目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    wfLoadExtension( 'MyExtension' );
    
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

致使用MediaWiki 1.25或更早版本的用户:

上面的说明介绍的是安装此扩展的新方法,它使用wfLoadExtension()。 如果您需要在早期版本(MediaWiki 1.25和更早版本)中安装此扩展,而不是wfLoadExtension( 'MyExtension' );,您需要使用:

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

需要注册

{{ExtensionInstall
|registration=required
}}
  • 下载文件,并将其放置在您extensions/文件夹中的MyExtension目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    wfLoadExtension( 'MyExtension' );
    
  • Yes 完成 – 在您的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
}}
  • 如果使用Vagrant ,请通过vagrant roles enable example --provision安装
手动安装
  • 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
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

致使用MediaWiki 1.24或更早版本的用户:

上面的说明介绍的是安装此扩展的新方法,它使用wfLoadExtension()。 如果您需要在早期版本(MediaWiki 1.24和更早版本)中安装此扩展,而不是wfLoadExtension( 'Example' );,您需要使用:

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