Phabricator项目： [[phab:tag/{{{phabricator}}}/|#{{{phabricator}}}]]

模板:扩展

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Template:Extension and the translation is 41% complete.
Other languages:
Deutsch • ‎English • ‎Nederlands • ‎Scots • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎galego • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎čeština • ‎Ελληνικά • ‎български • ‎македонски • ‎русский • ‎українська • ‎հայերեն • ‎العربية • ‎فارسی • ‎کوردی • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎မြန်မာဘာသာ • ‎中文 • ‎日本語 • ‎粵語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎조선말 • ‎한국어
模板文档

This template should be added to all extension pages on this wiki (but only the main page). It will add a useful infobox (see below) and will automatically add the extension to 分类:所有扩展 , along with the appropriate status and implementation type categories.

用法

复制粘贴: 

{{Extension |templatemode =
|name                 = 
|status               = 
|type1                = 
|type2                = 
|hook1                = 
|hook2                = 
|newhook1             = 
|newhook2             = 
|username             = 
|author               = 
|description          = 
|image                = 
|imagesize            = 
|version              = 
|update               = 
|version preview      = 
|update preview       = 
|compatibility policy =
|mediawiki            = 
|php                  = 
|needs-updatephp      = 
|composer             =
|table1               = 
|table2               = 
|license              = 
|download             = 
|readme               = 
|changelog            = 
|example              = 
|namespace            = 
|parameters           = 
|tags                 = 
|rights               = 
|compatibility        = 
|bugzilla             = 
|phabricator          =
|vagrant-role         = 
}}
For help with parameter values, see below.
MediaWiki扩展手册
OOjs UI icon advanced.svg
{{{name}}}
发布状态： 未知
Placeholder.png
实现 {{{type1}}}, {{{type2}}}
描述 {{{description}}}
作者 SomeAuthor (SomeUsertalk)
最新版本 {{{version}}} ({{{update}}})
最新预览版本 {{{version preview}}} ({{{update preview}}})
兼容性方针 无效
MediaWiki {{{mediawiki}}}
PHP {{{php}}}
数据更新 {{{needs-updatephp}}}
Composer {{{composer}}}
表格 [[Special:MyLanguage/Template:Extension/{{{table1}}} table|{{{table1}}}]][[:Template:Extension/{{{table1}}} table| ]]
[[Special:MyLanguage/Template:Extension/{{{table2}}} table|{{{table2}}}]][[:Template:Extension/{{{table2}}} table| ]]
许可协议 {{{license}}}
下载 {{{download}}}
{{{readme}}}
{{{changelog}}}
例子 {{{example}}}
名字空间
{{{namespace}}}
参数
{{{parameters}}}
标签
{{{tags}}}
添加的权限

{{{rights}}}

使用的钩子
提供的钩子
{{{compatibility}}}
翻译Extension扩展如果在translatewiki.net可用
Vagrant角色 {{{vagrant-role}}}
问题 [[phab:tag/{{{phabricator}}}|开放的工作]] · 报告错误

内容参数

This section describes parameters that govern infobox content. For help with templatemode and other control parameters, please see Control parameters.

Content parameters
参数 描述
namename of the extension
statuscurrent release status

One of:

  • unstable (broken - do not use this extension)
  • experimental (early stages of development, may change drastically)
  • beta (stable but not fully tested)
  • stable (stable version)
  • unmaintained (unmaintained - previously claimed to be stable, now unmaintained)
  • archive (archived - deprecated or merged with another extension)
  • unknown (default)

If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorized as unknown. In cases where the value is invalid, it will be placed in a special category so that the error can be caught and fixed.

type1
type2
type3
type4
type5
type6
implementation type

The implementation strategy(s) employed in building this extension. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the purpose or possible use cases, we recommend you add additional category links as needed.

Legal values for the type1, type2, ... parameters are:

  • parser - catchall for uncategorized parser extensions. If you have written a parser extension, please use one of the following more specific types:
  • access - catchall for user access extensions, that is, extensions that create, authenticate, grant permissions, revoke permissions, or monitor the activity of users. If you have written an access extension, please use one of the following more specific types:
    • user activity - extensions that monitor user activity (logins, logouts, new user creation, etc.)
    • user identity - extensions that create and delete users, and/or verify the identity of a user
    • user rights - extensions to the rights management system, e.g. changes to the way rights are assigned, API, maintenance tools (does not include extensions that merely name the rights needed to use the features of that extension; for this purpose use the rights parameter)
  • interface - catchall for uncategorized user interface extensions.
    • media - extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with $wgMediaHandlers .
    • mywiki - extensions that provide infrastructure so that users may personalize their MediaWiki experience and/or assist in the management of that infrastructure
    • notify - extensions that email users, broadcast messages and provide other forms of community notification
    • page action - extensions that enhance or modify page actions. This includes anything that implements an action that reads, writes, searches for, creates, renames, deletes, redirects or discusses a page. It does not include rights (use user rights) or logs (use user activity).
    • search - extensions that search through and select articles for users.
    • skin - extensions adding CSS or JavaScript, or implementing hook functions to change the look and feel of MediaWiki via the skins framework.
    • ajax - extensions that use Ajax programming techniques.
    • special - extensions that subclass the SpecialPage class, use one of its hooks, or patch one or more functions in SpecialPage.php. See Special:MyLanguage/Manual:Special pages for more information.
  • other
    • api - extensions that add a new API module or extend a core API module.
    • hook - Hook extension - defines a new hook - see hook1, etc. below if you want to define hooks used by your extension
    • database - adds tables and/or fields to the database backing a MediaWiki installation
    • data extraction - Data extraction
    • filerepo - extension that adds new file repository types as file backend
    • example - Not a real extension, but an example of how to write one

Any other value for 'type' is invalid, and will cause the extension to be placed in Category:Extensions with invalid or missing type/zh.

Note: Many extensions have more than one type, if this applies to yours, replace |type= with |type1=|type2=|type3=.... You may define up to six types for an extension.
hook1
hook2
hook3
hook4
...
hook30		 name of each hook used by the extension

Entering values in this field is a good way to get exposure for your extension and help other developers. Each documented hook will automatically add the extension to a category listing extensions that use that hook. This category is autolinked to each hook article so that programmers can easily find examples of extensions that use a particular hook.

For built-in hooks:

  • use the hook name alone. Please see Manual:Hooks for values (but omit introductory '/').

For custom hooks defined by extensions:

For multiple hooks, assign the first hook to hook1, the second to hook2 and so on.
newhook1
newhook2
newhook3
newhook4
...
newhook30		 name of each hook provided by the extension You might also want to add the hooks to Extension hook registry.
usernameThe author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s.
authorThe extension author's name, if different from their MediaWiki.org username. 免费文本。 If omitted then the 'username' field will be used (if present).
description简短描述
imagescreenshot or logo of extension. It should be provided without namespace and without [[]]s.
imagesizefacultative, size of the image (default size is 220px)
version最后版本
updatedate of the last update
compatibility policycompatibility policy (accepted values are master and rel). (积压 )
mediawikirequired version of MediaWiki
phprequired version of PHP
needs-updatephpYes indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run. It is a common pitfall: your MediaWiki will stall, if you forgot to run update.php - if the extension requires it. No should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty

Extensions which conform to MediaWiki extension standards come with a schema change script which you need to start manually (once) before starting and accessing the MediaWiki through your browser, and after you copied all the extension files to $IP/extensions/ExtensionName and inserted wfLoadExtension( "ExtensionName"); into "LocalSettings.php", run from the command line: 

cd path/to/wiki_install_directory
cd maintenance
php update.php
$IP代表MediaWiki安装的安装路径（或“目录”），即LocalSettings.php、index.php所在的目录。
composerIf applicable the name of the "vendor" as well as the "package" should be entered in the format vendor/package, e.g. mediawiki/semantic-media-wiki to point people directly to packagist.org, which serves as the package archive.
table1
table2
table3
table4
...
table30		name of each non-core table used by the extension Links to a subpage of your extension page. For instance, "table1 = cu_changes" at Extension:CheckUser will link to Extension:CheckUser/cu_changes table. Don't list core tables such as page or revision; only list tables that are added by extensions.
licenselicense governing use of this extension, as one of the codes found in https://spdx.org/licenses/, e.g. GPL-2.0-or-later, GPL-2.0-only or GPL-3.0-or-later, etc.
downloadlink to the download : Git, {{WikimediaDownload}} with server=svn in case it was not migrated from Subversion. If you put the code into page in the MediaWiki wiki, link to it using a full page name and section name, e.g. [[Extension:Example/version_1.22a#Code]] (it must remain valid when bot-copied elsewhere)
readmeexternal link to the readme file, e.g. https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README
changelogexternal link to the changelog file, e.g. Extension:LDAP Authentication/Changelog
parametersavailable parameters for LocalSettings.php
tagsany tags your extension uses (e.g. <tag1>, <tag2>).
rightsrights added by the extension. Not to be confused with the license! Rights are such as makebot or desysop, not such as GFDL or LGPL or GPL - those are licenses!
namespacenamespace in which this extension is used
exampleexample, website or screenshot of working extension
compatibilityAdditional compatibility information, for instance compatibility charts (formerly using Template:Extension Testing). It's encouraged to add any client-side compatibility information here too, especially when diverging from expectations of full support for a browser.
translateOptional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled. If the default link is incorrect, manually set it to:
  • ext-LOWERCASE(NOSPACES(Label as defined in config)), aka
  • the parameter you get in the URL after
bugzillaBugzilla MediaWiki extension component name
phabricatorPhabricator project name
CheckUsageNameOverrideoverride the page name used for the check usage link.

控制参数

控制参数
参数 描述
templatemodeControls auto-categorization of host page.

Normally left blank. Alternate values are:

  • nocats - suppresses categorization and the 'check usage' link. Use this value if you are adding this template to subpages of an extension or to how-to documentation of extensions. For example, the usage image above sets templatemode=nocats because this isn't an actual extension page and we don't want to add this page to any categories on account of it.
  • nousage - suppresses the 'check usage' link. Link is also suppressed if the page is a subpage; it is not in the Extension: namespace; or if suppressed by 'templatemode=nocats'


If this is left blank, this template will add the host page to Category:All extensions/zh and to one or more additional categories, depending on the values assigned to the Content parameters.

使用信息框

Existing extension pages

If you want to add the infobox to an existing page, copy and paste the code at the top of this page.

Create a new extension article

If you want to create a new extension page, enter the name below and click the button. A new page will be created with the infobox template already in place.

Template:Extension/Expectations

增强这个模版

If you would like to improve on this template, thanks! This is a complicated template so here is some help along the way:

创建扩展按钮

To improve the create extension button behavior:

Infobox parameters

In general:

  • To make this template easy to use, each label in the infobox is linked to documentation on the template parameter(s) it displays. If you add a parameter, please be sure to also add it to the content parameter documentation and link its label to that documentation.

To change/correct/add to the implementation type parameters:

To change the behavior of the hook parameters:

Test case

See if the following pages are still ok, after edited this template.

TemplateData

An infobox for a MediaWiki extension.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Statusstatus

Current release status. One of: unstable, experimental, beta, stable, unmaintained, unknown.

Default
unknown
Stringoptional
Namename

name of the extension

Stringoptional
Licenselicense

Extension's license.

Stringoptional
Modetemplatemode

Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.

Unknownoptional
Screenshot or logoimage

Screenshot or logo of extension. It should be provided without namespace and without [[]]s.

Unknownoptional
Imagesizeimagesize

Facultative, size of the image (default size is 220px)

Unknownoptional
Primary typetype

Implementation type. See detailed doc.

Unknownoptional
Secondary typetype1

Implementation type. See detailed doc.

Unknownoptional
Tertiary typetype2

Implementation type. See detailed doc.

Unknownoptional
Quaternary typetype3

Implementation type. See detailed doc.

Unknownoptional
Quaternary typetype4

Implementation type. See detailed doc.

Unknownoptional
Quinary typetype5

Implementation type. See detailed doc.

Unknownoptional
Senary typetype6

Implementation type. See detailed doc.

Unknownoptional
Descriptiondescription

Short description.

Unknownoptional
Authorauthor

The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).

Unknownoptional
Usernameusername

The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s.

Unknownoptional
Versionversion latest release version latest_release_version

no description

Unknownoptional
Updateupdate

date of the last update

Unknownoptional
Version previewversion preview

version preview

Unknownoptional
Update previewupdate preview

version preview

Unknownoptional
Compatibility policycompatibility policy

For older versions of MediaWiki, should one use the extension's master branch or the REL1_XX branch corresponding to the MediaWiki version? Allowed values: master, rel

Stringsuggested
Mediawikimediawiki

Required version of MediaWiki

Unknownoptional
Phpphp

Required version of PHP

Unknownoptional
Needs-updatephpneeds-updatephp

Yes indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run. It is a common pitfall: your MediaWiki will stall, if you forgot to run update.php - if the extension requires it. No should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty.

Unknownoptional
Composercomposer

If applicable the name of the "vendor" as well as the "package" should be entered in the format vendor/package, e.g. mediawiki/semantic-media-wiki to point people directly to packagist.org, which serves as the package archive.

Unknownoptional
Phabricatorphabricator

Phabricator project name

Example
MediaWiki-extensions-Babel
Stringsuggested
Table1table1

Name of a non-core table used by the extension.

Unknownoptional
Table2table2

Name of a non-core table used by the extension.

Unknownoptional
Table3table3

Name of a non-core table used by the extension.

Unknownoptional
Table4table4

Name of a non-core table used by the extension.

Unknownoptional
Table5table5

Name of a non-core table used by the extension.

Unknownoptional
Table6table6

Name of a non-core table used by the extension.

Unknownoptional
Table7table7

Name of a non-core table used by the extension.

Unknownoptional
Table8table8

Name of a non-core table used by the extension.

Unknownoptional
Table9table9

Name of a non-core table used by the extension.

Unknownoptional
Table10table10

Name of a non-core table used by the extension.

Unknownoptional
Downloaddownload

Link to the download.

Unknownoptional
Readmereadme

external link to the readme file

Unknownoptional
Changelogchangelog

external link to the changelog file

Unknownoptional
Exampleexample

example, website or screenshot of working extension

Unknownoptional
Namespacenamespace

namespace in which this extension is used

Unknownoptional
Parametersparameters

available parameters for LocalSettings.php

Unknownoptional
Tagstags

any tags your extension uses

Unknownoptional
Rightsrights

Rights added by the extension. Not to be confused with the license!

Unknownoptional
Hook1hook1

Name of a hook used by the extension.

Unknownoptional
Hook2hook2

Name of a hook used by the extension.

Unknownoptional
Hook3hook3

Name of a hook used by the extension.

Unknownoptional
Hook4hook4

Name of a hook used by the extension.

Unknownoptional
Hook5hook5

Name of a hook used by the extension.

Unknownoptional
Hook6hook6

Name of a hook used by the extension.

Unknownoptional
Hook7hook7

Name of a hook used by the extension.

Unknownoptional
Hook8hook8

Name of a hook used by the extension.

Unknownoptional
Hook9hook9

Name of a hook used by the extension.

Unknownoptional
Hook10hook10

Name of a hook used by the extension.

Unknownoptional
Hook11hook11

Name of a hook used by the extension.

Unknownoptional
Hook12hook12

Name of a hook used by the extension.

Unknownoptional
Hook13hook13

Name of a hook used by the extension.

Unknownoptional
Hook14hook14

Name of a hook used by the extension.

Unknownoptional
Hook15hook15

Name of a hook used by the extension.

Unknownoptional
Hook16hook16

Name of a hook used by the extension.

Unknownoptional
Hook17hook17

Name of a hook used by the extension.

Unknownoptional
Hook18hook18

Name of a hook used by the extension.

Unknownoptional
Hook19hook19

Name of a hook used by the extension.

Unknownoptional
Hook20hook20

Name of a hook used by the extension.

Unknownoptional
Hook21hook21

Name of a hook used by the extension.

Unknownoptional
Hook22hook22

Name of a hook used by the extension.

Unknownoptional
Hook23hook23

Name of a hook used by the extension.

Unknownoptional
Hook24hook24

Name of a hook used by the extension.

Unknownoptional
Hook25hook25

Name of a hook used by the extension.

Unknownoptional
Hook26hook26

Name of a hook used by the extension.

Unknownoptional
Hook27hook27

Name of a hook used by the extension.

Unknownoptional
Hook28hook28

Name of a hook used by the extension.

Unknownoptional
Hook29hook29

Name of a hook used by the extension.

Unknownoptional
Hook30hook30

Name of a hook used by the extension.

Unknownoptional
Hook31hook31

Name of a hook used by the extension.

Unknownoptional
Hook32hook32

Name of a hook used by the extension.

Unknownoptional
Hook33hook33

Name of a hook used by the extension.

Unknownoptional
Hook34hook34

Name of a hook used by the extension.

Unknownoptional
Hook35hook35

Name of a hook used by the extension.

Unknownoptional
Hook36hook36

Name of a hook used by the extension.

Unknownoptional
Hook37hook37

Name of a hook used by the extension.

Unknownoptional
Hook38hook38

Name of a hook used by the extension.

Unknownoptional
Hook39hook39

Name of a hook used by the extension.

Unknownoptional
Hook40hook40

Name of a hook used by the extension.

Unknownoptional
Hook41hook41

Name of a hook used by the extension.

Unknownoptional
Hook42hook42

Name of a hook used by the extension.

Unknownoptional
Hook43hook43

Name of a hook used by the extension.

Unknownoptional
Hook44hook44

Name of a hook used by the extension.

Unknownoptional
Hook45hook45

Name of a hook used by the extension.

Unknownoptional
Hook46hook46

Name of a hook used by the extension.

Unknownoptional
Hook47hook47

Name of a hook used by the extension.

Unknownoptional
Hook48hook48

Name of a hook used by the extension.

Unknownoptional
Newhook1newhook1

Name of a hook provided by the extension.

Unknownoptional
Newhook2newhook2

Name of a hook provided by the extension.

Unknownoptional
Newhook3newhook3

Name of a hook provided by the extension.

Unknownoptional
Newhook4newhook4

Name of a hook provided by the extension.

Unknownoptional
Newhook5newhook5

Name of a hook provided by the extension.

Unknownoptional
Newhook6newhook6

Name of a hook provided by the extension.

Unknownoptional
Newhook7newhook7

Name of a hook provided by the extension.

Unknownoptional
Newhook8newhook8

Name of a hook provided by the extension.

Unknownoptional
Newhook9newhook9

Name of a hook provided by the extension.

Unknownoptional
Newhook10newhook10

Name of a hook provided by the extension.

Unknownoptional
Newhook11newhook11

Name of a hook provided by the extension.

Unknownoptional
Newhook12newhook12

Name of a hook provided by the extension.

Unknownoptional
Newhook13newhook13

Name of a hook provided by the extension.

Unknownoptional
Newhook14newhook14

Name of a hook provided by the extension.

Unknownoptional
Newhook15newhook15

Name of a hook provided by the extension.

Unknownoptional
Newhook16newhook16

Name of a hook provided by the extension.

Unknownoptional
Newhook17newhook17

Name of a hook provided by the extension.

Unknownoptional
Newhook18newhook18

Name of a hook provided by the extension.

Unknownoptional
Newhook19newhook19

Name of a hook provided by the extension.

Unknownoptional
Newhook20newhook20

Name of a hook provided by the extension.

Unknownoptional
Newhook21newhook21

Name of a hook provided by the extension.

Unknownoptional
Newhook22newhook22

Name of a hook provided by the extension.

Unknownoptional
Newhook23newhook23

Name of a hook provided by the extension.

Unknownoptional
Newhook24newhook24

Name of a hook provided by the extension.

Unknownoptional
Newhook25newhook25

Name of a hook provided by the extension.

Unknownoptional
Newhook26newhook26

Name of a hook provided by the extension.

Unknownoptional
Newhook27newhook27

Name of a hook provided by the extension.

Unknownoptional
Newhook28newhook28

Name of a hook provided by the extension.

Unknownoptional
Newhook29newhook29

Name of a hook provided by the extension.

Unknownoptional
Newhook30newhook30

Name of a hook provided by the extension.

Unknownoptional
Newhook31newhook31

Name of a hook provided by the extension.

Unknownoptional
Newhook32newhook32

Name of a hook provided by the extension.

Unknownoptional
Newhook33newhook33

Name of a hook provided by the extension.

Unknownoptional
Newhook34newhook34

Name of a hook provided by the extension.

Unknownoptional
Newhook35newhook35

Name of a hook provided by the extension.

Unknownoptional
Newhook36newhook36

Name of a hook provided by the extension.

Unknownoptional
Newhook37newhook37

Name of a hook provided by the extension.

Unknownoptional
Newhook38newhook38

Name of a hook provided by the extension.

Unknownoptional
Newhook39newhook39

Name of a hook provided by the extension.

Unknownoptional
Newhook40newhook40

Name of a hook provided by the extension.

Unknownoptional
Newhook41newhook41

Name of a hook provided by the extension.

Unknownoptional
Newhook42newhook42

Name of a hook provided by the extension.

Unknownoptional
Newhook43newhook43

Name of a hook provided by the extension.

Unknownoptional
Newhook44newhook44

Name of a hook provided by the extension.

Unknownoptional
Newhook45newhook45

Name of a hook provided by the extension.

Unknownoptional
Newhook46newhook46

Name of a hook provided by the extension.

Unknownoptional
Newhook47newhook47

Name of a hook provided by the extension.

Unknownoptional
Newhook48newhook48

Name of a hook provided by the extension.

Unknownoptional
Compatibilitycompatibility

Compatibility chart, e.g. Template:Extension Testing.

Unknownoptional
Translatetranslate

Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled.

Unknownoptional
Bugzillabugzilla

Bugzilla MediaWiki extension component name

Unknowndeprecated
Vagrant rolevagrant-role

A MediaWiki-Vagrant role that lets you use this extension, if present

Stringoptional
Latest release datelatest release date

no description

Unknownoptional
Latest_release_datelatest_release_date

no description

Unknownoptional
Latest preview versionlatest preview version

no description

Unknownoptional
Latest_preview_versionlatest_preview_version

no description

Unknownoptional
Version_previewversion_preview

no description

Unknownoptional
Update_previewupdate_preview

no description

Unknownoptional
Nousagenousage

no description

Unknownoptional
CheckUsageNameOverrideCheckUsageNameOverride

no description

Unknownoptional
上述文档由Template:Extension/zh/doc转录。 (编辑 | 历史)
编者可以在此模板的沙盒 (创建 | 镜像)和测试样例 (创建)页面测试实验。
此模板的子页面

Maintenance: vulnerabilities, archived

Retrieved from "https://www.mediawiki.org/w/index.php?title=Template:Extension/zh&oldid=3397573"