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 75% 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 • ‎Ελληνικά • ‎български • ‎македонски • ‎русский • ‎українська • ‎հայերեն • ‎العربية • ‎فارسی • ‎کوردی • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎မြန်မာဘာသာ • ‎中文 • ‎日本語 • ‎粵語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎조선말 • ‎한국어
テンプレートの解説

このテンプレートは表示しているwikiのすべての拡張機能ページ (各メインページに限る) に追加する必要があります。 すると便利な基礎情報ボックスを付け加え (下記参照)、拡張機能を自動的に カテゴリ:すべての拡張機能 に追加すると同時に、適切な状態 および実装の種類 のカテゴリに分類します。

使用法

以下をコピー & ペーストします:

{{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         = 
}}
引数の値のヘルプは下記を参照してください。
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}}}
translatewiki.net で翻訳を利用できる場合は、Extension 拡張機能の翻訳にご協力ください
Vagrant role {{{vagrant-role}}}
問題点 [[phab:tag/{{{phabricator}}}|未解決のタスク]] · バグを報告

コンテンツのパラメーター

この節では情報ボックスの内容を制御する引数を解説します。

templatemodeその他の制御引数に関するヘルプは制御の引数を参照してください。
コンテンツの引数
パラメーター 説明
name拡張機能の名前
status現在のリリースの状態

以下のいずれか:

  • 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[[::category:extensions with unknown status| ]]. In cases where the value is invalid, it will be placed in a special category[[::category:extensions with invalid status| ]] so that the error can be caught and fixed.

type1
type2
type3
type4
type5
type6
実装の種類

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.

Allowed 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 action s. 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 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/ja.

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
...
hook90
拡張機能が使用する各フックの名前

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
...
newhook90
name of each hook provided by the extension You might also want to add the hooks to Extension hook registry.
usernameMediaWiki.orgでの作者の利用者名 (登録済の場合)。 省略可能ですが、登録してある場合は作者の利用者ぺージならびにそのトークページにリンクするため使用します。 名前空間名と[[]]を除去して記入します。
authorMediaWiki.org登録名と異なる場合、拡張機能の作者名。 フリーテキスト。 省略すると'username'欄を使用 (登録済みの場合)。
description短い説明
image拡張機能の画面キャプチャもしくはロゴ 名前空間名と[[]]を除去して記入します。
imagesize文字通り画像サイズ (既定値は220px)
version最終バージョン
update最終更新の日付
compatibility policy互換性の方針 (認められる値はmasterrel)。 (製品バックログ )
mediawiki必要とする MediaWiki のバージョン
php必要な 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 をインストールしたインストールパス (または「ディレクトリ」) を意味します (Install Path の略)。そのディレクトリには LocalSettings.phpindex.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:

  • templatemode=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/ja and to one or more additional categories, depending on the values assigned to the Content parameters.

基礎情報ボックスの使用

既存の拡張機能ページ

既存のページに情報ボックスを追加するには、このページ冒頭のコードをコピー&ペーストします。

拡張機能の記事の新規作成

拡張機能の新規ページを作成するには、下記の欄にページ名を記入してボタンをクリックします。 すると基礎情報ボックスを備えた新規ページが作成されます。


A developer sharing their code in the MediaWiki code repository should expect:

フィードバック / 批評 / コード レビュー
Review and comments by other developers on things like framework use, security, efficiency and usability.
Developer tweaking
Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.
Improved access for wiki sysadmins
If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then request commit access to continue maintaining it.
他の開発者による将来のバージョン
New branches of your code being created automatically as new versions of MediaWiki are released. You should backport to these branches if you want to support older versions.
Incorporation of your code into other extensions with duplicate or similar purposes — incorporating the best features from each extension.
帰属
Credit for your work being preserved in future versions — including any merged extensions.
Similarly, you should credit the developers of any extensions whose code you borrow from — especially when performing a merger.

Any developer who is uncomfortable with any of these actions occurring should not host in the code repository. You are still encouraged to create a summary page for your extension on the wiki to let people know about the extension, and where to download it.

テンプレートの強化

テンプレート改善に取り組もうと考えていますか、よろしくお願いします! テンプレートが複雑なため、いくつか手順のヘルプを提供します。

拡張機能作成ボタン

拡張機能作成ボタンの挙動を改善する方法:

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

Maintenance: vulnerabilities, archived