Jump to content

Template:ExtensionInstall/zh

From mediawiki.org
This page is a translated version of the page Template:ExtensionInstall and the translation is 100% complete.
  • 下载文件,并解压ExtensionInstall文件夹到extensions/目录中。
    开发者和代码贡献人员应改从Git安装此扩展,输入:
    cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ExtensionInstall
    
  • 請新增下列代码到您的LocalSettings.php 文件的底部:
    require_once "$IP/extensions/ExtensionInstall/ExtensionInstall.php";
    
  • Yes 完成 – 請导航至您的wiki上的Special:Version,以验证此扩展已成功安装。
模板文档

用法

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

示例

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

简单

{{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";
    
  • Yes 完成 – 請导航至您的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";
    
  • 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;
}}
  • 下载文件,并解压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;
    
  • Yes 完成 – 請导航至您的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";
    
  • Yes 完成 – 請导航至您的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";
    
  • 請运行更新脚本,它将自动创建此扩展所必须的数据库表。
  • Yes 完成 – 請导航至您的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";
    
  • Yes 完成 – 請导航至您的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
  • Yes 完成 – 請导航至您的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' );
    
  • Yes 完成 – 請导航至您的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' );
    
  • Yes 完成 – 請导航至您的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' );
    
  • 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
}}
  • 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.39或更早版本的用户們:

上面的指示描述的是使用wfLoadExtension()安装此扩展的新方法。 如果您需要在早期版本(MediaWiki 1.39和更早版本)中安装此扩展、而不是wfLoadExtension( 'Example' );,您需要使用:

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


使用Vagrant安装:

  • 如果你有使用Vagrant ,请通过vagrant roles enable example --provision安装